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