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