<?xml version='1.0' encoding='ascii'?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes" symrefs="yes" ?>
<rfc ipr="trust200902" category="std" docName="draft-ietf-codec-ambisonics-03" obsoletes="" updates="" submissionType="IETF" xml:lang="en">
  <front>
    <title abbrev="Opus Ambisonics">Ambisonics in an Ogg Opus Container</title>
    <author initials="J." surname="Skoglund" fullname="Jan Skoglund">
      <organization>Google Inc.</organization>
      <address>
        <postal>
          <street>345 Spear Street</street>
          <city>San Francisco</city>
          <region>CA</region>
          <code>94105</code>
          <country>USA</country>
        </postal>
        <email>jks@google.com</email>
      </address>
    </author>
    <author initials="M.G." surname="Graczyk" fullname="Michael Graczyk">
      <organization></organization>
      <address>
        <email>michael@graczyk.com</email>
      </address>
    </author>
    <date day="2" month="May" year="2017"/>
    <area>RAI</area>
    <workgroup>codec</workgroup>
    <abstract>
      <t>This document defines an extension to the Opus audio codec to encapsulate coded ambisonics using the Ogg format.  </t>
    </abstract>
  </front>
  <middle>
    <section anchor="intro" title="Introduction" toc="default">
      <t>Ambisonics is a representation format for three dimensional sound fields which can be used for surround sound and immersive virtual reality playback.  See <xref target="gerzon75" pageno="false" format="default"/> and <xref target="daniel04" pageno="false" format="default"/> for technical details on the ambisonics format.  For the purposes of the this document, ambisonics can be considered a multichannel audio stream.  A separate stereo stream can be used alongside the ambisonics in a head-tracked virtual reality experience to provide so-called non-diegetic audio - audio which should remain unchanged by listener head rotation; e.g., narration or stereo music.  Ogg is a general purpose container, supporting audio, video, and other media.  It can be used to encapsulate audio streams coded using the Opus codec.  See <xref target="RFC6716" pageno="false" format="default"/> and <xref target="RFC7845" pageno="false" format="default"/> for technical details on the Opus codec and its encapsulation in the Ogg container respectively.  </t>
      <t>This document extends the Ogg Opus format by defining two new channel mapping families for encoding ambisonics. The Ogg Opus format is extended indirectly by adding an item with value 2 or 3 to the IANA "Opus Channel Mapping Families" registry.  When 2 or 3 are used as the Channel Mapping Family Number in an Ogg stream, the semantic meaning of the channels in the multichannel Opus stream is one of the ambisonics layouts defined in this document. This mapping can also be used in other contexts which make use of the channel mappings defined by the Opus Channel Mapping Families registry.  </t>
    </section>
    <section anchor="terminology" title="Terminology" toc="default">
      <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in <xref target="RFC2119" pageno="false" format="default"/>.  </t>
    </section>
    <section anchor="ogg_extension" title="Ambisonics With Ogg Opus" toc="default">
      <t>Ambisonics can be encapsulated in the Ogg format by encoding with the Opus codec and setting the channel mapping family value to 2 or 3 in the Ogg identification header (ID). A demuxer implementation encountering Channel Mapping Family 2 or Family 3 MUST interpret the Opus stream as containing ambisonics with the format described in <xref target="channel_mapping_2" pageno="false" format="default"/> or <xref target="channel_mapping_3" pageno="false" format="default"/>, respectively.  </t>
      <section anchor="channel_mapping_2" title="Channel Mapping Family 2" toc="default">
        <t>Allowed numbers of channels: (1 + n)^2 + 2j for n = 0...14 and j = 0 or 1, where n denotes the (highest) ambisonic order and j whether or not there is a separate non-diegetic stereo stream.  This corresponds to periphonic ambisonics from zeroth to fourteenth order plus potentially two channels of non-diegetic stereo.  Explicitly the allowed number of channels are 1, 3, 4, 6, 9, 11, 16, 18, 25, 27, 36, 38, 49, 51, 64, 66, 81, 83, 100, 102, 121, 123, 144, 146, 169, 171, 196, 198, 225, 227.  </t>
        <t>This channel mapping uses the same channel mapping table format used by channel mapping family 1. The output channels are ambisonic components ordered in Ambisonic Channel Number (ACN) order, defined in <xref target="ACN" pageno="false" format="default"/>, followed by two optional channels of non-diegetic stereo indexed (left, right).  </t>
        <figure anchor="ACN" title="Ambisonic Channel Number (ACN)" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">
ACN = n * (n + 1) + m,
for order n and degree m.
</artwork>
        </figure>
        <t>For the ambisonic channels the ACN component corresponds to channel index as k = ACN. The reverse correspondence can also be computed for an ambisonic channel with index k.  </t>
        <figure anchor="inverseACN" title="Ambisonic Degree and Order   from ACN" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">
order   n = floor(sqrt(k)),
degree  m = k - n * (n + 1).
</artwork>
        </figure>
  <t> Note that channel mapping family 2 allows for so-called mixed order ambisonic representation where only a subset of the full ambisonic order number of channels. By specifying the full number in the channel count field, the inactive ACNs can then be indicated in the channel mapping field using the index 255.</t>
        <t>Ambisonic channels are normalized with Schmidt Semi-Normalization (SN3D).  The interpretation of the ambisonics signal as well as detailed definitions of ACN channel ordering and SN3D normalization are described in <xref target="ambix" pageno="false" format="default"/> Section 2.1.  </t>
      </section>
      <section anchor="channel_mapping_3" title="Channel Mapping Family 3" toc="default">
        <t> Allowed numbers of channels: (1 + n)^2 + 2j for n = 0...14 and j = 0 or 1, where n denotes the (highest) ambisonic order and j whether or not there is a separate non-diegetic stereo stream.  This corresponds to periphonic ambisonics from zeroth to fourteenth order plus potentially two channels of non-diegetic stereo.  Explicitly the allowed number of channels are 1, 3, 4, 6, 9, 11, 16, 18, 25, 27, 36, 38, 49, 51, 64, 66, 81, 83, 100, 102, 121, 123, 144, 146, 169, 171, 196, 198, 225, 227.
</t><t>In this mapping, C output channels (the channel count) are generated at the decoder by multiplying K = N + M decoded channels with a designated demixing matrix, D, having C rows and K columns. Here, N denotes the number of streams encoded and M the number of these which are coupled to produce two channels.   As for channel mapping family 2 this mapping family also allows for encoding and decoding of full order ambisonics, mixed order ambisonics, and for non-diegetic stereo channels, but also has the added flexibility of mixing channels.  Let X denote a column vector containing K decoded channels X1, X2, ..., XK (from N streams), and let S denote a column vector containing C output streams S1, S2, ..., SC. Then S = D X, i.e., </t>
        <figure anchor="demixing" title="Demixing in Channel Mapping Family 3" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">
/     \   /                   \ /     \
| S1  |   | D11  D12  ... D1K | | X1  |
| S2  |   | D21  D22  ... D2K | | X2  |
| ... | = | ...  ...  ... ... | | ... |
| SC  |   | DC1  DC2  ... DCK | | XK  |
\     /   \                   / \     /
</artwork>
        </figure>
        <t>The matrix MUST be provided as side information and MUST be stored in the channel mapping table part of the identification header, c.f. section 5.1.1 in <xref target="RFC7845" pageno="false" format="default"/>. The matrix replaces the need for a channel mapping field and for channel mapping family 3 the mapping table has the following layout: </t>
        <figure anchor="channel_mapping" title="Channel Mapping Table for  Channel Mapping Family 3" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
                                                +-+-+-+-+-+-+-+-+
                                                | Stream Count  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Coupled Count | Demixing Matrix                               :
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

</artwork>
        </figure>
        <t>The fields in the channel mapping table have the following meaning: <list style="numbers" counter="8"><t>Stream Count 'N' (8 bits, unsigned): <vspace blankLines="1"/> This is the total number of streams encoded in each Ogg packet.  <vspace blankLines="1"/> </t><t>Coupled Stream Count 'M' (8 bits, unsigned): <vspace blankLines="1"/> This is the number of the N streams whose decoders are to be configured to produce two channels (stereo).  <vspace blankLines="1"/> </t><t>Demixing Matrix (16*K*C bits, signed): <vspace blankLines="1"/> The coefficients of the demixing matrix stored column-wise as 16-bit, signed, two's complement fixed-point values with 15 fractional bits (Q15), little endian. If needed, the output gain field can be used for a normalization scale. For mixed order ambisonic representations, the silent ACN channels are indicated by all zeros in the corresponding rows of the mixing matrix. This allows also for mixed order with non-diegetic stereo as the number of columns implies the presence of non-diegetic channels.</t></list> </t>
        <t>Note that <xref target="RFC7845" pageno="false" format="default"/> specifies that the identification header cannot exceed one "page", which is 65,025 octets. This limits the ambisonic order to be lower than 12, if full order is utilized and the number of coded streams is the same as the ambisonic order plus the two non-diegetic channels.  Also note that the total output channel number, C, MUST be set in the 3rd field of the identification header.  </t>
      </section>
    </section>
    <section anchor="downmixing" title="Downmixing" toc="default">
             <t>An Ogg Opus player MAY use the matrix in Figure <xref target="stereo_downmix_matrix_1" format="counter" pageno="false"/> to implement downmixing from multichannel files using Channel Mapping Family 2 and 3, when there is no non-diegetic stereo.  This downmixing is known to give acceptable results for stereo downmixing from ambisonics. The first and second ambisonic channels are known as "W" and "Y" respectively.  </t>
        <figure anchor="stereo_downmix_matrix_1" title="Stereo Downmixing Matrix for Channel Mapping Family 2 and 3 -   only Ambisonic Channels" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">
/   \   /                  \ /     \
| L |   | 0.5  0.5 0.0 ... | |  W  |
| R | = | 0.5 -0.5 0.0 ... | |  Y  |
\   /   \                  / | ... |
                             \     /
</artwork>
        </figure>
        <t>The first ambisonic channel (W) is a mono audio stream which represents the average audio signal over all directions. Since W is not directional, Ogg Opus players MAY use W directly for mono playback.  </t>
        <t>If a non-diegetic stereo track is present, the player MAY use the matrix in Figure <xref target="stereo_downmix_matrix_2" format="counter" pageno="false"/> for downmixing.  Ls and Rs denote the two non-diegetic stereo channels.  </t>
        <figure anchor="stereo_downmix_matrix_2" title="Stereo Downmixing Matrix for Channel Mapping Family 2 and 3 -   Ambisonic Channels Plus a Non-diegetic Stereo Stream" align="center" suppress-title="false" alt="" width="" height="">
          <artwork align="center" xml:space="preserve" name="" type="" alt="" width="" height="">
/   \   /                            \  /     \
| L |   | 0.25  0.25 0.0 ... 0.5 0.0 |  |  W  |
| R | = | 0.25 -0.25 0.0 ... 0.0 0.5 |  |  Y  |
\   /   \                            /  | ... |
                                        |  Ls |
                                        |  Rs |
                                        \     /
</artwork>
        </figure>
     
      
    </section>
    <section anchor="security" title="Security Considerations" toc="default">
      <t>Implementations of the Ogg container need take appropriate security considerations into account, as outlined in Section 10 of <xref target="RFC7845" pageno="false" format="default"/>.  The extension defined in this document requires that semantic meaning be assigned to more channels than the existing Ogg format requires.  Since more allocations will be required to encode and decode these semantically meaningful channels, care should be taken in any new allocation paths.  Implementations MUST NOT overrun their allocated memory nor read from uninitialized memory when managing the ambisonic channel mapping.  </t>
    </section>
    <section anchor="iana" title="IANA Considerations" toc="default">
      <t>This document updates the IANA Media Types registry "Opus Channel Mapping Families" to add two new assignments.  </t>
      <texttable title="" suppress-title="false" align="center" style="full">
        <ttcol align="left">Value</ttcol>
        <ttcol align="left">Reference</ttcol>
        <c>2</c>
        <c>This Document <xref target="channel_mapping_2" pageno="false" format="default"/></c>
        <c>3</c>
        <c>This Document <xref target="channel_mapping_3" pageno="false" format="default"/></c>
      </texttable>
    </section>
    <section anchor="Acknowledgments" title="Acknowledgments" toc="default">
      <t>Thanks to Timothy Terriberry, Marcin Gorzel and Andrew Allen for their guidance and valuable contributions to this document.  </t>
    </section>
  </middle>
  <back>
    <references title="Normative References"><reference anchor="RFC2119" target="http://www.rfc-editor.org/info/rfc2119" quote-title="true"><front><title>Key words for use in RFCs to Indicate Requirement Levels</title><author initials="S." surname="Bradner" fullname="S. Bradner"><organization/></author><date year="1997" month="March"/><abstract><t>In many standards track documents several words are used to signify the requirements in the specification.  These words are often capitalized. This document defines these words as they should be interpreted in IETF documents.  This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t></abstract></front><seriesInfo name="BCP" value="14"/><seriesInfo name="RFC" value="2119"/><seriesInfo name="DOI" value="10.17487/RFC2119"/></reference> <reference anchor="RFC6716" target="http://www.rfc-editor.org/info/rfc6716" quote-title="true"><front><title>Definition of the Opus Audio Codec</title><author initials="JM." surname="Valin" fullname="JM. Valin"><organization/></author><author initials="K." surname="Vos" fullname="K. Vos"><organization/></author><author initials="T." surname="Terriberry" fullname="T. Terriberry"><organization/></author><date year="2012" month="September"/><abstract><t>This document defines the Opus interactive speech and audio codec. Opus is designed to handle a wide range of interactive audio applications, including Voice over IP, videoconferencing, in-game chat, and even live, distributed music performances.  It scales from low bitrate narrowband speech at 6 kbit/s to very high quality stereo music at 510 kbit/s.  Opus uses both Linear Prediction (LP) and the Modified Discrete Cosine Transform (MDCT) to achieve good compression of both speech and music.  [STANDARDS-TRACK]</t></abstract></front><seriesInfo name="RFC" value="6716"/><seriesInfo name="DOI" value="10.17487/RFC6716"/></reference> <reference anchor="RFC7845" target="http://www.rfc-editor.org/info/rfc7845" quote-title="true"><front><title>Ogg Encapsulation for the Opus Audio Codec</title><author initials="T." surname="Terriberry" fullname="T. Terriberry"><organization/></author><author initials="R." surname="Lee" fullname="R. Lee"><organization/></author><author initials="R." surname="Giles" fullname="R. Giles"><organization/></author><date year="2016" month="April"/><abstract><t>This document defines the Ogg encapsulation for the Opus interactive speech and audio codec.  This allows data encoded in the Opus format to be stored in an Ogg logical bitstream.</t></abstract></front><seriesInfo name="RFC" value="7845"/><seriesInfo name="DOI" value="10.17487/RFC7845"/></reference> <reference anchor="ambix" target="http://iem.kug.ac.at/fileadmin/media/iem/projects/2011/ambisonics11_nachbar_zotter_sontacchi_deleflie.pdf" quote-title="true"><front><title>AMBIX - A SUGGESTED AMBISONICS FORMAT</title><author initials="C." surname="Nachbar" fullname="Christian Nachbar"/><author initials="F." surname="Zotter" fullname="Franz Zotter"/><author initials="E." surname="Deleflie" fullname="Etienne Deleflie"/><author initials="A." surname="Sontacchi" fullname="Alois Sontacchi"/><date month="June" year="2011"/></front></reference></references>
    <references title="Informative References">
      <reference anchor="gerzon75" target="http://www.michaelgerzonphotos.org.uk/articles/Ambisonics%201.pdf" quote-title="true">
        <front>
          <title>Ambisonics. Part one: General system description</title>
          <author initials="M." surname="Gerzon" fullname="Michael Gerzon"/>
          <date month="August" year="1975"/>
        </front>
      </reference>
      <reference anchor="daniel04" target="http://pcfarina.eng.unipr.it/Public/phd-thesis/aes116%20high-passed%20hoa.pdf" quote-title="true">
        <front>
          <title>Further Study of Sound Field Coding with Higher Order Ambisonics</title>
          <author initials="J." surname="Daniel" fullname="J&#233;r&#244;me Daniel"/>
          <author initials="S." surname="Moreau" fullname="S&#233;bastien Moreau"/>
          <date month="May" year="2004"/>
        </front>
      </reference>
    </references>
  </back>
</rfc>
