View source for UM:Cli Cli Export

<div class="manualcontent">

{{Template:M-Navlinks-top|UM:Manual|UM:Cli_Cli_Generate_Proxies|UM:Cli_Cli_Export_Edl}}

{{Template:M-Title|Exporting Shots}}

{{M-Clioptions|--export <path>|Export/render supplied composition to specified path}}
{{M-Clioptions|--export-mode <single/multi>|Choose ''mode'' of export (single or multi). '''[REQUIRED]'''.}}
{{M-Clioptions|--multi-mode <MODE>|For ''multi-mode'' export, choose MODE. MODE can be one of :

* <tt>visible-src</tt>
* <tt>visible-rec</tt>
* <tt>tracks-src</tt>
* <tt>tracks-rec</tt>

'''[REQUIRED when using multi mode export]'''.}}
{{M-Clioptions|--export-format <FORMAT>|Specify extra information for DPX, TIFF and MXF format exports (see below).}}
{{M-Clioptions|--video-codec <PRESET>|For Quicktime exports, specify the video codec PRESET to use (see below).}}
{{M-Clioptions|--frame-padding <N>|Set with of numeric padding on filenames on export. This will be zero-padded. }}
{{M-Clioptions|--export-handles <N>|Export each shot with specified handles. '''[REQUIRED when using multi mode export]'''. }}
{{M-Clioptions|--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.

{{M-Heading1|Exporting a Composition}}

<tt>--export <path></tt><br/>
<tt>--export-mode <single|multi></tt> '''[REQUIRED]'''

The <tt>--export</tt> command will render and export the specified ''composition'' (given by the <tt>--composition</tt> parameter) to the specified path.

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

{{M-Note|The output format written (DPX, MXF etc.) is taken from the file '''extension'''.}}

{{M-Cli|
nucoda --project PROJ1 --composition COMP1 --export-mode single --export Z:\jobs\001\graded_m.dpx|...<br/>
INFO Opening project "PROJ1".<br/>
INFO Opening composition "COMP1".<br/>
INFO export ... exported 0 frames of 60 (0%)<br/>
...<br/>
INFO export ... exported 60 frames of 60 (100%)<br/>
}}

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

{{M-Heading1|Export Modes}}

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

There are two export ''modes'' and you must specify one.

{{M-Heading2|Single Mode}}

<tt>--export-mode single</tt>

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

{{M-Heading2|Multi Mode}}

<tt>--export-mode multi</tt><br/>
<tt>--multi-mode <MODE></tt><br/>
<tt>--export-handles <N></tt>

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

The mode option <tt>--multi-mode</tt> can have one of the following MODE values :

* <tt>visible-src</tt>
* <tt>visible-rec</tt>
* <tt>tracks-src</tt>
* <tt>tracks-rec</tt>

See the [[UM:Exporting|Exporting]] chapter for a fuller description of [[UM:Export_Modes|Export Modes]].

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

{{M-Heading2|Shot Handles}}

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

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

{{M-Heading1|Export Paths}}

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. 

{{M-Note|See the [[UM:Folder Hierarchy And Variables|Export Variables]] section for a description of available variables.}}

{{M-Heading3|Examples}}

{{M-Cli|--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

{{M-Cli|--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.

{{M-Cli|--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 ...

{{M-Heading1|Frame Number Padding}}

<tt>--frame-padding <N></tt>

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

{{M-Heading3|Example}}

{{M-Cli|--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

{{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).}}

{{M-Heading1|SMPTE Level Clipping}}

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

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.

{{M-Note|This is only applicable to '''SMPTE''' colourspace projects.}}

{{M-Heading1|File Format Information}}

<tt>--export-format <FORMAT></tt>

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.

{{M-Heading2|DPX Specification}}

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 :

* 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

{{M-Heading3|Examples}}

{{M-Cli|--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb16|}}
{{M-Cli|--export S:\exports\$o\$f.dpx --export-mode single --export-format rgb10_lin|}}
{{M-Cli|--export S:\exports\$o\$c_graded.dpx --export-mode single --export-format luma10|}}

{{M-Heading2|TIFF Specification}}

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 :

* TIF:8
* TIF:16

{{M-Heading3|Example}}

{{M-Cli|--export S:\exports\$o\$f.tif --export-mode single --export-format TIF:16|}} - Note use of TIF not TIFF

{{M-Heading2|MXF Specification}}

When exporting an MXF sequence, use <tt>--export-format <FORMAT></tt> 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

{{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}}

</div>

[[Category:Nucoda]]
[[Category:Phoenix]]
[[Category:Loki]]


<!--
Originally processed and converted on 2014-06-20 20:09:20
-->