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