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