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