UM:Cli Cli Format Spec Definition
A project is defined using a project format specification file.
This file is of the following format :
<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 (e.g. bilinear) are case-insensitive.
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 |
These parameters appear outside an output or source section, at the start of the file.
Required options are in bold.
Name | Values | Default |
---|---|---|
colourScaling |
SMPTE CGR FilmLog VideoLog |
- |
outputClip |
<bool> |
- |
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 |
dropFrame |
<bool> |
false |
Set if output format is drop-frame. |
cacheOutput |
<bool> |
false |
Specifies if Cache Output is enabled on output format. |
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.
|
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.
|