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