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