Difference between revisions of "UM:Cli Cli Format Spec Definition"

From DigitalVision
Jump to: navigation, search
m (Text replacement - "|Platform:" to "|UM:")
Line 5: Line 5:
 
{{Template:M-Title|Project Format Specification}}
 
{{Template:M-Title|Project Format Specification}}
  
<p class="p_DVBodyText"><span class="f_DVBodyText">A project is defined using a </span><span class="f_DVBodyText" style="font-style: italic;">project format specification</span><span class="f_DVBodyText"> file. This file is of the following format :</span></p>
+
A project is defined using a project format specification file.
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table bgcolor="#ddeeff" border="0" cellpadding="0" cellspacing="0" style="background-color: #ddeeff; border: none; border-spacing:0px;" width="80%">
+
This file is of the following format :
<tr style="text-align:left;vertical-align:top;">
+
 
<td valign="top"><p class="p_CodeExample"><span class="f_CodeExample">&lt;Global Parameters&gt;</span></p>
+
<pre>
<p class="p_CodeExample"><span class="f_CodeExample"># one or more output sections</span></p>
+
<Global Parameters>
<p class="p_CodeExample"><span class="f_CodeExample">[output]</span></p>
+
# one or more output sections
<p class="p_CodeExample"><span class="f_CodeExample">key=value</span></p>
+
[output]
<p class="p_CodeExample"><span class="f_CodeExample">...</span></p>
+
key=value
<p class="p_CodeExample"><span class="f_CodeExample"># zero or more source sections</span></p>
+
...
<p class="p_CodeExample"><span class="f_CodeExample">[source]</span></p>
+
# zero or more source sections
<p class="p_CodeExample"><span class="f_CodeExample">key=value</span></p>
+
[source]
<p class="p_CodeExample"><span class="f_CodeExample">...</span></p>
+
key=value
</td>
+
...
</tr>
+
</pre>
</table>
+
 
</div>
+
{{M-Note|Note that :
<p class="p_DVHeader3"><span class="f_DVHeader3">Data Types</span></p>
+
* The ''keys'' (e.g. ''convertFilter'') are '''case-sensitive'''
<p class="p_DVBodyText"><span class="f_DVBodyText">The various data types we can use in the specification are as shown in the table below.</span></p>
+
* The ''values'' (e.g. ''bilinear'') are case-insensitive.
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
}}
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="2" cellspacing="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
+
 
<tr style="text-align:left;vertical-align:top;">
+
{{M-Heading1|Data Types}}
<th bgcolor="#c0c0c0" style="width:207px; background-color:#c0c0c0; border: solid 1px #000000;" valign="top" width="207"><p class="p_DVTableTextHeader"><span class="f_DVTableTextHeader">Data Type</span></p>
+
 
</th>
+
The various data types we can use in the specification are as shown in the table below.
<th bgcolor="#c0c0c0" style="width:423px; background-color:#c0c0c0; border: solid 1px #000000;" valign="top" width="423"><p class="p_DVTableTextHeader"><span class="f_DVTableTextHeader">Description</span></p>
+
 
</th>
+
{| class="wikitable" width="70%"
<th bgcolor="#c0c0c0" style="width:358px; background-color:#c0c0c0; border: solid 1px #000000;" valign="top" width="358"><p class="p_DVTableTextHeader"><span class="f_DVTableTextHeader">Examples</span></p>
+
 
</th>
+
|- style="vertical-align:top;"
</tr>
+
!Data Type
<tr style="text-align:left;vertical-align:top;">
+
!Description
<td style="width:207px; border: solid 1px #000000;" valign="top" width="207"><p class="p_DVTableText"><span class="f_DVTableText">&lt;bool&gt;</span></p>
+
!Example
</td>
+
 
<td style="width:423px; border: solid 1px #000000;" valign="top" width="423"><p class="p_DVTableText"><span class="f_DVTableText">A boolean true/false</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:358px; border: solid 1px #000000;" valign="top" width="358"><p class="p_DVTableText"><span class="f_DVTableText">true, false</span></p>
+
|width="20%"|
</td>
+
<bool>
</tr>
+
|width="45%"|
<tr style="text-align:left;vertical-align:top;">
+
A boolean true/false
<td style="width:207px; border: solid 1px #000000;" valign="top" width="207"><p class="p_DVTableText"><span class="f_DVTableText">&lt;int&gt;</span></p>
+
|
</td>
+
true, false
<td style="width:423px; border: solid 1px #000000;" valign="top" width="423"><p class="p_DVTableText"><span class="f_DVTableText">Integer number</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:358px; border: solid 1px #000000;" valign="top" width="358"><p class="p_DVTableText"><span class="f_DVTableText">1556</span></p>
+
|width="20%"|
</td>
+
<int>
</tr>
+
|width="45%"|
<tr style="text-align:left;vertical-align:top;">
+
An integer number
<td style="width:207px; border: solid 1px #000000;" valign="top" width="207"><p class="p_DVTableText"><span class="f_DVTableText">&lt;float&gt;</span></p>
+
|
</td>
+
1556
<td style="width:423px; border: solid 1px #000000;" valign="top" width="423"><p class="p_DVTableText"><span class="f_DVTableText">Floating point number</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:358px; border: solid 1px #000000;" valign="top" width="358"><p class="p_DVTableText"><span class="f_DVTableText">29.97</span></p>
+
|width="20%"|
</td>
+
<float>
</tr>
+
|width="45%"|
</table>
+
A floating point number
</div>
+
|
<p class="p_DVHeader1"><span class="f_DVHeader1">Global Parameters</span></p>
+
29.97
<p class="p_DVBodyText"><span class="f_DVBodyText">These parameters appear </span><span class="f_DVBodyText" style="font-weight: bold;">outside</span><span class="f_DVBodyText"> an </span><span class="f_DVBodyText" style="font-style: italic;">output</span><span class="f_DVBodyText"> or </span><span class="f_DVBodyText" style="font-style: italic;">source</span><span class="f_DVBodyText"> section, at the start of the file. We </span><span class="f_DVBodyText" style="text-decoration: underline;">underline</span><span class="f_DVBodyText"> required options.</span></p>
+
<!-- ----------------------------------------------------- -->
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">colourScaling</span></p>
+
|}
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
{{M-Heading1|Global Parameters}}
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
 
<tr style="text-align:left;vertical-align:top;">
+
These parameters appear outside an output or source section, at the start of the file.
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
 
</td>
+
Required options are in '''bold'''.
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">SMPTE CGR FilmLog VideoLog</span></p>
+
 
</td>
+
 
</tr>
+
{| class="wikitable" width="70%"
<tr style="text-align:left;vertical-align:top;">
+
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
|- style="vertical-align:top;"
</td>
+
!Name
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
!Values
</td>
+
!Default
</tr>
+
 
</table>
+
<!-- ----------------------------------------------------- -->
</div>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="20%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Project colour scaling mode.</span></p>
+
'''colourScaling'''
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="45%"|
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">outputClip</span></p>
+
SMPTE CGR FilmLog VideoLog
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
|
<tr style="text-align:left;vertical-align:top;">
+
-
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;bool&gt;</span></p>
+
|width="20%"|
</td>
+
outputClip
</tr>
+
|width="45%"|
<tr style="text-align:left;vertical-align:top;">
+
<bool>
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
|
</td>
+
-
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText">false</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|}
</tr>
+
 
</table>
+
{{M-Heading1|Output Section Parameters}}
</div>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
These parameters appear inside an ''output'' section.
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Project output clipping.</span></p>
+
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Output Section Parameters</span></p>
+
{| class="wikitable" width="80%"
<p class="p_DVBodyText"><span class="f_DVBodyText">These parameters appear inside an </span><span class="f_DVBodyText" style="font-style: italic;">output</span><span class="f_DVBodyText"> section.</span></p>
+
 
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">width</span></p>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
+
!Name
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
!Values
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
!Default
<tr style="text-align:left;vertical-align:top;">
+
!Note
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;int&gt;</span></p>
+
|width="20%"|
</td>
+
'''width'''
</tr>
+
|width="10%"|
<tr style="text-align:left;vertical-align:top;">
+
<int>
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
|
</td>
+
-
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
|
</td>
+
The width (x resolution) of the output format in pixels.
</tr>
+
<!-- ----------------------------------------------------- -->
</table>
+
|- style="vertical-align:top;"
</div>
+
|width="20%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
'''height'''
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">The width (x resolution)of the output format in pixels.</span></p>
+
|width="10%"|
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">height</span></p>
+
<int>
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
+
|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"</span></p>
+
-
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
|
<tr style="text-align:left;vertical-align:top;">
+
The height (y resolution) of the output format in pixels.
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
 
</td>
+
<!-- ----------------------------------------------------- -->
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;int&gt;</span></p>
+
|- style="vertical-align:top;"
</td>
+
|width="20%"|
</tr>
+
'''fps'''
<tr style="text-align:left;vertical-align:top;">
+
|width="10%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
<float>
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
-
</td>
+
|
</tr>
+
The frames per second. If no decimal point set, we add a .0 automatically e.g. 29.97, 25
</table>
+
<!-- ----------------------------------------------------- -->
</div>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="20%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">The height (y resolution)of the output format in pixels.</span></p>
+
'''aspectRatio'''
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">fps</span></p>
+
|width="10%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
+
<int>/<int>
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
-
<tr style="text-align:left;vertical-align:top;">
+
|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
The output format image aspect ratio. Specify as M/N e.g. 1316/1000
</td>
+
<!-- ----------------------------------------------------- -->
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;float&gt;</span></p>
+
|- style="vertical-align:top;"
</td>
+
|width="20%"|
</tr>
+
dropFrame
<tr style="text-align:left;vertical-align:top;">
+
|width="10%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
<bool>
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
false
</td>
+
|
</tr>
+
Set if output format is drop-frame.
</table>
+
<!-- ----------------------------------------------------- -->
</div>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="20%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">The frames per second. If no decimal point set, we add a .0 automatically e.g. 29.97, 25</span></p>
+
cacheOutput
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">aspectRatio</span></p>
+
|width="10%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
+
<bool>
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
false
<tr style="text-align:left;vertical-align:top;">
+
|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
Specifies if ''Cache Output'' is enabled on output format.
</td>
+
<!-- ----------------------------------------------------- -->
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;int&gt;/&lt;int&gt;</span></p>
+
|- style="vertical-align:top;"
</td>
+
|width="20%"|
</tr>
+
videoOutput
<tr style="text-align:left;vertical-align:top;">
+
|width="10%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
<bool>
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
false
</td>
+
|
</tr>
+
Specifies if ''Video Output'' is enabled on output format.
</table>
+
<!-- ----------------------------------------------------- -->
</div>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="20%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">The output format image aspect ratio. Specify as M/N e.g. 1316/1000</span></p>
+
fields
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">dropFrame</span></p>
+
|width="10%"|
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
f2:f1,f1:f2,frames
<tr style="text-align:left;vertical-align:top;">
+
|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
frames
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;bool&gt;</span></p>
+
Specifies if output format is field based and gives field order.
</td>
+
<!-- ----------------------------------------------------- -->
</tr>
+
|- style="vertical-align:top;"
<tr style="text-align:left;vertical-align:top;">
+
|width="20%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
channels
</td>
+
|width="10%"|
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText">false</span></p>
+
RGB,RGBA
</td>
+
|
</tr>
+
RGB
</table>
+
|
</div>
+
Colour channels.
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
<!-- ----------------------------------------------------- -->
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Set if output format is drop-frame.</span></p>
+
|- style="vertical-align:top;"
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">videoOutput</span></p>
+
|width="20%"|
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
bitDepth
<tr style="text-align:left;vertical-align:top;">
+
|width="10%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
8,10,16,half
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;bool&gt;</span></p>
+
10
</td>
+
|
</tr>
+
Output colour depth per colour channel, in bits per pixel.
<tr style="text-align:left;vertical-align:top;">
+
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText">false</span></p>
+
|width="20%"|
</td>
+
convertMode
</tr>
+
|width="10%"|
</table>
+
none,fit,crop,center
</div>
+
|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
none
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Specifies if Video Output is enabled on output format.</span></p>
+
|
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">fields</span></p>
+
Output format conversion from source.
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
<!-- ----------------------------------------------------- -->
<tr style="text-align:left;vertical-align:top;">
+
|- style="vertical-align:top;"
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
|width="20%"|
</td>
+
convertFilter
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">f2:f1 f1:f2 frames</span></p>
+
|width="10%"|
</td>
+
none,box,bilinear,gaussian,zom,lanczos
</tr>
+
|
<tr style="text-align:left;vertical-align:top;">
+
zom
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
|
</td>
+
What conversion filter to use on the source (if ''convertMode'' not "none").
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">frames</span></p>
+
<!-- ----------------------------------------------------- -->
</td>
+
|- style="vertical-align:top;"
</tr>
+
|width="20%"|
</table>
+
applyCms
</div>
+
|width="10%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
<bool>
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Specifies if output format is field based and gives field order.</span></p>
+
|
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">channels</span></p>
+
false
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
|
<tr style="text-align:left;vertical-align:top;">
+
Specifies if the Apply CMS toggle is on or off.
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
 
</td>
+
<!-- ----------------------------------------------------- -->
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">RGB RGBA</span></p>
+
 
</td>
+
|}
</tr>
+
 
<tr style="text-align:left;vertical-align:top;">
+
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
{{M-Heading1|Source Section Parameters}}
</td>
+
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">RGB</span></p>
+
These parameters appear inside an ''input'' section.
</td>
+
 
</tr>
+
{| class="wikitable" width="80%"
</table>
+
 
</div>
+
|- style="vertical-align:top;"
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
!Name
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Colour channels</span></p>
+
!Values
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">bitDepth</span></p>
+
!Default
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
!Note
<tr style="text-align:left;vertical-align:top;">
+
<!-- ----------------------------------------------------- -->
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
|- style="vertical-align:top;"
</td>
+
|width="20%"|
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">8,10,16,half</span></p>
+
'''scale'''
</td>
+
|width="10%"|
</tr>
+
<int>
<tr style="text-align:left;vertical-align:top;">
+
|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
-
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">10</span></p>
+
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.
</td>
+
<!-- ----------------------------------------------------- -->
</tr>
+
|- style="vertical-align:top;"
</table>
+
|width="20%"|
</div>
+
bitDepth
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
|width="10%"|
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Output colour depth per colour channel, in bits per pixel.</span></p>
+
8,10,16,half
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">convertMode</span></p>
+
|
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
10
<tr style="text-align:left;vertical-align:top;">
+
|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
+
Output colour depth per colour channel, in bits per pixel.
</td>
+
<!-- ----------------------------------------------------- -->
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">none fit crop center</span></p>
+
|- style="vertical-align:top;"
</td>
+
|width="20%"|
</tr>
+
convertFilter
<tr style="text-align:left;vertical-align:top;">
+
|width="10%"|
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
+
none,box,bilinear,gaussian,zom,lanczos
</td>
+
|
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">none</span></p>
+
zom
</td>
+
|
</tr>
+
Only applicable if '''scale > 1'''.
</table>
+
 
</div>
+
<!-- ----------------------------------------------------- -->
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Output format conversion from source.</span></p>
+
|}
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">convertFilter</span></p>
+
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
+
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">none box bilinear gaussian zom lanczos</span></p>
 
</td>
 
</tr>
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">zom</span></p>
 
</td>
 
</tr>
 
</table>
 
</div>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">What conversion filter to use on the source (if </span><span class="f_DVBodyTextIndent1" style="font-style: italic;">convertMode</span><span class="f_DVBodyTextIndent1"> not "none")</span></p>
 
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">applyCms</span></p>
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;bool&gt;</span></p>
 
</td>
 
</tr>
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText">false</span></p>
 
</td>
 
</tr>
 
</table>
 
</div>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Specifies if the </span><span class="f_DVBodyTextIndent1" style="font-style: italic;">Apply CMS</span><span class="f_DVBodyTextIndent1"> toggle is on or off.</span></p>
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Source Section Parameters</span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText">These parameters appear inside an </span><span class="f_DVBodyText" style="font-style: italic;">input</span><span class="f_DVBodyText"> section.</span></p>
 
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam" style="text-decoration: underline;">scale</span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Required</span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="5" cellspacing="0" style="border: none; border-spacing:0px;">
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Values :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVConfigParam"><span class="f_DVConfigParam">&lt;int&gt;</span></p>
 
</td>
 
</tr>
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:112px;" valign="top" width="112"><p class="p_DVTableText" style="text-align: right;"><span class="f_DVTableText" style="font-weight: bold;">Default :</span></p>
 
</td>
 
<td style="width:651px;" valign="top" width="651"><p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
 
</td>
 
</tr>
 
</table>
 
</div>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">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.</span></p>
 
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">bitDepth</span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">As output section above.</span></p>
 
<p class="p_DVHeaderParam"><span class="f_DVHeaderParam">convertFilter</span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVTableText">As outp</span><span class="f_DVBodyTextIndent1">ut section above.</span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1" style="font-weight: bold;">Only applicable if scale &gt; 1.</span></p>
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Notes</span></p>
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyTextIndent1">The </span><span class="f_DVBodyTextIndent1" style="font-style: italic;">key</span><span class="f_DVBodyTextIndent1"> values are </span><span class="f_DVBodyTextIndent1" style="font-weight: bold;">case-sensitive</span><span class="f_DVBodyTextIndent1">.</span></td></tr></table></div><div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="0" cellpadding="0" cellspacing="0" style="line-height: normal;"><tr style="vertical-align:baseline" valign="baseline"><td width="13"><span style="font-size: 11pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVBodyText" style="font-style: italic;">Values</span><span class="f_DVBodyText"> are </span><span class="f_DVBodyText" style="font-weight: bold;">case-insensitive</span><span class="f_DVBodyText"> (e.g. use "rgb" or "RGB").</span></td></tr></table></div><p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
 
  
 
{{Template:M-Navlinks-bottom|UM:Manual|UM:Cli_Cli_Project|UM:Cli_Attach_And_Detach_Project}}
 
{{Template:M-Navlinks-bottom|UM:Manual|UM:Cli_Cli_Project|UM:Cli_Attach_And_Detach_Project}}
Line 368: Line 305:
 
<!--
 
<!--
 
Originally processed and converted on 2014-06-20 20:09:21
 
Originally processed and converted on 2014-06-20 20:09:21
 +
Now re-formatted on 2017-07-31
 
-->
 
-->

Revision as of 11:11, 2 August 2017

Darrow-up.png     Previous Next

Project Format Specification

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.
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

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

colourScaling

SMPTE CGR FilmLog VideoLog

-

outputClip

<bool>

-

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

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.



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.



Darrow-up.png     Previous Next