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