Define TOC sequence briefly.
[opus.git] / doc / draft-terriberry-oggopus.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
3 <?rfc toc="yes" symrefs="yes" ?>
4
5 <rfc ipr="trust200902" category="std" docName="draft-terriberry-oggopus-01">
6
7 <front>
8 <title abbrev="Ogg Opus">Ogg Encapsulation for the Opus Audio Codec</title>
9 <author initials="T.B." surname="Terriberry" fullname="Timothy B. Terriberry">
10 <organization>Mozilla Corporation</organization>
11 <address>
12 <postal>
13 <street>650 Castro Street</street>
14 <city>Mountain View</city>
15 <region>CA</region>
16 <code>94041</code>
17 <country>USA</country>
18 </postal>
19 <phone>+1 650 903-0800</phone>
20 <email>tterribe@xiph.org</email>
21 </address>
22 </author>
23
24 <author initials="R." surname="Lee" fullname="Ron Lee">
25 <organization>Voicetronix</organization>
26 <address>
27 <postal>
28 <street>246 Pulteney Street, Level 1</street>
29 <city>Adelaide</city>
30 <region>SA</region>
31 <code>5000</code>
32 <country>Australia</country>
33 </postal>
34 <phone>+61 8 8232 9112</phone>
35 <email>ron@debian.org</email>
36 </address>
37 </author>
38
39 <author initials="R." surname="Giles" fullname="Ralph Giles">
40 <organization>Mozilla Corporation</organization>
41 <address>
42 <postal>
43 <street>163 West Hastings Street</street>
44 <city>Vancouver</city>
45 <region>BC</region>
46 <code>V6B 1H5</code>
47 <country>Canada</country>
48 </postal>
49 <phone>+1 604 778 1540</phone>
50 <email>giles@xiph.org</email>
51 </address>
52 </author>
53
54 <date day="3" month="July" year="2012"/>
55 <area>RAI</area>
56 <workgroup>codec</workgroup>
57
58 <abstract>
59 <t>
60 This document defines the Ogg encapsulation for the Opus interactive speech and
61  audio codec.
62 This allows data encoded in the Opus format to be stored in an Ogg logical
63  bitstream.
64 Ogg encapsulation provides Opus with a long-term storage format supporting
65  all of the essential features, including metadata, fast and accurate seeking,
66  corruption detection, recapture after errors, low overhead, and the ability to
67  multiplex Opus with other codecs (including video) with minimal buffering.
68 It also provides a live streamable format, capable of delivery over a reliable
69  stream-oriented transport, without requiring all the data, or even the total
70  length of the data, up-front, in a form that is identical to the on-disk
71  storage format.
72 </t>
73 </abstract>
74 </front>
75
76 <middle>
77 <section anchor="intro" title="Introduction">
78 <t>
79 The IETF Opus codec is a low-latency audio codec optimized for both voice and
80  general-purpose audio.
81 See <xref target="RFCOpus"/> for technical details.
82 This document defines the encapsulation of Opus in a continuous, logical Ogg
83  bitstream&nbsp;<xref target="RFC3533"/>.
84 </t>
85 <t>
86 Ogg bitstreams are made up of a series of 'pages', each of which contains data
87  from one or more 'packets'.
88 Pages are the fundamental unit of multiplexing in an Ogg stream.
89 Each page is associated with a particular logical stream and contains a capture
90  pattern and checksum, flags to mark the beginning and end of the logical
91  stream, and a 'granule position' that represents an absolute position in the
92  stream, to aid seeking.
93 A single page can contain up to 65,025 octets of packet data from up to 255
94  different packets.
95 Packets may be split arbitrarily across pages, and continued from one page to
96  the next (allowing packets much larger than would fit on a single page).
97 Each page contains 'lacing values' that indicate how the data is partitioned
98  into packets, allowing a demuxer to recover the packet boundaries without
99  examining the encoded data.
100 A packet is said to 'complete' on a page when the page contains the final
101  lacing value corresponding to that packet.
102 </t>
103 <t>
104 This encapsulation defines the required contents of the packet data, including
105  the necessary headers, the organization of those packets into a logical
106  stream, and the interpretation of the codec-specific granule position field.
107 It does not attempt to describe or specify the existing Ogg container format.
108 Readers unfamiliar with the basic concepts mentioned above are encouraged to
109  review the details in <xref target="RFC3533"/>.
110 </t>
111
112 </section>
113
114 <section anchor="terminology" title="Terminology">
115 <t>
116 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
117  "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
118  interpreted as described in <xref target="RFC2119"/>.
119 </t>
120
121 <t>
122 Implementations that fail to satisfy one or more "MUST" requirements are
123  considered non-compliant.
124 Implementations that satisfy all "MUST" requirements, but fail to satisfy one
125  or more "SHOULD" requirements are said to be "conditionally compliant".
126 All other implementations are "unconditionally compliant".
127 </t>
128
129 </section>
130
131 <section anchor="packet_organization" title="Packet Organization">
132 <t>
133 An Opus stream is organized as follows.
134 </t>
135 <t>
136 There are two mandatory header packets.
137 The granule position of the pages on which these packets complete MUST be zero.
138 </t>
139 <t>
140 The first packet in the logical Ogg bitstream MUST contain the identification
141  (ID) header, which uniquely identifies a stream as Opus audio.
142 The format of this header is defined in <xref target="id_header"/>.
143 It MUST be placed alone (without any other packet data) on the first page of
144  the logical Ogg bitstream.
145 This page MUST have its 'beginning of stream' flag set.
146 </t>
147 <t>
148 The second packet in the logical Ogg bitstream MUST contain the comment header,
149  which contains user-supplied metadata.
150 The format of this header is defined in <xref target="comment_header"/>.
151 It MAY span one or more pages, beginning on the second page of the logical
152  stream.
153 However many pages it spans, the comment header packet MUST finish the page on
154  which it completes.
155 </t>
156 <t>
157 All subsequent pages are audio data pages, and the Ogg packets they contain are
158  audio data packets.
159 Each audio data packet contains one Opus packet for each of N different
160  streams, where N is typically one for mono or stereo, but may be greater than
161  one for, e.g., multichannel audio.
162 The value N is specified in the ID header (see
163  <xref target="channel_mapping"/>), and is fixed over the entire length of the
164  logical Ogg bitstream.
165 </t>
166 <t>
167 The first N-1 Opus packets, if any, are packed one after another in sequence
168  into the Ogg packet, using the self-delimiting framing from Appendix&nbsp;B
169  of <xref target="RFCOpus"/>.
170 The remaining Opus packet is packed at the end of the audio data packet
171  using the regular, undelimited framing from Section&nbsp;3 of
172  <xref target="RFCOpus"/>.
173 All of the Opus packets in a single Ogg packet MUST be constrained to have the
174  same duration.
175 The duration and coding modes of each Opus packet are contained in the
176  TOC (table of contents) sequence in the first few bytes.
177 A decoder SHOULD treat any Opus packet whose duration is different from that of
178  the first Opus packet in an Ogg packet as if it were an Opus packet with an
179  illegal TOC sequence.
180 </t>
181 <t>
182 The first audio data page SHOULD NOT have the 'continued packet' flag set
183  (which would indicated the first audio data packet is continued from a
184  previous page).
185 Packets MUST be placed into Ogg pages in order until the end of stream.
186 Audio packets MAY span page boundaries.
187 A decoder MUST treat a zero-octet audio data packet as if it were an Opus
188  packet with an illegal TOC sequence.
189 The last page SHOULD have the 'end of stream' flag set, but implementations
190  should be prepared to deal with truncated streams that do not have a page
191  marked 'end of stream'.
192 The final packet on the last page SHOULD NOT be a continued packet, i.e., the
193  final lacing value should be less than 255.
194 There MUST NOT be any more pages in an Opus logical bitstream after a page
195  marked 'end of stream'.
196 </t>
197 </section>
198
199 <section anchor="granpos" title="Granule Position">
200 <t>
201 The granule position of an audio data page encodes the total number of PCM
202  samples in the stream up to and including the last fully-decodable sample from
203  the last packet completed on that page.
204 A page that is entirely spanned by a single packet (that completes on a
205  subsequent page) has no granule position, and the granule position field MUST
206  be set to the special value '-1' in two's complement.
207 </t>
208
209 <t>
210 The granule position of an audio data page is in units of PCM audio samples at
211  a fixed rate of 48&nbsp;kHz (per channel; a stereo stream's granule position
212  does not increment at twice the speed of a mono stream).
213 It is possible to run an Opus decoder at other sampling rates, but the value
214  in the granule position field always counts samples assuming a 48&nbsp;kHz
215  decoding rate, and the rest of this specification makes the same assumption.
216 </t>
217
218 <t>
219 The duration of an Opus packet may be any multiple of 2.5&nbsp;ms, up to a
220  maximum of 120&nbsp;ms.
221 This duration is encoded in the TOC sequence at the beginning of each packet.
222 The number of samples returned by a decoder corresponds to this duration
223  exactly, even for the first few packets.
224 For example, a 20&nbsp;ms packet fed to a decoder running at 48&nbsp;kHz will
225  always return 960&nbsp;samples.
226 A demuxer can parse the TOC sequence at the beginning of each Ogg packet to
227  work backwards or forwards from a packet with a known granule position (i.e.,
228  the last packet completed on some page) in order to assign granule positions
229  to every packet, or even every individual sample.
230 The one exception is the last page in the stream, as described below.
231 </t>
232
233 <t>
234 All other pages with completed packets after the first MUST have a granule
235  position equal to the number of samples contained in packets that complete on
236  that page plus the granule position of the most recent page with completed
237  packets.
238 This guarantees that a demuxer can assign individual packets the same granule
239  position when working forwards as when working backwards.
240 For this to work, there cannot be any gaps.
241 In order to support capturing a stream that uses discontinuous transmission
242  (DTX), an encoder SHOULD emit packets that explicitly request the use of
243  Packet Loss Concealment (PLC) (i.e., with a frame length of 0, as defined in
244  Section 3.2.1 of <xref target="RFCOpus"/>) in place of the packets that were
245  not transmitted.
246 </t>
247
248 <t>
249 There is some amount of latency introduced during the decoding process, to
250  allow for overlap in the MDCT modes, stereo mixing in the LP modes, and
251  resampling, and the encoder will introduce even more latency (though the exact
252  amount is not specified).
253 Therefore, the first few samples produced by the decoder do not correspond to
254  real input audio, but are instead composed of padding inserted by the encoder
255  to compensate for this latency.
256 These samples need to be stored and decoded, as Opus is an asymptotically
257  convergent predictive codec, meaning the decoded contents of each frame depend
258  on the recent history of decoder inputs.
259 However, a decoder will want to skip these samples after decoding them.
260 </t>
261
262 <t>
263 A 'pre-skip' field in the ID header (see <xref target="id_header"/>) signals
264  the number of samples which should be skipped at the beginning of the stream.
265 This provides sufficient history to the decoder so that it has already
266  converged before the stream's output begins.
267 It may also be used to perform sample-accurate cropping of existing encoded
268  streams.
269 This amount need not be a multiple of 2.5&nbsp;ms, may be smaller than a single
270  packet, or may span the contents of several packets.
271 </t>
272
273 <t>
274 The PCM sample position is determined from the granule position using the
275  formula
276 <figure align="center">
277 <artwork align="center"><![CDATA[
278 'PCM sample position' = 'granule position' - 'pre-skip' .
279 ]]></artwork>
280 </figure>
281 </t>
282
283 <t>
284 For example, if the granule position of the first audio data page is 59,971,
285  and the pre-skip is 11,971, then the PCM sample position of the last decoded
286  sample from that page is 48,000.
287 This can be converted into a playback time using the formula
288 <figure align="center">
289 <artwork align="center"><![CDATA[
290                   'PCM sample position'
291 'playback time' = --------------------- .
292                          48000.0
293 ]]></artwork>
294 </figure>
295 </t>
296
297 <t>
298 The initial PCM sample position before any samples are played is normally '0'.
299 In this case, the PCM sample position of the first audio sample to be played
300  starts at '1', because it marks the time on the clock
301  <spanx style="emph">after</spanx> that sample has been played, and a stream
302  that is exactly one second long has a final PCM sample position of '48000',
303  as in the example here.
304 </t>
305
306 <t>
307 Vorbis streams use a granule position smaller than the number of audio samples
308  contained in the first audio data page to indicate that some of those samples
309  must be trimmed from the output.
310 However, to do so, Vorbis requires that the first audio data page contains
311  exactly two packets, in order to allow the decoder to perform PCM position
312  adjustments before needing to return any PCM data.
313 Opus uses the pre-skip mechanism for this purpose instead, since the encoder
314  may introduce more than a single packet's worth of latency, and since very
315  large packets in streams with a very large number of channels might not fit on
316  a single page.
317 </t>
318
319 <t>
320 The page with the 'end of stream' flag set MAY have a granule position that
321  indicates the page contains less audio data than would normally be returned by
322  decoding up through the final packet.
323 This is used to end the stream somewhere other than an even frame boundary.
324 The granule position of the most recent audio data page with completed packets
325  is used to make this determination, or '0' is used if there were no previous
326  audio data pages with a completed packet.
327 The difference between these granule positions indicates how many samples to
328  keep after decoding the packets that completed on the final page.
329 The remaining samples are discarded.
330 The number of discarded samples SHOULD be no larger than the number decoded
331  from the last packet.
332 </t>
333
334 <t>
335 The granule position of the first audio data page with a completed packet MAY
336  be larger than the number of samples contained in packets that complete on
337  that page, however it MUST NOT be smaller, unless that page has the 'end of
338  stream' flag set.
339 Allowing a granule position larger than the number of samples allows the
340  beginning of a stream to be cropped or a live stream to be joined without
341  rewriting the granule position of all the remaining pages.
342 This means that the PCM sample position just before the first sample to be
343  played may be larger than '0'.
344 Synchronization when multiplexing with other logical streams still uses the PCM
345  sample position relative to '0' to compute sample times.
346 This does not affect the behavior of pre-skip: exactly 'pre-skip' samples
347  should be skipped from the beginning of the decoded output, even if the
348  initial PCM sample position is greater than zero.
349 </t>
350
351 <t>
352 On the other hand, a granule position that is smaller than the number of
353  decoded samples prevents a demuxer from working backwards to assign each
354  packet or each individual sample a valid granule position, since granule
355  positions must be non-negative.
356 A decoder MUST reject as invalid any stream where the granule position is
357  smaller than the number of samples contained in packets that complete on the
358  first audio data page with a completed packet, unless that page has the 'end
359  of stream' flag set.
360 It MAY defer this action until it decodes the last packet completed on that
361  page.
362 If that page has the 'end of stream' flag set, a demuxer can work forwards from
363  the granule position '0', but MUST reject as invalid any stream where the
364  granule position is smaller than the 'pre-skip' amount.
365 This would indicate that more samples should be skipped from the initial
366  decoded output than exist in the stream.
367 </t>
368 </section>
369
370 <section anchor="headers" title="Header Packets">
371 <t>
372 An Opus stream contains exactly two mandatory header packets.
373 </t>
374
375 <section anchor="id_header" title="Identification Header">
376
377 <figure anchor="id_header_packet" title="ID Header Packet" align="center">
378 <artwork align="center"><![CDATA[
379  0                   1                   2                   3
380  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
381 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
382 |      'O'      |      'p'      |      'u'      |      's'      |
383 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
384 |      'H'      |      'e'      |      'a'      |      'd'      |
385 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
386 |  Version = 1  | Channel Count |           Pre-skip            |
387 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
388 |                     Input Sample Rate (Hz)                    |
389 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
390 |   Output Gain (Q7.8 in dB)    | Mapping Family|               |
391 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               :
392 |                                                               |
393 :               Optional Channel Mapping Table...               :
394 |                                                               |
395 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
396 ]]></artwork>
397 </figure>
398
399 <t>
400 The fields in the identification (ID) header have the following meaning:
401 <list style="numbers">
402 <t><spanx style="strong">Magic Signature</spanx>:
403 <vspace blankLines="1"/>
404 This is an 8-octet (64-bit) field that allows codec identification and is
405  human-readable.
406 It contains, in order, the magic numbers:
407 <list style="empty">
408 <t>0x4F 'O'</t>
409 <t>0x70 'p'</t>
410 <t>0x75 'u'</t>
411 <t>0x73 's'</t>
412 <t>0x48 'H'</t>
413 <t>0x65 'e'</t>
414 <t>0x61 'a'</t>
415 <t>0x64 'd'</t>
416 </list>
417 Starting with "Op" helps distinguish it from audio data packets, as this is an
418  invalid TOC sequence.
419 <vspace blankLines="1"/>
420 </t>
421 <t><spanx style="strong">Version</spanx> (8 bits, unsigned):
422 <vspace blankLines="1"/>
423 The version number MUST always be '1' for this version of the encapsulation
424  specification.
425 Implementations SHOULD treat streams where the upper four bits of the version
426  number match that of a recognized specification as backwards-compatible with
427  that specification.
428 That is, the version number can be split into "major" and "minor" version
429  sub-fields, with changes to the "minor" sub-field (in the lower four bits)
430  signaling compatible changes.
431 For example, a decoder implementing this specification SHOULD accept any stream
432  with a version number of '15' or less, and SHOULD assume any stream with a
433  version number '16' or greater is incompatible.
434 The initial version '1' was chosen to keep implementations from relying on this
435  octet as a null terminator for the "OpusHead" string.
436 <vspace blankLines="1"/>
437 </t>
438 <t><spanx style="strong">Output Channel Count</spanx> 'C' (8 bits, unsigned):
439 <vspace blankLines="1"/>
440 This is the number of output channels.
441 This might be different than the number of encoded channels, which can change
442  on a packet-by-packet basis.
443 This value MUST NOT be zero.
444 The maximum allowable value depends on the channel mapping family, and might be
445  as large as 255.
446 See <xref target="channel_mapping"/> for details.
447 <vspace blankLines="1"/>
448 </t>
449 <t><spanx style="strong">Pre-skip</spanx> (16 bits, unsigned, little
450  endian):
451 <vspace blankLines="1"/>
452 This is the number of samples (at 48&nbsp;kHz) to discard from the decoder
453  output when starting playback, and also the number to subtract from a page's
454  granule position to calculate its PCM sample position.
455 When constructing cropped Ogg Opus streams, a pre-skip of at least
456  3,840&nbsp;samples (80&nbsp;ms) is RECOMMENDED to ensure complete convergence.
457 <vspace blankLines="1"/>
458 </t>
459 <t><spanx style="strong">Input Sample Rate</spanx> (32 bits, unsigned, little
460  endian):
461 <vspace blankLines="1"/>
462 This field is <spanx style="emph">not</spanx> the sample rate to use for
463  playback of the encoded data.
464 <vspace blankLines="1"/>
465 Opus has a handful of coding modes, with internal audio bandwidths of 4, 6, 8,
466  12, and 20&nbsp;kHz.
467 Each packet in the stream may have a different audio bandwidth.
468 Regardless of the audio bandwidth, the reference decoder supports decoding any
469  stream at a sample rate of 8, 12, 16, 24, or 48&nbsp;kHz.
470 The original sample rate of the encoder input is not preserved by the lossy
471  compression.
472 <vspace blankLines="1"/>
473 An Ogg Opus player SHOULD select the playback sample rate according to the
474  following procedure:
475 <list style="numbers">
476 <t>If the hardware supports 48&nbsp;kHz playback, decode at 48&nbsp;kHz</t>
477 <t>Else if the hardware's highest available sample rate is a supported rate,
478  decode at this sample rate,</t>
479 <t>Else if the hardware's highest available sample rate is less than
480  48&nbsp;kHz, decode at the highest supported rate above this and resample.</t>
481 <t>Else decode at 48&nbsp;kHz and resample.</t>
482 </list>
483 However, the 'Input Sample Rate' field allows the encoder to pass the sample
484  rate of the original input stream as metadata.
485 This may be useful when the user requires the output sample rate to match the
486  input sample rate.
487 For example, a non-player decoder writing PCM format samples to disk might
488  choose to resample the output audio back to the original input sample rate to
489  reduce surprise to the user, who might reasonably expect to get back a file
490  with the same sample rate as the one they fed to the encoder.
491 <vspace blankLines="1"/>
492 A value of zero indicates 'unspecified'.
493 Encoders SHOULD write the actual input sample rate or zero, but decoder
494  implementations which do something with this field SHOULD take care to behave
495  sanely if given crazy values (e.g., do not actually upsample the output to
496  10 MHz if requested).
497 <vspace blankLines="1"/>
498 </t>
499 <t><spanx style="strong">Output Gain</spanx> (16 bits, signed, little
500  endian):
501 <vspace blankLines="1"/>
502 This is a gain to be applied by the decoder.
503 It is 20*log10 of the factor to scale the decoder output by to achieve the
504  desired playback volume, stored in a 16-bit, signed, two's complement
505  fixed-point value with 8 fractional bits (i.e., Q7.8).
506 To apply the gain, a decoder could use
507 <figure align="center">
508 <artwork align="center"><![CDATA[
509 sample *= pow(10, output_gain/(20.0*256)) ,
510 ]]></artwork>
511 </figure>
512  where output_gain is the raw 16-bit value from the header.
513 <vspace blankLines="1"/>
514 Virtually all players and media frameworks should apply it by default.
515 If a player chooses to apply any volume adjustment or gain modification, such
516  as the R128_TRACK_GAIN (see <xref target="comment_header"/>) or a user-facing
517  volume knob, the adjustment MUST be applied in addition to this output gain in
518  order to achieve playback at the desired volume.
519 <vspace blankLines="1"/>
520 An encoder SHOULD set this field to zero, and instead apply any gain prior to
521  encoding, when this is possible and does not conflict with the user's wishes.
522 The output gain should only be nonzero when the gain is adjusted after
523  encoding, or when the user wishes to adjust the gain for playback while
524  preserving the ability to recover the original signal amplitude.
525 <vspace blankLines="1"/>
526 Although the output gain has enormous range (+/- 128 dB, enough to amplify
527  inaudible sounds to the threshold of physical pain), most applications can
528  only reasonably use a small portion of this range around zero.
529 The large range serves in part to ensure that gain can always be losslessly
530  transferred between OpusHead and R128_TRACK_GAIN (see below) without
531  saturating.
532 <vspace blankLines="1"/>
533 </t>
534 <t><spanx style="strong">Channel Mapping Family</spanx> (8 bits,
535  unsigned):
536 <vspace blankLines="1"/>
537 This octet indicates the order and semantic meaning of the various channels
538  encoded in each Ogg packet.
539 <vspace blankLines="1"/>
540 Each possible value of this octet indicates a mapping family, which defines a
541  set of allowed channel counts, and the ordered set of channel names for each
542  allowed channel count.
543 The details are described in <xref target="channel_mapping"/>.
544 </t>
545 </list>
546 </t>
547
548 <section anchor="channel_mapping" title="Channel Mapping">
549 <t>
550 An Ogg Opus stream allows mapping one number of Opus streams (N) to a possibly
551  larger number of decoded channels (M+N) to yet another number of output
552  channels (C), which might be larger or smaller than the number of decoded
553  channels.
554 The order and meaning these channels is defined by a channel mapping, which
555  consists of the 'channel mapping family' octet and, for channel mapping
556  families other than family&nbsp;0, a channel mapping table, as illustrated in
557  <xref target="channel_mapping_table"/>.
558 </t>
559
560 <figure anchor="channel_mapping_table" title="Channel Mapping Table"
561  align="center">
562 <artwork align="center"><![CDATA[
563  0                   1                   2                   3
564  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
565                                                 +-+-+-+-+-+-+-+-+
566                                                 | Stream Count  |
567 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
568 | Coupled Count |              Channel Mapping...               :
569 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
570 ]]></artwork>
571 </figure>
572
573 <t>
574 The fields in the channel mapping table have the following meaning:
575 <list style="numbers" counter="8">
576 <t><spanx style="strong">Stream Count</spanx> 'N' (8 bits, unsigned):
577 <vspace blankLines="1"/>
578 This is the total number of streams encoded in each Ogg packet.
579 This value is required to correctly parse the packed Opus packets inside an
580  Ogg packet, as described in <xref target="packet_organization"/>.
581 This value MUST NOT be zero, as without at least one Opus packet with a valid
582  TOC sequence, a demuxer cannot recover the duration of an Ogg packet.
583 <vspace blankLines="1"/>
584 For channel mapping family&nbsp;0, this value defaults to 1, and is not coded.
585 <vspace blankLines="1"/>
586 </t>
587 <t><spanx style="strong">Coupled Stream Count</spanx> 'M' (8 bits, unsigned):
588 This is the number of streams whose decoders should be configured to produce
589  two channels.
590 This MUST be no larger than the total number of streams, N.
591 <vspace blankLines="1"/>
592 Each packet in an Opus stream has an internal channel count of 1 or 2, which
593  can change from packet to packet.
594 This is selected by the encoder depending on the bitrate and the contents being
595  encoded.
596 The original channel count of the encoder input is not preserved by the lossy
597  compression.
598 <vspace blankLines="1"/>
599 Regardless of the internal channel count, any Opus stream can be decoded as
600  mono (a single channel) or stereo (two channels) by appropriate initialization
601  of the decoder.
602 The 'coupled stream count' field indicates that the first M Opus decoders are
603  to be initialized in stereo mode, and the remaining N-M decoders are to be
604  initialized in mono mode.
605 The total number of decoded channels, (M+N), MUST be no larger than 255, as
606  there is no way to index more channels than that in the channel mapping.
607 <vspace blankLines="1"/>
608 For channel mapping family&nbsp;0, this value defaults to C-1 (i.e., 0 for mono
609  and 1 for stereo), and is not coded.
610 <vspace blankLines="1"/>
611 </t>
612 <t><spanx style="strong">Channel Mapping</spanx> (8*C bits):
613 This contains one octet per output channel, indicating which decoded channel
614  should be used for each one.
615 Let 'index' be the value of this octet for a particular output channel.
616 This value MUST either be smaller than (M+N), or be the special value 255.
617 If 'index' is less than 2*M, the output MUST be taken from decoding stream
618  ('index'/2) as stereo and selecting the left channel if 'index' is even, and
619  the right channel if 'index' is odd.
620 If 'index' is 2*M or larger, the output MUST be taken from decoding stream
621  ('index'-M) as mono.
622 If 'index' is 255, the corresponding output channel MUST contain pure silence.
623 <vspace blankLines="1"/>
624 The number of output channels, C, is not constrained to match the number of
625  decoded channels (M+N).
626 A single index value MAY appear multiple times, i.e., the same decoded channel
627  might be mapped to multiple output channels.
628 Some decoded channels might not be assigned to any output channel, as well.
629 <vspace blankLines="1"/>
630 For channel mapping family&nbsp;0, the first index defaults to 0, and if C==2,
631  the second index defaults to 1.
632 Neither index is coded.
633 </t>
634 </list>
635 </t>
636
637 <t>
638 After producing the output channels, the channel mapping family determines the
639  semantic meaning of each one.
640 Currently there are three defined mapping families, although more may be added:
641 <list style="symbols">
642 <t>Family&nbsp;0 (RTP mapping):
643 <vspace blankLines="1"/>
644 Allowed numbers of channels: 1 or 2.
645 <list style="symbols">
646 <t>1 channel: monophonic (mono).</t>
647 <t>2 channels: stereo (left, right).</t>
648 </list>
649 <spanx style="strong">Special mapping</spanx>: This channel mapping value also
650  indicates that the contents consists of a single Opus stream that is stereo if
651  and only if C==2, with stream index 0 mapped to channel 0, and (if stereo)
652  stream index 1 mapped to channel 1.
653 When the 'channel mapping family' octet has this value, the channel mapping
654  table MUST be omitted from the ID header packet.
655 <vspace blankLines="1"/>
656 </t>
657 <t>Family&nbsp;1 (Vorbis channel order):
658 <vspace blankLines="1"/>
659 Allowed numbers of channels: 1...8.<vspace/>
660 Channel meanings depend on the number of channels.
661 See <xref target="vorbis-mapping">the
662  Vorbis mapping</xref> for the assignments from output channel number to
663  specific speaker locations.
664 <vspace blankLines="1"/>
665 </t>
666 <t>Family&nbsp;255 (no defined channel meaning):
667 <vspace blankLines="1"/>
668 Allowed numbers of channels: 1...255.<vspace/>
669 Channels are unidentified.
670 General-purpose players SHOULD NOT attempt to play these streams, and offline
671  decoders MAY deinterleave the output into separate PCM files, one per channel.
672 Decoders SHOULD NOT produce output for channels mapped to stream index 255
673  (pure silence) unless they have no other way to indicate the index of
674  non-silent channels.
675 </t>
676 </list>
677 The remaining channel mapping families (2...254) are reserved.
678 A decoder encountering a reserved channel mapping family value should act as
679  though the value is 255.
680 <vspace blankLines="1"/>
681 An Ogg Opus player MUST play any Ogg Opus stream with a channel mapping family
682  of 0 or 1, even if the number of channels does not match the physically
683  connected audio hardware.
684 Players SHOULD perform channel mixing to increase or reduce the number of
685  channels as needed.
686 </t>
687
688 </section>
689
690 </section>
691
692 <section anchor="comment_header" title="Comment Header">
693
694 <figure anchor="comment_header_packet" title="Comment Header Packet"
695  align="center">
696 <artwork align="center"><![CDATA[
697  0                   1                   2                   3
698  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
699 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
700 |      'O'      |      'p'      |      'u'      |      's'      |
701 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
702 |      'T'      |      'a'      |      'g'      |      's'      |
703 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
704 |                     Vendor String Length                      |
705 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
706 |                                                               |
707 :                        Vendor String...                       :
708 |                                                               |
709 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
710 |                   User Comment List Length                    |
711 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
712 |                 User Comment #0 String Length                 |
713 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
714 |                                                               |
715 :                   User Comment #0 String...                   :
716 |                                                               |
717 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
718 |                 User Comment #1 String Length                 |
719 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
720 :                                                               :
721 ]]></artwork>
722 </figure>
723
724 <t>
725 The comment header consists of a 64-bit magic signature, followed by data in
726  the same format as the <xref target="vorbis-comment"/> header used in Ogg
727  Vorbis (without the final "framing bit"), Ogg Theora, and Speex.
728 <list style="numbers">
729 <t><spanx style="strong">Magic Signature</spanx>:
730 <vspace blankLines="1"/>
731 This is an 8-octet (64-bit) field that allows codec identification and is
732  human-readable.
733 It contains, in order, the magic numbers:
734 <list style="empty">
735 <t>0x4F 'O'</t>
736 <t>0x70 'p'</t>
737 <t>0x75 'u'</t>
738 <t>0x73 's'</t>
739 <t>0x54 'T'</t>
740 <t>0x61 'a'</t>
741 <t>0x67 'g'</t>
742 <t>0x73 's'</t>
743 </list>
744 Starting with "Op" helps distinguish it from audio data packets, as this is an
745  invalid TOC sequence.
746 <vspace blankLines="1"/>
747 </t>
748 <t><spanx style="strong">Vendor String Length</spanx> (32 bits, unsigned,
749  little endian):
750 <vspace blankLines="1"/>
751 This field gives the length of the following vendor string, in octets.
752 It MUST NOT indicate that the vendor string is longer than the rest of the
753  packet.
754 <vspace blankLines="1"/>
755 </t>
756 <t><spanx style="strong">Vendor String</spanx> (variable length, UTF-8 vector):
757 <vspace blankLines="1"/>
758 This is a simple human-readable tag for vendor information, encoded as a UTF-8
759  string.
760 No terminating NUL octet is required.
761 <vspace blankLines="1"/>
762 </t>
763 <t><spanx style="strong">User Comment List Length</spanx> (32 bits, unsigned,
764  little endian):
765 <vspace blankLines="1"/>
766 This field indicates the number of user-supplied comments.
767 It MAY indicate there are zero user-supplied comments, in which case there are
768  no additional fields in the packet.
769 It MUST NOT indicate that there are so many comments that the comment string
770  lengths would require more data than is available in the rest of the packet.
771 <vspace blankLines="1"/>
772 </t>
773 <t><spanx style="strong">User Comment #i String Length</spanx> (32 bits,
774  unsigned, little endian):
775 <vspace blankLines="1"/>
776 This field gives the length of the following user comment string, in octets.
777 There is one for each user comment indicated by the 'user comment list length'
778  field.
779 It MUST NOT indicate that the string is longer than the rest of the packet.
780 <vspace blankLines="1"/>
781 </t>
782 <t><spanx style="strong">User Comment #i String</spanx> (variable length, UTF-8
783  vector):
784 <vspace blankLines="1"/>
785 This field contains a single user comment string.
786 There is one for each user comment indicated by the 'user comment list length'
787  field.
788 </t>
789 </list>
790 </t>
791
792 <t>
793 The user comment strings follow the NAME=value format described by
794  <xref target="vorbis-comment"/> with the same recommended tag names.
795 One new comment tag is introduced for Ogg Opus:
796 <figure align="center">
797 <artwork align="left"><![CDATA[
798 R128_TRACK_GAIN=-573
799 ]]></artwork>
800 </figure>
801 representing the volume shift needed to normalize the track's volume.
802 The gain is a Q7.8 fixed point number in dB, as in the ID header's 'output
803  gain' field.
804 This tag is similar to the REPLAYGAIN_TRACK_GAIN tag in
805  Vorbis&nbsp;<xref target="replay-gain"/>, except that the normal volume
806  reference is the <xref target="EBU-R128"/> standard.
807 </t>
808 <t>
809 An Ogg Opus file MUST NOT have more than one such tag, and if present its
810  value MUST be an integer from -32768 to 32767, inclusive, represented in
811  ASCII with no whitespace.
812 If present, it MUST correctly represent the R128 normalization gain relative
813  to the 'output gain' field specified in the ID header.
814 If a player chooses to make use of the R128_TRACK_GAIN tag, it MUST be
815  applied <spanx style="emph">in addition</spanx> to the 'output gain' value.
816 If an encoder wishes to use R128 normalization, and the output gain is not
817  otherwise constrained or specified, the encoder SHOULD write the R128 gain
818  into the 'output gain' field and store a tag containing "R128_TRACK_GAIN=0".
819 That is, it should assume that by default tools will respect the 'output gain'
820  field, and not the comment tag.
821 If a tool modifies the ID header's 'output gain' field, it MUST also update or
822  remove the R128_TRACK_GAIN comment tag.
823 </t>
824 <t>
825 To avoid confusion with multiple normalization schemes, an Opus comment header
826  SHOULD NOT contain any of the REPLAYGAIN_TRACK_GAIN, REPLAYGAIN_TRACK_PEAK,
827  REPLAYGAIN_ALBUM_GAIN, or REPLAYGAIN_ALBUM_PEAK tags.
828 </t>
829 <t>
830 There is no Opus comment tag corresponding to REPLAYGAIN_ALBUM_GAIN.
831 That information should instead be stored in the ID header's 'output gain'
832  field.
833 </t>
834
835 </section>
836
837 </section>
838
839 <section anchor="other_implementation_notes"
840  title="Other Implementation Notes">
841 <t>
842 When seeking within an Ogg Opus stream, the decoder should start decoding (and
843  discarding the output) at least 3840&nbsp;samples (80&nbsp;ms) prior to the
844  seek point in order to ensure that the output audio is correct at the seek
845  point.
846 </t>
847 <t>
848 Technically valid Opus packets can be arbitrarily large due to the padding
849  format, although the amount of non-padding data they can contain is bounded.
850 These packets might be spread over a similarly enormous number of Ogg pages.
851 Encoders SHOULD use no more padding than required to make a variable bitrate
852  (VBR) stream constant bitrate (CBR).
853 Decoders SHOULD avoid attempting to allocate excessive amounts of memory when
854  presented with a very large packet.
855 The presence of an extremely large packet in the stream could indicate a
856  potential memory exhaustion attack or stream corruption.
857 Decoders SHOULD reject a packet that is too large to process, and display a
858  warning message.
859 </t>
860 <t>
861 In an Ogg Opus stream, the largest possible valid packet that does not use
862  padding has a size of (61,298*N&nbsp;-&nbsp;2) octets, or about 60&nbsp;kB per
863  Opus stream.
864 With 255&nbsp;streams, this is 15,630,988&nbsp;octets (14.9&nbsp;MB) and can
865  span up to 61,298&nbsp;Ogg pages, all but one of which will have a granule
866  position of -1.
867 This is of course a very extreme packet, consisting of 255&nbsp;streams, each
868  containing 120&nbsp;ms of audio encoded as 2.5&nbsp;ms frames, each frame
869  using the maximum possible number of octets (1275) and stored in the least
870  efficient manner allowed (a VBR code&nbsp;3 Opus packet).
871 Even in such a packet, most of the data will be zeros, as 2.5&nbsp;ms frames,
872  which are required to run in the MDCT mode, cannot actually use all
873  1275&nbsp;octets.
874 The largest packet consisting of entirely useful data is
875  (15,326*N&nbsp;-&nbsp;2) octets, or about 15&nbsp;kB per stream.
876 This corresponds to 120&nbsp;ms of audio encoded as 10&nbsp;ms frames in either
877  LP or Hybrid mode, but at a data rate of over 1&nbsp;Mbps, which makes little
878  sense for the quality achieved.
879 A more reasonable limit is (7,664*N&nbsp;-&nbsp;2) octets, or about 7.5&nbsp;kB
880  per stream.
881 This corresponds to 120&nbsp;ms of audio encoded as 20&nbsp;ms stereo MDCT-mode
882  frames, with a total bitrate just under 511&nbsp;kbps (not counting the Ogg
883  encapsulation overhead).
884 With N=8, the maximum number of streams currently defined by mapping
885  family&nbsp;1, this gives a maximum packet size of 61,310&nbsp;octets, or just
886  under 60&nbsp;kB.
887 This is still quite conservative, as it assumes each output channel is taken
888  from one decoded channel of a stereo packet.
889 An implementation could reasonably choose any of these numbers for its internal
890  limits.
891 </t>
892 </section>
893
894 <section anchor="security" title="Security Considerations">
895 <t>
896 Implementations of the Opus codec need to take appropriate security
897  considerations into account, as outlined in <xref target="RFC4732"/>.
898 This is just as much a problem for the container as it is for the codec itself.
899 It is extremely important for the decoder to be robust against malicious
900  payloads.
901 Malicious payloads must not cause the decoder to overrun its allocated memory
902  or to take an excessive amount of resources to decode.
903 Although problems in encoders are typically rarer, the same applies to the
904  encoder.
905 Malicious audio streams must not cause the encoder to misbehave because this
906  would allow an attacker to attack transcoding gateways.
907 </t>
908
909 <t>
910 Like most other container formats, Ogg Opus files should not be used with
911  insecure ciphers or cipher modes that are vulnerable to known-plaintext
912  attacks.
913 Elements such as the Ogg page capture pattern and the magic signatures in the
914  ID header and the comment header all have easily predictable values, in
915  addition to various elements of the codec data itself.
916 </t>
917 </section>
918
919 <section anchor="content_type" title="Content Type">
920 <t>
921 An "Ogg Opus file" consists of one or more sequentially multiplexed segments,
922  each containing exactly one Ogg Opus stream.
923 The RECOMMENDED mime-type for Ogg Opus files is "audio/ogg".
924 When Opus is concurrently multiplexed with other streams in an Ogg container,
925  one SHOULD use one of the "audio/ogg", "video/ogg", or "application/ogg"
926  mime-types, as defined in <xref target="RFC5334"/>.
927 </t>
928
929 <t>
930 If more specificity is desired, one MAY indicate the presence of Opus streams
931  using the codecs parameter defined in <xref target="RFC6381"/>, e.g.,
932 <figure align="center">
933 <artwork align="left"><![CDATA[
934 audio/ogg; codecs=opus
935 ]]></artwork>
936 </figure>
937  for an Ogg Opus file.
938 </t>
939
940 <t>
941 The RECOMMENDED filename extension for Ogg Opus files is '.opus'.
942 </t>
943
944 </section>
945
946 <section title="IANA Considerations">
947 <t>
948 This document has no actions for IANA.
949 </t>
950 </section>
951
952 <section anchor="Acknowledgments" title="Acknowledgments">
953 <t>
954 Thanks to Ralph Giles, Greg Maxwell, Christopher "Monty" Montgomery, and
955  Jean-Marc Valin for their valuable contributions to this document.
956 Additional thanks to Andrew D'Addesio, Ralph Giles, Greg Maxwell, and
957  Vincent Penqeurc'h for their feedback based on early implementations.
958 </t>
959 </section>
960
961 <section title="Copying Conditions">
962 <t>
963 The authors agree to grant third parties the irrevocable right to copy, use,
964  and distribute the work, with or without modification, in any medium, without
965  royalty, provided that, unless separate permission is granted, redistributed
966  modified works do not contain misleading author, version, name of work, or
967  endorsement information.
968 </t>
969 </section>
970
971 </middle>
972 <back>
973 <references title="Normative References">
974
975 <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?>
976 <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.3533.xml"?>
977 <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.5334.xml"?>
978 <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.6381.xml"?>
979
980 <reference anchor="RFCOpus">
981 <front>
982 <title>Definition of the Opus Audio Codec</title>
983 <author initials="JM" surname="Valin" fullname="Jean-Marc Valin"/>
984 <author initials="K." surname="Vos" fullname="Koen Vos"/>
985 <author initials="T.B." surname="Terriberry" fullname="Timothy B. Terriberry"/>
986 </front>
987 <seriesInfo name="RFC" value="XXXX"/>
988 </reference>
989
990 <reference anchor="vorbis-mapping"
991  target="http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">
992 <front>
993 <title>The Vorbis I Specification, Section 4.3.9 Output Channel Order</title>
994 <author initials="C." surname="Montgomery"
995  fullname="Christopher &quot;Monty&quot; Montgomery"/>
996 </front>
997 </reference>
998
999 <reference anchor="vorbis-comment"
1000  target="http://www.xiph.org/vorbis/doc/v-comment.html">
1001 <front>
1002 <title>Ogg Vorbis I Format Specification: Comment Field and Header
1003  Specification</title>
1004 <author initials="C." surname="Montgomery"
1005  fullname="Christopher &quot;Monty&quot; Montgomery"/>
1006 </front>
1007 </reference>
1008
1009 <reference anchor="EBU-R128" target="http://tech.ebu.ch/loudness">
1010 <front>
1011 <title>"Loudness Recommendation EBU R128</title>
1012 <author fullname="EBU Technical Committee"/>
1013 </front>
1014 </reference>
1015
1016 </references>
1017
1018 <references title="Informative References">
1019
1020 <!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.3550.xml"?-->
1021 <?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.4732.xml"?>
1022
1023 <reference anchor="replay-gain"
1024  target="http://wiki.xiph.org/VorbisComment#Replay_Gain">
1025 <front>
1026 <title>VorbisComment: Replay Gain</title>
1027 <author initials="C." surname="Parker" fullname="Conrad Parker"/>
1028 <author initials="M." surname="Leese" fullname="Martin Leese"/>
1029 </front>
1030 </reference>
1031
1032 </references>
1033
1034 </back>
1035 </rfc>