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