Image/Video Reader
Brief Description
Similar to a Media Reader in the project panel, except that you don't need to import the file first. This is useful when using a Bind To Table with a List Directory generator set on the File parameter, to dynamically load images from a directory.
Controls
| Parameter / Script Name | Type | Default | Function |
|---|---|---|---|
Enabled / enabled | Boolean | On | |
File / inputFile | File | ||
Enable Caching / enableCaching | Boolean | On | When checked, the media frames are cached in the Media Cache for faster access in subsequent requests. This is generally very useful while modifying the project if using the media on a layer. If doing only playback or rendering of long sequences, this setting is probably useless as it caches frames that will eventually be removed from the cache because of its size limit. In these situations, unchecking can even improve performances. |
On Missing Frame / missingFrameMode | Choice | Load Previous | - Load Previous - Load Next - Load Nearest - Black - Error |
Before / beforeFirst | Choice | Hold | - Hold - Loop - Bounce - Black |
After / afterLast | Choice | Hold | - Hold - Loop - Bounce - Black |
Proxy File / proxyFile | File | The proxy file is a distinct video/image sequence that can be read instead of the main video, generally to provide a lower resolution that is used to speed-up the project. The proxy file is used waccording to the Proxy Mode parameter. To work best, the proxy image should have the same aspect ratio and the same metadata (channels, etc...) | |
Proxy Mode / proxyMode | Choice | Greater Or Equal | When to use the proxy file, when specified - Always: Always use proxy file if valid - Never: Never use proxy file - Greater Or Equal: Use proxy file only if the render requested scale does not involve upscaling the proxy - Nearest: Use the file that involves less scaling with respect to the requested scale (be it upscale or downscale) |
File Alpha Premult / filePremult | Choice | Auto | Controls the alpha-premultiplication metadata used to interpret the file. Some softwares advertise misleading values which can cause wrong interpretation of the footage. This parameter allows to force a different interpretation. - Auto: The alpha premultiplication metadata is the one indicated in the file - Opaque: Force the decoder to assume the file contains opaque pixels - Premult: Force the decoder to assume the file contains alpha premultiplied pixels - Unpremult: Force the decoder to assume the file contains non-alpha premultiplied pixels (sometimes called straight) |
Background Color / bgColor | Color | 0, 0, 0, 0 | If the image file contains a alpha premultiplied foreground blended with a background that is not black, you may remove the background by specifying its color here. This is useful in some cases for wrongful files exported by some third party softwares with file formats other than png. The background color is removed using the following formula: output.rgb = src.rgb - background_color.rgb * (1.0 - src.a) |
Colorspace Correction / enableCS | Boolean | On | When checked, the image colorspace will be converted to the colorspace defined in Output Colorspace |
File Colorspace / fileCS | Choice | - | The colorspace detected from the file metadata. Some files may advertise incorrect colorspace, this allows to override the colorspace metadata from the file. - linear: Scene-linear, high dynamic range. Used for rendering and compositing. - sRGB: Standard RGB Display Space - sRGBf: Standard RGB Display Space, but with additional range to preserve float highlights. - rec709: Rec. 709 (Full Range) Display Space - Cineon: Cineon (Log Film Scan) - Gamma1.8: Emulates an idealized Gamma 1.8 display device. - Gamma2.2: Emulates an idealized Gamma 2.2 display device. - Gamma2.4: Emulates an idealized Gamma 2.4 display device. - Gamma2.6: Emulates an idealized Gamma 2.6 display device. - Panalog: Sony/Panavision Genesis Log Space - REDLog: RED Log Space - ViperLog: Viper Log Space - AlexaV3LogC: Alexa Log C - PLogLin: Josh Pines style pivoted log/lin conversion. 445->0.18 - SLog: Sony SLog - SLog1: Sony SLog1 - SLog2: Sony SLog2 - SLog3: Sony SLog3 - CLog: Canon CLog - Log3G10: Log3G10 - Log3G12: Log3G12 - HybridLogGamma: HybdridLogGamma - Protune: GoPro Protune - BT1886: Emulates an idealized Gamma 2.4 display device. - st2084: st2084 - raw: Raw Data. Used for normals, points, etc. - Filmic Log: Log based filmic shaper with 16.5 stops of latitude, and 25 stops of dynamic range. - Filmic sRGB: Filmic sRGB view transform - False Color: Filmic false color view transform |
Output Colorspace / outputCS | Choice | Project Working Space | The colorspace in output of the footage, as seen by layers - linear: Scene-linear, high dynamic range. Used for rendering and compositing. - sRGB: Standard RGB Display Space - sRGBf: Standard RGB Display Space, but with additional range to preserve float highlights. - rec709: Rec. 709 (Full Range) Display Space - Cineon: Cineon (Log Film Scan) - Gamma1.8: Emulates an idealized Gamma 1.8 display device. - Gamma2.2: Emulates an idealized Gamma 2.2 display device. - Gamma2.4: Emulates an idealized Gamma 2.4 display device. - Gamma2.6: Emulates an idealized Gamma 2.6 display device. - Panalog: Sony/Panavision Genesis Log Space - REDLog: RED Log Space - ViperLog: Viper Log Space - AlexaV3LogC: Alexa Log C - PLogLin: Josh Pines style pivoted log/lin conversion. 445->0.18 - SLog: Sony SLog - SLog1: Sony SLog1 - SLog2: Sony SLog2 - SLog3: Sony SLog3 - CLog: Canon CLog - Log3G10: Log3G10 - Log3G12: Log3G12 - HybridLogGamma: HybdridLogGamma - Protune: GoPro Protune - BT1886: Emulates an idealized Gamma 2.4 display device. - st2084: st2084 - raw: Raw Data. Used for normals, points, etc. - Filmic Log: Log based filmic shaper with 16.5 stops of latitude, and 25 stops of dynamic range. - Filmic sRGB: Filmic sRGB view transform - False Color: Filmic false color view transform - Project Working Space |
Enable Cryptomatte / enableCryptomatte | Boolean | Off | If enabled, the resulting image is the extracted matte based on the options below. If disabled, the Output Part parameter controls what is output from the OpenEXR file |
Matte List / cryptoMatteList | - | ||
Layer Source / cryptoLayer | Choice | - | |
Output Mode / cryptoOutputMode | Choice | Matte Over Colored Preview | Select what is output by Cryptomatte - Selected Matte: The RGBA channels are filled with the selected matte - Colored Preview: Each separate matte is visible in the red/green/blue channels of the image with a different color. This mode is helpful to pick mattes and add them to the matte list - Matte Over Colored Preview: Same as Colored Preview mode but with the selected matte added to the red channel |
Expand Wildcards / cryptoExpandWildcards | Boolean | Off | If enabled, matte names can contain wildcard expressions. '*' character is used to match zero or more of any charaters. '?' matches any single character. The '' character can be used to escape the wildcard characters if the names of the object contain those characters. |
Separate Fields / fieldOrder | Choice | Off | For interlaced videos, determine which field is dominant. To determine which field is dominant, scrub the footage through a shot with visible motion on the timeline. If the motion appears to go back and forth, this is because the wrong dominant field was selected. - Off: Video is assumed to be progressive - Upper First: Video is assumed to be upper field first. Generally HD or D1 PAL - Lower First: Video is assumed to be lower field first. Generally DV (PAL or NTSC) or D1 NTSC (but not always) |
Algorithm / deinterlaceMode | Choice | Duplicate (Bob) | - Duplicate (Bob): Display each half-picture like a full picture, by simply displaying each row twice. - Temporal & Spatial: A temporal and spatial interpolator that reconstructs the missing row using adjacent frames and neighboor image rows |
Override FPS / fpsOverride | Float | 1 | Set the framerate at which the image sequence should be read |
Reformat / reformatMode | Choice | None | Controls the format of the image - None: The image format is not modified - Custom: Reformat the image to a specific size and pixel aspect ratio - Preset: Reformat the image to the specified format preset |
Format / outputFormat | Choice | HD (1920x1080) | - PC VIDEO (640x480) - NTSC (720x486:0.91) - PAL (720x576:1.09) - NTSC 16:9 (720x486:1.21) - PAL 16:9 (720x576:1.46) - QHD (960x540) - LHD (1280x720) - HD (1920x1080) - VHD (1080x1920) - UHD 4K (3840x2160) - VUHD 4K (2160x3840) - UHD 8K (7680x4320) - Super35 1K FULL AP (1024x778) - Cinemascope 1K (914x778:2.00) - Super35 2K FULL AP (2048x1556) - Cinemascope 2K (1828x1556:2.00) - DCP 2K (2048x1080) - Super35 4K FULL AP (4096x3112) - DCP 4K (4096x2160) - Square 256 (256x256) - Square 512 (512x512) - Square 1K (1024x1024) - Square 2K (2048x2048) - Format 21 (1920x1080) |
Width / output_width | Float | 0 | |
Height / output_height | Float | 0 | |
Pixel Aspect / pixelAspect | Float | 0 | |
Type / constraint | Choice | Width | - Width: Scale the original so that its width fits the output width while preserving the aspect ratio. - Height: Scale the original so that its height fits the output height while preserving the aspect ratio. - Fit: Scale the original so that its smallest size fits the output width or height, while preserving the aspect ratio - Fill: Scale the original so that its longest size fits the output width or height, while preserving the aspect ratio - Distort: Scale the original so that both sides fit the output dimensions. This does not preserve the aspect ratio |
Mirror H. / mirror_h | Boolean | Off | |
Mirror V. / mirror_v | Boolean | Off | |
Turn / turn_90_ccw | Boolean | Off | |
Crop Transparent Borders / autoCropAlpha | Boolean | Off | |
Centered Crop / centered | Boolean | Off |