Using CrCache#

Clarisse render cache tool crcache is a dedicated tool to let you display information, manage and extract images from Clarisse render cache generated by CNode.

Usage#

crcache <cache_file(s)> [-extract] [-info] [-output <output_file>] [-format <output_file_format>]

Use -help argument to display command line help.

Arguments#

crcache supports the * wildcard to process multiple render cache files at once. For example:

crcache render.*.ix.00.dat -extract

Optional Arguments#

crcache comes with a few optional arguments used to control the application.

extract#

-extract

Extract image file(s) from render cache using the settings set at render time.

info#

-info

Display a XML summary of the content of the specified render cache.

The XML ouput allows you to get a quick and parse-easy description of the content of the render cache. Here is the resulting XML from a cache file:

<render_cache>
    <version>1.0</version>
    <cache_file>/home/user/renders/r00_layer.00000</cache_file>
    <header>
        <command>/home/user/clarisse/bin/cnode.bin /home/user/clarisse_test/r00.project -enable_render_cache -keep_render_cache</command>
        <project>/home/user/renders/r00.project'</project>
        <render_target>project://scene/image.background</render_target>
        <frame>0</frame>
        <render_start_time>Wed Sep 12 10:13:19 2018</render_start_time>
    </header>
    <canvas>
        <pixel_aspect_ratio>1.0</pixel_aspect_ratio>
        <data_region>0 0 640 360</data_region>
        <display_region>0 0 640 360</display_region>
    </canvas>
    <output>
        <render></render>
        <save_to_disk>1</save_to_disk>
        <filename>/home/user/renders/r00_layer.00000.exr</filename>
        <deep>
            <save_to_disk>1</save_to_disk>
            <filename>/home/user/renders/r00_deep.00000.exr</filename>
        </deep>
    </output>
    <image_layers>
        <layer>rgba</layer>
        <layer>camera_normal</layer>
        <layer>camera_position</layer>
        <layer>depth</layer>
        <layer>cryptomatte_material</layer>
        <layer>cryptomatte_material00</layer>
        <layer>cryptomatte_material01</layer>
        <layer>cryptomatte_material02</layer>
        <layer>cryptomatte_object</layer>
        <layer>cryptomatte_object00</layer>
        <layer>cryptomatte_object01</layer>
        <layer>cryptomatte_object02</layer>
        <layer>cryptomatte_asset</layer>
        <layer>cryptomatte_asset00</layer>
        <layer>cryptomatte_asset01</layer>
        <layer>cryptomatte_asset02</layer>
    </image_layers>
    <stats>
        <render_time>00:00:00</render_time>
        <job_duration>00:00:00</job_duration>
        <down_time>00:00:00</down_time>
        <progress>1.0<progress>
    </stats>
</render_cache>

output#

-output filename

Specify an alternate output filename.

By default crcache uses the filename information specified in the cache. Using this argument you can force the output name of the image. Please note extensions are automatically appended to filename according to the chosen image file format.

format#

-format type

Specify the output image file format.

By default, images are saved in the format specified in the render cache. Using this argument is it possible to use an alternate image format from the following list:

skip_existing#

-skip_existing

Skip the generation of output frame(s) if already exist(s) on disk.

When specified, crcache checks if the final frame exists on disk before generating it from the render cache. If it exists, the frame is skipped. This argument must be used in conjunction with -extract.

deep#

-deep  yes/no (=yes)

Specify if the deep image should be output.

By default, the deep image is automatically extracted from the cache if the deep data exists. Using -deep no allows you to skip the output of the deep image.

deep_output#

-deep_output filename

Specify an alternate output filename for the deep EXR image.

By default crcache uses the filename information specified in the cache. Using this argument you can force the output name of the deep EXR image.

force_split#

-force_split

Force the output of each image layer as a single image file whatever the output format.

Use this feature to force the output of an individual image per image layer. This is only useful for image formats like Open EXR that embeds image layers in single files.

image_layer_list#

-image_layer_list image_layer_name ...

Filter the list of output image layers.

By default, crcache outputs all image layers (AOVs) found in the cache file. Using this argument you can choose to extract only a subset of them by providing a list of existing image layer names. This argument supports an argument list.

-image_layer_list "rgba"

-image_layer_list "normal" "depth" "my_custom_aov"

lut#

-lut lut_name

Specify the LUT applied to the rgba (beauty) image layer of the image.

By default, all images and image channel layers are saved in linear whatever the format you chose. Using this argument you can override the default behavior by specifying a custom LUT. Note the LUT is only applied to the rgba image layer.