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