Update Ralph's phone number.
[opus.git] / doc / draft-ietf-codec-oggopus.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd' [
3 <!ENTITY rfc2119 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.2119.xml'>
4 <!ENTITY rfc3533 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.3533.xml'>
5 <!ENTITY rfc3629 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.3629.xml'>
6 <!ENTITY rfc4732 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.4732.xml'>
7 <!ENTITY rfc5334 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.5334.xml'>
8 <!ENTITY rfc6381 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.6381.xml'>
9 <!ENTITY rfc6716 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.6716.xml'>
10 ]>
11 <?rfc toc="yes" symrefs="yes" ?>
12
13 <rfc ipr="trust200902" category="std" docName="draft-ietf-codec-oggopus-01">
14
15 <front>
16 <title abbrev="Ogg Opus">Ogg Encapsulation for the Opus Audio Codec</title>
17 <author initials="T.B." surname="Terriberry" fullname="Timothy B. Terriberry">
18 <organization>Mozilla Corporation</organization>
19 <address>
20 <postal>
21 <street>650 Castro Street</street>
22 <city>Mountain View</city>
23 <region>CA</region>
24 <code>94041</code>
25 <country>USA</country>
26 </postal>
27 <phone>+1 650 903-0800</phone>
28 <email>tterribe@xiph.org</email>
29 </address>
30 </author>
31
32 <author initials="R." surname="Lee" fullname="Ron Lee">
33 <organization>Voicetronix</organization>
34 <address>
35 <postal>
36 <street>246 Pulteney Street, Level 1</street>
37 <city>Adelaide</city>
38 <region>SA</region>
39 <code>5000</code>
40 <country>Australia</country>
41 </postal>
42 <phone>+61 8 8232 9112</phone>
43 <email>ron@debian.org</email>
44 </address>
45 </author>
46
47 <author initials="R." surname="Giles" fullname="Ralph Giles">
48 <organization>Mozilla Corporation</organization>
49 <address>
50 <postal>
51 <street>163 West Hastings Street</street>
52 <city>Vancouver</city>
53 <region>BC</region>
54 <code>V6B 1H5</code>
55 <country>Canada</country>
56 </postal>
57 <phone>+1 778 785 1540</phone>
58 <email>giles@xiph.org</email>
59 </address>
60 </author>
61
62 <date day="24" month="May" year="2013"/>
63 <area>RAI</area>
64 <workgroup>codec</workgroup>
65
66 <abstract>
67 <t>
68 This document defines the Ogg encapsulation for the Opus interactive speech and
69  audio codec.
70 This allows data encoded in the Opus format to be stored in an Ogg logical
71  bitstream.
72 Ogg encapsulation provides Opus with a long-term storage format supporting
73  all of the essential features, including metadata, fast and accurate seeking,
74  corruption detection, recapture after errors, low overhead, and the ability to
75  multiplex Opus with other codecs (including video) with minimal buffering.
76 It also provides a live streamable format, capable of delivery over a reliable
77  stream-oriented transport, without requiring all the data, or even the total
78  length of the data, up-front, in a form that is identical to the on-disk
79  storage format.
80 </t>
81 </abstract>
82 </front>
83
84 <middle>
85 <section anchor="intro" title="Introduction">
86 <t>
87 The IETF Opus codec is a low-latency audio codec optimized for both voice and
88  general-purpose audio.
89 See <xref target="RFC6716"/> for technical details.
90 This document defines the encapsulation of Opus in a continuous, logical Ogg
91  bitstream&nbsp;<xref target="RFC3533"/>.
92 </t>
93 <t>
94 Ogg bitstreams are made up of a series of 'pages', each of which contains data
95  from one or more 'packets'.
96 Pages are the fundamental unit of multiplexing in an Ogg stream.
97 Each page is associated with a particular logical stream and contains a capture
98  pattern and checksum, flags to mark the beginning and end of the logical
99  stream, and a 'granule position' that represents an absolute position in the
100  stream, to aid seeking.
101 A single page can contain up to 65,025 octets of packet data from up to 255
102  different packets.
103 Packets may be split arbitrarily across pages, and continued from one page to
104  the next (allowing packets much larger than would fit on a single page).
105 Each page contains 'lacing values' that indicate how the data is partitioned
106  into packets, allowing a demuxer to recover the packet boundaries without
107  examining the encoded data.
108 A packet is said to 'complete' on a page when the page contains the final
109  lacing value corresponding to that packet.
110 </t>
111 <t>
112 This encapsulation defines the required contents of the packet data, including
113  the necessary headers, the organization of those packets into a logical
114  stream, and the interpretation of the codec-specific granule position field.
115 It does not attempt to describe or specify the existing Ogg container format.
116 Readers unfamiliar with the basic concepts mentioned above are encouraged to
117  review the details in <xref target="RFC3533"/>.
118 </t>
119
120 </section>
121
122 <section anchor="terminology" title="Terminology">
123 <t>
124 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
125  "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
126  interpreted as described in <xref target="RFC2119"/>.
127 </t>
128
129 <t>
130 Implementations that fail to satisfy one or more "MUST" requirements are
131  considered non-compliant.
132 Implementations that satisfy all "MUST" requirements, but fail to satisfy one
133  or more "SHOULD" requirements are said to be "conditionally compliant".
134 All other implementations are "unconditionally compliant".
135 </t>
136
137 </section>
138
139 <section anchor="packet_organization" title="Packet Organization">
140 <t>
141 An Opus stream is organized as follows.
142 </t>
143 <t>
144 There are two mandatory header packets.
145 The granule position of the pages on which these packets complete MUST be zero.
146 </t>
147 <t>
148 The first packet in the logical Ogg bitstream MUST contain the identification
149  (ID) header, which uniquely identifies a stream as Opus audio.
150 The format of this header is defined in <xref target="id_header"/>.
151 It MUST be placed alone (without any other packet data) on the first page of
152  the logical Ogg bitstream, and must complete on that page.
153 This page MUST have its 'beginning of stream' flag set.
154 </t>
155 <t>
156 The second packet in the logical Ogg bitstream MUST contain the comment header,
157  which contains user-supplied metadata.
158 The format of this header is defined in <xref target="comment_header"/>.
159 It MAY span one or more pages, beginning on the second page of the logical
160  stream.
161 However many pages it spans, the comment header packet MUST finish the page on
162  which it completes.
163 </t>
164 <t>
165 All subsequent pages are audio data pages, and the Ogg packets they contain are
166  audio data packets.
167 Each audio data packet contains one Opus packet for each of N different
168  streams, where N is typically one for mono or stereo, but may be greater than
169  one for, e.g., multichannel audio.
170 The value N is specified in the ID header (see
171  <xref target="channel_mapping"/>), and is fixed over the entire length of the
172  logical Ogg bitstream.
173 </t>
174 <t>
175 The first N-1 Opus packets, if any, are packed one after another into the Ogg
176  packet, using the self-delimiting framing from Appendix&nbsp;B of
177  <xref target="RFC6716"/>.
178 The remaining Opus packet is packed at the end of the Ogg packet using the
179  regular, undelimited framing from Section&nbsp;3 of <xref target="RFC6716"/>.
180 All of the Opus packets in a single Ogg packet MUST be constrained to have the
181  same duration.
182 The duration and coding modes of each Opus packet are contained in the
183  TOC (table of contents) sequence in the first few bytes.
184 A decoder SHOULD treat any Opus packet whose duration is different from that of
185  the first Opus packet in an Ogg packet as if it were an Opus packet with an
186  illegal TOC sequence.
187 </t>
188 <t>
189 The first audio data page SHOULD NOT have the 'continued packet' flag set
190  (which would indicate the first audio data packet is continued from a previous
191  page).
192 Packets MUST be placed into Ogg pages in order until the end of stream.
193 Audio packets MAY span page boundaries.
194 A decoder MUST treat a zero-octet audio data packet as if it were an Opus
195  packet with an illegal TOC sequence.
196 The last page SHOULD have the 'end of stream' flag set, but implementations
197  should be prepared to deal with truncated streams that do not have a page
198  marked 'end of stream'.
199 The final packet on the last page SHOULD NOT be a continued packet, i.e., the
200  final lacing value should be less than 255.
201 There MUST NOT be any more pages in an Opus logical bitstream after a page
202  marked 'end of stream'.
203 </t>
204 </section>
205
206 <section anchor="granpos" title="Granule Position">
207 <t>
208 The granule position of an audio data page encodes the total number of PCM
209  samples in the stream up to and including the last fully-decodable sample from
210  the last packet completed on that page.
211 A page that is entirely spanned by a single packet (that completes on a
212  subsequent page) has no granule position, and the granule position field MUST
213  be set to the special value '-1' in two's complement.
214 </t>
215
216 <t>
217 The granule position of an audio data page is in units of PCM audio samples at
218  a fixed rate of 48&nbsp;kHz (per channel; a stereo stream's granule position
219  does not increment at twice the speed of a mono stream).
220 It is possible to run an Opus decoder at other sampling rates, but the value
221  in the granule position field always counts samples assuming a 48&nbsp;kHz
222  decoding rate, and the rest of this specification makes the same assumption.
223 </t>
224
225 <t>
226 The duration of an Opus packet may be any multiple of 2.5&nbsp;ms, up to a
227  maximum of 120&nbsp;ms.
228 This duration is encoded in the TOC sequence at the beginning of each packet.
229 The number of samples returned by a decoder corresponds to this duration
230  exactly, even for the first few packets.
231 For example, a 20&nbsp;ms packet fed to a decoder running at 48&nbsp;kHz will
232  always return 960&nbsp;samples.
233 A demuxer can parse the TOC sequence at the beginning of each Ogg packet to
234  work backwards or forwards from a packet with a known granule position (i.e.,
235  the last packet completed on some page) in order to assign granule positions
236  to every packet, or even every individual sample.
237 The one exception is the last page in the stream, as described below.
238 </t>
239
240 <t>
241 All other pages with completed packets after the first MUST have a granule
242  position equal to the number of samples contained in packets that complete on
243  that page plus the granule position of the most recent page with completed
244  packets.
245 This guarantees that a demuxer can assign individual packets the same granule
246  position when working forwards as when working backwards.
247 For this to work, there cannot be any gaps.
248 </t>
249
250 <section anchor="gap-repair" title="Repairing Gaps in Real-time Streams">
251 <t>
252 In order to support capturing a real-time stream that has lost or not
253  transmitted packets, a muxer SHOULD emit packets that explicitly request the
254  use of Packet Loss Concealment (PLC) in place of the missing packets.
255 Only gaps that are a multiple of 2.5&nbsp;ms are repairable, as these are the
256  only durations that can be created by packet loss or discontinuous
257  transmission.
258 Muxers need not handle other gap sizes.
259 Creating the necessary packets involves synthesizing a TOC byte (defined in
260 Section&nbsp;3.1 of&nbsp;<xref target="RFC6716"/>)&mdash;and whatever
261  additional internal framing is needed&mdash;to indicate the packet duration
262  for each stream.
263 The actual length of each missing Opus frame inside the packet is zero bytes,
264  as defined in Section&nbsp;3.2.1 of&nbsp;<xref target="RFC6716"/>.
265 </t>
266
267 <t>
268 <xref target="RFC6716"/> does not impose any requirements on the PLC, but this
269  section outlines choices that are expected to have a positive influence on
270  most PLC implementations, including the reference implementation.
271 Where possible, synthesized TOC bytes MAY use the same mode, audio bandwidth,
272  channel count, and frame size as the previous packet (if any).
273 This is the simplest and usually the most well-tested case for the PLC to
274  handle and it covers all losses that do not include a configuration switch,
275  as defined in Section&nbsp;4.5 of&nbsp;<xref target="RFC6716"/>.
276 </t>
277
278 <t>
279 When a previous packet is available, keeping the audio bandwidth and channel
280  count the same allows the PLC to provide maximum continuity in the concealment
281  data it generates.
282 However, if the size of the gap is not a multiple of the most recent frame
283  size, then the frame size will have to change for at least some frames.
284 Delaying such changes as long as possible simplifies things for PLC
285  implementations.
286 </t>
287
288 <t>
289 As an example, a 95&nbsp;ms gap could be encoded as nineteen 5&nbsp;ms frames
290  in two bytes with a single CBR code&nbsp;3 packet.
291 If the previous frame size was 20&nbsp;ms, using four 20&nbsp;ms frames
292  followed by three 5&nbsp;ms frames requires 4&nbsp;bytes (plus an extra byte
293  of Ogg lacing overhead), but allows the PLC to use its well-tested steady
294  state behavior for as long as possible.
295 The total bitrate of the latter approach, including Ogg overhead, is about
296  0.4&nbsp;kbps, so the impact on file size is minimal.
297 </t>
298
299 <t>
300 Changing modes is discouraged, since this causes some decoder implementations
301  to reset their PLC state.
302 However, SILK and Hybrid modes cannot fill gaps that are not a multiple of
303  10&nbsp;ms.
304 If switching to CELT mode is needed to match the gap size, doing so at the end
305  of the gap allows the PLC to function for as long as possible.
306 Thus in the above example, if the previous frame was a 20&nbsp;ms SILK mode
307  frame, a better solution would be to synthesize a packet describing four
308  20&nbsp;ms SILK frames, followed by a packet with a single 10&nbsp;ms SILK
309  frame, and finally a packet with a 5&nbsp;ms CELT frame, to fill the 95&nbsp;ms
310  gap.
311 This also requires four bytes to describe the synthesized packet data (two
312  bytes for a CBR code 3 and one byte each for two code 0 packets) but requires
313  three bytes of Ogg lacing overhead to mark the packet boundaries.
314 At 0.6 kbps this is still a minimal bitrate impact over a naive, low quality
315  solution.
316 </t>
317
318 <t>
319 Since CELT does not support medium-band audio, using wideband when switching
320  from medium-band SILK ensures that any PLC implementation that does try to
321  migrate state between the modes will not be forced to artificially reduce the
322  bandwidth.
323 </t>
324
325 <t>
326 The synthetic TOC byte MAY use any of codes&nbsp;0, 1, 2, or&nbsp;3 to pack the
327  frame(s) into a packet.
328 If the TOC configuration matches, the muxer MAY combine the empty frames with
329  previous or subsequent non-zero-length frames (using code&nbsp;2 or
330  VBR code&nbsp;3).
331 </t>
332 </section>
333
334 <section anchor="preskip" title="Pre-skip">
335 <t>
336 There is some amount of latency introduced during the decoding process, to
337  allow for overlap in the MDCT modes, stereo mixing in the LP modes, and
338  resampling, and the encoder will introduce even more latency (though the exact
339  amount is not specified).
340 Therefore, the first few samples produced by the decoder do not correspond to
341  real input audio, but are instead composed of padding inserted by the encoder
342  to compensate for this latency.
343 These samples need to be stored and decoded, as Opus is an asymptotically
344  convergent predictive codec, meaning the decoded contents of each frame depend
345  on the recent history of decoder inputs.
346 However, a decoder will want to skip these samples after decoding them.
347 </t>
348
349 <t>
350 A 'pre-skip' field in the ID header (see <xref target="id_header"/>) signals
351  the number of samples which SHOULD be skipped (decoded but discarded) at the
352  beginning of the stream.
353 This provides sufficient history to the decoder so that it has already
354  converged before the stream's output begins.
355 It may also be used to perform sample-accurate cropping of existing encoded
356  streams.
357 This amount need not be a multiple of 2.5&nbsp;ms, may be smaller than a single
358  packet, or may span the contents of several packets.
359 </t>
360 </section>
361
362 <section anchor="pcm_sample_position" title="PCM Sample Position">
363 <t>
364 The PCM sample position is determined from the granule position using the
365  formula
366 <figure align="center">
367 <artwork align="center"><![CDATA[
368 'PCM sample position' = 'granule position' - 'pre-skip' .
369 ]]></artwork>
370 </figure>
371 </t>
372
373 <t>
374 For example, if the granule position of the first audio data page is 59,971,
375  and the pre-skip is 11,971, then the PCM sample position of the last decoded
376  sample from that page is 48,000.
377 This can be converted into a playback time using the formula
378 <figure align="center">
379 <artwork align="center"><![CDATA[
380                   'PCM sample position'
381 'playback time' = --------------------- .
382                          48000.0
383 ]]></artwork>
384 </figure>
385 </t>
386
387 <t>
388 The initial PCM sample position before any samples are played is normally '0'.
389 In this case, the PCM sample position of the first audio sample to be played
390  starts at '1', because it marks the time on the clock
391  <spanx style="emph">after</spanx> that sample has been played, and a stream
392  that is exactly one second long has a final PCM sample position of '48000',
393  as in the example here.
394 </t>
395
396 <t>
397 Vorbis streams use a granule position smaller than the number of audio samples
398  contained in the first audio data page to indicate that some of those samples
399  must be trimmed from the output (see <xref target="vorbis-trim"/>).
400 However, to do so, Vorbis requires that the first audio data page contains
401  exactly two packets, in order to allow the decoder to perform PCM position
402  adjustments before needing to return any PCM data.
403 Opus uses the pre-skip mechanism for this purpose instead, since the encoder
404  may introduce more than a single packet's worth of latency, and since very
405  large packets in streams with a very large number of channels might not fit
406  on a single page.
407 </t>
408 </section>
409
410 <section anchor="end_trimming" title="End Trimming">
411 <t>
412 The page with the 'end of stream' flag set MAY have a granule position that
413  indicates the page contains less audio data than would normally be returned by
414  decoding up through the final packet.
415 This is used to end the stream somewhere other than an even frame boundary.
416 The granule position of the most recent audio data page with completed packets
417  is used to make this determination, or '0' is used if there were no previous
418  audio data pages with a completed packet.
419 The difference between these granule positions indicates how many samples to
420  keep after decoding the packets that completed on the final page.
421 The remaining samples are discarded.
422 The number of discarded samples SHOULD be no larger than the number decoded
423  from the last packet.
424 </t>
425 </section>
426
427 <section anchor="start_granpos_restrictions"
428  title="Restrictions on the Initial Granule Position">
429 <t>
430 The granule position of the first audio data page with a completed packet MAY
431  be larger than the number of samples contained in packets that complete on
432  that page, however it MUST NOT be smaller, unless that page has the 'end of
433  stream' flag set.
434 Allowing a granule position larger than the number of samples allows the
435  beginning of a stream to be cropped or a live stream to be joined without
436  rewriting the granule position of all the remaining pages.
437 This means that the PCM sample position just before the first sample to be
438  played may be larger than '0'.
439 Synchronization when multiplexing with other logical streams still uses the PCM
440  sample position relative to '0' to compute sample times.
441 This does not affect the behavior of pre-skip: exactly 'pre-skip' samples
442  should be skipped from the beginning of the decoded output, even if the
443  initial PCM sample position is greater than zero.
444 </t>
445
446 <t>
447 On the other hand, a granule position that is smaller than the number of
448  decoded samples prevents a demuxer from working backwards to assign each
449  packet or each individual sample a valid granule position, since granule
450  positions must be non-negative.
451 A decoder MUST reject as invalid any stream where the granule position is
452  smaller than the number of samples contained in packets that complete on the
453  first audio data page with a completed packet, unless that page has the 'end
454  of stream' flag set.
455 It MAY defer this action until it decodes the last packet completed on that
456  page.
457 </t>
458
459 <t>
460 If that page has the 'end of stream' flag set, a demuxer MUST reject as invalid
461  any stream where its granule position is smaller than the 'pre-skip' amount.
462 This would indicate that more samples should be skipped from the initial
463  decoded output than exist in the stream.
464 If the granule position is smaller than the number of decoded samples produced
465  by the packets that complete on that page, then a demuxer MUST use an initial
466  granule position of '0', and can work forwards from '0' to timestamp
467  individual packets.
468 If the granule position is larger than the number of decoded samples available,
469  then the demuxer MUST still work backwards as described above, even if the
470  'end of stream' flag is set, to determine the initial granule position, and
471  thus the initial PCM sample position.
472 Both of these will be greater than '0' in this case.
473 </t>
474 </section>
475
476 <section anchor="seeking_and_preroll" title="Seeking and Pre-roll">
477 <t>
478 Seeking in Ogg files is best performed using a bisection search for a page
479  whose granule position corresponds to a PCM position at or before the seek
480  target.
481 With appropriately weighted bisection, accurate seeking can be performed with
482  just three or four bisections even in multi-gigabyte files.
483 See <xref target="seeking"/> for general implementation guidance.
484 </t>
485
486 <t>
487 When seeking within an Ogg Opus stream, the decoder SHOULD start decoding (and
488  discarding the output) at least 3840&nbsp;samples (80&nbsp;ms) prior to the
489  seek target in order to ensure that the output audio is correct by the time it
490  reaches the seek target.
491 This 'pre-roll' is separate from, and unrelated to, the 'pre-skip' used at the
492  beginning of the stream.
493 If the point 80&nbsp;ms prior to the seek target comes before the initial PCM
494  sample position, the decoder SHOULD start decoding from the beginning of the
495  stream, applying pre-skip as normal, regardless of whether the pre-skip is
496  larger or smaller than 80&nbsp;ms, and then continue to discard the samples
497  required to reach the seek target (if any).
498 </t>
499 </section>
500
501 </section>
502
503 <section anchor="headers" title="Header Packets">
504 <t>
505 An Opus stream contains exactly two mandatory header packets:
506  an identification header and a comment header.
507 </t>
508
509 <section anchor="id_header" title="Identification Header">
510
511 <figure anchor="id_header_packet" title="ID Header Packet" align="center">
512 <artwork align="center"><![CDATA[
513  0                   1                   2                   3
514  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
515 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
516 |      'O'      |      'p'      |      'u'      |      's'      |
517 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
518 |      'H'      |      'e'      |      'a'      |      'd'      |
519 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
520 |  Version = 1  | Channel Count |           Pre-skip            |
521 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
522 |                     Input Sample Rate (Hz)                    |
523 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
524 |   Output Gain (Q7.8 in dB)    | Mapping Family|               |
525 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+               :
526 |                                                               |
527 :               Optional Channel Mapping Table...               :
528 |                                                               |
529 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
530 ]]></artwork>
531 </figure>
532
533 <t>
534 The fields in the identification (ID) header have the following meaning:
535 <list style="numbers">
536 <t><spanx style="strong">Magic Signature</spanx>:
537 <vspace blankLines="1"/>
538 This is an 8-octet (64-bit) field that allows codec identification and is
539  human-readable.
540 It contains, in order, the magic numbers:
541 <list style="empty">
542 <t>0x4F 'O'</t>
543 <t>0x70 'p'</t>
544 <t>0x75 'u'</t>
545 <t>0x73 's'</t>
546 <t>0x48 'H'</t>
547 <t>0x65 'e'</t>
548 <t>0x61 'a'</t>
549 <t>0x64 'd'</t>
550 </list>
551 Starting with "Op" helps distinguish it from audio data packets, as this is an
552  invalid TOC sequence.
553 <vspace blankLines="1"/>
554 </t>
555 <t><spanx style="strong">Version</spanx> (8 bits, unsigned):
556 <vspace blankLines="1"/>
557 The version number MUST always be '1' for this version of the encapsulation
558  specification.
559 Implementations SHOULD treat streams where the upper four bits of the version
560  number match that of a recognized specification as backwards-compatible with
561  that specification.
562 That is, the version number can be split into "major" and "minor" version
563  sub-fields, with changes to the "minor" sub-field (in the lower four bits)
564  signaling compatible changes.
565 For example, a decoder implementing this specification SHOULD accept any stream
566  with a version number of '15' or less, and SHOULD assume any stream with a
567  version number '16' or greater is incompatible.
568 The initial version '1' was chosen to keep implementations from relying on this
569  octet as a null terminator for the "OpusHead" string.
570 <vspace blankLines="1"/>
571 </t>
572 <t><spanx style="strong">Output Channel Count</spanx> 'C' (8 bits, unsigned):
573 <vspace blankLines="1"/>
574 This is the number of output channels.
575 This might be different than the number of encoded channels, which can change
576  on a packet-by-packet basis.
577 This value MUST NOT be zero.
578 The maximum allowable value depends on the channel mapping family, and might be
579  as large as 255.
580 See <xref target="channel_mapping"/> for details.
581 <vspace blankLines="1"/>
582 </t>
583 <t><spanx style="strong">Pre-skip</spanx> (16 bits, unsigned, little
584  endian):
585 <vspace blankLines="1"/>
586 This is the number of samples (at 48&nbsp;kHz) to discard from the decoder
587  output when starting playback, and also the number to subtract from a page's
588  granule position to calculate its PCM sample position.
589 When cropping the beginning of existing Ogg Opus streams, a pre-skip of at
590  least 3,840&nbsp;samples (80&nbsp;ms) is RECOMMENDED to ensure complete
591  convergence in the decoder.
592 <vspace blankLines="1"/>
593 </t>
594 <t><spanx style="strong">Input Sample Rate</spanx> (32 bits, unsigned, little
595  endian):
596 <vspace blankLines="1"/>
597 This field is <spanx style="emph">not</spanx> the sample rate to use for
598  playback of the encoded data.
599 <vspace blankLines="1"/>
600 Opus has a handful of coding modes, with internal audio bandwidths of 4, 6, 8,
601  12, and 20&nbsp;kHz.
602 Each packet in the stream may have a different audio bandwidth.
603 Regardless of the audio bandwidth, the reference decoder supports decoding any
604  stream at a sample rate of 8, 12, 16, 24, or 48&nbsp;kHz.
605 The original sample rate of the encoder input is not preserved by the lossy
606  compression.
607 <vspace blankLines="1"/>
608 An Ogg Opus player SHOULD select the playback sample rate according to the
609  following procedure:
610 <list style="numbers">
611 <t>If the hardware supports 48&nbsp;kHz playback, decode at 48&nbsp;kHz.</t>
612 <t>Otherwise, if the hardware's highest available sample rate is a supported
613  rate, decode at this sample rate.</t>
614 <t>Otherwise, if the hardware's highest available sample rate is less than
615  48&nbsp;kHz, decode at the highest supported rate above this and resample.</t>
616 <t>Otherwise, decode at 48&nbsp;kHz and resample.</t>
617 </list>
618 However, the 'Input Sample Rate' field allows the encoder to pass the sample
619  rate of the original input stream as metadata.
620 This may be useful when the user requires the output sample rate to match the
621  input sample rate.
622 For example, a non-player decoder writing PCM format samples to disk might
623  choose to resample the output audio back to the original input sample rate to
624  reduce surprise to the user, who might reasonably expect to get back a file
625  with the same sample rate as the one they fed to the encoder.
626 <vspace blankLines="1"/>
627 A value of zero indicates 'unspecified'.
628 Encoders SHOULD write the actual input sample rate or zero, but decoder
629  implementations which do something with this field SHOULD take care to behave
630  sanely if given crazy values (e.g., do not actually upsample the output to
631  10 MHz if requested).
632 <vspace blankLines="1"/>
633 </t>
634 <t><spanx style="strong">Output Gain</spanx> (16 bits, signed, little
635  endian):
636 <vspace blankLines="1"/>
637 This is a gain to be applied by the decoder.
638 It is 20*log10 of the factor to scale the decoder output by to achieve the
639  desired playback volume, stored in a 16-bit, signed, two's complement
640  fixed-point value with 8 fractional bits (i.e., Q7.8).
641 To apply the gain, a decoder could use
642 <figure align="center">
643 <artwork align="center"><![CDATA[
644 sample *= pow(10, output_gain/(20.0*256)) ,
645 ]]></artwork>
646 </figure>
647  where output_gain is the raw 16-bit value from the header.
648 <vspace blankLines="1"/>
649 Virtually all players and media frameworks should apply it by default.
650 If a player chooses to apply any volume adjustment or gain modification, such
651  as the R128_TRACK_GAIN (see <xref target="comment_header"/>) or a user-facing
652  volume knob, the adjustment MUST be applied in addition to this output gain in
653  order to achieve playback at the desired volume.
654 <vspace blankLines="1"/>
655 An encoder SHOULD set this field to zero, and instead apply any gain prior to
656  encoding, when this is possible and does not conflict with the user's wishes.
657 The output gain should only be nonzero when the gain is adjusted after
658  encoding, or when the user wishes to adjust the gain for playback while
659  preserving the ability to recover the original signal amplitude.
660 <vspace blankLines="1"/>
661 Although the output gain has enormous range (+/- 128 dB, enough to amplify
662  inaudible sounds to the threshold of physical pain), most applications can
663  only reasonably use a small portion of this range around zero.
664 The large range serves in part to ensure that gain can always be losslessly
665  transferred between OpusHead and R128_TRACK_GAIN (see below) without
666  saturating.
667 <vspace blankLines="1"/>
668 </t>
669 <t><spanx style="strong">Channel Mapping Family</spanx> (8 bits,
670  unsigned):
671 <vspace blankLines="1"/>
672 This octet indicates the order and semantic meaning of the various channels
673  encoded in each Ogg packet.
674 <vspace blankLines="1"/>
675 Each possible value of this octet indicates a mapping family, which defines a
676  set of allowed channel counts, and the ordered set of channel names for each
677  allowed channel count.
678 The details are described in <xref target="channel_mapping"/>.
679 </t>
680 <t><spanx style="strong">Channel Mapping Table</spanx>:
681 This table defines the mapping from encoded streams to output channels.
682 It is omitted when the channel mapping family is 0, but REQUIRED otherwise.
683 Its contents are specified in <xref target="channel_mapping"/>.
684 </t>
685 </list>
686 </t>
687
688 <t>
689 All fields in the ID headers are REQUIRED, except for the channel mapping
690  table, which is omitted when the channel mapping family is 0.
691 Implementations SHOULD reject ID headers which do not contain enough data for
692  these fields, even if they contain a valid Magic Signature.
693 Future versions of this specification, even backwards-compatible versions,
694  might include additional fields in the ID header.
695 If an ID header has a compatible major version, but a larger minor version,
696  an implementation MUST NOT reject it for containing additional data not
697  specified here.
698 However, implementations MAY reject streams in which the ID header does not
699  complete on the first page.
700 </t>
701
702 <section anchor="channel_mapping" title="Channel Mapping">
703 <t>
704 An Ogg Opus stream allows mapping one number of Opus streams (N) to a possibly
705  larger number of decoded channels (M+N) to yet another number of output
706  channels (C), which might be larger or smaller than the number of decoded
707  channels.
708 The order and meaning of these channels are defined by a channel mapping,
709  which consists of the 'channel mapping family' octet and, for channel mapping
710  families other than family&nbsp;0, a channel mapping table, as illustrated in
711  <xref target="channel_mapping_table"/>.
712 </t>
713
714 <figure anchor="channel_mapping_table" title="Channel Mapping Table"
715  align="center">
716 <artwork align="center"><![CDATA[
717  0                   1                   2                   3
718  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
719                                                 +-+-+-+-+-+-+-+-+
720                                                 | Stream Count  |
721 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
722 | Coupled Count |              Channel Mapping...               :
723 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
724 ]]></artwork>
725 </figure>
726
727 <t>
728 The fields in the channel mapping table have the following meaning:
729 <list style="numbers" counter="8">
730 <t><spanx style="strong">Stream Count</spanx> 'N' (8 bits, unsigned):
731 <vspace blankLines="1"/>
732 This is the total number of streams encoded in each Ogg packet.
733 This value is required to correctly parse the packed Opus packets inside an
734  Ogg packet, as described in <xref target="packet_organization"/>.
735 This value MUST NOT be zero, as without at least one Opus packet with a valid
736  TOC sequence, a demuxer cannot recover the duration of an Ogg packet.
737 <vspace blankLines="1"/>
738 For channel mapping family&nbsp;0, this value defaults to 1, and is not coded.
739 <vspace blankLines="1"/>
740 </t>
741 <t><spanx style="strong">Coupled Stream Count</spanx> 'M' (8 bits, unsigned):
742 This is the number of streams whose decoders should be configured to produce
743  two channels.
744 This MUST be no larger than the total number of streams, N.
745 <vspace blankLines="1"/>
746 Each packet in an Opus stream has an internal channel count of 1 or 2, which
747  can change from packet to packet.
748 This is selected by the encoder depending on the bitrate and the audio being
749  encoded.
750 The original channel count of the encoder input is not preserved by the lossy
751  compression.
752 <vspace blankLines="1"/>
753 Regardless of the internal channel count, any Opus stream can be decoded as
754  mono (a single channel) or stereo (two channels) by appropriate initialization
755  of the decoder.
756 The 'coupled stream count' field indicates that the first M Opus decoders are
757  to be initialized in stereo mode, and the remaining N-M decoders are to be
758  initialized in mono mode.
759 The total number of decoded channels, (M+N), MUST be no larger than 255, as
760  there is no way to index more channels than that in the channel mapping.
761 <vspace blankLines="1"/>
762 For channel mapping family&nbsp;0, this value defaults to C-1 (i.e., 0 for mono
763  and 1 for stereo), and is not coded.
764 <vspace blankLines="1"/>
765 </t>
766 <t><spanx style="strong">Channel Mapping</spanx> (8*C bits):
767 This contains one octet per output channel, indicating which decoded channel
768  should be used for each one.
769 Let 'index' be the value of this octet for a particular output channel.
770 This value MUST either be smaller than (M+N), or be the special value 255.
771 If 'index' is less than 2*M, the output MUST be taken from decoding stream
772  ('index'/2) as stereo and selecting the left channel if 'index' is even, and
773  the right channel if 'index' is odd.
774 If 'index' is 2*M or larger, the output MUST be taken from decoding stream
775  ('index'-M) as mono.
776 If 'index' is 255, the corresponding output channel MUST contain pure silence.
777 <vspace blankLines="1"/>
778 The number of output channels, C, is not constrained to match the number of
779  decoded channels (M+N).
780 A single index value MAY appear multiple times, i.e., the same decoded channel
781  might be mapped to multiple output channels.
782 Some decoded channels might not be assigned to any output channel, as well.
783 <vspace blankLines="1"/>
784 For channel mapping family&nbsp;0, the first index defaults to 0, and if C==2,
785  the second index defaults to 1.
786 Neither index is coded.
787 </t>
788 </list>
789 </t>
790
791 <t>
792 After producing the output channels, the channel mapping family determines the
793  semantic meaning of each one.
794 Currently there are three defined mapping families, although more may be added.
795 </t>
796
797 <section anchor="channel_mapping_0" title="Channel Mapping Family 0">
798 <t>
799 Allowed numbers of channels: 1 or 2.
800 RTP mapping.
801 </t>
802 <t>
803 <list style="symbols">
804 <t>1 channel: monophonic (mono).</t>
805 <t>2 channels: stereo (left, right).</t>
806 </list>
807 <spanx style="strong">Special mapping</spanx>: This channel mapping value also
808  indicates that the contents consists of a single Opus stream that is stereo if
809  and only if C==2, with stream index 0 mapped to output channel 0 (mono, or
810  left channel) and stream index 1 mapped to output channel 1 (right channel)
811  if stereo.
812 When the 'channel mapping family' octet has this value, the channel mapping
813  table MUST be omitted from the ID header packet.
814 </t>
815 </section>
816
817 <section anchor="channel_mapping_1" title="Channel Mapping Family 1">
818 <t>
819 Allowed numbers of channels: 1...8.
820 Vorbis channel order.
821 </t>
822 <t>
823 Each channel is assigned to a speaker location in a conventional surround
824  configuration.
825 Specific locations depend on the number of channels, and are given below
826  in order of the corresponding channel indicies.
827 <list style="symbols">
828   <t>1 channel: monophonic (mono).</t>
829   <t>2 channels: stereo (left, right).</t>
830   <t>3 channels: linear surround (left, center, right)</t>
831   <t>4 channels: quadraphonic (front&nbsp;left, front&nbsp;right, rear&nbsp;left, rear&nbsp;right).</t>
832   <t>5 channels: 5.0 surround (front&nbsp;left, front&nbsp;center, front&nbsp;right, rear&nbsp;left, rear&nbsp;right).</t>
833   <t>6 channels: 5.1 surround (front&nbsp;left, front&nbsp;center, front&nbsp;right, rear&nbsp;left, rear&nbsp;right, LFE).</t>
834   <t>7 channels: 6.1 surround (front&nbsp;left, front&nbsp;center, front&nbsp;right, side&nbsp;left, side&nbsp;right, rear&nbsp;center, LFE).</t>
835   <t>8 channels: 7.1 surround (front&nbsp;left, front&nbsp;center, front&nbsp;right, side&nbsp;left, side&nbsp;right, rear&nbsp;left, rear&nbsp;right, LFE)</t>
836 </list>
837 This set of surround configurations and speaker location orderings is the same
838  as the one used by the Vorbis codec <xref target="vorbis-mapping"/>.
839 The ordering is different from the one used by the
840  WAVE <xref target="wave-multichannel"/> and
841  FLAC <xref target="flac"/> formats,
842  so correct ordering requires permutation of the output channels when encoding
843  from or decoding to those formats.
844 'LFE' here refers to a Low Frequency Effects, often mapped to a subwoofer
845  with no particular spacial position.
846 Implementations SHOULD identify 'side' or 'rear' speaker locations with
847  'surround' and 'back' as appropriate when interfacing with audio formats
848  or systems which prefer that terminology.
849 Speaker configurations other than those described here are not supported.
850 </t>
851 </section>
852
853 <section anchor="channel_mapping_255"
854  title="Channel Mapping Family 255">
855 <t>
856 Allowed numbers of channels: 1...255.
857 No defined channel meaning.
858 </t>
859 <t>
860 Channels are unidentified.
861 General-purpose players SHOULD NOT attempt to play these streams, and offline
862  decoders MAY deinterleave the output into separate PCM files, one per channel.
863 Decoders SHOULD NOT produce output for channels mapped to stream index 255
864  (pure silence) unless they have no other way to indicate the index of
865  non-silent channels.
866 </t>
867 </section>
868
869 <section anchor="channel_mapping_undefined"
870  title="Undefined Channel Mappings">
871 <t>
872 The remaining channel mapping families (2...254) are reserved.
873 A decoder encountering a reserved channel mapping family value SHOULD act as
874  though the value is 255.
875 </t>
876 </section>
877
878 <section anchor="downmix" title="Downmixing">
879 <t>
880 An Ogg Opus player MUST play any Ogg Opus stream with a channel mapping family
881  of 0 or 1, even if the number of channels does not match the physically
882  connected audio hardware.
883 Players SHOULD perform channel mixing to increase or reduce the number of
884  channels as needed.
885 </t>
886
887 <t>
888 Implementations MAY use the following matricies to implement downmixing from
889  multichannel files using <xref target="channel_mapping_1">Channel Mapping
890  Family 1</xref>, which are known to give acceptable results for stereo.
891 Matricies for 3 and 4 channels are normalized so each coefficent row sums
892  to 1 to avoid clipping.
893 For 5 or more channels they are normalized to 2 as a compromize between
894  clipping and dynamic range reduction.
895 </t>
896 <t>
897 In these matricies the front left and front right channels are generally
898 passed through directly.
899 When a surround channel is split between both the left and right stereo
900  channels, coefficients are chosen so their squares sum to 1, which
901  helps preserve the perceived intensity.
902 Rear channels are mixed more diffusely or attenuated to maintain focus
903  on the front channels.
904 </t>
905
906 <figure anchor="downmix-matrix-3"
907  title="Stereo downmix matrix for the linear surround channel mapping"
908  align="center">
909 <artwork align="center"><![CDATA[
910  Left output = ( 0.585786 * left + 0.414214 * center                    )
911 Right output = (                   0.414214 * center + 0.585786 * right )
912 ]]></artwork>
913 <postamble>
914 Exact coefficient values are 1 and 1/sqrt(2), multiplied by
915  1/(1 + 1/sqrt(2)) for normalization.
916 </postamble>
917 </figure>
918
919 <figure anchor="downmix-matrix-4"
920  title="Stereo downmix matrix for the quadraphonic channel mapping"
921  align="center">
922 <artwork align="center"><![CDATA[
923 /          \   /                                     \ / FL \
924 | L output |   | 0.422650 0.000000 0.366025 0.211325 | | FR |
925 | R output | = | 0.000000 0.422650 0.211325 0.366025 | | RL |
926 \          /   \                                     / \ RR /
927 ]]></artwork>
928 <postamble>
929 Exact coefficient values are 1, sqrt(3)/2 and 1/2, multiplied by
930  1/(1&nbsp;+&nbsp;sqrt(3)/2&nbsp;+&nbsp;1/2) for normalization.
931 </postamble>
932 </figure>
933
934 <figure anchor="downmix-matrix-5"
935  title="Stereo downmix matrix for the 5.0 surround mapping"
936  align="center">
937 <artwork align="center"><![CDATA[
938                                                          / FL \
939 /   \   /                                              \ | FC |
940 | L |   | 0.650802 0.460186 0.000000 0.563611 0.325401 | | FR |
941 | R | = | 0.000000 0.460186 0.650802 0.325401 0.563611 | | RL |
942 \   /   \                                              / | RR |
943                                                          \    /
944 ]]></artwork>
945 <postamble>
946 Exact coefficient values are 1, 1/sqrt(2), sqrt(3)/2 and 1/2, multiplied by
947  2/(1&nbsp;+&nbsp;1/sqrt(2)&nbsp;+&nbsp;sqrt(3)/2&nbsp;+&nbsp;1/2)
948  for normalization.
949 </postamble>
950 </figure>
951
952 <figure anchor="downmix-matrix-6"
953  title="Stereo downmix matrix for the 5.1 surround mapping"
954  align="center">
955 <artwork align="center"><![CDATA[
956                                                                 /FL \
957 / \   /                                                       \ |FC |
958 |L|   | 0.529067 0.374107 0.000000 0.458186 0.264534 0.374107 | |FR |
959 |R| = | 0.000000 0.374107 0.529067 0.264534 0.458186 0.374107 | |RL |
960 \ /   \                                                       / |RR |
961                                                                 \LFE/
962 ]]></artwork>
963 <postamble>
964 Exact coefficient values are 1, 1/sqrt(2), sqrt(3)/2 and 1/2, multiplied by
965 2/(1&nbsp;+&nbsp;1/sqrt(2)&nbsp;+&nbsp;sqrt(3)/2&nbsp;+&nbsp;1/2 + 1/sqrt(2))
966  for normalization.
967 </postamble>
968 </figure>
969
970 <figure anchor="downmix-matrix-7"
971  title="Stereo downmix matrix for the 6.1 surround mapping"
972  align="center">
973 <artwork align="center"><![CDATA[
974  /                                                                \
975  | 0.455310 0.321953 0.000000 0.394310 0.227655 0.278819 0.321953 |
976  | 0.000000 0.321953 0.455310 0.227655 0.394310 0.278819 0.321953 |
977  \                                                                /
978 ]]></artwork>
979 <postamble>
980 Exact coefficient values are 1, 1/sqrt(2), sqrt(3)/2, 1/2 and
981  sqrt(3)/2/sqrt(2), multiplied by
982  2/(1&nbsp;+&nbsp;1/sqrt(2)&nbsp;+&nbsp;sqrt(3)/2&nbsp;+&nbsp;1/2 +
983  sqrt(3)/2/sqrt(2) + 1/sqrt(2)) for normalization.
984 The coeffients are in the same order as in <xref target="channel_mapping_1" />,
985  and the matricies above.
986 </postamble>
987 </figure>
988
989 <figure anchor="downmix-matrix-8"
990  title="Stereo downmix matrix for the 7.1 surround mapping"
991  align="center">
992 <artwork align="center"><![CDATA[
993 /                                                                 \
994 | .388631 .274804 .000000 .336565 .194316 .336565 .194316 .274804 |
995 | .000000 .274804 .388631 .194316 .336565 .194316 .336565 .274804 |
996 \                                                                 /
997 ]]></artwork>
998 <postamble>
999 Exact coefficient values are 1, 1/sqrt(2), sqrt(3)/2 and 1/2, multiplied by
1000  2/(2&nbsp;+&nbsp;2/sqrt(2)&nbsp;+&nbsp;sqrt(3)) for normalization.
1001 The coeffients are in the same order as in <xref target="channel_mapping_1" />,
1002  and the matricies above.
1003 </postamble>
1004 </figure>
1005
1006 </section>
1007
1008 </section> <!-- end channel_mapping_table -->
1009
1010 </section> <!-- end id_header -->
1011
1012 <section anchor="comment_header" title="Comment Header">
1013
1014 <figure anchor="comment_header_packet" title="Comment Header Packet"
1015  align="center">
1016 <artwork align="center"><![CDATA[
1017  0                   1                   2                   3
1018  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
1019 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1020 |      'O'      |      'p'      |      'u'      |      's'      |
1021 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1022 |      'T'      |      'a'      |      'g'      |      's'      |
1023 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1024 |                     Vendor String Length                      |
1025 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1026 |                                                               |
1027 :                        Vendor String...                       :
1028 |                                                               |
1029 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1030 |                   User Comment List Length                    |
1031 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1032 |                 User Comment #0 String Length                 |
1033 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1034 |                                                               |
1035 :                   User Comment #0 String...                   :
1036 |                                                               |
1037 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1038 |                 User Comment #1 String Length                 |
1039 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1040 :                                                               :
1041 ]]></artwork>
1042 </figure>
1043
1044 <t>
1045 The comment header consists of a 64-bit magic signature, followed by data in
1046  the same format as the <xref target="vorbis-comment"/> header used in Ogg
1047  Vorbis, except (like Ogg Theora and Speex) the final "framing bit" specified
1048  in the Vorbis spec is not present.
1049 <list style="numbers">
1050 <t><spanx style="strong">Magic Signature</spanx>:
1051 <vspace blankLines="1"/>
1052 This is an 8-octet (64-bit) field that allows codec identification and is
1053  human-readable.
1054 It contains, in order, the magic numbers:
1055 <list style="empty">
1056 <t>0x4F 'O'</t>
1057 <t>0x70 'p'</t>
1058 <t>0x75 'u'</t>
1059 <t>0x73 's'</t>
1060 <t>0x54 'T'</t>
1061 <t>0x61 'a'</t>
1062 <t>0x67 'g'</t>
1063 <t>0x73 's'</t>
1064 </list>
1065 Starting with "Op" helps distinguish it from audio data packets, as this is an
1066  invalid TOC sequence.
1067 <vspace blankLines="1"/>
1068 </t>
1069 <t><spanx style="strong">Vendor String Length</spanx> (32 bits, unsigned,
1070  little endian):
1071 <vspace blankLines="1"/>
1072 This field gives the length of the following vendor string, in octets.
1073 It MUST NOT indicate that the vendor string is longer than the rest of the
1074  packet.
1075 <vspace blankLines="1"/>
1076 </t>
1077 <t><spanx style="strong">Vendor String</spanx> (variable length, UTF-8 vector):
1078 <vspace blankLines="1"/>
1079 This is a simple human-readable tag for vendor information, encoded as a UTF-8
1080  string&nbsp;<xref target="RFC3629"/>.
1081 No terminating null octet is required.
1082 <vspace blankLines="1"/>
1083 This tag is intended to identify the codec encoder and encapsulation
1084  implementations, for tracing differences in technical behavior.
1085 User-facing encoding applications can use the 'ENCODER' user comment tag
1086  to identify themselves.
1087 <vspace blankLines="1"/>
1088 </t>
1089 <t><spanx style="strong">User Comment List Length</spanx> (32 bits, unsigned,
1090  little endian):
1091 <vspace blankLines="1"/>
1092 This field indicates the number of user-supplied comments.
1093 It MAY indicate there are zero user-supplied comments, in which case there are
1094  no additional fields in the packet.
1095 It MUST NOT indicate that there are so many comments that the comment string
1096  lengths would require more data than is available in the rest of the packet.
1097 <vspace blankLines="1"/>
1098 </t>
1099 <t><spanx style="strong">User Comment #i String Length</spanx> (32 bits,
1100  unsigned, little endian):
1101 <vspace blankLines="1"/>
1102 This field gives the length of the following user comment string, in octets.
1103 There is one for each user comment indicated by the 'user comment list length'
1104  field.
1105 It MUST NOT indicate that the string is longer than the rest of the packet.
1106 <vspace blankLines="1"/>
1107 </t>
1108 <t><spanx style="strong">User Comment #i String</spanx> (variable length, UTF-8
1109  vector):
1110 <vspace blankLines="1"/>
1111 This field contains a single user comment string.
1112 There is one for each user comment indicated by the 'user comment list length'
1113  field.
1114 </t>
1115 </list>
1116 </t>
1117
1118 <t>
1119 The vendor string length and user comment list length are REQUIRED, and
1120  implementations SHOULD reject comment headers that do not contain enough data
1121  for these fields, or that do not contain enough data for the corresponding
1122  vendor string or user comments they describe.
1123 Making this check before allocating the associated memory to contain the data
1124  may help prevent a possible Denial-of-Service (DoS) attack from small comment
1125  headers that claim to contain strings longer than the entire packet or more
1126  user comments than than could possibly fit in the packet.
1127 </t>
1128
1129 <t>
1130 The user comment strings follow the NAME=value format described by
1131  <xref target="vorbis-comment"/> with the same recommended tag names.
1132 One new comment tag is introduced for Ogg Opus:
1133 <figure align="center">
1134 <artwork align="left"><![CDATA[
1135 R128_TRACK_GAIN=-573
1136 ]]></artwork>
1137 </figure>
1138 representing the volume shift needed to normalize the track's volume.
1139 The gain is a Q7.8 fixed point number in dB, as in the ID header's 'output
1140  gain' field.
1141 This tag is similar to the REPLAYGAIN_TRACK_GAIN tag in
1142  Vorbis&nbsp;<xref target="replay-gain"/>, except that the normal volume
1143  reference is the <xref target="EBU-R128"/> standard.
1144 </t>
1145 <t>
1146 An Ogg Opus file MUST NOT have more than one such tag, and if present its
1147  value MUST be an integer from -32768 to 32767, inclusive, represented in
1148  ASCII with no whitespace.
1149 If present, it MUST correctly represent the R128 normalization gain relative
1150  to the 'output gain' field specified in the ID header.
1151 If a player chooses to make use of the R128_TRACK_GAIN tag, it MUST be
1152  applied <spanx style="emph">in addition</spanx> to the 'output gain' value.
1153 If an encoder wishes to use R128 normalization, and the output gain is not
1154  otherwise constrained or specified, the encoder SHOULD write the R128 gain
1155  into the 'output gain' field and store a tag containing "R128_TRACK_GAIN=0".
1156 That is, it should assume that by default tools will respect the 'output gain'
1157  field, and not the comment tag.
1158 If a tool modifies the ID header's 'output gain' field, it MUST also update or
1159  remove the R128_TRACK_GAIN comment tag.
1160 </t>
1161 <t>
1162 To avoid confusion with multiple normalization schemes, an Opus comment header
1163  SHOULD NOT contain any of the REPLAYGAIN_TRACK_GAIN, REPLAYGAIN_TRACK_PEAK,
1164  REPLAYGAIN_ALBUM_GAIN, or REPLAYGAIN_ALBUM_PEAK tags.
1165 </t>
1166 <t>
1167 There is no Opus comment tag corresponding to REPLAYGAIN_ALBUM_GAIN.
1168 That information should instead be stored in the ID header's 'output gain'
1169  field.
1170 </t>
1171 </section>
1172
1173 </section>
1174
1175 <section anchor="packet_size_limits" title="Packet Size Limits">
1176 <t>
1177 Technically valid Opus packets can be arbitrarily large due to the padding
1178  format, although the amount of non-padding data they can contain is bounded.
1179 These packets might be spread over a similarly enormous number of Ogg pages.
1180 Encoders SHOULD use no more padding than required to make a variable bitrate
1181  (VBR) stream constant bitrate (CBR).
1182 Decoders SHOULD avoid attempting to allocate excessive amounts of memory when
1183  presented with a very large packet.
1184 The presence of an extremely large packet in the stream could indicate a
1185  memory exhaustion attack or stream corruption.
1186 Decoders SHOULD reject a packet that is too large to process, and display a
1187  warning message.
1188 </t>
1189 <t>
1190 In an Ogg Opus stream, the largest possible valid packet that does not use
1191  padding has a size of (61,298*N&nbsp;-&nbsp;2) octets, or about 60&nbsp;kB per
1192  Opus stream.
1193 With 255&nbsp;streams, this is 15,630,988&nbsp;octets (14.9&nbsp;MB) and can
1194  span up to 61,298&nbsp;Ogg pages, all but one of which will have a granule
1195  position of -1.
1196 This is of course a very extreme packet, consisting of 255&nbsp;streams, each
1197  containing 120&nbsp;ms of audio encoded as 2.5&nbsp;ms frames, each frame
1198  using the maximum possible number of octets (1275) and stored in the least
1199  efficient manner allowed (a VBR code&nbsp;3 Opus packet).
1200 Even in such a packet, most of the data will be zeros as 2.5&nbsp;ms frames
1201  cannot actually use all 1275&nbsp;octets.
1202 The largest packet consisting of entirely useful data is
1203  (15,326*N&nbsp;-&nbsp;2) octets, or about 15&nbsp;kB per stream.
1204 This corresponds to 120&nbsp;ms of audio encoded as 10&nbsp;ms frames in either
1205  LP or Hybrid mode, but at a data rate of over 1&nbsp;Mbps, which makes little
1206  sense for the quality achieved.
1207 A more reasonable limit is (7,664*N&nbsp;-&nbsp;2) octets, or about 7.5&nbsp;kB
1208  per stream.
1209 This corresponds to 120&nbsp;ms of audio encoded as 20&nbsp;ms stereo MDCT-mode
1210  frames, with a total bitrate just under 511&nbsp;kbps (not counting the Ogg
1211  encapsulation overhead).
1212 With N=8, the maximum number of channels currently defined by mapping
1213  family&nbsp;1, this gives a maximum packet size of 61,310&nbsp;octets, or just
1214  under 60&nbsp;kB.
1215 This is still quite conservative, as it assumes each output channel is taken
1216  from one decoded channel of a stereo packet.
1217 An implementation could reasonably choose any of these numbers for its internal
1218  limits.
1219 </t>
1220 </section>
1221
1222 <section anchor="encoder" title="Encoder Guidelines">
1223 <t>
1224 When encoding Opus files, Ogg encoders should take into account the
1225  algorithmic delay of the Opus encoder.
1226 </t>
1227 <figure align="center">
1228 <preamble>
1229 In encoders derived from the reference implementation, the number of
1230  samples can be queried with:
1231 </preamble>
1232 <artwork align="center"><![CDATA[
1233  opus_encoder_ctl(encoder_state, OPUS_GET_LOOKAHEAD, &samples_delay);
1234 ]]></artwork>
1235 </figure>
1236 <t>
1237 To achieve good quality in the very first samples of a stream, the Ogg encoder
1238  MAY use LPC extrapolation to generate at least 120 extra samples
1239  (extra_samples) at the beginning to avoid the Opus encoder having to encode
1240  a discontinuous signal.
1241 For an input file containing length samples, the Ogg encoder SHOULD set the
1242  preskip header flag to samples_delay+extra_samples, encode at least
1243  length+samples_delay+extra_samples samples, and set the granulepos of the last
1244  page to length+samples_delay+extra_samples.
1245 This ensures that the encoded file has the same duration as the original, with
1246  no time offset. The best way to pad the end of the stream is to also use LPC
1247  extrapolation, but zero-padding is also acceptable.
1248 </t>
1249
1250 <section anchor="lpc" title="LPC Extrapolation">
1251 <t>
1252 The first step in LPC extrapolation is to compute linear prediction
1253  coefficients.
1254 When extending the end of the signal, order-N (typically with N ranging from 8
1255  to 40) LPC analysis is performed on a window near the end of the signal.
1256 The last N samples are used as memory to an infinite impulse response (IIR)
1257  filter.
1258 </t>
1259 <figure align="center">
1260 <preamble>
1261 The filter is then applied on a zero input to extrapolate the end of the signal.
1262 Let a(k) be the kth LPC coefficient and x(n) be the nth sample of the signal,
1263  each new sample past the end of the signal is computed as:
1264 </preamble>
1265 <artwork align="center"><![CDATA[
1266         N
1267        ---
1268 x(n) = \   a(k)*x(n-k)
1269        /
1270        ---
1271        k=1
1272 ]]></artwork>
1273 </figure>
1274 <t>
1275 The process is repeated independently for each channel.
1276 It is possible to extend the beginning of the signal by applying the same
1277  process backward in time.
1278 When extending the beginning of the signal, it is best to apply a "fade in" to
1279  the extrapolated signal, e.g. by multiplying it by a half-Hanning window
1280  <xref target="hanning"/>.
1281 </t>
1282
1283 </section>
1284
1285 <section anchor="continuous_chaining" title="Continuous Chaining">
1286 <t>
1287 In some applications, such as Internet radio, it is desirable to cut a long
1288  streams into smaller chains, e.g. so the comment header can be updated.
1289 This can be done simply by separating the input streams into segments and
1290  encoding each segment independently.
1291 The drawback of this approach is that it creates a small discontinuity
1292  at the boundary due to the lossy nature of Opus.
1293 An encoder MAY avoid this discontinuity by using the following procedure:
1294 <list style="numbers">
1295 <t>Encode the last frame of the first segment as an independent frame by
1296  turning off all forms of inter-frame prediction.
1297 De-emphasis is allowed.</t>
1298 <t>Set the granulepos of the last page to a point near the end of the last
1299  frame.</t>
1300 <t>Begin the second segment with a copy of the last frame of the first
1301  segment.</t>
1302 <t>Set the preskip flag of the second stream in such a way as to properly
1303  join the two streams.</t>
1304 <t>Continue the encoding process normally from there, without any reset to
1305  the encoder.</t>
1306 </list>
1307 </t>
1308 </section>
1309
1310 </section>
1311
1312 <section anchor="implementation" title="Implementation Status">
1313 <t>
1314 A brief summary of major implementations of this draft is available
1315  at <eref target="https://wiki.xiph.org/OggOpusImplementation"/>,
1316   along with their status.
1317 </t>
1318 <t>
1319 [Note to RFC Editor: please remove this entire section before
1320  final publication per <xref target="draft-sheffer-running-code"/>.]
1321 </t>
1322 </section>
1323
1324 <section anchor="security" title="Security Considerations">
1325 <t>
1326 Implementations of the Opus codec need to take appropriate security
1327  considerations into account, as outlined in <xref target="RFC4732"/>.
1328 This is just as much a problem for the container as it is for the codec itself.
1329 It is extremely important for the decoder to be robust against malicious
1330  payloads.
1331 Malicious payloads must not cause the decoder to overrun its allocated memory
1332  or to take an excessive amount of resources to decode.
1333 Although problems in encoders are typically rarer, the same applies to the
1334  encoder.
1335 Malicious audio streams must not cause the encoder to misbehave because this
1336  would allow an attacker to attack transcoding gateways.
1337 </t>
1338
1339 <t>
1340 Like most other container formats, Ogg Opus files should not be used with
1341  insecure ciphers or cipher modes that are vulnerable to known-plaintext
1342  attacks.
1343 Elements such as the Ogg page capture pattern and the magic signatures in the
1344  ID header and the comment header all have easily predictable values, in
1345  addition to various elements of the codec data itself.
1346 </t>
1347 </section>
1348
1349 <section anchor="content_type" title="Content Type">
1350 <t>
1351 An "Ogg Opus file" consists of one or more sequentially multiplexed segments,
1352  each containing exactly one Ogg Opus stream.
1353 The RECOMMENDED mime-type for Ogg Opus files is "audio/ogg".
1354 </t>
1355
1356 <figure>
1357 <preamble>
1358 If more specificity is desired, one MAY indicate the presence of Opus streams
1359  using the codecs parameter defined in <xref target="RFC6381"/>, e.g.,
1360 </preamble>
1361 <artwork align="center"><![CDATA[
1362     audio/ogg; codecs=opus
1363 ]]></artwork>
1364 <postamble>
1365  for an Ogg Opus file.
1366 </postamble>
1367 </figure>
1368
1369 <t>
1370 The RECOMMENDED filename extension for Ogg Opus files is '.opus'.
1371 </t>
1372
1373 <t>
1374 When Opus is concurrently multiplexed with other streams in an Ogg container,
1375  one SHOULD use one of the "audio/ogg", "video/ogg", or "application/ogg"
1376  mime-types, as defined in <xref target="RFC5334"/>.
1377 Such streams are not strictly "Ogg Opus files" as described above,
1378  since they contain more than a single Opus stream per sequentially
1379  multiplexed segment, e.g. video or multiple audio tracks.
1380 In such cases the the '.opus' filename extension is NOT RECOMMENDED.
1381 </t>
1382 </section>
1383
1384 <section title="IANA Considerations">
1385 <t>
1386 This document has no actions for IANA.
1387 </t>
1388 </section>
1389
1390 <section anchor="Acknowledgments" title="Acknowledgments">
1391 <t>
1392 Thanks to Greg Maxwell, Christopher "Monty" Montgomery, and Jean-Marc Valin for
1393  their valuable contributions to this document.
1394 Additional thanks to Andrew D'Addesio, Greg Maxwell, and Vincent Penqeurc'h for
1395  their feedback based on early implementations.
1396 </t>
1397 </section>
1398
1399 <section title="Copying Conditions">
1400 <t>
1401 The authors agree to grant third parties the irrevocable right to copy, use,
1402  and distribute the work, with or without modification, in any medium, without
1403  royalty, provided that, unless separate permission is granted, redistributed
1404  modified works do not contain misleading author, version, name of work, or
1405  endorsement information.
1406 </t>
1407 </section>
1408
1409 </middle>
1410 <back>
1411 <references title="Normative References">
1412  &rfc2119;
1413  &rfc3533;
1414  &rfc3629;
1415  &rfc5334;
1416  &rfc6381;
1417  &rfc6716;
1418
1419 <reference anchor="EBU-R128" target="http://tech.ebu.ch/loudness">
1420 <front>
1421 <title>"Loudness Recommendation EBU R128</title>
1422 <author fullname="EBU Technical Committee"/>
1423 <date month="August" year="2011"/>
1424 </front>
1425 </reference>
1426
1427 <reference anchor="vorbis-comment"
1428  target="http://www.xiph.org/vorbis/doc/v-comment.html">
1429 <front>
1430 <title>Ogg Vorbis I Format Specification: Comment Field and Header
1431  Specification</title>
1432 <author initials="C." surname="Montgomery"
1433  fullname="Christopher &quot;Monty&quot; Montgomery"/>
1434 <date month="July" year="2002"/>
1435 </front>
1436 </reference>
1437
1438 </references>
1439
1440 <references title="Informative References">
1441
1442 <!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.3550.xml"?-->
1443  &rfc4732;
1444
1445 <reference anchor="draft-sheffer-running-code"
1446   target="https://tools.ietf.org/html/draft-sheffer-running-code-05#section-2">
1447  <front>
1448    <title>Improving "Rough Consensus" with Running Code</title>
1449    <author initials="Y." surname="Sheffer" fullname="Yaron Sheffer"/>
1450    <author initials="A." surname="Farrel" fullname="Adrian Farrel"/>
1451    <date month="May" year="2013"/>
1452  </front>
1453 </reference>
1454
1455 <reference anchor="flac"
1456  target="https://xiph.org/flac/format.html">
1457   <front>
1458     <title>FLAC - Free Lossless Audio Codec Format Description</title>
1459     <author initials="J." surname="Coalson" fullname="Josh Coalson"/>
1460     <date month="January" year="2008"/>
1461   </front>
1462 </reference>
1463
1464 <reference anchor="hanning"
1465  target="http://en.wikipedia.org/wiki/Hamming_function#Hann_.28Hanning.29_window">
1466   <front>
1467     <title>"Hann window</title>
1468     <author fullname="Wikipedia"/>
1469     <date month="May" year="2013"/>
1470   </front>
1471 </reference>
1472
1473 <reference anchor="replay-gain"
1474  target="http://wiki.xiph.org/VorbisComment#Replay_Gain">
1475 <front>
1476 <title>VorbisComment: Replay Gain</title>
1477 <author initials="C." surname="Parker" fullname="Conrad Parker"/>
1478 <author initials="M." surname="Leese" fullname="Martin Leese"/>
1479 <date month="June" year="2009"/>
1480 </front>
1481 </reference>
1482
1483 <reference anchor="seeking"
1484  target="http://wiki.xiph.org/Seeking">
1485 <front>
1486 <title>Granulepos Encoding and How Seeking Really Works</title>
1487 <author initials="S." surname="Pfeiffer" fullname="Silvia Pfeiffer"/>
1488 <author initials="C." surname="Parker" fullname="Conrad Parker"/>
1489 <author initials="G." surname="Maxwell" fullname="Greg Maxwell"/>
1490 <date month="May" year="2012"/>
1491 </front>
1492 </reference>
1493
1494 <reference anchor="vorbis-mapping"
1495  target="http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">
1496 <front>
1497 <title>The Vorbis I Specification, Section 4.3.9 Output Channel Order</title>
1498 <author initials="C." surname="Montgomery"
1499  fullname="Christopher &quot;Monty&quot; Montgomery"/>
1500 <date month="January" year="2010"/>
1501 </front>
1502 </reference>
1503
1504 <reference anchor="vorbis-trim"
1505  target="http://xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-130000A.2">
1506   <front>
1507     <title>The Vorbis I Specification, Appendix&nbsp;A: Embedding Vorbis
1508       into an Ogg stream</title>
1509     <author initials="C." surname="Montgomery"
1510      fullname="Christopher &quot;Monty&quot; Montgomery"/>
1511     <date month="November" year="2008"/>
1512   </front>
1513 </reference>
1514
1515 <reference anchor="wave-multichannel"
1516  target="http://msdn.microsoft.com/en-us/windows/hardware/gg463006.aspx">
1517   <front>
1518     <title>Multiple Channel Audio Data and WAVE Files</title>
1519     <author fullname="Microsoft Corporation"/>
1520     <date month="March" year="2007"/>
1521   </front>
1522 </reference>
1523
1524 </references>
1525
1526 </back>
1527 </rfc>