Dolby Atmos®

Encoding.com's API provides the ability to produce Joint Audio Coding audio output for Dolby Atmos® source files.

DAMF Source File

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>
        <url>[SourceFile]</url> <!-- main video source file -->
        <url> 
            <main_source>[DAMFSourceFile]</main_source>  <!-- DAMF Atmos file -->
            <sidecar>
                <url>[DAMFMetaFile]</url> <!-- DAMF metadata file -->
                <type>damf_meta</type>
            </sidecar>
            <sidecar>
                <url>[DAMFAudioFile]</url> <!-- DAMF audio file-->
                <type>damf_audio</type>
            </sidecar>
        </url> <!-- DAMF source files -->
        <audio_stream> <!-- map DAMF source file as audio stream -->
            <use_stream_id>1:0</use_stream_id>
            <natural_order>yes</natural_order>
        </audio_stream>
    </source> <!-- required-->
    <format>
        <output>[OutputFormat]</output> <!-- required-->
        <audio_stream>
            <use_stream_id>0</use_stream_id>
            <audio_codec>eac3joc</audio_codec>
            <natural_order>yes</natural_order>
            <!-- audio_stream params -->
        </audio_stream>
        <!-- Multiple stream params may be included in output format -->
        <!-- Maximum number of available streams is 15 -->
        <audio_stream>
            <!-- audio_stream params -->
        </audio_stream>
        <!-- format params -->
    </format>
</query>
{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]", // required
        "source": {
            "url": [
                "SourceFile", // main video source file
                {
                    "main_source": "[DAMFSourceFile]", // DAMF Atmos file
                    "sidecar": [
                        {
                            "url": "[DAMFMetaFile]",  // DAMF metadata file
                            "type": "damf_meta"
                        },
                        {
                            "url": "[DAMFAudioFile]",  // DAMF audio file
                            "type": "damf_audio"
                        }
                    ]
                } // DAMF source files
            ],
            "audio_stream": { // map ADM BWF source file as audio stream
                "use_stream_id": "1:0",
                "natural_order": "yes"
            }
        }, // required
        "format": {
            "output": "[OutputFormat]", // required
            "audio_stream": [
                {
                    "use_stream_id": "0",
                    "audio_codec": "eac3joc",
                    "natural_order": "yes"
                    // audio_stream params
                },
                {
                    // audio_stream params
                }
            ]
            // format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
Media parameters--
 sourceMedia Source descriptionnone
 main_sourceDAMF Atmos source fileValid URLnone
URL parameters---
 sidecarDAMF Sidecars-none
Sidecar parameters---
 typeDAMF Sidecar typedamf_meta, damf_audionone
 urlDAMF Sidecar fileValid URLnone
Format parameters---
 outputOutput formatmp4, mpegts, apple_prores, m4a, wowza, wowza_multibitrate, wowza_multibitrate_mp4, roku_*, kindle_fire, mov, smooth_streaming, mpeg_dashnone
 audio_streamOutput audio streams mapping-none
Source parameters---
 urlMedia Source File description-none
 audio_streamSource audio streams description-none
Source audio stream parameters---
 use_stream_idSpecify the media stream ID.Set of 2 non-negative integer numbers separated by colon sign
e.g. F:S
Where
F – File index (index of <url /> param in <source /> block)
S – Stream index in source file
none
 natural_orderIf set to yes then value of <use_stream_id /> will mean number of source's audio stream, not number of stream in all type streams list.yes, no

It's hardly recommended to set it to yes
no
Format audio stream parameters---
 audio_codecSpecify the audio codeceac3joc for Dolby Atmos® audio

m4a: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mp4: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, ac3, eac3, eac3joc
wowza, roku_*, kindle_fire: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mov: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc, pcm_f32be, pcm_f32le
wowza_multibitrate, wowza_multibitrate_mp4, roku_hls, hds: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
smooth_streaming: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mpegts: ac3, eac3, eac3joc, libfaac, libmp3lame, mp2, dolby_aac, dolby_heaac, dolby_heaacv2, copy
mpeg_dash: libfaac, eac3, eac3joc
mp4: libfaac
mpegts: ac3
m4a: libfaac
apple_prores: libfaac
wowza: libfaac
wowza_multibitrate: libfaac
wowza_multibitrate_mp4: libfaac
roku_*: libfaac
kindle_fire: libfaac
mov: libfaac
smooth_streaming: libfaac
mpeg_dash: libfaac
 use_stream_idSpecify the source media stream ID.Non negative integer numberBy default # of **<audio_stream /> param will be used.
 natural_orderIf set to yes then value of <use_stream_id /> will mean number of source's audio stream, not number of stream in all type streams list.yes, no

It's hardly recommended to set it to yes
no

ADM BWF Source FIle

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>
        <url>[SourceFile]</url> <!-- main video source file -->
        <url>[ADMSourceFile]</url> <!-- ADM BWF source file -->
        <audio_stream> <!-- map ADM BWF source file as audio stream -->
            <use_stream_id>1:0</use_stream_id>
            <natural_order>yes</natural_order>
        </audio_stream>
    </source> <!-- required-->
    <format>
        <output>[OutputFormat]</output> <!-- required-->
        <audio_stream>
            <use_stream_id>0</use_stream_id>
            <audio_codec>eac3joc</audio_codec>
            <natural_order>yes</natural_order>
            <!-- audio_stream params -->
        </audio_stream>
        <!-- Multiple stream params may be included in output format -->
        <!-- Maximum number of available streams is 15 -->
        <audio_stream>
            <!-- audio_stream params -->
        </audio_stream>
        <!-- format params -->
    </format>
</query>
{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]", // required
        "source": {
            "url": [
                "[SourceFile]",   // main video source file
                "[ADMSourceFile]" // ADM BWF source file
            ],
            "audio_stream": { // map ADM BWF source file as audio stream
                "use_stream_id": "1:0",
                "natural_order": "yes"
            }
        }, // required
        "format": {
            "output": "[OutputFormat]", // required
            "audio_stream": [
                {
                    "use_stream_id": "0",
                    "audio_codec": "eac3joc",
                    "natural_order": "yes"
                    // audio_stream params
                },
                {
                    // audio_stream params
                }
            ]
            // format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
Media parameters--
 sourceMedia Source descriptionnone
Format parameters---
 outputOutput formatmp4, mpegts, apple_prores, m4a, wowza, wowza_multibitrate, wowza_multibitrate_mp4, roku_*, kindle_fire, mov, smooth_streaming, mpeg_dashnone
 audio_streamOutput audio streams mapping-none
Source parameters---
 urlMedia Source Files: input video file and ADM BWF fileValid URLnone
 audio_streamSource audio streams description-none
Source audio stream parameters---
 use_stream_idSpecify the media stream ID.Set of 2 non-negative integer numbers separated by colon sign
e.g. F:S
Where
F – File index (index of <url /> param in <source /> block)
S – Stream index in source file
none
 natural_orderIf set to yes then value of <use_stream_id /> will mean number of source's audio stream, not number of stream in all type streams list.yes, no

It's hardly recommended to set it to yes
no
Format audio stream parameters---
 audio_codecSpecify the audio codeceac3joc for Dolby Atmos® audio

m4a: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mp4: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, ac3, eac3, eac3joc
wowza, roku_*, kindle_fire: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mov: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc, pcm_f32be, pcm_f32le
wowza_multibitrate, wowza_multibitrate_mp4, roku_hls, hds: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
smooth_streaming: libfaac, dolby_aac, dolby_heaac, dolby_heaacv2, eac3, eac3joc
mpegts: ac3, eac3, eac3joc, libfaac, libmp3lame, mp2, dolby_aac, dolby_heaac, dolby_heaacv2, copy
mpeg_dash: libfaac, eac3, eac3joc
mp4: libfaac
mpegts: ac3
m4a: libfaac
apple_prores: libfaac
wowza: libfaac
wowza_multibitrate: libfaac
wowza_multibitrate_mp4: libfaac
roku_*: libfaac
kindle_fire: libfaac
mov: libfaac
smooth_streaming: libfaac
mpeg_dash: libfaac
 use_stream_idSpecify the source media stream ID.Non negative integer numberBy default # of **<audio_stream /> param will be used.
 natural_orderIf set to yes then value of <use_stream_id /> will mean number of source's audio stream, not number of stream in all type streams list.yes, no

It's hardly recommended to set it to yes
no