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