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 ... |
Data Types
The various data types we can use in the specification are as shown in the table below.
Data Type |
Description |
Examples |
---|---|---|
<bool> |
A boolean true/false |
true, false |
<int> |
Integer number |
1556 |
<float> |
Floating point number |
29.97 |
Global Parameters
These parameters appear outside an output or source section, at the start of the file. We underline required options.
colourScaling
Required
Values : |
SMPTE CGR FilmLog VideoLog |
Default : |
|
Project colour scaling mode.
outputClip
Values : |
<bool> |
Default : |
false |
Project output clipping.
Output Section Parameters
These parameters appear inside an output section.
width
Required
Values : |
<int> |
Default : |
|
The width (x resolution)of the output format in pixels.
height
Required
Values : |
<int> |
Default : |
|
The height (y resolution)of the output format in pixels.
fps
Required
Values : |
<float> |
Default : |
|
The frames per second. If no decimal point set, we add a .0 automatically e.g. 29.97, 25
aspectRatio
Required
Values : |
<int>/<int> |
Default : |
|
The output format image aspect ratio. Specify as M/N e.g. 1316/1000
dropFrame
Values : |
<bool> |
Default : |
false |
Set if output format is drop-frame.
videoOutput
Values : |
<bool> |
Default : |
false |
Specifies if Video Output is enabled on output format.
fields
Values : |
f2:f1 f1:f2 frames |
Default : |
frames |
Specifies if output format is field based and gives field order.
channels
Values : |
RGB RGBA |
Default : |
RGB |
Colour channels
bitDepth
Values : |
8,10,16,half |
Default : |
10 |
Output colour depth per colour channel, in bits per pixel.
convertMode
Values : |
none fit crop center |
Default : |
none |
Output format conversion from source.
convertFilter
Values : |
none box bilinear gaussian zom lanczos |
Default : |
zom |
What conversion filter to use on the source (if convertMode not "none")
applyCms
Values : |
<bool> |
Default : |
false |
Specifies if the Apply CMS toggle is on or off.
Source Section Parameters
These parameters appear inside an input section.
scale
Required
Values : |
<int> |
Default : |
|
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
As output section above.
convertFilter
As output section above.
Only applicable if scale > 1.
Notes
• | The key values are case-sensitive. |
• | Values are case-insensitive (e.g. use "rgb" or "RGB"). |