UM:Cli Cli Format Spec Definition

Project Format Specification

A project is defined using a project format specification file.

The format is as follows :

<Global Parameters>
# one or more output sections
[output]
key=value
...
# zero or more source sections
[source]
key=value
...

Note that :

The keys (e.g. convertFilter) are case-sensitive.
The values are case-insensitive.
- So "SMPTE" can be written "smpte", "FilmLog" as "filmlog" etc.

Data Types

The various data types we can use in the specification are as shown in the table below.

Data Type	Description	Example
<bool>	A boolean true/false	true, false
<int>	An integer number	1556
<float>	A floating point number	29.97
<string>	A string	This is a string NOTE: quotes should not be used.

Global Parameters

These parameters appear outside an output or source section, at the start of the file.

Required options are in bold.

Name	Values	Default	Note
colourScaling	SMPTE, CGR, FilmLog, VideoLog, ACES	-	ACES from [2011.2.094]
outputClip	<bool>	-
outputScaling	none, tosdi, tosmpte, <bool>	none Note: tosmpte if colourScaling is CGR	Whether to perform output colour scaling. [2015.2]
stereo	<bool>	false	[2011.2.094]
previewTransform	none, dolby_pq	-	Valid for colourScaling ACES only. If not set, we use Gamma 2.2. [2012.1.054]
contentMappingID	DolbyCM	-	[2014.2.020]
AcesVersion	1, 2, 3	-	Valid for colourScaling ACES only. 1 = ACES version 0.1 2 = 0.1.1 3 = 1.0.1 [2015.3.038]
cacheStages	Source, InputFx, Layer, Output Also : All, None, ToLayers	-	Supercedes "Output / cacheOutput" setting "All" is equivalent to : Source,InputFx,Layer,Output "ToLayers" is equivalent to : Source,InputFx,Layer [2017.1]

Output Section Parameters

These parameters appear inside an output section.

Name	Values	Default	Note
width	<int>	-	The width (x resolution) of the output format in pixels.
height	<int>	-	The height (y resolution) of the output format in pixels.
fps	<float>	-	The frames per second. If no decimal point set, we add a .0 automatically e.g. 29.97, 25
aspectRatio	<int>/<int>	-	The output format image aspect ratio. Specify as M/N e.g. 1316/1000
name	<string>	-	Give the output format a user-defined name e.g. TV Format 2.2. [2013.1.027]
dropFrame	<bool>	false	Set if output format is drop-frame.
cacheOutput	<bool>	false	Deprecated from release 2017.1. See cacheStages setting above. If cacheOutput appears in 2017.1 or newer : If "true" - equivalent to cacheStages = All If "false" - equivalent to cacheStages = ToLayers If there are multiple output sections with this directive, the last one will set the cacheStages state.
videoOutput	<bool>	false	Specifies if Video Output is enabled on output format.
fields	f2:f1,f1:f2,frames	frames	Specifies if output format is field based and gives field order.
channels	RGB,RGBA	RGB	Colour channels.
bitDepth	8,10,16,half	10	Output colour depth per colour channel, in bits per pixel.
convertMode	none,fit,crop,center	none	Output format conversion from source.
convertFilter	none,box,bilinear,gaussian,zom,lanczos	zom	What conversion filter to use on the source (if convertMode not "none").
applyCms	<bool>	false	Specifies if the Apply CMS toggle is on or off.

Source Section Parameters

These parameters appear inside an input section.

Name	Values	Default	Note
scale	<int>	-	Sets the scale of the source/proxy. This integer will divide the width and height to set the proxy size. A scale N gives an "N:1" proxy.
bitDepth	8,10,16,half	10	Output colour depth per colour channel, in bits per pixel.
convertFilter	none,box,bilinear,gaussian,zom,lanczos	zom	Only applicable if scale > 1.

Navigation menu