Ogg Opus Draft: Add R128_ALBUM_GAIN.
[opus.git] / doc / draft-ietf-codec-oggopus.xml
index 038faf8..cc7b2ae 100644 (file)
@@ -1,16 +1,17 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd' [
-<!ENTITY rfc2119 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.2119.xml'>
-<!ENTITY rfc3533 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.3533.xml'>
-<!ENTITY rfc3629 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.3629.xml'>
-<!ENTITY rfc4732 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.4732.xml'>
-<!ENTITY rfc5334 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.5334.xml'>
-<!ENTITY rfc6381 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.6381.xml'>
-<!ENTITY rfc6716 PUBLIC '' 'https://xml2rfc.tools.ietf.org/tools/xml2rfc/public/rfc/bibxml/reference.RFC.6716.xml'>
+<!ENTITY rfc2119 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
+<!ENTITY rfc3533 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3533.xml'>
+<!ENTITY rfc3629 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3629.xml'>
+<!ENTITY rfc4732 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4732.xml'>
+<!ENTITY rfc5334 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5334.xml'>
+<!ENTITY rfc6381 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6381.xml'>
+<!ENTITY rfc6716 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6716.xml'>
+<!ENTITY rfc6982 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6982.xml'>
 ]>
 <?rfc toc="yes" symrefs="yes" ?>
 
-<rfc ipr="trust200902" category="std" docName="draft-ietf-codec-oggopus-02">
+<rfc ipr="trust200902" category="std" docName="draft-ietf-codec-oggopus-03">
 
 <front>
 <title abbrev="Ogg Opus">Ogg Encapsulation for the Opus Audio Codec</title>
@@ -59,7 +60,7 @@
 </address>
 </author>
 
-<date day="17" month="January" year="2014"/>
+<date day="7" month="February" year="2014"/>
 <area>RAI</area>
 <workgroup>codec</workgroup>
 
@@ -122,8 +123,8 @@ Readers unfamiliar with the basic concepts mentioned above are encouraged to
 <section anchor="terminology" title="Terminology">
 <t>
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
- "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
- interpreted as described in <xref target="RFC2119"/>.
+ "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref target="RFC2119"/>.
 </t>
 
 <t>
@@ -166,7 +167,7 @@ All subsequent pages are audio data pages, and the Ogg packets they contain are
  audio data packets.
 Each audio data packet contains one Opus packet for each of N different
  streams, where N is typically one for mono or stereo, but may be greater than
- one for, e.g., multichannel audio.
+ one for multichannel audio.
 The value N is specified in the ID header (see
  <xref target="channel_mapping"/>), and is fixed over the entire length of the
  logical Ogg bitstream.
@@ -188,7 +189,7 @@ The coding mode (SILK, Hybrid, or CELT), audio bandwidth, channel count,
  duration (frame size), and number of frames per packet, are indicated in the
  TOC (table of contents) in the first byte of each Opus packet, as described
  in Section&nbsp;3.1 of&nbsp;<xref target="RFC6716"/>.
-The combination of mode, audio bandwidth, and frame size, is referred to as
+The combination of mode, audio bandwidth, and frame size is referred to as
  the configuration of an Opus packet.
 </t>
 <t>
@@ -348,8 +349,8 @@ Since medium-band audio is an option only in the SILK mode, wideband frames
 There is some amount of latency introduced during the decoding process, to
  allow for overlap in the CELT mode, stereo mixing in the SILK mode, and
  resampling.
-The encoder will also introduce latency (though the exact amount is not
- specified).
+The encoder may introduce additional latency through its own resampling
and analysis (though the exact amount is not specified).
 Therefore, the first few samples produced by the decoder do not correspond to
  real input audio, but are instead composed of padding inserted by the encoder
  to compensate for this latency.
@@ -363,20 +364,39 @@ However, a decoder will want to skip these samples after decoding them.
 A 'pre-skip' field in the ID header (see <xref target="id_header"/>) signals
  the number of samples which SHOULD be skipped (decoded but discarded) at the
  beginning of the stream.
-This provides sufficient history to the decoder so that it has already
- converged before the stream's output begins.
-It may also be used to perform sample-accurate cropping of existing encoded
- streams.
-This amount need not be a multiple of 2.5&nbsp;ms, may be smaller than a single
- packet, or may span the contents of several packets.
+This amount MAY not be a multiple of 2.5&nbsp;ms, MAY be smaller than a single
+ packet, or MAT span the contents of several packets.
+These samples are not valid audio, and should not be played.
 </t>
+
+<t>
+For example, if the first Opus frame uses the CELT mode, it will always
+ produce 120 samples of windowed overlap-add data.
+However, the overlap data is initially all zeros (since there is no prior
+ frame), meaning this cannot, in general, accurately represent the original
+ audio.
+The SILK mode requires additional delay to account for its analysis and
+ resampling latency.
+The encoder delays the original audio to avoid this problem.
+</t>
+
+<t>
+The pre-skip field MAY also be used to perform sample-accurate cropping of
+ already encoded streams.
+In this case, a value of at least 3840&nbsp;samples (80&nbsp;ms) provides
+ sufficient history to the decoder that it will have converged
+ before the stream's output begins.
+</t>
+
 </section>
 
 <section anchor="pcm_sample_position" title="PCM Sample Position">
 <t>
+<figure align="center">
+<preamble>
 The PCM sample position is determined from the granule position using the
  formula
-<figure align="center">
+</preamble>
 <artwork align="center"><![CDATA[
 'PCM sample position' = 'granule position' - 'pre-skip' .
 ]]></artwork>
@@ -387,8 +407,10 @@ The PCM sample position is determined from the granule position using the
 For example, if the granule position of the first audio data page is 59,971,
  and the pre-skip is 11,971, then the PCM sample position of the last decoded
  sample from that page is 48,000.
-This can be converted into a playback time using the formula
 <figure align="center">
+<preamble>
+This can be converted into a playback time using the formula
+</preamble>
 <artwork align="center"><![CDATA[
                   'PCM sample position'
 'playback time' = --------------------- .
@@ -625,7 +647,8 @@ An Ogg Opus player SHOULD select the playback sample rate according to the
 <t>Otherwise, if the hardware's highest available sample rate is a supported
  rate, decode at this sample rate.</t>
 <t>Otherwise, if the hardware's highest available sample rate is less than
- 48&nbsp;kHz, decode at the highest supported rate above this and resample.</t>
+ 48&nbsp;kHz, decode at the next highest supported rate above this and
+ resample.</t>
 <t>Otherwise, decode at 48&nbsp;kHz and resample.</t>
 </list>
 However, the 'Input Sample Rate' field allows the encoder to pass the sample
@@ -651,13 +674,17 @@ This is a gain to be applied by the decoder.
 It is 20*log10 of the factor to scale the decoder output by to achieve the
  desired playback volume, stored in a 16-bit, signed, two's complement
  fixed-point value with 8 fractional bits (i.e., Q7.8).
-To apply the gain, a decoder could use
 <figure align="center">
+<preamble>
+To apply the gain, a decoder could use
+</preamble>
 <artwork align="center"><![CDATA[
 sample *= pow(10, output_gain/(20.0*256)) ,
 ]]></artwork>
-</figure>
+<postamble>
  where output_gain is the raw 16-bit value from the header.
+</postamble>
+</figure>
 <vspace blankLines="1"/>
 Virtually all players and media frameworks should apply it by default.
 If a player chooses to apply any volume adjustment or gain modification, such
@@ -682,8 +709,7 @@ The large range serves in part to ensure that gain can always be losslessly
 <t><spanx style="strong">Channel Mapping Family</spanx> (8 bits,
  unsigned):
 <vspace blankLines="1"/>
-This octet indicates the order and semantic meaning of the various channels
- encoded in each Ogg packet.
+This octet indicates the order and semantic meaning of the output channels.
 <vspace blankLines="1"/>
 Each possible value of this octet indicates a mapping family, which defines a
  set of allowed channel counts, and the ordered set of channel names for each
@@ -784,8 +810,8 @@ This value MUST either be smaller than (M+N), or be the special value 255.
 If 'index' is less than 2*M, the output MUST be taken from decoding stream
  ('index'/2) as stereo and selecting the left channel if 'index' is even, and
  the right channel if 'index' is odd.
-If 'index' is 2*M or larger, the output MUST be taken from decoding stream
- ('index'-M) as mono.
+If 'index' is 2*M or larger, but less than 255, the output MUST be taken from
decoding stream ('index'-M) as mono.
 If 'index' is 255, the corresponding output channel MUST contain pure silence.
 <vspace blankLines="1"/>
 The number of output channels, C, is not constrained to match the number of
@@ -847,15 +873,17 @@ Specific locations depend on the number of channels, and are given below
   <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>
   <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>
 </list>
+</t>
+<t>
 This set of surround options and speaker location orderings is the same
  as those used by the Vorbis codec <xref target="vorbis-mapping"/>.
 The ordering is different from the one used by the
  WAVE <xref target="wave-multichannel"/> and
  FLAC <xref target="flac"/> formats,
- so correct ordering requires permutation of the output channels when encoding
from or decoding to those formats.
+ so correct ordering requires permutation of the output channels when decoding
to or encoding from those formats.
 'LFE' here refers to a Low Frequency Effects, often mapped to a subwoofer
- with no particular spacial position.
+ with no particular spatial position.
 Implementations SHOULD identify 'side' or 'rear' speaker locations with
  'surround' and 'back' as appropriate when interfacing with audio formats
  or systems which prefer that terminology.
@@ -902,7 +930,7 @@ Implementations MAY use the following matricies to implement downmixing from
  Family 1</xref>, which are known to give acceptable results for stereo.
 Matricies for 3 and 4 channels are normalized so each coefficent row sums
  to 1 to avoid clipping.
-For 5 or more channels they are normalized to 2 as a compromize between
+For 5 or more channels they are normalized to 2 as a compromise between
  clipping and dynamic range reduction.
 </t>
 <t>
@@ -919,8 +947,8 @@ Rear channels are mixed more diffusely or attenuated to maintain focus
  title="Stereo downmix matrix for the linear surround channel mapping"
  align="center">
 <artwork align="center"><![CDATA[
- Left output = ( 0.585786 * left + 0.414214 * center                    )
-Right output = (                   0.414214 * center + 0.585786 * right )
+L output = ( 0.585786 * left + 0.414214 * center                    )
+R output = (                   0.414214 * center + 0.585786 * right )
 ]]></artwork>
 <postamble>
 Exact coefficient values are 1 and 1/sqrt(2), multiplied by
@@ -1133,7 +1161,7 @@ The vendor string length and user comment list length are REQUIRED, and
  for these fields, or that do not contain enough data for the corresponding
  vendor string or user comments they describe.
 Making this check before allocating the associated memory to contain the data
may help prevent a possible Denial-of-Service (DoS) attack from small comment
helps prevent a possible Denial-of-Service (DoS) attack from small comment
  headers that claim to contain strings longer than the entire packet or more
  user comments than than could possibly fit in the packet.
 </t>
@@ -1141,45 +1169,55 @@ Making this check before allocating the associated memory to contain the data
 <t>
 The user comment strings follow the NAME=value format described by
  <xref target="vorbis-comment"/> with the same recommended tag names.
-One new comment tag is introduced for Ogg Opus:
+</t>
 <figure align="center">
+  <preamble>Two new comment tags are introduced for Ogg Opus:</preamble>
 <artwork align="left"><![CDATA[
 R128_TRACK_GAIN=-573
 ]]></artwork>
-</figure>
+<postamble>
 representing the volume shift needed to normalize the track's volume.
 The gain is a Q7.8 fixed point number in dB, as in the ID header's 'output
  gain' field.
+</postamble>
+</figure>
+<t>
 This tag is similar to the REPLAYGAIN_TRACK_GAIN tag in
  Vorbis&nbsp;<xref target="replay-gain"/>, except that the normal volume
  reference is the <xref target="EBU-R128"/> standard.
 </t>
+<artwork align="left"><![CDATA[
+R128_ALBUM_GAIN=111
+]]></artwork>
+<postamble>
+representing the volume shift needed to normalize the volume of a collection
+ of tracks.
+The gain is a Q7.8 fixed point number in dB, as in the ID header's 'output
+ gain' field.
+</postamble>
+</figure>
 <t>
-An Ogg Opus file MUST NOT have more than one such tag, and if present its
value MUST be an integer from -32768 to 32767, inclusive, represented in
+An Ogg Opus file MUST NOT have more than one of each tags, and if present
their values MUST be an integer from -32768 to 32767, inclusive, represented in
  ASCII with no whitespace.
-If present, it MUST correctly represent the R128 normalization gain relative
- to the 'output gain' field specified in the ID header.
-If a player chooses to make use of the R128_TRACK_GAIN tag, it MUST be
- applied <spanx style="emph">in addition</spanx> to the 'output gain' value.
+If present, REPLAYGAIN_TRACK_GAIN MUST correctly represent the R128
+ normalization gain relative to the 'output gain' field specified in the ID header.
+If a player chooses to make use of the R128_TRACK_GAIN tag or the
+ R128_ALBUM_GAIN, it MUST be applied <spanx style="emph">in addition</spanx> to
+ the 'output gain' value.
 If an encoder wishes to use R128 normalization, and the output gain is not
  otherwise constrained or specified, the encoder SHOULD write the R128 gain
  into the 'output gain' field and store a tag containing "R128_TRACK_GAIN=0".
 That is, it should assume that by default tools will respect the 'output gain'
  field, and not the comment tag.
 If a tool modifies the ID header's 'output gain' field, it MUST also update or
- remove the R128_TRACK_GAIN comment tag.
+ remove the R128_TRACK_GAIN and R128_ALBUM_GAIN comment tags.
 </t>
 <t>
 To avoid confusion with multiple normalization schemes, an Opus comment header
  SHOULD NOT contain any of the REPLAYGAIN_TRACK_GAIN, REPLAYGAIN_TRACK_PEAK,
  REPLAYGAIN_ALBUM_GAIN, or REPLAYGAIN_ALBUM_PEAK tags.
 </t>
-<t>
-There is no Opus comment tag corresponding to REPLAYGAIN_ALBUM_GAIN.
-That information should instead be stored in the ID header's 'output gain'
- field.
-</t>
 </section>
 
 </section>
@@ -1344,7 +1382,7 @@ A brief summary of major implementations of this draft is available
 </t>
 <t>
 [Note to RFC Editor: please remove this entire section before
- final publication per <xref target="draft-sheffer-running-code"/>.]
+ final publication per <xref target="RFC6982"/>.]
 </t>
 </section>
 
@@ -1443,16 +1481,18 @@ The authors agree to grant third parties the irrevocable right to copy, use,
  &rfc6381;
  &rfc6716;
 
-<reference anchor="EBU-R128" target="http://tech.ebu.ch/loudness">
+<reference anchor="EBU-R128" target="https://tech.ebu.ch/loudness">
 <front>
-<title>"Loudness Recommendation EBU R128</title>
-<author fullname="EBU Technical Committee"/>
-<date month="August" year="2011"/>
+  <title>Loudness Recommendation EBU R128</title>
+  <author>
+    <organization>EBU Technical Committee</organization>
+  </author>
+  <date month="August" year="2011"/>
 </front>
 </reference>
 
 <reference anchor="vorbis-comment"
- target="http://www.xiph.org/vorbis/doc/v-comment.html">
+ target="https://www.xiph.org/vorbis/doc/v-comment.html">
 <front>
 <title>Ogg Vorbis I Format Specification: Comment Field and Header
  Specification</title>
@@ -1468,16 +1508,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
 
 <!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.3550.xml"?-->
  &rfc4732;
-
-<reference anchor="draft-sheffer-running-code"
-  target="https://tools.ietf.org/html/draft-sheffer-running-code-05#section-2">
- <front>
-   <title>Improving "Rough Consensus" with Running Code</title>
-   <author initials="Y." surname="Sheffer" fullname="Yaron Sheffer"/>
-   <author initials="A." surname="Farrel" fullname="Adrian Farrel"/>
-   <date month="May" year="2013"/>
- </front>
-</reference>
+ &rfc6982;
 
 <reference anchor="flac"
  target="https://xiph.org/flac/format.html">
@@ -1492,7 +1523,9 @@ The authors agree to grant third parties the irrevocable right to copy, use,
  target="https://en.wikipedia.org/wiki/Hamming_function#Hann_.28Hanning.29_window">
   <front>
     <title>Hann window</title>
-    <author surname="Wikipedia" fullname="Wikipedia"/>
+    <author>
+      <organization>Wikipedia</organization>
+    </author>
     <date month="May" year="2013"/>
   </front>
 </reference>
@@ -1501,7 +1534,9 @@ The authors agree to grant third parties the irrevocable right to copy, use,
  target="https://en.wikipedia.org/wiki/Linear_predictive_coding">
   <front>
     <title>Linear Predictive Coding</title>
-    <author surname="Wikipedia" fullname="Wikipedia"/>
+    <author>
+      <organization>Wikipedia</organization>
+    </author>
     <date month="January" year="2014"/>
   </front>
 </reference>
@@ -1510,7 +1545,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
   target="https://svn.xiph.org/trunk/vorbis/lib/lpc.c">
 <front>
   <title>Autocorrelation LPC coeff generation algorithm
-    (vorbis source code)</title>
+    (Vorbis source code)</title>
 <author initials="J." surname="Degener" fullname="Jutta Degener"/>
 <author initials="C." surname="Bormann" fullname="Carsten Bormann"/>
 <date month="November" year="1994"/>
@@ -1519,7 +1554,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
 
 
 <reference anchor="replay-gain"
- target="http://wiki.xiph.org/VorbisComment#Replay_Gain">
+ target="https://wiki.xiph.org/VorbisComment#Replay_Gain">
 <front>
 <title>VorbisComment: Replay Gain</title>
 <author initials="C." surname="Parker" fullname="Conrad Parker"/>
@@ -1529,7 +1564,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
 </reference>
 
 <reference anchor="seeking"
- target="http://wiki.xiph.org/Seeking">
+ target="https://wiki.xiph.org/Seeking">
 <front>
 <title>Granulepos Encoding and How Seeking Really Works</title>
 <author initials="S." surname="Pfeiffer" fullname="Silvia Pfeiffer"/>
@@ -1540,7 +1575,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
 </reference>
 
 <reference anchor="vorbis-mapping"
- target="http://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">
+ target="https://www.xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-800004.3.9">
 <front>
 <title>The Vorbis I Specification, Section 4.3.9 Output Channel Order</title>
 <author initials="C." surname="Montgomery"
@@ -1550,7 +1585,7 @@ The authors agree to grant third parties the irrevocable right to copy, use,
 </reference>
 
 <reference anchor="vorbis-trim"
- target="http://xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-130000A.2">
+ target="https://xiph.org/vorbis/doc/Vorbis_I_spec.html#x1-130000A.2">
   <front>
     <title>The Vorbis I Specification, Appendix&nbsp;A: Embedding Vorbis
       into an Ogg stream</title>
@@ -1564,7 +1599,9 @@ The authors agree to grant third parties the irrevocable right to copy, use,
  target="http://msdn.microsoft.com/en-us/windows/hardware/gg463006.aspx">
   <front>
     <title>Multiple Channel Audio Data and WAVE Files</title>
-    <author surname="Microsoft" fullname="Microsoft Corporation"/>
+    <author>
+      <organization>Microsoft Corporation</organization>
+    </author>
     <date month="March" year="2007"/>
   </front>
 </reference>