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