Burn-in Templates
From IRIDAS Online Documentation
Contents |
Burn-In Templates
IRIDAS applications support a common syntax for specifying Burn-In templates. You can use Burn-In templates to add text and graphical elements to your frames at load time. Placeholders are replaced with the current file name, time code etc.
FrameCycler Professional, DDS and SpeedGrade NX 2011 include several presets found in the burn-in pull-down:
Using the Standard Burn-In
If you choose "Standard" from the list, three elements will be superimposed on the footage displayed in the viewport:
- Current frame number
- Location on disk of current sequence
- Native Time Code of current frame (if this field doesn't exist in the header of the file format you're using there will be no display of Time Code information)
The location of all three elements is always absolute to the actual image size. If you want to be sure you see all burn-in elements, zoom to fit (either via the +/- keys on the numpad or automatically via < Ctrl + Home >
Using the All Fields Burn-In
The "All FIelds" Burn-In will display all data in the header of the file that is on display in the viewport. This view is usually used for quality control purposes but also gives the full represenation of Placeholders that can be used to create a custom Burn-In template.
Creating a Custom Burn-In
The easiest way to generate a customised Burn-In is to open the Standard Burn-In and change it according to your needs. The Standard Burn-In file is located in your IRIDAS apllication's folder under settings/burn-in. On a Windows installation this usually would be
C:\Program Files\IRIDAS FrameCycler DDS\Settings\burn-in
for an installation of FrameCycler DDS.
Under OS X please click on the launch icon for your IRIDAS application. Select “Show package contents” from popup menu and new finder window will open. Double click on the Contents folder to open it. Then open the MacOS folder, then open the log folder, then burn-in.
Open the file Standard.burnin with a text editor such as Wordpad or Textedit. Save the file under a different name inside the same folder and then start to make changes (please refer to the paragpraph below on how to change the file). Next time you launch your IRIDAS application the new template will show in the pull-down for Burn-Ins.
Elements of a .burnin file
If you'd like to use a different frame size as reference for placing the burn-in content you can make changes in the first section of the .burnin file:
<width>"2048"</width> <height>"1556"</height>
For using the same file for full HD content please change this section to:
<width>"1920"</width> <height>"1080"</height>
The next section includes the actual Parameters shown in the viewport. Every element is called a textnote. In Standard.burnin the first textnote is
<textnote>
<text>"{Src.FrameNumber}"</text>
<textsize>"2"</textsize>
<textcolor>"255,255,255,255"</textcolor>
<backgroundcolor>"0,0,0,0"</backgroundcolor>
<arrow>"0"</arrow>
<position>"40,40"</position>
</textnote>
If you want to change the size you can select from presets 0 (small) to 2 (large) or enter pixel values. A much larger text than preset 2 can be created using the pixel value method, e.g.:
<textsize>"60px"</textsize>
To change the color from white to black change the text color to (all color values are listed in RGBA)
<textcolor>"0,0,0,0"</textcolor>
The background color is defined in RGBA as well, this example would give a solid black bar:
<backgroundcolor>"0,0,0,255"</backgroundcolor>
To change the position of a text note just use x,y values, this example would place the text note above the image:
<position>"40,-40"</position>
Adding a new Text Note
To add a new text note simply copy an existing text note in the standard.burnin and paste it after the last text note. Change the position next to make sure the new text note is not overlapping with any existing text note. Then replace the Placeholder with the new Placeholder you want to add. The full list of Placeholders for the file format you'd like to use is available in the All Fields view inside your IRIDAS application, the item in front of the colon can be used as a Placeholder in a text note.
Here's a list of typical Placeholders that would apply to formats such as DPX, CIN, TGA:
- Src.FileFormat
- Src.SequenceName
- Src.SequencePath
- Src.FrameName
- Src.FrameNumber
- PlayheadPosition
For an overview of all meta data fields available, please see Metadata Placeholders.
If you'd like to add a text note for Playhead Position this could look like this:
<textnote>
<text>"{PlayheadPosition}"</text>
<textsize>"2"</textsize>
<textcolor>"255,255,255,255"</textcolor>
<backgroundcolor>"0,0,0,0"</backgroundcolor>
<arrow>"0"</arrow>
<position>"40,100"</position>
</textnote>
After adding or changing text note elements, save the .burnin file. The new template is ready to use and will show up in the pull-down for Burn-Ins next time you launch your IRIDAS application
Adding or Subtracting Numbers From Metadata Fields
You can add or subtract numbers from numerical metadata fields like FrameNumber, NativeTimeCode or FrameIndex.
The syntax for that is:
{FrameIndex+1}
This feature allows you to compensate for fixed offsets or start with different numbers in your Burn-In. In the above example, the first frame would show 1 instead of 0 in the burn in. This feature is available in IRIDAS product builds 3160 and above.