Dolby Atmos Conversion Tool Guide
Dolby Atmos Conversion Tool Guide
Guide
6 July 2023
Software v2.1.2
Notices
Notices
Copyright
© 2015-2023 Dolby Laboratories. All rights reserved.
Trademarks
Dolby and the double-D symbol are registered trademarks of Dolby Laboratories.
The following are trademarks of Dolby Laboratories:
Contents
1 Introduction to the Dolby Atmos Conversion Tool documentation..........................................................6
1.1 Contacting Dolby................................................................................................................................... 7
9 Primary languages supported by the Dolby Atmos Conversion Tool (IMF IAB only)................................84
Glossary....................................................................................................................................................... 100
• Contacting Dolby
Operating system Dolby Atmos Conversion Tool Dolby Atmos Conversion Tool
application (with a dedicated user command-line application
interface (UI) window)
Linux No Yes
2.4.1 Installing the Dolby Atmos Conversion Tool Debian package on a Linux
system
You can install the Dolby Atmos Conversion Tool Debian package on a Linux system that is qualified by Dolby.
Procedure
1. Ensure that the Dolby Atmos Conversion Tool Debian package (.deb file) is on your Linux machine.
2. Open the terminal window.
3. Install the Dolby Atmos Conversion Tool package:
a. Execute one of these command lines:
sudo dpkg -i dolby-atmos-conversion-tool-X.X.X.xxxxxxx-Linux.deb (where
xxxxxxx is the build number)
b. If prompted with a warning that the package cannot be authenticated unless you accept the install
without verification, execute y for yes.
Results
Each Dolby Atmos Conversion Tool package component is installed on your computer, at the noted location:
• Dolby Atmos Conversion Tool command-line application
(cmdline_atmos_conversion_tool): /usr/bin
• Dolby Atmos Conversion Tool documentation: /usr/share/doc/dolby-atmos-conversion-
tool
Procedure
Execute this command line:
sudo dpkg -r dolby-atmos-conversion-tool
Procedure
1. Start the installer by double-clicking the Dolby Atmos Conversion Tool installer package
DolbyAtmosConversionTool_X.X.X_xxxxxxx_Mac.pkg (where xxxxxxx is the build
number).
2. Follow the on-screen instructions.
Results
Each supported Dolby Atmos Conversion Tool package component is installed on your computer at the
locations listed here:
• Dolby Atmos Conversion Tool: /Applications/Dolby/Dolby Atmos Conversion Tool
• Dolby Atmos Conversion Tool command-line application (cmdline_atmos_conversion_tool): /
Applications/Dolby/Dolby Atmos Conversion Tool
• Dolby Atmos Conversion Tool documentation: /Applications/Dolby/Dolby Atmos
Conversion Tool
Procedure
1. To uninstall the package:
a. Navigate to /Applications/Dolby.
b. Perform one of these steps:
• Right-click on the Dolby Atmos Conversion Tool folder and choose Move to Trash.
• Drag the Dolby Atmos Conversion Tool folder to the trash.
2. To uninstall the tool application or command-line executable:
a. Navigate to /Applications/Dolby/Dolby Atmos Conversion Tool.
b. Perform one of these steps:
• Right-click on the Dolby Atmos Conversion Tool application file (or
cmdline_atmos_conversion_tool Unix executable file) folder and choose Move to Trash.
• Drag the file to the trash.
Procedure
1. Start the installer by double-clicking the Dolby Atmos Conversion Tool installer package
DolbyAtmosConversionTool_X.X.X_xxxxxxx_Win64.msi (where xxxxxxx is the build
number).
Note: If prompted to uninstall an earlier version, close the message window, uninstall the older
version, and then start the installer again.
Results
Each supported Dolby Atmos Conversion Tool package component is installed on your computer at the
locations listed here:
• Dolby Atmos Conversion Tool: C:\Program Files\Dolby\Dolby Atmos Conversion Tool
Procedure
1. Navigate to Control Panel > Programs > Programs and Features.
2. Highlight Dolby Atmos Conversion Tool.
3. Click the Uninstall button.
4. Follow the on-screen instructions.
Procedure
1. Locate the Dolby Atmos Conversion Tool application name or icon:
•
Mac: The Dolby Atmos Conversion Tool application is in the Applications/Dolby/Dolby
Atmos Conversion Tool folder.
• Windows: The Dolby Atmos Conversion Tool application is in the C:\Program Files\Dolby
\Dolby Atmos Conversion Tool folder.
2. Double-click the Dolby Atmos Conversion Tool application name or click the icon in the dock (Mac only).
Results
The Dolby Atmos Conversion Tool home window displays.
Procedure
• On Mac, perform one of these steps:
• Choose Dolby Atmos Conversion Tool > Quit.
• Click the quit application circle in the application window.
• Press Command + Q.
• On Windows, perform one of these steps:
• Choose Dolby Atmos Conversion Tool > Quit.
• Click the quit application circle in the application window.
• Press Control + Q.
Procedure
Perform one of these steps:
• On systems with the Dolby Atmos Conversion Tool, access an atmos_conversion_tool.log file that
is automatically archived to your drive:
Note: Each log file name includes the date the file was created (for example,
atmos_conversion_tool.2018-11-05.log).
• On Mac:
a. Press Command + Shift + G.
b. In the Go to the folder: field, enter the path ~/Library/Logs/Dolby/Atmos Conversion
Tool, and then click Go.
c. Double-click the Atmos Conversion Tool folder.
• Home window UI
• Conversion window UI
• Composition window UI
• Progress windows
Output section
In the default Conversion window, the controls and displays in this section are grayed out and unavailable.
The controls and displays become available when a master is imported.
Figure 6: Source master file section for master files other than .rpl
The frame rate is included in the window. Valid frame rate values are all frame rates supported by the
source master. If the input .atmos (or .damf), .wav (ADM BWF), .mxf (IMF IAB), or Cinema MXF file has
a supported fps value, it will be automatically loaded. If the .damf does not have a specified frame rate,
the field defaults to 23.976 fps.
• .rpl
After importing an .rpl into the Conversion window, the source drop-down menu displays under the
file name. By default, this menu sets the source frame rate. Changing this value also changes these
timecode values in the Output section: target frame rate, and output start, end, and duration.
The right side provides detailed information about the source master:
• Bed configuration: For each bed that was defined when the master was originally created or joined
together, this assigns a number to the bed in sequential order and provides the bed number and
respective width.
• Created with: This provides the name and version of the application that was used to create the master
(such as Dolby Atmos Renderer, Dolby Atmos Conversion Tool, or a third-party application).
Output section
This section provides settings for the conversion target master, dependent on the source master and selected
target format.
Figure 10: Default Composition window, with MASTER FILES list hidden
Output section
In the default Composition window, the controls and displays in this section are grayed out and unavailable.
The controls and displays become available when a clip is imported into the timeline.
Figure 11: Composition window example, with multiple master files in the MASTER FILES list and timeline
Figure 12: Composition window, with MASTER FILES list revealed and no master files
The MASTER FILES list provides these items to manage master files for a composition:
MASTER FILES list counter
This blue circle with white text provides the number of master files that have been imported into the list.
In the default window, the count is 0.
Reveal button
This button reveals and hides the list. In the default window, the list is empty.
List
This is the area in the MASTER FILES section that has a dotted outline. You can import a master file into
the list by dragging the file into this area or by using the File menu. Alternatively, you can import a
Dolby Atmos master file into the timeline, which also adds it to the MASTER FILES list.
For a new composition, the list is empty.
After a file is imported, it displays in the list with the file name, format, frame rate, sample rate, and
FFOA. Each file in the list is available for adding to the composition timeline as a clip.
Figure 14: Example of the MASTER FILES list with multiple masters imported
You can click (select) a file in the list to see detailed information about the file, or to remove the file from
the list. When you click on a master file in the list, the file displays with an outline to show that is has
been selected.
• If the advanced metadata section is open, it displays detailed information about the selected master.
• When a file is selected, you can right-click on the file, and select Remove master file to remove the
master from the list. Alternatively, you can choose Edit > Remove Master File.
3.3.4 Timeline
The timeline provides the area where you import one or more masters as clips for performing composition
tasks.
• Selected clip: When you click on a clip, it updates with a blue outline.
You can then use menu commands or right-click commands to perform composition tasks (such as Trim,
Split, or Remove timeline). If you have edited the clip, you can also use the Reset to original right-click
command to return the clip to its original state.
The outline also includes handles for trimming the clip.
Figure 19: Clip with extended silence to the next frame boundary
• Start, end, and duration of a clip (the master associated with the clip), relative to the start of the clip: This
metadata displays when you hover over the clip in the timeline (or click on the clip in the Composition
section).
Figure 20: Timecode locations, relative to a clip (shown in the timeline) and composition (shown in the
Composition section)
Concurrently, the Output section includes the timecode location relative to the composition in the
Composition section. The two timecodes and respective timecode lines, along with a cursor, display
when you hover over the timeline. You can move the cursor to the left or right to display other timecode
locations.
Note: The timecode in the timeline is in the source frame rate; the timecode in the Output section
is in the target frame rate.
Silence clip
A silence clip displays in green. When you hover over a silence clip, it displays the timecode location of
the silence, relative to the silence clip (shown in the timeline) and composition (shown in the
Composition section).
You can right-click on a silence clip to edit the length or remove the silence from the timeline.
When a silence clip is selected and the advanced metadata section is shown, the advanced metadata
section shows the length of the clip.
View controls
Zoom slider
Use this slider to change how clips display in the timeline.
• To zoom in on the clips in the timeline, click on the zoom slidebar and drag it to the right (toward the
+ symbol).
• To zoom out on the clips in the timeline, click on the zoom slidebar and drag it to left (toward the -
symbol).
• To zoom so that all the clips fit in the visible timeline, click on the zoom slidebar and drag it all the
way to the left.
Clips scroll bar
Use this scroll bar to scroll left or right through the clips in the timeline. This scroll bar displays when you
have one or more clips that do not fit in the timeline viewable area (for example, after zooming in on a
clip, or after importing multiple masters as clips).
Alternatively, you can click anywhere in the timeline above or below the clips, and scroll to the left or
right.
Click on the advanced metadata icon to show (or hide) the advanced metadata section, or click the X icon to
close the section. When the metadata section is open, the icon is blue.
When no master or clip is selected, the section contains no metadata, and provides a tip to select a clip or
master to see its details. When a clip or master is selected, the section displays the relevant metadata.
Figure 21: Advanced metadata section, with a master selected in the MASTER FILES list
Figure 22: Advanced metadata section, with a clip selected in the composition timeline
All timecode values in the Composition section are in the source frame rate, in fps.
Composition bar and clips
The Composition bar lets you view the entire composition regardless of the zoom level in the timeline.
The bar provides a representation of each clip.
Click a clip in the bar to select the clip and bring the clip into view in the timeline. If the advanced
metadata section is open, it will display metadata for the clip and the associated master.
Additionally, you can click (or hover over) a clip to display the clip start, end, and duration timecode,
relative to the composition.
Start field
This field displays the start time that will be used for the composition when it is converted into a new
master. The start time is in timecode, in the source frame rate. You can keep the value as is, or update it.
By default, the value is at zero.
When this value is changed, the Duration and End displays in the Composition section update
accordingly. Additionally, related displays in the Output sections update.
If the start value results in an invalid FFOA (as entered in the Add FFOA field), the FFOA in the Output
reads FFOA invalid, the start, end, and duration times in the Output section are not calculated, and the
composition cannot be converted. If the start value results in an invalid start, end, or duration value (for
example, when crossing the midnight boundary), these values display in the Output section in red.
Note: The start, end, FFOA, and duration may be different than what is shown in the
Composition section if you are converting to a different frame rate.
End
This display shows the end of the target master, in timecode, in the source frame rate, and is based on
the source start time.
Duration
This display shows the duration of the target master in timecode, in the source frame rate, and is based
on the source start time.
typically have default values, unless they have been manually edited within the .dbmd file within
an .atmos or .rpl package.
Program-level metadata specified by the primary master is applied for all supported target master
formats: .atmos, .mxf (IMF IAB), .rpl, and .wav (ADM BWF).
Frame rate
Valid values for this menu are all frame rates supported by the target master, in fps.
Sample rate
This menu sets the target sample rate. Valid values for this drop-down menu are 48 kHz and 96 kHz,
dependent on the target master.
• By default, the sample rate of the source master is used.
• These 96 kHz conversions are supported:
• 96 kHz ADM BWF .wav to 48 kHz ADM BWF .wav, IMF IAB .mxf, or .atmos master
• 96 kHz ADM BWF .wav to 96 kHz ADM BWF .wav (for example, for a frame rate conversion)
• 96 kHz .atmos to 96 kHz ADM BWF .wav
Primary language
When converting to .mxf (IMF IAB), use this drop-down menu and field to choose a primary language.
The Conversion Tool supports setting the primary language to a common language. For a full list, see
Primary languages supported by the Conversion Tool .
There are two ways to change the language:
• Click on the Primary language drop-down menu, scroll to the desired language, and click (highlight)
a language.
• Click in the Primary language field, highlight the existing text (if any), type the first letters of the
desired language, scroll to the language, and then click (highlight) the language:
• The field is not character sensitive.
• You can enter uppercase or lowercase characters to discover a language. Pressing Escape returns
the last selected language.
Note: The tool remembers the last primary language that was selected. For example, when you
change the output format from .mxf (IMF IAB) to another output format, or close the tool, the
primary language that was selected last will be displayed in the Output section, in the Primary
language field.
Output displays
This section provides the start, end, FFOA, and duration of the converted target master, in timecode, in the
target frame rate.
Note: The start, end, FFOA, and duration of the converted files may be different than what is shown in
the Composition section if you are converting to a different frame rate. You can import your
converted file after the conversion to verify these values in the advanced metadata window in the
Composition window, or information section of the Conversion window.
Start
This display shows the start of the target master, as set in the Composition section, and based on the
target frame rate.
End
This display shows the end of the target master, relative to the start time set in the Composition section,
and based on the target frame rate.
FFOA
This display shows the first frame of action value or status, in the target frame rate.
It is based on the Add FFOA switch and setting in the Composition section. If the Add FFOA switch is off,
the status displays Not included, grayed out. If the switch is on, and the set value is invalid, this display
reads Invalid FFOA, in red.
Duration
This display shows the duration of the target master, relative to the start time set in the Composition
section, and based on the target frame rate.
Convert button
Press this button to begin the conversion process.
Progress bar for importing a master file into the master files list
File being loaded message and progress bar
The file name being loaded and display bar, located at the top of the MASTER FILES list, show the
progress of the import.
X button
Click this button to stop the import.
Cancel button
Click this button to stop the conversion.
File exported successfully message and button
When the conversion completes, the File exported successfully message displays. The available button
and result of pressing the button is dependent on the current workflow window:
• If performing a conversion in the Conversion window, click OK. This returns you to the Conversion
window and the most recent master and conversion settings.
• If performing a conversion in the Composition window, click Return to timeline. This returns you to
the Composition window, and the most recent clip and composition settings (as well as the most
recent MASTER FILES list).
New conversion
The New Conversion menu command opens the default Conversion window, where you can import a
master for converting. Optionally, you can click the New Conversion button in the home window.
Keyboard shortcut: Command + N (Mac) or Control + N (Windows).
New composition
The New Composition menu command opens the default Composition window, where you can import one
or more masters for editing or joining, or one master for converting. Optionally, you can click the New
Composition button in the main window.
Keyboard shortcut: Command + Shift + N (Mac) or Control + Shift + N (Windows).
Note: To import an .xml (pmstitch) file into a composition, you must use the File > Open .xml
(pmstitch) command.
Copy
Use this command to copy the FFOA of a master so that you can use the value with another conversion or
for your records.
To copy the FFOA from a master, the master must be loaded in the tool and have a defined FFOA, the Add
FFOA switch is enabled, and you have highlighted the value.
Alternatively, press Command + C (Mac) or Control + C (Windows).
Paste
Use this command to paste a new FFOA value into a master before running a conversion.
To paste the FFOA into a master, the master must be loaded in the tool, the Add FFOA switch is enabled,
and you have highlighted the existing value. Additionally, the FFOA must be the same as or later than the
offset in the file, and before the last frame of the file.
Alternatively, press Command + V (Mac) or Control + V (Windows).
Copy
Use this command to copy the FFOA or start time of a composition so that you can use the value with
another entry or for your records.
To copy the FFOA or start time, there must be at least one master clip in the timeline and you have
highlighted the timecode value you want to copy. Additionally, for the FFOA, the primary master in the
timeline must have a defined FFOA, and the Add FFOA switch is enabled.
Alternatively, press Command + C (Mac) or Control + C (Windows).
Paste
Use this command to paste a new FFOA or start value into a composition before running a composition
conversion.
To paste the FFOA or start time into a composition, there must be at least one master clip in the timeline,
and you must have highlighted the target timecode. Additionally, for an FFOA, the Add FFOA switch is
enabled, and the FFOA must be the same as or later than the offset in the composition.
The FFOA must be the same as or later than the offset in the .atmos or .wav file, and before the last
frame of the file.
Alternatively, press Command + V (Mac) or Control + V (Windows).
Remove, remove master file, or remove from timeline
Use this command to remove the currently selected master in the MASTER FILES list or clip in the
timeline, respectively. When no master or clip is selected, this command is grayed out and displays as
Remove.
When attempting to remove a master from the list that has any associated clips in the timeline, you will
be prompted with a message that removing the master will also remove the clips. Click Remove master
to remove the master, or click Cancel to return to the composition with no changes.
Alternatively, press Delete (Mac US QWERTY) or Backspace (Mac International QWERTY, or Windows).
Trim
Use this command to trim the start and end of a selected clip in the timeline. The command opens the
Trim window, where you can set the start and end times.
Alternatively, press Command + T (Mac) or Control + T (Windows).
The Trim command is available when a clip is selected.
Split
Use this command to split a selected clip into two clips. The command opens the Split window, where
you can set the location of the split.
Alternatively, press Command + E (Mac) or Control + E (Windows).
The Split command is available when a clip is selected.
Add Silence
This menu provides access to the commands for inserting silence before or after a selected clip in the
timeline:
• Before Selected Clip: This command opens the Insert silence window, where you can set the
amount of silence to add before the selected clip.
• After Selected Clip: This command opens the Insert silence window, where you can set the amount
of silence to add after the selected clip.
The Add Silence command is available when a clip is selected.
Add Master File to Timeline
Use this command to add a master selected in the MASTER FILES list to the timeline as a clip, so that
you can work on it. If the timeline has one or more clips in it, this operation places the master after the
last master in the timeline.
Alternatively, press Command + J (Mac) or Control + J (Windows).
Clear Timeline
Use this command to clear all of the clips in the composition timeline. This command opens the Clear
Timeline window, where you can choose to proceed with the operation, or cancel it.
Remove master file (when a master is Delete (US QWERTY), Backspace Delete
selected in the MASTER FILES list) (International QWERTY)
Remove from timeline (when a clip is Delete (US QWERTY), Backspace Delete
selected in the timeline) (International QWERTY)
New conversion
Create a new conversion to convert the format, frame rate, sample rate, FFOA, or primary language (IMF IAB
only) of a master.
You perform conversion work in the Conversion window.
You can perform changes to the format, frame rate, sample rate, FFOA, or primary language (IMF IAB only)
simultaneously or separately.
The length of a master file opened in the Conversion window is not altered if the master file starts and ends
on non-frame boundaries.
New composition
Create a new composition to edit one or more masters (for example, to trim a master or insert silence), join
multiple masters (with or without making edits), or convert the format, frame rate, sample rate, FFOA, or
primary language (IMF IAB only) of a master.
You perform composition work in the Composition window.
Figure 32: Example of a composition, with multiple master files in the master files list and composition
timeline
You can perform changes to the format, start time, frame rate, sample rate, FFOA, or primary language (IMF
IAB only) simultaneously or separately.
When a file that starts or ends on subframe boundaries is imported into the Composition window, it is
extended with silence to the next frame boundary in either direction, so that no underlying content is
trimmed. The clip displays a horizontal green line to denote the extension.
Figure 33: Clip with extended silence to the next frame boundary
.mxf (IMF IAB) Yes [c] Yes Yes [c] Yes [c]
[a] .atmos, .damf, and .rpl file formats can include a .dbmd metadata file when converting to .atmos, .mxf (IMF IAB), .wav
(ADM BWF). However, the output file does not include a .dbmd file.
[b] An .atmos file created with Renderer v3.2.x, 3.3.x, or 3.4.x automatically includes a .dbmd file.
[c] Because IMF IAB positional metadata is quantized to eight events per frame, an IMF IAB .mxf is considered a mezzanine rather than a
master. Converting from IMF IAB to another format will keep metadata events quantized. Therefore, it may be desirable to convert from
the original master file rather than from the IMF IAB mezzanine.
[d] .xml (pmstitch) files can include .atmos, .mxf, .rpl, and .wav (ADM BWF) files. Imports are supported with new
compositions and command-line options.
The Conversion Tool is not intended for use with Dolby Atmos VR masters. The tool does not support VR
metadata.
Related information
Converting the format and other metadata of a master file (Conversion window) on page 59
Performing tool operations with an .xml (pmstitch) file on page 89
Performing tool operations with command-line options on page 95
When an entry matches any of the listed group labels, the corresponding IAB AudioDescriptionText will be
written. When there is no match, the custom string will persist. This mapping is performed automatically.
.atmos v0.3
or .damf
.atmos v0.3
or .damf
Note: The .mxf and .rpl formats do not support sample rates of 96 kHz, and therefore do not
support sample rate conversion.
Table 12: Source frame rates for Dolby Atmos master file formats
Dolby Atmos master file Versions [a] Frame rate, as specified in Source frame rate [b]
format the source file program-
level metadata
.wav (ADM BWF) All 23.976, 24, 25, 29.97, 29.97 As specified
DF, or 30 fps
[a] The versions column refers to the release number of the specification for the format. To see the version for a home theater master,
open the .atmos or .damf file of the master with a plain text editor, and look at the first line of code.
[b] This is the frame rate interpreted by the tool. It is shown below the file name (in the Conversion window) and in the advanced
metadata section (in the Composition window). While the target frame rate defaults to the source in Conversion mode, it can be
changed.
[c] Higher cinema frame rates (such as 48, 50, 60, 96, 100, and 120 fps) are not supported.
.atmos (or .damf) 23.976, 24, 25, 29.97, 29.97 drop frame (DF), or 30 fps
.wav (ADM BWF) 23.976, 24, 25, 29.97, 29.97 DF, or 30 fps
Note: The .rpl format supports 24, 25, and 30 fps only as a source or target frame rate.
Table 14: Frame rate conversion ratios (playback speed for source and target files)
Source frame 23.976 fps 24 fps target 25 fps target 29.97 fps target 29.97 DF target 30 fps target
rate (fps) target
FFOA time after frame rate (fps) modification. A wrong FFOA can lead to the desired start of program
occurring at the wrong timecode value on the timeline.
You typically set the FFOA in .atmos master file sets created with the Home Theater Renderer software
during master recording. Version 0.4 and 0.5 .atmos files can carry the FFOA, but it is optional. Version
0.3 .atmos files did not carry the FFOA. You can open the file in the Dolby Atmos Renderer to see the FFOA
value (if present).
Note:
The IMF IAB file format does not support FFOA. Instead, all files start at 00:00:00:00.
Note: The Cinema MXF .mxf file format has an offset of 00:00:00:00. It does support FFOA.
If the FFOA is not present in a file format that supports FFOA, be sure to check any mastering notes and enter
a value in the Dolby Atmos Conversion Tool accurately before starting conversion to another Dolby Atmos
master file type, or before frame rate (fps) or FFOA conversion operations. If it was included, but is wrong,
you can override the value in the field provided in the tool. As noted, the FFOA can be used in Dolby bitstream
encoders to set the start point of the encode, trimming off the beginning audio samples. If the master file was
created with no leading silent portion, and encoding should start from the very first audio samples of the
master file, the FFOA must correspond to the starting offset time of the source master file.
Note: The frame rate and sample rate are taken from the source master.
Procedure
1. On Mac, perform these steps:
a. Open the Finder
b. Choose Go > Go to Folder.
c. Enter the path:
~/Library/Preferences
d. Click Go.
e. Command-click on the two preference files:
com.dolby.AtmosConversionTool.ini
com.dolby.AtmosConversionTool.plist
f. Perform one of these steps:
• Right-click on the preference files, and choose Move to Trash.
• Drag the preference files to the trash.
2. On Windows, perform these steps:
a. Navigate to the C:\ProgramData\Dolby\Atmos Conversion Tool\ folder.
b. Delete this file:
AtmosConversionTool.ini
Procedure
1. Launch the Dolby Atmos Conversion Tool.
2. Start a new conversion by performing one of these steps:
• Click New Conversion in the home window.
• Choose File > New Conversion.
Alternatively, you can press Command + N (Mac) or Control + N (Windows).
The Conversion window displays.
What to do next
Import a master file.
Note: You can return to the home window at any time by choosing File > Close. Alternatively, you can
press Command + W (Mac) or Control + W (Windows).
Prerequisites
Create a new conversion in the Conversion Tool.
Procedure
Add a master to the Conversion window by performing one of these steps:
• Drop a master file into the Conversion window.
• Click in the Conversion window, and then use your browser to locate and choose a master file.
What to do next
You are now ready to perform a conversion.
Prerequisites
• Create a new conversion, and then import a master file.
Procedure
1. In the Output section, click the File format drop-down menu, and select the master file format that you
want to convert to.
• If you want to set the FFOA for master formats that support changing the FFOA, enable the Add FFOA
switch, and then set the FFOA.
The FFOA must be the same as or later than the offset in the .atmos or .wav file, and before the last
frame of the file.
Note: Offset is the timecode value of the start of the master.
The FFOA is the reference point for the start of picture that the audio needs to sync with, and is
typically the starting point when encoding the audio. The FFOA is used as a reference point during
frame rate conversion, so the audio will start at the same frame before and after conversion.
3. (Optional) If you want to apply frame rate conversion, perform these steps:
a. Click the Frame rate drop-down menu, and select a target frame rate.
b. Select whether you want to maintain the pitch and length of the source master.
• Set Maintain pitch and length to Yes to maintain the pitch and length of the source master.
Set Maintain pitch and length to No to scale the playback speed by a specific ratio (see Frame
•
rate conversion ratios ). The audio duration and pitch will also change by the same ratio as the
different source and target frame rates.
4. (Optional) If you want to convert the sample rate, click the Sample rate drop-down menu, and select a
target sample rate.
5. (Optional) If converting to .mxf (IMF IAB), set the primary language by performing one of these steps:
• Click the Primary language drop-down menu, scroll to the desired language, and then click
(highlight) a language.
Figure 36: Selecting the target primary language (IMF IAB only)
• Click in the Primary language field, highlight the existing text (if any), type the first letters of the
desired language, scroll to the language, and then click (highlight) the language:
•Pressing Escape returns the last selected language.
•The field is not character sensitive. You can enter uppercase or lowercase characters to discover a
language.
6. Click the Convert button.
7. Select a file name and destination for the target file, and then click Save to begin the conversion process.
When the target format is .atmos, .wav (ADM BWF), or .mxf (IMF IAB), the output file name for a
conversion uses the source file name by default (Mac only).
The file name for an .rpl master must be dub_out.rpl.
8. When the conversion completes and the File exported successfully message appears, click OK.
This returns you to the Conversion window and the most recent master and conversion settings.
9. (Recommended) Perform a quality control (QC) listening pass on the result.
Use the Dolby Atmos Renderer, or another application that supports playback of a Dolby Atmos master
file.
10. Redo the conversion with new settings, as needed, and then choose File > Close to return to the
Conversion Tool home window.
Procedure
1. Launch the Dolby Atmos Conversion Tool.
2. Start a new composition by performing one of these steps:
• Click New Composition in the home window.
• Choose File > New Composition.
Alternatively, you can press Command + Shift + N (Mac) or Control + Shift + N (Windows).
The Composition window displays.
What to do next
Import one or more master files.
Note: You can return to the home window at any time by choosing File > Close. Alternatively, you
can press Command + W (Mac) or Control + W (Windows).
Prerequisites
Create a new composition in the Conversion Tool.
Procedure
1. If the timeline is empty, perform one of these steps:
• Select one or more masters (for example, on a hard drive), and then drag and drop them into the
timeline.
• Click in the empty timeline, browse to the location of your masters (for example, on a hard drive),
select one or more of them, and complete the import.
2. If the timeline already has one or more clips, select one or more master files (for example, on a hard
drive), and drag and drop them to the timeline.
You can drag and drop masters before, after, or in between clips in the timeline.
Results
A loading message and progress bar display in the middle of the window, to show the progress of the import.
What to do next
You are now ready to work with the clips in the timeline.
Prerequisites
Create a new composition in the Conversion Tool.
Procedure
• Reveal the MASTER FILES list, select one or more masters (for example, on a hard drive), and drag and
drop them into the list.
Figure 38: Example of dropping four master files into the master files list
• Choose File > Import Master File, navigate to your masters, select one or more of the masters, and
complete the import.
Alternatively, you can press Command + I (Mac) or Control + I (Windows).
Results
A loading message and progress bar display at the top of the MASTER FILES list to show the progress of the
import.
What to do next
You can add a master from the list to the composition timeline as an editable clip.
Prerequisites
• Create a new composition in the Conversion Tool.
• Verify that each Dolby Atmos master file associated with the .xml (pmstitch) file is at the path
specified in the .xml file.
Procedure
• Choose File > Open .xml (pmstitch), navigate to the file, select it, and complete the import.
Alternatively, you can press Command + O (Mac) or Control + O (Windows).
Results
A loading message and progress bar display in the middle of the window, to show the progress of the import.
What to do next
You are now ready to work with the clip in the timeline.
7.2.4 Adding a master from the master files list to the timeline
You can add a master from the MASTER FILES list to the timeline as a clip, so that you can work on it. When
there are existing clips in the timeline, you can choose to drop the master before or after any of the clips in
the timeline.
Prerequisites
Create a new composition in the Conversion Tool.
Procedure
1. Click (highlight) a master in the MASTER FILES list.
What to do next
You are now ready to work with the clips in the timeline.
Prerequisites
There are one or more masters in the MASTER FILES list.
Procedure
1. In the MASTER FILES list, click (highlight) the master that you want to remove.
2. Perform one of these steps:
• Click Delete (Mac US QWERTY) or Backspace (Mac International QWERTY, or Windows).
• Right-click on the master, and select Remove master file.
Prerequisites
There are one or more clips in the composition timeline.
Procedure
1. In the composition timeline, click (highlight) the clip that you want to remove.
2. Perform one of these steps:
• Click Delete (Mac US QWERTY) or Backspace (Mac International QWERTY, or Windows).
• Right-click on the clip, and select Remove from timeline.
Prerequisites
There are one or more clips in the composition timeline.
Procedure
1. Choose Timeline > Clear Timeline.
2. In the Clear timeline dialog, click Clear timeline.
Procedure
• To view the start, end, and duration of a clip, relative to the start of the master file associated with the
clip, perform one of these tasks:
• Hover over the clip in the timeline.
• To view the start, end, and duration of a clip, relative to the composition start time, perform one of the
tasks:
• Hover over the composition bar for the clip in the Composition section.
• Click on the composition bar for the clip in the Composition section.
• To display advanced metadata of a master or clip, or the length of a silence clip, perform these steps:
1. Choose View > Show Advanced Metadata, or click the advanced metadata icon
.
Note: The advanced metadata icon is located at the top-right corner of the Composition
window.
Alternatively, you can press Command + Shift + P (Mac) or Control + Shift + P (Windows).
2. Perform the task for the desired advanced metadata:
• To display the advanced metadata of a master, click the master in the MASTER FILES list.
• To display advanced metadata of a clip, click the clip in the timeline, or click on the bar for the clip
in the Composition section.
• To display the length of a silence clip, click the silence clip in the timeline.
• To scroll through the clips in the timeline, click on the scroll bar (located at the bottom of the timeline), or
anywhere in the timeline above or below the clips, and scroll to the left or right.
• To zoom in, zoom out, or zoom to fit, perform the respective steps using the menu zoom slidebar, menu
command, or keyboard shortcut:
Note: On Mac, you can also use standard macOS trackpad and mouse shortcuts for zooming.
• To zoom in on the clips in the timeline, click on the zoom slide bar and drag it to the right (toward the
plus symbol), or choose View > Zoom In.
Alternatively, you can press Command + the plus symbol (Mac) or Control + the plus symbol
(Windows).
• To zoom out on the clips in the timeline, click on the zoom slide bar and drag it to left (toward the
minus symbol), or choose View > Zoom Out.
Alternatively, you can press Command + the minus symbol (Mac) or Control + the minus symbol
(Windows).
• To zoom so that all the clips display in the visible timeline, click on the zoom slide bar and drag it all
the way to the left, or choose View > Zoom to Fit.
Alternatively, you can press Command + 0 (Mac) or Control + 0 (Windows).
Procedure
• Use the up and down arrow keys to change a value, or type in a valid value.
• Use the left and right arrow keys to toggle through the timecode unit (such as hours, seconds, minutes,
samples), or click on a different time.
• Copy and paste timecode values.
Prerequisites
Ensure that one or most masters have been added as clips to the timeline.
Procedure
1. If desired, insert silence before (or after) a clip:
a. In the timeline, perform one of these steps.
• Hover over the empty silence bar located to the left (or right) of the clip, so that it changes to green
with a + sign in the middle of it, and then click on it.
•
Click (highlight) the clip, and then choose Timeline > Add Silence > Before Selected Clip (or After
Selected Clip).
b. In the Insert silence window, in the Length field, add the amount of desired silence.
c. Click the Insert button.
2. If changing the length of a silence clip, perform these steps:
a. Right-click on the silence clip, which is displayed in green, and then choose Edit length.
b. In the Change length window, in the Length field, add the amount of desired silence.
Results
The silence is inserted.
What to do next
Perform other composition edits, as needed, until you are ready to convert the composition.
Prerequisites
In a composition, ensure that the clip is in the timeline.
Procedure
1. If you want to trim the start and end of the clip, perform these steps:
a. Click (highlight) the clip in the timeline to select it.
b. Perform one of these steps:
• Right-click on the clip, and choose Trim.
• Choose Timeline > Trim.
c. In the Trim window, set the From and To values to the new start and end times, respectively.
cursor displays, and then click and drag the cursor to the right, or click on it.
c. In the Trim window, set the Start of the clip.
cursor displays, and then click and drag the cursor to the left, or click on it.
c. In the Trim window, set the End of the clip.
Results
The clip is trimmed.
What to do next
Perform other composition edits, as needed, until you are ready to convert the composition.
Prerequisites
In a composition, ensure that the clip is in the timeline.
Procedure
1. If using the cursor (to split at a specific location), perform these steps:
a. In the timeline, move the cursor over the clip until you see the time where you want to perform the
split.
This is the location relative to the start of the clip. Alternatively, you can view the cursor in the
Composition (in source fps) section relative to the start time, and then move the mouse vertically
upward until the cursor is in the clip.
b. Right-click at the location, and choose Split.
c. In the Split window, verify the Location, and then click Split.
Results
The clip is split.
What to do next
Perform other composition edits, as needed, until you are ready to convert the composition.
Procedure
1. Start a new composition.
2. In the Composition window, import masters to the composition timeline as clips, or add masters from
the MASTER FILES list to the timeline as clips.
3. Order the clips as desired.
You can click on a master in the MASTER FILES list and drag and drop it into the timeline as a clip, before
or after other clips.
You can click on a clip in the timeline and drag it to a new location (for example, before or after other
clips).
4. Choose which master associated with a clip should be considered the primary master for the converted
master.
The primary master defines the metadata values to be used.
• If you want to set the FFOA for master formats that support changing the FFOA, enable the Add FFOA
switch, and then set the FFOA.
The FFOA must be the same as or later than the offset in the .atmos or .wav file, and before the last
frame of the file.
Note: Offset is the timecode value of the start of the master.
The FFOA is the reference point for the start of picture that the audio needs to sync with, and is
typically the starting point when encoding the audio. The FFOA is used as a reference point during
frame rate conversion, so the audio will start at the same frame before and after conversion.
What to do next
Perform other composition edits, as needed, until you are ready to convert the composition into a single
master.
Prerequisites
• Create a new conversion or new composition, and then import a master file.
• If converting with a composition, make sure that the master has been imported to the timeline (as a clip)
in the Composition window.
• If an invalid .xml (pmstitch) or other Dolby Atmos master file is imported, an error message is
displayed. The error message indicates if the issue is with the .xml syntax or file path.
• The error message will indicate if the issue is with the .xml syntax or file path(s).
Procedure
1. In the Output section, click the File format drop-down menu, and select the master file format that you
want to convert to.
2. (Optional) If you want to apply frame rate conversion, perform these steps:
a. Click the Frame rate drop-down menu, and select a target frame rate.
b. Select whether you want to maintain the pitch and length of the source master.
• Set Maintain pitch and length to Yes to maintain the pitch and length of the source master.
Set Maintain pitch and length to No to scale the playback speed by a specific ratio (see Frame
•
rate conversion ratios ). The audio duration and pitch will also change by the same ratio as the
different source and target frame rates.
3. (Optional) If you want to convert the sample rate, click the Sample rate drop-down menu, and select a
target sample rate.
4. (Optional) Set the FFOA by performing one of these steps:
• If you want to not include the FFOA for master formats that support changing the FFOA, disable the
Add FFOA switch.
• If you want to set the FFOA for master formats that support changing the FFOA, enable the Add FFOA
switch, and then set the FFOA.
The FFOA must be the same as or later than the offset in the .atmos or .wav file, and before the last
frame of the file.
Note: Offset is the timecode value of the start of the master.
The FFOA is the reference point for the start of picture that the audio needs to sync with, and is
typically the starting point when encoding the audio. The FFOA is used as a reference point during
frame rate conversion, so the audio will start at the same frame before and after conversion.
5. (Optional) If converting to .mxf (IMF IAB), set the primary language by performing one of these steps.
Figure 48: Selecting the target primary language (IMF IAB only)
• Click the Primary language drop-down menu, scroll to the desired language, and then click
(highlight) a language.
• Click in the Primary language field, highlight the existing text (if any), type the first letters of the
desired language, scroll to the language, and then click (highlight) the language:
•
Pressing Escape returns the last selected language.
•
The field is not character sensitive. You can enter uppercase or lowercase characters to discover a
language.
6. (Optional) If you want to set a new start time, change the value in the Start field.
The start value must not result in the composition duration crossing the midnight (24 hour) boundary.
Adjust the start time (or shorten the duration of the timeline), as needed.
What to do next
Perform other composition edits, as needed, until you are ready to convert the composition into a single
master.
Prerequisites
You have created a new composition, imported one or more masters into the timeline, and have performed
composition edits.
Procedure
1. Click the Convert button.
2. Select a file name and destination for the target file, and then click Save to begin the conversion process.
3. After the conversion completes and the File exported successfully message appears, click Return to
timeline.
This returns you to the Composition window, and the most recent clip and composition settings (as well
as the most recent MASTER FILES list).
What to do next
You can continue to work in the Composition window, close the window, and create a new composition or
conversion, or quit the tool.
Table 15: Languages and command-line codes for the primary language option
Language Command-line code
Acoli ach
Afrikaans af
Albanian sq
Arabic ar
Aramaic arc
Armenian hy
Azerbaijani az
Bambara bm
Bashkir ba
Belarusian be
Bengali bn
Bosnian bs
Bulgarian bg
Burmese my
Catalan ca
Chechen ce
Cheyenne chy
Croatian hr
Czech cs
Danish da
Dinka din
Dutch nl
Dzongkha dz
Efik efi
Elamite elx
English [a] en
Esperanto eo
Estonian et
Faroese fo
Farsi (Persian) fa
Filipino fil
Finnish fi
Flemish vls
French fr
French-Canadian fr-CA
Gaelic ga
Georgian ka
German de
Greek el
Gujarati gu
Hawaiian haw
Hebrew he
Hindi hi
Hungarian hu
Icelandic is
Indonesian id
Inuktitut iu
Italian it
Table 15: Languages and command-line codes for the primary language option (continued)
Language Command-line code
Japanese ja
Javanese jv
Kannada kn
Kazakh kk
Khmer (Cambodian) km
Kikuyu ki
Kinyarwanda rw
Kirghiz ky
Korean ko
Kurdish ku
Latin la
Latvian lv
Lingala ln
Lithuanian lt
Luxembourgish lb
Macedonian mk
Malagasy mg
Malay ms
Malayalam ml
Maltese mt
Marathi mr
Maya myn
Mende men
Mongolian mn
Nepali ne
Newari new
Norwegian no
Norwegian (Bokmål) nb
Norwegian (Nynorsk) nn
Polish pl
Portuguese pt
Punjabi pa
Romanian ro
Romansh rm
Romany rom
Russian ru
Sami smi
Scottish Gaelic gd
Sanskrit sa
Serbian sr
Sinhala si
Slovak sk
Slovenian sl
Somali so
Songhai son
Spanish es
Swahili sw
Swedish sv
Swiss-German gsw
Tagalog tl
Tamashek tmh
Tamil ta
Telugu te
Thai th
Tibetan bo
Tonga to
Turkish tr
Tuvan tyv
Ugaritic uga
Ukranian uk
Table 15: Languages and command-line codes for the primary language option (continued)
Language Command-line code
Urdu ur
Vietnamese vi
Welsh cy
Wolof wo
Xhosa xh
Yiddish yi
Zapotec zap
Zulu zu
[a] Default
When joining masters that have different encoding metadata (either within a .dbmd metadata file or the
master), you can specify which source master defines the metadata values to be used for the resulting master
by setting the master as the primary master.
In the application, click on the Primary drop-down menu and select which master is the primary one. When
using the command-line option, add primary="true" to the <source> element. For example:
<source primary="true">
<stitch>
Root element of the .xml (pmstitch) file. All .xml (pmstitch) files must start with <stitch> and
end with </stitch>.
<config>
Contains the frame rate element.
<framerate>
Defines the frame rate of the source included in the operation. Valid values are all frame rates supported
by the source master.
<sources>
Contains the elements and attributes for a list of source masters, including source and output settings.
<source>
Contains the elements and attributes for a source master, including source and output settings. When
joining masters, the primary <source> element contains the primary="true” attribute.
<sources primary="true”>
Specifies which source master defines the metadata values to be used for the resulting master when
joining masters that have different program-level metadata (such as .dbmd parameters).
<path>
Defines the absolute or relative path to the master file. The absolute path is the full location of the file
starting with /volumes (Mac) or with the drive letter:\\ (Windows). If no full path is given, the
Conversion Tool will interpret the path relative to the location of the .xml file and use the location of
the .xml (pmstitch) file as a starting point.
<sourceStart>
Defines the start time of the source master in relation to the value of the start offset of the source master.
For example, if the source master starts at 1:00:00:00, this value can be set to 1:00:08:00 to skip the first
eight seconds of the content or 00:59:58:00 to add two seconds of silence to the start.
This element is required, unless joining two adjacent masters with no trimming and no gap, in which
case the <sourceStart>, <outputStart>, and <outputEnd> should not be included for all masters.
Note: The timecode is interpreted in the context of the <framerate> value.
Note: With Dolby Atmos Conversion Tool v1.8, <start> and </start> were renamed to
<outputStart> and </outputStart>, respectively, to better describe their function.
Note: With Dolby Atmos Conversion Tool v1.8, <end> and </end> were renamed to <outputEnd>
and</outputEnd>, respectively, to better describe their function.
<count>
Defines the number of times the current print master is repeated in the target master. For example, if the
source master is one second of silence, to get five seconds of silence in the target master, the source print
master may be repeated five times by specifying a count of five.
10.3 .xml (pmstitch) file examples for Dolby Atmos Conversion Tool
operations
Dolby provides .xml (pmstitch) file examples for use when creating a new .xml configuration file for
padding a master, joining together masters, or trimming a master. The examples can also be used to
create .xml files for other tool operations (such as converting the master file format).
You can find examples and supporting media files online, at https://professionalsupport.dolby.com/s/article/
Where-can-I-find-more-examples-of-pmstitch-xml-files.
An .xml (pmstitch) file configured for a tool operation can be imported into the Dolby Atmos Conversion
Tool user interface composition (Mac and Windows), or can be used with the Conversion Tool command-line
application (Linux, Mac, and Windows).
Prerequisites
XML or plain text editor such as TextEdit (on Mac) or Microsoft Notepad (on Windows). If creating the file for
use in Linux (with the Dolby Atmos Conversion Tool command-line option), use a Linux text editor (such as
gedit).
Procedure
1. Create an .xml (pmstitch) file, or open one of the .xml (pmstitch) example files supplied by Dolby.
2. Include the lines shown in the example file, as needed.
<stitch>
<config>
<framerate>24</framerate>
</config>
<sources>
<source>
<!--original start 00:59:58:00
original end 01:20:00:00
original duration 00:20:02:00
operation:
trims 2 seconds from head (removes 2pop)-->
<path>/Volumes/Media/DACT_Sample_Media/Reel1_w2pop/Reel1_w2pop.atmos</
path>
<sourceStart>01:00:00:00</sourceStart>
<outputStart>01:00:00:00</outputStart>
<outputEnd>01:00:20:00</outputEnd>
</source>
</sources>
<!--Finished file duration is 00:20:00:00-->
</stitch>
Note: If joining masters, repeat the layout text between the <source> and </source> lines for each
additional source master (clip). Additionally, make sure that all clips to be joined were created
using the same frame rate to ensure proper audio/video (A/V) sync in the output master. If the
frame rates do not match, the conversion will result in an error message.
<stitch
<config>
<framerate>24</framerate>
</config>
<sources>
<!--This example illustrates joining together film reels-->
<source primary="true">
<path>/Volumes/Media/DACT_Sample_Media/Reel1/Reel1.atmos</path>
<sourceStart>01:00:00:00</sourceStart>
<outputStart>01:00:00:00</outputStart>
<outputEnd>01:20:00:00</outputEnd>
</source>
<source>
<path>/Volumes/Media/DACT_Sample_Media/Reel2/Reel2.atmos</path>
<sourceStart>02:00:00:00</sourceStart>
<outputStart>01:20:00:00</outputStart>
<outputEnd>01:40:00:00</outputEnd>
</source>
<source>
<path>/Volumes/Media/DACT_Sample_Media/Reel3/Reel3.atmos</path>
<sourceStart>03:00:00:00</sourceStart>
<outputStart>01:40:00:00</outputStart>
<outputEnd>02:00:00:00</outputEnd>
</source>
<source>
<path>/Volumes/Media/DACT_Sample_Media/Reel4/Reel4.atmos</path>
<sourceStart>04:00:00:00</sourceStart>
<outputStart>02:00:00:00</outputStart>
<outputEnd>02:20:00:00</outputEnd>
</source>
</sources>
</stitch>
3. In the <config> section, verify the frame rate matches the frame rate of the master (if available), or
change it if desired.
If working with an .atmos master, and you do not know the frame rate of the master, open the .atmos
file with a text editor, and look at the fps value.
4. In the <sources> section, update the <path> for the master folder and file, and then the <sourceStart>,
<outputStart>, and <outputEnd> parameters, based on whether you are trimming or padding the
master, joining masters, or doing another operation.
Note: If joining masters, edit the <sources> section parameters for each source master.
• <path>: Enter the location of the master folder and file (.atmos, .rpl, or .wav). Use the absolute
path to the file.
If you do not use the absolute path, ensure that the .xml (pmstitch) file is in the source directory of
the master that will be converted.
• <sourceStart>: This timecode represents the offset value into the source content. Use this timecode
to set the amount of trim or padding at the front of a single master, or any master when joining
multiple masters.
Source master offset is the value of the offset field in .atmos files, offset field in .rpl files, and
audioProgramme start value for .wav (ADM BWF) files.
• To trim the front of a master, set the <sourceStart> to a value larger than the source master offset
(but less than 24 hours, such as 23:59:59:23 for 24 fps and 23:59:59:29 for 30 fps).
• To add padding (silence) to the front of a master, set the <sourceStart> to a value less than the
source master offset (but not less than 0).
• To add no trimming or padding, set the <sourceStart> to the same value as the source master
offset.
Note: When joining masters, the <sourceStart> for each master should correspond to the first
videoFrame. The master will be trimmed by the difference between the source offset and the
FFOA.
• <outputStart> and <outputEnd>: These timecode values define the range of the output file. Use this
range to set the amount of trim or padding at the end of a master, or to define the start and end of
each master to be joined.
When joining adjacent masters, if the end of the first clip comes after the start of the next clip, the start
of the second clip is used to determine the length of the first clip.
•To trim the end of a single master, set the <outputStart> and <outputEnd> to define a range that is
less than the length of the file, based on the <sourceStart> timecode.
• To add padding to the end of a single master, set the <outputStart> and <outputEnd> to define a
range that is greater than the length of the file, based on the <sourceStart> timecode.
• To join two adjacent masters with a gap of silence, set the <outputEnd> of the first master to a
value less than the start of the next master by a value greater than one frame.
• To join two adjacent masters with a data overlap, set the <outputStart> of the second master to a
value less than the end of the first master. This trims the length of the first master by the amount of
the overlap.
• To join two adjacent masters with no trimming and no gap, do not include the <sourceStart>,
<outputStart>, and <outputEnd> for all masters.
5. (Optional) Add <count>.
The <count> field sets the number of times the source will be added to the target master (output file)
back-to-back. If you include this field, always set it to a value greater than 1. Setting the field to 1 has no
effect. When <count> is not included in the file, the parameter defaults to 1.
6. Save the file as an .xml (pmstitch) file.
--help -h Displays help (full list of Dolby Atmos Conversion Tool command-line
options).
--version -v Displays the application version, and exits the application.
--pm_in arg -i Specifies the path to the input Dolby Atmos master file.
--output_path arg -o Specifies the output path for the audio and metadata files. The
(=.) default is the current working directory.
--output_format arg -f Specifies the output file format: .atmos, .mxf, .rpl, or
(=atmos) Waveform Audio Format.
--source_fps arg Specifies the frame rate of the source master file, in frames per
second (fps). This option will set the frame rate of the source master
file that does not specify one. Valid values are dependent on the
frame rate supported by the source master. They can include 23.976,
24, 25, 29.97, 29.97df, and 30 fps.
--target_fps arg Specifies the frame rate of the target master file. Valid values are
dependent on the frame rate supported by the target master. They
can include 23.976, 24, 25, 29.97, 29.97df, and 30 fps. Numbers near
23.976 and 29.97 will be rounded to (24 × 1,000) ÷ 1001 and (30 ×
1000) ÷ 1001. If this value is equal to the frame rate in the source file,
frame rate conversion is bypassed and the tool does a format
conversion only.
--no_ffoa arg Specifies to not include FFOA when creating the new master.
--ffoa arg (=-1) Specifies FFOA. If none is specified, the source master FFOA will be
used.
-l [ --primary_ Specifies IMF IAB sound field primary spoken language as RFC 5646
lang ] arg code value. Applicable only for MXF output format. If none is specified
for an input MXF master, its primary language is passed through to
the output. If none is specified for all other master types, "en" will be
used. See Primary languages supported by the Dolby Atmos
Conversion Tool (IMF IAB only) .
--list_languages Displays full list of supported RFC 5646 primary spoken language
codes.
--quality arg (=0) Specifies the quality of sample rate conversion [0=best_quality -
4=linear] during frame rate/sample rate conversion.
--disable_ Disables multithreading and uses a single thread for the resampling
multithreading during frame rate/sample rate conversion.
--set_warp_mode arg Specifies the warp mode for the target master.
Valid options:
• downmix_loro, Standard (Lo/Ro)
• downmix_pliix, Dolby Pro Logix IIx
• warping, Direct render with room balance
• normal, Direct render
--trim_start arg Trims n seconds from the beginning of the input master. Applied
(=0) before prepending or appending silence.
--trim_duration arg Trims input master to n seconds after the defined start. Applied
(=0) before prepending or appending silence.
--append_silence arg Appends n seconds of audio silence to the end of the input master.
(=0)
Procedure
Perform the step for your operating system:
• Linux (desktop version): Open the terminal window by pressing Ctrl + Alt + T.
• Mac: Open the Terminal application (located in the /Applications/Utilities folder).
• Windows: Open the Command Prompt from the Run Window.
Procedure
Perform the step for your operating system:
• Linux: Type cd followed by the path where the cmdline_atmos_conversion_tool binary is
located. For example: cd /usr/bin/cmdline_atmos_conversion_tool.
• Mac: Type cd "/Applications/Dolby/Dolby Atmos Conversion Tool/".
• Windows: Type cd "Program Files\Dolby\Dolby Atmos Conversion Tool"
Procedure
1. Open the command-line program if working with Linux (desktop version), Mac, or Windows.
Skip this step if you are working with the server version of Linux.
2. On a command-line, navigate to the Dolby Atmos Conversion Tool command-line application
(cmdline_atmos_conversion_tool).
3. Enter the commands for creating a new master:
On a command line, type the commands to start the Dolby Atmos Conversion Tool command-line
executable (cmdline_atmos_conversion_tool), add --pm, and then specify the location name of
the source .xml file, followed by the --output path and the master file path. Provide additional
commands, as desired.
Example:
In this example, the source file path is defined in the .xml file, and the output path will be the current
working directory (which in this case, is the same folder as the .xml file). The master will be a home
theater .atmos master file set:
• Linux or Mac: ./cmdline_atmos_conversion_tool --pm_in example.xml --output_pathexample.
atmos
• Windows: cmdline_atmos_conversion_tool.exe --pm_in example.xml --
output_pathexample.atmos
Example:
In this example, the source file path is defined in the .xml file, and the output path will be the current
working directory (which in this case, is the same folder as the .xml file). The master will be a .wav
(ADM BWF) master, with a first frame of action at 3600 seconds (01:00:00:00):
•Linux or Mac: ./cmdline_atmos_conversion_tool --pm_in example.xml --
output_pathexample.wav --output_format wav --ffoa 3600
• Windows: cmdline_atmos_conversion_tool --pm_in example.xml --
output_pathexample.wav --output_format wav --ffoa 3600
4. Verify that the destination path directories you are using are not the directories where the source files are
located.
Caution: Double-check the destination path before pressing Enter in the next step. Using the
same path as your source files is destructive. (It will overwrite the existing files.)
Glossary
A/V
Audio/video.
ADM BWF
Audio Definition Model Broadcast Wave Format.
audio definition model
A metadata model specified in ITU-R BS.2076 that describes the content and format of audio files.
BWF
Broadcast Wave Format. An extension of the Microsoft Waveform Audio File Format (.wav) that includes
metadata important to broadcast applications. This format is specified in EBU Tech 3285.
CLI
Command-line interface.
container
A formatted file (such as an MP4 file) comprising one or more multiplexed elementary streams and
including format-specific metadata.
DAW
Digital audio workstation. An electronic device or computer software application used to record, edit,
and produce audio files.
DCP
Digital Cinema Package. A packing list (PKL) file and all of the files that it references.
Dolby RMU
Dolby Rendering and Mastering Unit.
FFOA
First frame of action. The point on a film reel or corresponding file at which the program content begins.
fps
Frames per second. Measurement unit of frame rate.
frame rate
The number of frames decoded per second in real-time operation.
GUI
Graphical user interface.
IAB
Immersive audio bitstream. A frame-based audio bitstream that includes audio channels and/or audio
objects, plus metadata.
IMF
Interoperable Master Format. A SMPTE standard that defines an interoperable, file-based framework
designed to facilitate the management and processing of multiple versions of the same high-quality
finished work. See SMPTE ST 2067-2 and related documentation.
immersive stereo
A technology that delivers a virtualized immersive experience to headphones or stereo speakers through
a Dolby AC‑4 bitstream with appropriate stereo content and metadata that converts the stereo signal
into the virtualized experience.
ITU
International Telecommunication Union.
Line mode
A dynamic range control (DRC) mode that applies metadata with a target dialogue level of -31 dBFS.
Lo/Ro
Left only/Right only. A stereo representation that preserves separation of Left Surround and Right
Surround channels in conversion from a surround format, and is also mono compatible.
Lt/Rt
Left total/Right total. A stereo representation that can be converted to the Left, Center, Right, and
Surround channels of a surround format.
mezzanine
Audio or video signals with an intermediate amount of compression for transport and distribution.
These lightly compressed signals are smaller in size but have enough quality for multiple compression
and decompression cycles in a postproduction chain without producing obvious artifacts. In video, the
signal is converted from the source during the color grading and mastering process. In audio, the signal
is converted during the ingestion process. Ingestion and conversion of audio and video may occur
simultaneously or separately, depending on the situation and workflow.
MXF
Material Exchange Format. A file format used to transfer and store different types of content (for
example, audio, video, data, or metadata). MXF currently supports various compression and encoding
formats, and its specification can be extended to new essence formats, if needed.
object
An audio signal plus associated object audio metadata.
rendering
Processing of audio content to adapt it to specific speaker layouts, such as 5.1‑ and 7.1‑speaker feeds, or
headphones and sound bars.
SMPTE
Society of Motion Picture and Television Engineers.
substream
A decodable unit that represents a specific channel configuration (mono, stereo, or 5.1) and contains
audio data and corresponding metadata.
UI
User interface.
Laboratories.
All other trademarks remain the property of their respective owners.