Difference between revisions of "UM:Cli Cli Export"

From DigitalVision
Jump to: navigation, search
m (Text replacement - "|Platform:" to "|UM:")
 
(2 intermediate revisions by one other user not shown)
Line 5: Line 5:
 
{{Template:M-Title|Exporting Shots}}
 
{{Template:M-Title|Exporting Shots}}
  
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="0" cellpadding="3" cellspacing="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
+
{{M-Clioptions|--export <path>|Export/render supplied composition to specified path}}
<tr style="text-align:left;vertical-align:top;">
+
{{M-Clioptions|--export-mode <single/multi>|Choose ''mode'' of export (single or multi). '''[REQUIRED]'''.}}
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--export &lt;path&gt;</span></p>
+
{{M-Clioptions|--multi-mode <MODE>|For ''multi-mode'' export, choose MODE. MODE can be one of :
</td>
+
 
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Export/render supplied composition to specified path</span></p>
+
* <tt>visible-src</tt>
</td>
+
* <tt>visible-rec</tt>
</tr>
+
* <tt>tracks-src</tt>
<tr style="text-align:left;vertical-align:top;">
+
* <tt>tracks-rec</tt>
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--export-mode &lt;single|multi&gt;</span></p>
+
 
</td>
+
'''[REQUIRED when using multi mode export]'''.}}
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Choose mode of export (single or multi). </span><span class="f_DVTableText" style="font-weight: bold;">Required.</span></p>
+
{{M-Clioptions|--export-format <FORMAT>|Specify extra information for DPX, TIFF and MXF format exports (see below).}}
</td>
+
{{M-Clioptions|--video-codec <PRESET>|For Quicktime exports, specify the video codec PRESET to use (see below).}}
</tr>
+
{{M-Clioptions|--frame-padding <N>|Set with of numeric padding on filenames on export. This will be zero-padded. }}
<tr style="text-align:left;vertical-align:top;">
+
{{M-Clioptions|--export-handles <N>|Export each shot with specified handles. '''[REQUIRED when using multi mode export]'''. }}
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--multi-mode </span></p>
+
{{M-Clioptions|--smpte-level-clip <true/false>|Clip the exported shot colourspace to SMPTE video levels. }}
<p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">&lt;visible-src|tracks-src|</span></p>
+
 
<p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">visible-rec|tracks-rec&gt;</span></p>
+
 
</td>
+
This chapter describes how to export shots on a composition to various file formats, such as DPX, MXF DNxHD and
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Set export mode. </span></p>
+
Quicktime. You can choose to export the composition in various "modes", taking account of tracks and shot
<p class="p_DVTableText"><span class="f_DVTableText" style="font-weight: bold;">Required when using </span><span class="f_DVTableText" style="font-style: italic; font-weight: bold;">multi</span><span class="f_DVTableText" style="font-weight: bold;"> mode export.</span></p>
+
visibility or as a single contiguous "mixdown" sequence.
<p class="p_DVTableText"><span class="f_DVTableText"> </span></p>
+
 
</td>
+
{{M-Heading1|Exporting a Composition}}
</tr>
+
 
<tr style="text-align:left;vertical-align:top;">
+
<tt>--export <path></tt><br/>
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--frame-padding &lt;N&gt;</span></p>
+
<tt>--export-mode <single|multi></tt> '''[REQUIRED]'''
</td>
+
 
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Set with of numeric padding on filenames on export. This will be zero-padded.</span></p>
+
The <tt>--export</tt> command will render and export the specified ''composition'' (given by the <tt>--composition</tt> parameter) to the specified path.
</td>
+
 
</tr>
+
The <path> argument should be the ''full'' path, including the '''drive letter, filename and extension'''.
<tr style="text-align:left;vertical-align:top;">
+
 
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--export-handles &lt;N&gt;</span></p>
+
{{M-Note|The output format written (DPX, MXF etc.) is taken from the file '''extension'''.}}
</td>
+
 
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Export each shot with specified handles</span></p>
+
{{M-Cli|
<p class="p_DVTableText"><span class="f_DVTableText" style="font-weight: bold;">Required when using </span><span class="f_DVTableText" style="font-style: italic; font-weight: bold;">multi</span><span class="f_DVTableText" style="font-weight: bold;"> mode export.</span></p>
+
nucoda --project PROJ1 --composition COMP1 --export-mode single --export Z:\jobs\001\graded_m.dpx|...<br/>
</td>
+
INFO Opening project "PROJ1".<br/>
</tr>
+
INFO Opening composition "COMP1".<br/>
<tr style="text-align:left;vertical-align:top;">
+
INFO export ... exported 0 frames of 60 (0%)<br/>
<td bgcolor="#b9c7d5" style="width:313px; background-color:#b9c7d5; border: solid 1px #808080;" valign="top" width="313"><p class="p_CmdLineEmphasized" style="text-align: right;"><span class="f_CmdLineEmphasized">--smpte-level-clip &lt;true|false&gt;</span></p>
+
...<br/>
</td>
+
INFO export ... exported 60 frames of 60 (100%)<br/>
<td bgcolor="#ccdfe3" style="width:754px; background-color:#ccdfe3; border: solid 1px #808080;" valign="top" width="754"><p class="p_DVTableText"><span class="f_DVTableText">Clip the exported shot colourspace to SMPTE video levels</span></p>
+
}}
</td>
+
 
</tr>
+
{{M-Note|Exporting shots on the command line will not generate caches. This is different behaviour to the GUI where you have a choice of [[UM:Global_Options|caching behaviour]] when exporting media.}}
</table>
+
 
</div>
+
{{M-Heading1|Export Modes}}
<p class="p_DVHeader1"><span class="f_DVHeader1">Exporting a Composition</span></p>
+
 
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--export &lt;path&gt;</span></p>
+
<tt>--export-mode <single/multi></tt> '''[REQUIRED]'''<br>
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--export-mode &lt;single|multi&gt; </span><span class="f_DVBodyText" style="font-weight: bold;">REQUIRED</span></p>
+
<tt>--multi-mode <MODE></tt><br>
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
<tt>--export-handles <N></tt><br>
<p class="p_DVBodyText"><span class="f_DVBodyText">This command will </span><span class="f_Emphasis" style="font-weight: normal;">render</span><span class="f_DVBodyText"> and export the specified composition (given by the</span><span class="f_CmdLine"> --composition</span><span class="f_DVBodyText"> parameter) to the specified path.</span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
There are two export ''modes'' and you must specify one.
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
 
<tr style="text-align:left;vertical-align:middle;">
+
{{M-Heading2|Single Mode}}
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
 
</td>
+
<tt>--export-mode single</tt>
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVBodyText">The &lt;path&gt; argument should be the </span><span class="f_DVBodyText" style="font-style: italic;">full</span><span class="f_DVBodyText"> path, </span><span class="f_DVBodyText" style="font-weight: bold;">including the drive letter, filename and extension</span><span class="f_DVBodyText">.</span></p>
+
 
</td>
+
In ''single'' mode, the composition is exported as a '''single contiguous clip'''.
</tr>
+
 
</table>
+
{{M-Heading2|Multi Mode}}
</div>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
<tt>--export-mode multi</tt><br/>
<p class="p_DVBodyText"><span class="f_DVBodyText">The export </span><span class="f_DVBodyText" style="font-style: italic;">mode</span><span class="f_DVBodyText"> option is </span><span class="f_DVBodyText" style="font-weight: bold;">required</span><span class="f_DVBodyText">.</span></p>
+
<tt>--multi-mode <MODE></tt><br/>
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
<tt>--export-handles <N></tt>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table bgcolor="#eeeeee" border="0" cellpadding="2" cellspacing="0" style="background-color: #eeeeee; border: none; border-spacing:0px;">
+
 
<tr style="text-align:left;vertical-align:top;">
+
In ''multi'' mode, the composition is exported as multiple shots with a layout specified with the required ''mode'' option.
<td bgcolor="#bbccff" style="background-color:#bbccff;" valign="top"><p class="p_DVTableText"><span class="f_DVTableText" style="font-weight: bold;">Command :</span></p>
+
 
</td>
+
The mode option <tt>--multi-mode</tt> can have one of the following MODE values :
</tr>
+
 
<tr style="text-align:left;vertical-align:top;">
+
* <tt>visible-src</tt>
<td valign="top"><p class="p_CmdLine"><span class="f_CmdLinePrompts">$</span><span class="f_CmdLine"> film_master --project PROJ1 </span><span class="f_CmdLineEmphasized">--composition COMP1</span><span class="f_CmdLine"> \</span></p>
+
* <tt>visible-rec</tt>
<p class="p_CmdLine"><span class="f_CmdLine">  </span><span class="f_CmdLine" style="font-weight: bold;">--export-mode single \</span></p>
+
* <tt>tracks-src</tt>
<p class="p_CmdLine"><span class="f_CmdLine">  </span><span class="f_CmdLineEmphasized">--export</span><span class="f_CmdLine"> </span><span class="f_CmdLine" style="font-weight: bold;">Z:\jobs\001\graded_m.dpx</span></p>
+
* <tt>tracks-rec</tt>
<p class="p_CmdLinePrompts"><span class="f_CmdLinePrompts" style="font-size: 9pt;">INFO Opening project "PROJ1".</span></p>
+
 
<p class="p_CmdLinePrompts"><span class="f_CmdLinePrompts" style="font-size: 9pt;">INFO Opening composition "COMP1".</span></p>
+
See the [[UM:Exporting|Exporting]] chapter for a fuller description of [[UM:Export_Modes|Export Modes]].
<p class="p_CmdLinePrompts"><span class="f_CmdLinePrompts" style="font-size: 9pt;">INFO export ... exported 0 frames of 60 (0%)</span></p>
+
 
<p class="p_CmdLinePrompts"><span class="f_CmdLinePrompts" style="font-size: 9pt;">...</span></p>
+
{{M-Alert|If some shots have timecodes that ''overlap'',use an '''event folder variable''' ($e) when exporting. This will place exported shots inside "event" numbered folders and prevent overlapping shots being overwritten.}}
<p class="p_CmdLinePrompts"><span class="f_CmdLinePrompts" style="font-size: 9pt;">INFO export ... exported 60 frames of 60 (100%)</span></p>
+
 
</td>
+
{{M-Heading2|Shot Handles}}
</tr>
+
 
</table>
+
<tt>--export-handles <N></tt> '''[REQUIRED in multi-mode exports]'''
</div>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
The <tt>--export-handles <N></tt> option sets how many frames to use for ''handles'' (extra frames either side of a cut) when exporting.
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
 
<tr style="text-align:left;vertical-align:middle;">
+
{{M-Heading1|Export Paths}}
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
 
</td>
+
When using <tt>--export</tt>, the <path> argument should be the ''full'' path, including the '''drive letter, filename and extension'''. You can also use ''export variables'' such as $o, $f etc.
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">Exporting shots on the command line will </span><span class="f_DVTableText" style="font-weight: bold;">not</span><span class="f_DVTableText"> generate </span><span class="f_DVTableText" style="font-style: italic;">caches</span><span class="f_DVTableText">. This is different behaviour to the GUI where you have a choice of [[Platform:Global_Options|caching behaviour]] when exporting media.</span></p>
+
 
</td>
+
{{M-Note|See the [[UM:Folder Hierarchy And Variables|Export Variables]] section for a description of available variables.}}
</tr>
+
 
</table>
+
{{M-Heading3|Examples}}
</div>
+
 
<p class="p_DVHeader2"><span class="f_DVHeader2">Export Variables</span></p>
+
{{M-Cli|--export S:\exports\$o\$c_graded..dpx --export-mode single|}}
<p class="p_DVBodyText"><span class="f_DVBodyText">The export path specified with </span><span class="f_DVCmdline">--export</span><span class="f_DVBodyText"> can contain export variables such as $o, $f etc.</span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
This produces a single file sequence named from the clip name, in a folder named from composition e.g.
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
 
<tr style="text-align:left;vertical-align:middle;">
+
  GRADED_MASTER\approved_graded.090000.dpx
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
  GRADED_MASTER\approved_graded.090001.dpx
</td>
+
  ...
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">See section [[Platform:Folder_Hierarchy_And_Variables#variables|Export Variables]] for a description of available variables.</span></p>
+
  GRADED_MASTER\approved_graded.092421.dpx
</td>
+
 
</tr>
+
{{M-Cli|--export S:\export\$e\$c..dpx --export-mode multi --multi-mode visible-rec --export-handles 20|}}
</table>
+
 
</div>
+
This produces multiple event folders, each containing one shot with record order timecodes. Each shot is assigned to be exported with 20 frame handles :
<p class="p_DVHeader3"><span class="f_DVHeader3">Example</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVCmdlineF">--export S:\exports\</span><span class="f_DVCmdlineF" style="font-weight: bold;">$o</span><span class="f_DVCmdlineF">\</span><span class="f_DVCmdlineF" style="font-weight: bold;">$c</span><span class="f_DVCmdlineF">_graded..dpx \</span></p>
+
  0001\NOCLIP.090000.dpx ...
<p class="p_DVBodyTextIndent1"><span class="f_DVCmdlineF">  --export-mode single</span></p>
+
  0002\fixed.0090078.dpx ...
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
  etc.
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Producing a single file sequence named from the </span><span class="f_DVBodyTextIndent1" style="font-style: italic;">clip name</span><span class="f_DVBodyTextIndent1">, in a folder named from </span><span class="f_DVBodyTextIndent1" style="font-style: italic;">composition</span><span class="f_DVBodyText"> :</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
{{M-Cli|--export S:\exports\$e\$f.tiff|}}
<p class="p_DVBodyTextIndent1"><span class="f_DVFFilepath">GRADED_MASTER\approved.090000.dpx ... approved.092421.dpx</span></p>
+
 
<p class="p_DVHeader3"><span class="f_DVHeader3">Exporting Numeric Files</span></p>
+
This exports files with ''numeric'' filenames only via the '''$f''' (frame number) variable, inside ''event'' folders e.g.
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">To export files with </span><span class="f_DVBodyTextIndent1" style="font-weight: bold;">numeric filenames only</span><span class="f_DVBodyTextIndent1">, use the </span><span class="f_DVBodyTextIndent1" style="font-weight: bold;">$f</span><span class="f_DVBodyTextIndent1"> (frame number) variable :</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
  0045\008331.tiff ...
<p class="p_DVBodyTextIndent1"><span class="f_DVCmdlineF">--export S:\exports\$e\</span><span class="f_DVCmdlineF" style="font-weight: bold;">$f</span><span class="f_DVCmdlineF">.tiff</span></p>
+
  0046\009039.tiff ...
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Produces numeric files in event folders e.g.</span></p>
+
{{M-Heading1|Frame Number Padding}}
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVFFilepath">0045\</span><span class="f_DVFFilepath" style="font-weight: bold;">008331</span><span class="f_DVFFilepath">.tiff</span></p>
+
<tt>--frame-padding <N></tt>
<p class="p_DVHeader1"><span class="f_DVHeader1">Export Modes</span></p>
+
 
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--export-mode &lt;single|multi&gt; </span><span class="f_DVBodyText" style="font-weight: bold;">REQUIRED</span></p>
+
Use the <tt>--frame-padding</tt> option to set the amount of numeric padding for frame numbers on exported filenames
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--multi-mode &lt;</span><span class="f_DVCmdlineF">visible-src|visible-rec|tracks-src|tracks-rec&gt;</span></p>
+
 
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_DVCmdlineF">--export-handles &lt;N&gt;</span></p>
+
{{M-Heading3|Example}}
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText">You can export your composition as a </span><span class="f_DVBodyText" style="font-weight: bold;">single contiguous clip</span><span class="f_DVBodyText"> (</span><span class="f_DVBodyText" style="font-style: italic;">single</span><span class="f_DVBodyText">), in </span><span class="f_DVBodyText" style="font-weight: bold;">multiple shot chunks</span><span class="f_DVBodyText"> (</span><span class="f_DVBodyText" style="font-style: italic;">multi</span><span class="f_DVBodyText">), using </span><span class="f_DVBodyText" style="font-weight: bold;">source timecode</span><span class="f_DVBodyText"> (</span><span class="f_DVBodyText" style="font-style: italic;">src</span><span class="f_DVBodyText">) or using</span><span class="f_DVBodyText" style="font-weight: bold;"> record timecode</span><span class="f_DVBodyText"> (</span><span class="f_DVBodyText" style="font-style: italic;">rec</span><span class="f_DVBodyText">). </span></p>
+
{{M-Cli|--export S:\exports\$o\$c_graded..dpx --export-mode single --frame-padding 5|}}
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText">There is one single mode and four types of multi mode, each multi mode laying out the exported shots slightly differently. The four multi modes are :</span></p>
+
  GRADED_MASTER\approved_graded.00900.dpx
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
  GRADED_MASTER\approved_graded.00901.dpx
<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: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVCmdlineF">--multi-mode visible-src</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: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVCmdlineF">--multi-mode visible-rec</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: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVCmdlineF">--multi-mode tracks-src</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: 10pt; font-family: 'Arial Unicode MS', 'Lucida Sans Unicode', 'Arial'; color: #000000;">•</span></td><td><span class="f_DVCmdlineF">--multi-mode tracks-rec</span></td></tr></table></div><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 border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #d50000; border-spacing:10px;">
+
  GRADED_MASTER\approved_graded.09242.dpx
<tr style="text-align:left;vertical-align:middle;">
+
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_alert.png|alt=dv_alert]]</p>
+
{{M-Note|Frame numbers are '''zero''' padded i.e. 00067727.dpx is a frame padding of eight (8).<br/>The default padding is '''six''' (6).}}
</td>
+
 
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">Because shots might be overwritten if they have </span><span class="f_DVTableText" style="font-weight: bold;">overlapping timecodes</span><span class="f_DVTableText">, you should consider the use of an </span><span class="f_DVTableText" style="font-style: italic;">event folder variable</span><span class="f_DVTableText"> ($e) when exporting.</span></p>
+
{{M-Heading1|SMPTE Level Clipping}}
</td>
+
 
</tr>
+
<tt>--smpte-level-clip <true|false></tt>
</table>
+
 
</div>
+
To clip the exported shots to a SMPTE legal range (e.g. 64-940 for 10 bit data), use the <tt>--smpte-level-clip</tt> option.
<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 border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
{{M-Note|This is only applicable to '''SMPTE''' colourspace projects.}}
<tr style="text-align:left;vertical-align:middle;">
+
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
{{M-Heading1|File Format Information}}
</td>
+
 
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">See the [[Platform:Exporting|Exporting]] chapter for a fuller description of [[Platform:Export_Modes|Export Modes]].</span></p>
+
<tt>--export-format <FORMAT></tt>
</td>
+
 
</tr>
+
Use the <tt>--export-format</tt> option to specify a specific output format type to write. This option is used for DPX, TIFF and MXF formats.
</table>
+
 
</div>
+
{{M-Heading2|DPX Specification}}
<p class="p_DVHeader3"><span class="f_DVHeader3">Example</span></p>
+
 
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 40px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
When exporting to a DPX sequence, you can use the <tt>--export-format <FORMAT></tt> option to set the bit-depth, colour space/channels and scaling. FORMAT can be one of the following :
<tr style="text-align:left;vertical-align:middle;">
+
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
* rgb16
</td>
+
* rgb12
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">The following examples are split over two lines using a line continuation character. In reality, the command would be on a single line only.</span></p>
+
* rgb10
</td>
+
* rgb8
</tr>
+
* yuv10
</table>
+
* luma16
</div>
+
* luma12
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
* luma10
<p class="p_DVBodyTextIndent1"><span class="f_DVCmdlineF">--export S:\export\$e\$c..dpx --export-mode multi \</span></p>
+
* luma8
<p class="p_DVBodyTextIndent1"><span class="f_DVCmdlineF">  --multi-mode visible-rec --export-handles 20</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
You can optionally append the following suffixes to modify the output DPX file format :
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1">Producing multiple event folders, each containing one shot with record order timecodes :</span></p>
+
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
+
* _log
<p class="p_DVBodyTextIndent1"><span class="f_DVFFilepath">0001/NOCLIP.090000.dpx ...</span></p>
+
* _lin
<p class="p_DVBodyTextIndent1"><span class="f_DVFFilepath">0002/fixed.0090078.dpx ...</span></p>
+
* _smpte
<p class="p_DVBodyTextIndent1"><span class="f_DVFFilepath">etc.</span></p>
+
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Frame Number Padding</span></p>
+
{{M-Heading3|Examples}}
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--frame-padding &lt;N&gt;</span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
{{M-Cli|--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb16|}}
<p class="p_DVBodyText"><span class="f_DVBodyText">This sets the numeric padding on exported filenames.</span></p>
+
{{M-Cli|--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb10_lin|}}
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
{{M-Cli|--export S:\exports\$o\$c_graded.dpx --export-mode single --export-format luma10|}}
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
 
<tr style="text-align:left;vertical-align:middle;">
+
{{M-Heading2|TIFF Specification}}
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
 
</td>
+
When exporting a TIFF sequence, you can use the <tt>--export-format <FORMAT></tt> option to specify the bit-depth of the TIFF output. FORMAT can be one of :
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">Numbers are </span><span class="f_DVTableText" style="font-weight: bold;">zero padded</span><span class="f_DVTableText"> i.e. 008999.dpx is frame padding of six.</span></p>
+
 
</td>
+
* TIF:8
</tr>
+
* TIF:16
</table>
+
 
</div>
+
{{M-Heading3|Example}}
<p class="p_DVHeader1"><span class="f_DVHeader1">Shot Handles</span></p>
+
 
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--export-handles &lt;N&gt;</span></p>
+
{{M-Cli|--export S:\exports\$o\$f.tif --export-mode single --export-format TIF:16|}} - Note use of TIF not TIFF
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText">In multi-mode export, set how many handles to export per shot. </span><span class="f_DVBodyText" style="font-weight: bold;">This is required in multi-mode.</span></p>
+
{{M-Heading2|MXF Specification}}
<p class="p_DVHeader1"><span class="f_DVHeader1">SMPTE Level Clip</span></p>
+
 
<p class="p_CmdLine" style="margin: 0px 0px 0px 0px;"><span class="f_CmdLine">--smpte-level-clip &lt;true|false&gt;</span></p>
+
When exporting an MXF sequence, use <tt>--export-format <FORMAT></tt> where FORMAT is one of :
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText">This setting will clip the exported shot to a SMPTE video level (i.e. 64-940 for 10 bit data).</span></p>
+
* MXF:Uncomp HD 10 bit
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
* MXF:Uncomp HD 8 bit
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px;"><table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
+
* MXF:1:1 10b RGB
<tr style="text-align:left;vertical-align:top;">
+
* MXF:1:1 10b RGB
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
+
* MXF:DNxHD 40 1080p
</td>
+
* MXF:DNxHD 120 1080p
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">This is only applicable to </span><span class="f_DVTableText" style="font-weight: bold;">SMPTE</span><span class="f_DVTableText"> colourspace projects.</span></p>
+
* MXF:DNxHD 185 1080p
</td>
+
* MXF:DNxHD 185X 1080p
</tr>
+
* MXF:DNx444 370X 1080p
</table>
+
* MXF OP1a:XDCAM HD 50
</div>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
{{M-Note|You will need to "quote" the format for execution.}}
 +
 
 +
{{M-Heading3|Example}}
 +
 
 +
{{M-Cli|--export S:\exports\output.mxf --export-mode single --export-format "MXF:DNxHD 185 1080p"|}}
 +
 
 +
{{M-Heading1|MOV Codec Information}}
 +
 
 +
<tt>--video-codec <PRESET></tt>
 +
 
 +
When exporting to Quicktime, use the <tt>--video-codec <PRESET></tt> option to select the Quicktime ''preset'' to use. The following presets are built-in :
 +
 
 +
* ProRes 4444
 +
* ProRes 422 (HQ)
 +
* ProRes 422
 +
* ProRes 422 (LT)
 +
* ProRes 422 (Proxy)
 +
 
 +
{{M-Note|You will need to "quote" the format for execution.}}
 +
 
 +
{{M-Heading2|Video Codec Presets}}
 +
 
 +
For details on how to create and use presets, see the appendix [[UM:Creating_QT_Presets|Creating Quicktime Presets]].
 +
 
 +
{{M-Heading3|Example}}
 +
 
 +
{{M-Cli|--export S:\exports\output.mov --export-mode single --video-codec "ProRes 422 (LT)"|}}
  
 
{{Template:M-Navlinks-bottom|UM:Manual|UM:Cli_Cli_Generate_Proxies|UM:Cli_Cli_Export_Edl}}
 
{{Template:M-Navlinks-bottom|UM:Manual|UM:Cli_Cli_Generate_Proxies|UM:Cli_Cli_Export_Edl}}

Latest revision as of 11:11, 2 September 2016

Darrow-up.png     Previous Next

Exporting Shots
--export <path> Export/render supplied composition to specified path
--export-mode <single/multi> Choose mode of export (single or multi). [REQUIRED].
--multi-mode <MODE> For multi-mode export, choose MODE. MODE can be one of :
  • visible-src
  • visible-rec
  • tracks-src
  • tracks-rec

[REQUIRED when using multi mode export].

--export-format <FORMAT> Specify extra information for DPX, TIFF and MXF format exports (see below).
--video-codec <PRESET> For Quicktime exports, specify the video codec PRESET to use (see below).
--frame-padding <N> Set with of numeric padding on filenames on export. This will be zero-padded.
--export-handles <N> Export each shot with specified handles. [REQUIRED when using multi mode export].
--smpte-level-clip <true/false> Clip the exported shot colourspace to SMPTE video levels.


This chapter describes how to export shots on a composition to various file formats, such as DPX, MXF DNxHD and Quicktime. You can choose to export the composition in various "modes", taking account of tracks and shot visibility or as a single contiguous "mixdown" sequence.

Exporting a Composition

--export <path>
--export-mode <single|multi> [REQUIRED]

The --export command will render and export the specified composition (given by the --composition parameter) to the specified path.

The <path> argument should be the full path, including the drive letter, filename and extension.

The output format written (DPX, MXF etc.) is taken from the file extension.

Command :
nucoda --project PROJ1 --composition COMP1 --export-mode single --export Z:\jobs\001\graded_m.dpx
...

INFO Opening project "PROJ1".
INFO Opening composition "COMP1".
INFO export ... exported 0 frames of 60 (0%)
...
INFO export ... exported 60 frames of 60 (100%)

Exporting shots on the command line will not generate caches. This is different behaviour to the GUI where you have a choice of caching behaviour when exporting media.

Export Modes

--export-mode <single/multi> [REQUIRED]
--multi-mode <MODE>
--export-handles <N>

There are two export modes and you must specify one.

Single Mode

--export-mode single

In single mode, the composition is exported as a single contiguous clip.

Multi Mode

--export-mode multi
--multi-mode <MODE>
--export-handles <N>

In multi mode, the composition is exported as multiple shots with a layout specified with the required mode option.

The mode option --multi-mode can have one of the following MODE values :

  • visible-src
  • visible-rec
  • tracks-src
  • tracks-rec

See the Exporting chapter for a fuller description of Export Modes.

If some shots have timecodes that overlap,use an event folder variable ($e) when exporting. This will place exported shots inside "event" numbered folders and prevent overlapping shots being overwritten.

Shot Handles

--export-handles <N> [REQUIRED in multi-mode exports]

The --export-handles <N> option sets how many frames to use for handles (extra frames either side of a cut) when exporting.

Export Paths

When using --export, the <path> argument should be the full path, including the drive letter, filename and extension. You can also use export variables such as $o, $f etc.

See the Export Variables section for a description of available variables.

Examples
Command :
--export S:\exports\$o\$c_graded..dpx --export-mode single

This produces a single file sequence named from the clip name, in a folder named from composition e.g.

 GRADED_MASTER\approved_graded.090000.dpx
 GRADED_MASTER\approved_graded.090001.dpx
 ...
 GRADED_MASTER\approved_graded.092421.dpx
Command :
--export S:\export\$e\$c..dpx --export-mode multi --multi-mode visible-rec --export-handles 20

This produces multiple event folders, each containing one shot with record order timecodes. Each shot is assigned to be exported with 20 frame handles :

 0001\NOCLIP.090000.dpx ...
 0002\fixed.0090078.dpx ...
 etc.
Command :
--export S:\exports\$e\$f.tiff

This exports files with numeric filenames only via the $f (frame number) variable, inside event folders e.g.

 0045\008331.tiff ...
 0046\009039.tiff ...
Frame Number Padding

--frame-padding <N>

Use the --frame-padding option to set the amount of numeric padding for frame numbers on exported filenames

Example
Command :
--export S:\exports\$o\$c_graded..dpx --export-mode single --frame-padding 5
 GRADED_MASTER\approved_graded.00900.dpx
 GRADED_MASTER\approved_graded.00901.dpx
 ...
 GRADED_MASTER\approved_graded.09242.dpx

Frame numbers are zero padded i.e. 00067727.dpx is a frame padding of eight (8).
The default padding is six (6).

SMPTE Level Clipping

--smpte-level-clip <true|false>

To clip the exported shots to a SMPTE legal range (e.g. 64-940 for 10 bit data), use the --smpte-level-clip option.

This is only applicable to SMPTE colourspace projects.

File Format Information

--export-format <FORMAT>

Use the --export-format option to specify a specific output format type to write. This option is used for DPX, TIFF and MXF formats.

DPX Specification

When exporting to a DPX sequence, you can use the --export-format <FORMAT> option to set the bit-depth, colour space/channels and scaling. FORMAT can be one of the following :

  • rgb16
  • rgb12
  • rgb10
  • rgb8
  • yuv10
  • luma16
  • luma12
  • luma10
  • luma8

You can optionally append the following suffixes to modify the output DPX file format :

  • _log
  • _lin
  • _smpte
Examples
Command :
--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb16
Command :
--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb10_lin
Command :
--export S:\exports\$o\$c_graded.dpx --export-mode single --export-format luma10
TIFF Specification

When exporting a TIFF sequence, you can use the --export-format <FORMAT> option to specify the bit-depth of the TIFF output. FORMAT can be one of :

  • TIF:8
  • TIF:16
Example
Command :
--export S:\exports\$o\$f.tif --export-mode single --export-format TIF:16
- Note use of TIF not TIFF
MXF Specification

When exporting an MXF sequence, use --export-format <FORMAT> where FORMAT is one of :

  • MXF:Uncomp HD 10 bit
  • MXF:Uncomp HD 8 bit
  • MXF:1:1 10b RGB
  • MXF:1:1 10b RGB
  • MXF:DNxHD 40 1080p
  • MXF:DNxHD 120 1080p
  • MXF:DNxHD 185 1080p
  • MXF:DNxHD 185X 1080p
  • MXF:DNx444 370X 1080p
  • MXF OP1a:XDCAM HD 50

You will need to "quote" the format for execution.

Example
Command :
--export S:\exports\output.mxf --export-mode single --export-format "MXF:DNxHD 185 1080p"
MOV Codec Information

--video-codec <PRESET>

When exporting to Quicktime, use the --video-codec <PRESET> option to select the Quicktime preset to use. The following presets are built-in :

  • ProRes 4444
  • ProRes 422 (HQ)
  • ProRes 422
  • ProRes 422 (LT)
  • ProRes 422 (Proxy)

You will need to "quote" the format for execution.

Video Codec Presets

For details on how to create and use presets, see the appendix Creating Quicktime Presets.

Example
Command :
--export S:\exports\output.mov --export-mode single --video-codec "ProRes 422 (LT)"

Darrow-up.png     Previous Next