Difference between revisions of "UM:Appendix Output Format Configuration"

From DigitalVision
Jump to: navigation, search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<div class="manualcontent">
 
<div class="manualcontent">
  
{{Template:M-Navlinks-top|UM:Manual|UM:Appendix_Effect_Selector_Configuration|UM:New_Item}}
+
{{Template:M-Navlinks-top|UM:Manual|UM:Appendix_Effect_Selector_Configuration|UM:Colour_Tool_Order}}
  
 
{{Template:M-Title|Output Format Configuration}}
 
{{Template:M-Title|Output Format Configuration}}
Line 23: Line 23:
 
<p class="p_DVBodyText"><span class="f_DVBodyText">The output formats available can be defined through the use of text configuration files.</span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText">The output formats available can be defined through the use of text configuration files.</span></p>
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Configuration Files</span></p>
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Configuration Files</span></p>
<p class="p_DVBodyText"><span class="f_DVBodyText">The </span><span class="f_DVBodyText" style="font-style: italic;">default</span><span class="f_DVBodyText"> configuration file exists in the application C:\Nucoda\VERSION\root.</span></p>
+
<p class="p_DVBodyText"><span class="f_DVBodyText">The </span><span class="f_DVBodyText" style="font-style: italic;">default</span><span class="f_DVBodyText"> configuration file exists in the application folder C:\Nucoda\VERSION\root\Presets\System.</span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
<p class="p_DVBodyText"><span class="f_DVBodyText">If a </span><span class="f_DVBodyText" style="font-style: italic;">user</span><span class="f_DVBodyText"> configuration file exists in the same folder it will override the defaults. This user configuration file does not exists unless you </span><span class="f_DVBodyText" style="font-weight: bold;">create it</span><span class="f_DVBodyText">.</span></p>
+
 
 
<p class="p_DVHeader3"><span class="f_DVHeader3">Default Configuration File</span></p>
 
<p class="p_DVHeader3"><span class="f_DVHeader3">Default Configuration File</span></p>
 
<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;">
 
<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;">
Line 37: Line 37:
 
<td style="width:387px; border: solid 1px #333333;" valign="top" width="387"><p style="text-align: right;"><span style="font-weight: bold;">Location : </span></p>
 
<td style="width:387px; border: solid 1px #333333;" valign="top" width="387"><p style="text-align: right;"><span style="font-weight: bold;">Location : </span></p>
 
</td>
 
</td>
<td style="width:518px; border: solid 1px #333333;" valign="top" width="518"><p>C:\Nucoda\VERSION\root</p>
+
<td style="width:518px; border: solid 1px #333333;" valign="top" width="518"><p>C:\Nucoda\VERSION\root\Presets\System</p>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 49: Line 49:
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_alert.png|alt=dv_alert]]</p>
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_alert.png|alt=dv_alert]]</p>
 
</td>
 
</td>
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">You should not edit or modify this file. It will be </span><span class="f_DVTableText" style="font-weight: bold;">over-written</span><span class="f_DVTableText"> by every application install. If you want to modify the format list, edit the </span><span class="f_DVTableText" style="font-style: italic;">userOutputFormats.prefs</span><span class="f_DVTableText"> file.</span></p>
+
<td style="width:760px; border: none" valign="middle" width="760"><p class="p_DVTableText"><span class="f_DVTableText">You should not edit or modify this file. It will be </span><span class="f_DVTableText" style="font-weight: bold;">over-written</span><span class="f_DVTableText"> by every application install. If you want to modify the format list, edit the </span><span class="f_DVTableText" style="font-style: italic;">userOutputFormats.prefs</span><span class="f_DVTableText"> file instead (see below).</span></p>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 55: Line 55:
 
</div>
 
</div>
 
<p class="p_DVHeader3"><span class="f_DVHeader3">User Configuration File</span></p>
 
<p class="p_DVHeader3"><span class="f_DVHeader3">User Configuration File</span></p>
 +
 +
If you set up your own ''user'' login for the application, you can define your own output formats. This file does not exist by default but if it exists, it will over-ride the default settings in the <tt>defaultOutputFormats.prefs</tt> file.
 +
 
<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;">
 
<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;">
 
<tr style="text-align:left;vertical-align:top;">
 
<tr style="text-align:left;vertical-align:top;">
Line 65: Line 68:
 
<td style="width:387px; border: solid 1px #333333;" valign="top" width="387"><p style="text-align: right;"><span style="font-weight: bold;">Location : </span></p>
 
<td style="width:387px; border: solid 1px #333333;" valign="top" width="387"><p style="text-align: right;"><span style="font-weight: bold;">Location : </span></p>
 
</td>
 
</td>
<td style="width:518px; border: solid 1px #333333;" valign="top" width="518"><p>C:\Nucoda\VERSION\root</p>
+
<td style="width:518px; border: solid 1px #333333;" valign="top" width="518"><p>C:\Nucoda\VERSION\root\Users\USERNAME</p>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
</div>
 
</div>
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText" style="font-weight: bold;">This file does not exist by default</span><span class="f_DVBodyText">.</span></p>
+
{{M-Note|You can also add this file to the ''Default'' or ''AllUsers'' folders to have these user formats available to everyone.}}
<p class="p_DVBodyText"><span class="f_DVBodyText"> </span></p>
+
 
<p class="p_DVBodyText"><span class="f_DVBodyText">If it exists, it will </span><span class="f_DVBodyText" style="font-style: italic;">over-ride</span><span class="f_DVBodyText"> the default settings in the </span><span style="font-style: italic;">defaultOutputFormats.prefs</span> file.</p>
+
<table border="1" cellpadding="0" cellspacing="10" style="border: solid 1px #ff9900; border-spacing:10px;">
<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;">
 
 
<tr style="text-align:left;vertical-align:top;">
 
<tr style="text-align:left;vertical-align:top;">
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
 
<td style="width:36px; border: none" valign="top" width="36"><p class="p_DVTableText">[[File:dv_note.png|alt=dv_note]]</p>
Line 83: Line 84:
 
</tr>
 
</tr>
 
</table>
 
</table>
</div>
+
 
 +
 
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Configuration File Format</span></p>
 
<p class="p_DVHeader1"><span class="f_DVHeader1">Configuration File Format</span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText">A high-level overview of the file format is shown below :</span></p>
 
<p class="p_DVBodyText"><span class="f_DVBodyText">A high-level overview of the file format is shown below :</span></p>
Line 338: Line 340:
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
 
<p class="p_DVBodyTextIndent1"><span class="f_DVBodyTextIndent1"> </span></p>
  
{{Template:M-Navlinks-bottom|UM:Manual|UM:Appendix_Effect_Selector_Configuration|UM:New_Item}}
+
{{Template:M-Navlinks-bottom|UM:Manual|UM:Appendix_Effect_Selector_Configuration|UM:Colour_Tool_Order}}
  
 
</div>
 
</div>

Latest revision as of 15:17, 23 February 2017

Darrow-up.png     Previous Next

Output Format Configuration

Every project a main output format defined and may also have one or more secondary formats configured. Available formats appear as a drop-down list on the project screen with a name Setup.

 

app-output-format-selector1

 

The Output Format Selector drop-down list.

app-output-format-selector2

 

Interacting with the Output Format Selector drop-down list and choosing a format.

 

The output formats available can be defined through the use of text configuration files.

Configuration Files

The default configuration file exists in the application folder C:\Nucoda\VERSION\root\Presets\System.

 

Default Configuration File

Name :

defaultOutputFormats.prefs

Location :

C:\Nucoda\VERSION\root\Presets\System

 

This is the main configuration file for the drop-down list and defines the standard output formats available.

 

dv_alert

You should not edit or modify this file. It will be over-written by every application install. If you want to modify the format list, edit the userOutputFormats.prefs file instead (see below).

User Configuration File

If you set up your own user login for the application, you can define your own output formats. This file does not exist by default but if it exists, it will over-ride the default settings in the defaultOutputFormats.prefs file.

Name :

userOutputFormats.prefs

Location :

C:\Nucoda\VERSION\root\Users\USERNAME

You can also add this file to the Default or AllUsers folders to have these user formats available to everyone.

dv_note

An example userOutputFormats.prefs file exists in the example_files folder.


Configuration File Format

A high-level overview of the file format is shown below :

 

outputFormats
[
   // Multiple formats allowed

   FORMATNAME  // Must be unique
   {
       name "<Format Name>"      // as displayed
       size N N                  // X Y pixels
       aspect W H                // Rational aspect
       fps N N                   // Rational FPS
       fieldOrder <FIELD ORDER>  // See below
       dropFrame <Boolean>        
       initial <Boolean>         // Optional - see below
   }

   FORMATNAME2  // Must be unique
   {
       name "<Format Name>"      // as displayed
       size N N                  // X Y pixels
       aspect W H                // Rational aspect
       fps N N                   // Rational FPS
       fieldOrder <FIELD ORDER>  // See below
       dropFrame <Boolean>        
       initial <Boolean>         // Optional - see below
   }

   insertDefault <Boolean>       // insert default list?
]

 

dv_note

Note that the entire outputFormats content is wrapped in SQUARE ([,]) brackets.

Definitions

Some configuration file parameters are of a specific type :

 

Rational :

A Rational number is a fraction and is composed of a numerator (top) and a denominator (bottom).

 

Rather than using a floating point number (and decimal places), a rational number can more accurate reflect a parameter such as aspect ratio, or frames per second.

Boolean :

A Boolean value is either true or false.

 

Sections

FORMATNAME

Type : Identifier

 

Each output format definition is grouped (using curly braces), and named. These names :

 

Must be unique
Must not contain spaces (Only : a-z,A-Z,0-9,_,-)

 

dv_note

These names are not related to the user visible name field used inside the format definition and can be different.

 

Example :

 

Main_Feature_2800x1800_Test

{

 

}

 

name S

Type : String

 

This is the user visible display name for the format. It is a string wrapped in double-quotes ("") and can contain spaces.

 

Example :

 

name "2800 x 1800 Test"

size W H

Type : Rational

 

The size parameter specifies the pixel width and height as a rational number.

 

Example :

 

size 2800 1800

aspect N M

Type : Rational

 

The aspect parameter specifies the aspect ratio as a rational number (fraction with a numerator and a denominator).

 

dv_note

A 1:1 aspect can always be chosen by setting the aspect values the same as the size values.

 

Example :

 

aspect 37 20  // 1.85

fps N M

Type : Rational

 

The fps parameter specifies the frames per second as a rational number.

 

Example :

 

fps 2997 100  // i.e. "29.97"

fieldOrder S

Type : String

 

The fieldOrder parameter specifies how to interpret a frame in the format. It is a string wrapped in double-quotes ("") and can take values :

 

InterlacedUpper

Format uses interlaced frames (fields) with upper field dominant.

InterlacedLower

Format uses interlaced frames (fields) with lower field dominant.

Progressive

Format is not fielld based.

 

Example :

 

fieldOrder "Progressive"

dropFrame B

Type : Boolean

 

The dropFrame parameter specifies if the format uses drop-frame timecode (true) or not (false).

 

Example :

 

dropFrame false

initial B

Type : Boolean

 

This parameter is optional.

 

The initial parameter specifies that the format it appears in will be selected on application start (for a completely fresh installation).

 

Example :

 

initial true

insertDefault B

Type : Boolean

 

The insertDefault parameter can be used in a user configuration file (userOutputFormats.prefs) to load in the default output formats (a specified in the defaultOutputFormats.prefs file) at the location the directive appears.

 

dv_note

This parameter must be placed outside any actual format definition section.

 

Example :

 

insertDefault true

 

Darrow-up.png     Previous Next