ComfyUI Node: OCIO Write

OCIO Write:

OCIOWrite is a node designed to facilitate the output of images or video sequences with precise color management using the OpenColorIO (OCIO) framework. This node is particularly beneficial for AI artists and designers who need to ensure that their visual outputs maintain consistent color fidelity across different devices and platforms. By leveraging OCIOWrite, you can export your work in various formats, such as still images or video files, while embedding the appropriate color space information. This ensures that the colors in your images or videos are accurately represented, regardless of where they are viewed. The node supports a range of configurations, allowing you to specify the output format, color space, and other parameters to tailor the output to your specific needs. Whether you are working with high dynamic range images or standard video formats, OCIOWrite provides the tools necessary to achieve professional-grade color accuracy and consistency.

OCIO Write Input Parameters:

profile

The profile parameter specifies the color profile to be used during the writing process. It determines how colors are interpreted and managed in the output file. The default value is "none," which means no specific color profile is applied unless specified otherwise.

from_colorspace

The from_colorspace parameter defines the source color space of the input images. This is crucial for ensuring that the color conversion process is accurate when writing the output. It allows you to specify the color space from which the conversion should begin.

output_colorspace

The output_colorspace parameter sets the target color space for the output file. This ensures that the colors in the output are represented correctly according to the specified color space, maintaining color fidelity across different viewing environments.

container

The container parameter determines the type of file container for the output. Options include "still image" for single images or "video" for sequences. This choice affects the file format and how the output is structured.

still_format

The still_format parameter specifies the file format for still images, such as "exr" for OpenEXR files. This determines the encoding and compression used for the output image, impacting both quality and file size.

video_codec

The video_codec parameter defines the codec used for video output, with options like "prores_4444" for high-quality video encoding. This affects the compression and quality of the video file.

bit_depth

The bit_depth parameter sets the precision of color representation in the output file, with "32f" indicating 32-bit floating-point precision. This impacts the dynamic range and color accuracy of the output.

compression

The compression parameter specifies the compression method used for the output file, such as "zip" for lossless compression. This affects the file size and quality of the output.

auto_range

The auto_range parameter, when enabled, automatically adjusts the color range of the output to fit within the specified bit depth. This ensures that the full dynamic range of the image is utilized.

first_frame

The first_frame parameter indicates the starting frame number for sequences, allowing you to specify where the output sequence should begin. This is useful for maintaining continuity in video projects.

last_frame

The last_frame parameter specifies the ending frame number for sequences, defining the duration of the output sequence. This helps in controlling the length of video outputs.

start_number

The start_number parameter sets the starting number for frame numbering in sequences, ensuring that the output files are correctly ordered and named.

source_start

The source_start parameter indicates the starting frame number of the source material, which can be useful for aligning the output with the original sequence.

raw_data

The raw_data parameter, when enabled, writes the pixel data as-is without any color conversion. This is useful for preserving the original data for further processing.

colorspace_in_name

The colorspace_in_name parameter, when enabled, includes the color space tag in the output file name. This helps in identifying the color space used in the output file.

auto_colorspace

The auto_colorspace parameter, when enabled, automatically selects the appropriate color space for the output based on the input data. This simplifies the color management process.

output_folder

The output_folder parameter specifies the directory where the output files will be saved. This allows you to organize and manage your output files effectively.

filename

The filename parameter sets the base name for the output files. This is used in conjunction with other parameters to generate the final file names.

images

The images parameter refers to the input images to be processed and written to the output. This is the primary data that the node operates on.

alpha

The alpha parameter specifies the alpha channel data for the input images, which is used for transparency and compositing in the output.

fps

The fps parameter sets the frames per second for video outputs, determining the playback speed of the video file.

render_nonce

The render_nonce parameter is a unique identifier used to distinguish different render sessions, ensuring that output files do not overwrite each other.

OCIO Write Output Parameters:

path

The path parameter provides the file path(s) of the output files generated by the node. This is essential for locating and accessing the output images or videos after processing.

OCIO Write Usage Tips:

• Ensure that the from_colorspace and output_colorspace parameters are correctly set to maintain color accuracy across different devices.
• Use the compression parameter wisely to balance between file size and quality, especially when working with large image sequences or high-resolution videos.
• Enable colorspace_in_name to easily identify the color space used in your output files, which can be helpful for organizing and managing your assets.

OCIO Write Common Errors and Solutions:

FileNotFoundError

• Explanation: This error occurs when the specified output_folder does not exist or is inaccessible.
• Solution: Verify that the output_folder path is correct and that you have the necessary permissions to write to the directory.

ValueError: Invalid Colorspace

• Explanation: This error indicates that the specified from_colorspace or output_colorspace is not recognized.
• Solution: Double-check the color space names and ensure they are valid and supported by the OCIO configuration.

IOError: Unable to Write File

• Explanation: This error can occur if there is an issue with writing the output file, such as insufficient disk space or file permission issues.
• Solution: Ensure there is enough disk space and that you have write permissions for the output_folder.