b63f95017adb83557bb56ab1c1116c1bebdf0d93
[opus.git] / doc / draft-ietf-codec-opus.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
3 <?rfc toc="yes" symrefs="yes" ?>
4
5 <rfc ipr="trust200902" category="std" docName="draft-ietf-codec-opus-01">
6
7 <front>
8 <title abbrev="Interactive Audio Codec">Definition of the Opus Audio Codec</title>
9
10
11 <author initials="JM" surname="Valin" fullname="Jean-Marc Valin">
12 <organization>Octasic Inc.</organization>
13 <address>
14 <postal>
15 <street>4101, Molson Street</street>
16 <city>Montreal</city>
17 <region>Quebec</region>
18 <code></code>
19 <country>Canada</country>
20 </postal>
21 <phone>+1 514 282-8858</phone>
22 <email>jean-marc.valin@octasic.com</email>
23 </address>
24 </author>
25
26 <author initials="K." surname="Vos" fullname="Koen Vos">
27 <organization>Skype Technologies S.A.</organization>
28 <address>
29 <postal>
30 <street>Stadsgarden 6</street>
31 <city>Stockholm</city>
32 <region></region>
33 <code>11645</code>
34 <country>SE</country>
35 </postal>
36 <phone>+46 855 921 989</phone>
37 <email>koen.vos@skype.net</email>
38 </address>
39 </author>
40
41
42 <date day="14" month="November" year="2010" />
43
44 <area>General</area>
45
46 <workgroup></workgroup>
47
48 <abstract>
49 <t>
50 This document describes the Opus codec, designed for interactive speech and audio 
51 transmission over the Internet.
52 </t>
53 </abstract>
54 </front>
55
56 <middle>
57
58 <section anchor="introduction" title="Introduction">
59 <t>
60 We propose the Opus codec based on a linear prediction layer (LP) and an
61 MDCT-based enhancement layer. The main idea behind the proposal is that
62 the speech low frequencies are usually more efficiently coded using
63 linear prediction codecs (such as CELP variants), while the higher frequencies
64 are more efficiently coded in the transform domain (e.g. MDCT). For low 
65 sampling rates, the MDCT layer is not useful and only the LP-based layer is
66 used. On the other hand, non-speech signals are not always adequately coded
67 using linear prediction, so for music only the MDCT-based layer is used.
68 </t>
69
70 <t>
71 In this proposed prototype, the LP layer is based on the 
72 <eref target='http://developer.skype.com/silk'>SILK</eref> codec 
73 <xref target="SILK"></xref> and the MDCT layer is based on the 
74 <eref target='http://www.celt-codec.org/'>CELT</eref>  codec
75  <xref target="CELT"></xref>.
76 </t>
77
78 <t>This is a work in progress.</t>
79 </section>
80
81 <section anchor="hybrid" title="Opus Codec">
82
83 <t>
84 In hybrid mode, each frame is coded first by the LP layer and then by the MDCT 
85 layer. In the current prototype, the cutoff frequency is 8 kHz. In the MDCT
86 layer, all bands below 8 kHz are discarded, such that there is no coding
87 redundancy between the two layers. Also both layers use the same instance of 
88 the range coder to encode the signal, which ensures that no "padding bits" are
89 wasted. The hybrid approach makes it easy to support both constant bit-rate
90 (CBR) and varaible bit-rate (VBR) coding. Although the SILK layer used is VBR,
91 it is easy to make the bit allocation of the CELT layer produce a final stream
92 that is CBR by using all the bits left unused by the SILK layer.
93 </t>
94
95 <t>The implementation of SILK-based LP layer is similar to the description in
96 the <xref target="SILK">SILK Internet-Draft</xref> with the main exception that 
97 SILK was modified to 
98 use the same range coder as CELT. The implementation of the CELT-based MDCT
99 layer is available from the CELT website and is a more recent version (0.8.1) 
100 of the <xref target="CELT">CELT Internet-Draft</xref>. 
101 The main changes
102 include better support for 20 ms frames as well as the ability to encode 
103 only the higher bands using a range coder partially filled by the SILK layer.</t>
104
105 <t>
106 In addition to their frame size, the SILK and CELT codecs require
107 a look-ahead of 5.2 ms and 2.5 ms, respectively. SILK's look-ahead is due to
108 noise shaping estimation (5 ms) and the internal resampling (0.2 ms), while
109 CELT's look-ahead is due to the overlapping MDCT windows. To compensate for the
110 difference, the CELT encoder input is delayed by 2.7 ms. This ensures that low
111 frequencies and high frequencies arrive at the same time.
112 </t>
113
114
115 <section title="Source Code">
116 <t>
117 The source code is currently available in a
118 <eref target='git://git.xiph.org/users/jm/ietfcodec.git'>Git repository</eref> 
119 which references two other
120 repositories (for SILK and CELT). Some snapshots are provided for 
121 convenience at <eref target='http://people.xiph.org/~jm/ietfcodec/'/> along
122 with sample files.
123 Although the build system is very primitive, some instructions are provided 
124 in the toplevel README file.
125 This is very early development so both the quality and feature set should
126 greatly improve over time. In the current version, only 48 kHz audio is 
127 supported, but support for all configurations listed in 
128 <xref target="modes"></xref> is planned. 
129 </t>
130 </section>
131
132 </section>
133
134 <section anchor="modes" title="Codec Modes">
135 <t>
136 There are three possible operating modes for the proposed prototype:
137 <list style="numbers">
138 <t>A linear prediction (LP) mode for use in low bit-rate connections with up to 8 kHz audio bandwidth (16 kHz sampling rate)</t>
139 <t>A hybrid (LP+MDCT) mode for full-bandwidth speech at medium bitrates</t>
140 <t>An MDCT-only mode for very low delay speech transmission as well as music transmission.</t>
141 </list>
142 Each of these modes supports a number of difference frame sizes and sampling
143 rates. In order to distinguish between the various modes and configurations,
144 we need to define a simple header that can used in the transport layer 
145 (e.g RTP) to signal this information. The following describes the proposed
146 header.
147 </t>
148
149 <t>
150 The LP mode supports the following configurations (numbered from 00000...01011 in binary):
151 <list style="symbols">
152 <t>8 kHz:  10, 20, 40, 60 ms (00000...00011)</t>
153 <t>12 kHz: 10, 20, 40, 60 ms (00100...00111)</t>
154 <t>16 kHz: 10, 20, 40, 60 ms (01000...01011)</t>
155 </list>
156 for a total of 12 configurations.
157 </t>
158
159 <t>
160 The hybrid mode supports the following configurations (numbered from 01100...01111):
161 <list style="symbols">
162 <t>32 kHz: 10, 20 ms (01100...01101)</t>
163 <t>48 kHz: 10, 20 ms (01110...01111)</t>
164 </list>
165 for a total of 4 configurations.
166 </t>
167
168 <t>
169 The MDCT-only mode supports the following configurations (numbered from 10000...11101):
170 <list style="symbols">
171 <t>8 kHz:  2.5, 5, 10, 20 ms (10000...10011)</t>
172 <t>16 kHz: 2.5, 5, 10, 20 ms (10100...10111)</t>
173 <t>32 kHz: 2.5, 5, 10, 20 ms (11000...11011)</t>
174 <t>48 kHz: 2.5, 5, 10, 20 ms (11100...11111)</t>
175 </list>
176 for a total of 16 configurations.
177 </t>
178
179 <t>
180 There is thus a total of 32 configurations, so 5 bits are necessary to 
181 indicate the mode, frame size and sampling rate (MFS). This leaves 3 bits for the number of frames per packets (codes 0 to 7):
182 <list style="symbols">
183 <t>0-2:  1-3 frames in the packet, each with equal compressed size</t>
184 <t>3:    arbitrary number of frames in the packet, each with equal compressed size (one size needs to be encoded)</t>
185 <t>4-5:  2-3 frames in the packet, with different compressed sizes, which need to be encoded (except the last one)</t>
186 <t>6:    arbitrary number of frames in the packet, with different compressed sizes, each of which needs to be encoded</t>
187 <t>7:    The first frame has this MFS, but others have different MFS. Each compressed size needs to be encoded.</t>
188 </list>
189 When code 7 is used and the last frames of a packet have the same MFS, it is 
190 allowed to switch to another code for them.
191 </t>
192
193 <t>
194 The compressed size of the frames (if needed) is indicated -- usually -- with one byte, with the following meaning:
195 <list style="symbols">
196 <t>0:          No frame (DTX or lost packet)</t>
197 <t>1-251:    Size of the frame in bytes</t>
198 <t>252-255: A second byte is needed. The total size is (size[1]*4)+(size[0]%4)+252</t>
199 </list>
200 </t>
201
202 <t>
203 The maximum size representable is 255*4+3+252=1275 bytes. For 20 ms frames, that 
204 represents a bit-rate of 510 kb/s, which is really the highest rate anyone would want 
205 to use in stereo mode (beyond that point, lossless codecs would be more appropriate).
206 </t>
207
208 <section anchor="examples" title="Examples">
209 <t>
210 Simplest case: one packet
211 </t>
212
213 <t>
214 <figure>
215 <artwork><![CDATA[
216  0                   1                   2                   3
217  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
218 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
219 |   MFS   |0|0|0|               compressed data...              |
220 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
221 ]]></artwork>
222 </figure>
223 </t>
224
225 <t>
226 Four frames of the same compressed size:
227 </t>
228
229 <t>
230 <figure>
231 <artwork><![CDATA[
232  0                   1                   2                   3
233  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
234 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
235 |   MFS   |0|1|1|               compressed data...              |
236 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
237 ]]></artwork>
238 </figure>
239 </t>
240
241 <t>
242 Two frames of different compressed size:
243 </t>
244
245 <t>
246 <figure>
247 <artwork><![CDATA[
248  0                   1                   2                   3
249  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
250 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
251 |   MFS   |1|0|1|   frame size  |        compressed data...     |
252 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
253 ]]></artwork>
254 </figure>
255 </t>
256
257 <t>
258 Three frames of different <spanx style="emph">durations</spanx>:
259
260 </t>
261
262 <t>
263 <figure>
264 <artwork><![CDATA[
265  0                   1                   2                   3
266  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
267 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
268 | 1st MFS |1|1|1|   frame size  | 2nd MFS |1|1|1|   frame size  |
269 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
270 | 3rd MFS |1|1|1|   frame size  |      compressed data...       |
271 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
272 ]]></artwork>
273 </figure>
274 </t>
275 </section>
276
277
278 </section>
279
280 <section anchor="security" title="Security Considerations">
281
282 <t>
283 The codec needs to take appropriate security considerations 
284 into account, as outlined in <xref target="DOS"/> and <xref target="SECGUIDE"/>.
285 It is extremely important for the decoder to be robust against malicious
286 payloads. Malicious payloads must not cause the decoder to overrun its
287 allocated memory or to take much more resources to decode. Although problems
288 in encoders are typically rarer, the same applies to the encoder. Malicious
289 audio stream must not cause the encoder to misbehave because this would
290 allow an attacker to attack transcoding gateways.
291 </t>
292 <t>
293 In its current version, the Opus codec likely does NOT meet these
294 security considerations, so it should be used with caution.
295 </t>
296 </section> 
297
298
299 <section title="IANA Considerations ">
300 <t>
301 This document has no actions for IANA.
302 </t>
303 </section>
304
305 <section anchor="Acknowledgments" title="Acknowledgments">
306 <t>
307 Thanks to all other developers, including Raymond Chen, Soeren Skak Jensen, Gregory Maxwell, 
308 Christopher Montgomery, Karsten Vandborg Soerensen, and Timothy Terriberry.
309 </t>
310 </section> 
311
312 </middle>
313
314 <back>
315
316 <references title="Informative References">
317
318 <reference anchor='SILK'>
319 <front>
320 <title>SILK Speech Codec</title>
321 <author initials='K.' surname='Vos' fullname='K. Vos'>
322 <organization /></author>
323 <author initials='S.' surname='Jensen' fullname='S. Jensen'>
324 <organization /></author>
325 <author initials='K.' surname='Soerensen' fullname='K. Soerensen'>
326 <organization /></author>
327 <date year='2010' month='March' />
328 <abstract>
329 <t></t>
330 </abstract></front>
331 <seriesInfo name='Internet-Draft' value='draft-vos-silk-01' />
332 <format type='TXT' target='http://tools.ietf.org/html/draft-vos-silk-01' />
333 </reference>
334
335 <reference anchor='CELT'>
336 <front>
337 <title>Constrained-Energy Lapped Transform (CELT) Codec</title>
338 <author initials='J-M.' surname='Valin' fullname='J-M. Valin'>
339 <organization /></author>
340 <author initials='T.' surname='Terriberry' fullname='T. Terriberry'>
341 <organization /></author>
342 <author initials='G.' surname='Maxwell' fullname='G. Maxwell'>
343 <organization /></author>
344 <author initials='C.' surname='Montgomery' fullname='C. Montgomery'>
345 <organization /></author>
346 <date year='2010' month='July' />
347 <abstract>
348 <t></t>
349 </abstract></front>
350 <seriesInfo name='Internet-Draft' value='draft-valin-celt-codec-02' />
351 <format type='TXT' target='http://tools.ietf.org/html/draft-valin-celt-codec-02' />
352 </reference>
353
354 <reference anchor='DOS'>
355 <front>
356 <title>Internet Denial-of-Service Considerations</title>
357 <author initials='M.' surname='Handley' fullname='M. Handley'>
358 <organization /></author>
359 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
360 <organization /></author>
361 <author>
362 <organization>IAB</organization></author>
363 <date year='2006' month='December' />
364 <abstract>
365 <t>This document provides an overview of possible avenues for denial-of-service (DoS) attack on Internet systems.  The aim is to encourage protocol designers and network engineers towards designs that are more robust.  We discuss partial solutions that reduce the effectiveness of attacks, and how some solutions might inadvertently open up alternative vulnerabilities.  This memo provides information for the Internet community.</t></abstract></front>
366 <seriesInfo name='RFC' value='4732' />
367 <format type='TXT' octets='91844' target='ftp://ftp.isi.edu/in-notes/rfc4732.txt' />
368 </reference>
369
370 <reference anchor='SECGUIDE'>
371 <front>
372 <title>Guidelines for Writing RFC Text on Security Considerations</title>
373 <author initials='E.' surname='Rescorla' fullname='E. Rescorla'>
374 <organization /></author>
375 <author initials='B.' surname='Korver' fullname='B. Korver'>
376 <organization /></author>
377 <date year='2003' month='July' />
378 <abstract>
379 <t>All RFCs are required to have a Security Considerations section.  Historically, such sections have been relatively weak.  This document provides guidelines to RFC authors on how to write a good Security Considerations section.  This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t></abstract></front>
380
381 <seriesInfo name='BCP' value='72' />
382 <seriesInfo name='RFC' value='3552' />
383 <format type='TXT' octets='110393' target='ftp://ftp.isi.edu/in-notes/rfc3552.txt' />
384 </reference>
385
386
387 </references> 
388
389 <section anchor="ref-implementation" title="Reference Implementation">
390
391 <t>This appendix contains the complete source code for the
392 reference implementation of the Opus codec written in C. This
393 implementation can be compiled for 
394 either floating-point or fixed-point architectures.
395 </t>
396
397 <t>The implementation can be compiled with either a C89 or a C99
398 compiler. It is reasonably optimized for most platforms such that
399 only architecture-specific optimizations are likely to be useful.
400 The FFT used is a slightly modified version of the KISS-FFT package,
401 but it is easy to substitute any other FFT library.
402 </t>
403
404 <section title="Extracting the source">
405 <t>
406 The complete source code can be extracted from this draft, by running the
407 following command line:
408
409 <list style="symbols">
410 <t><![CDATA[
411 cat draft-ietf-codec-opus.txt | grep '^   ###' | sed 's/   ###//' | base64 -d > opus_source.tar.gz
412 ]]></t>
413 <t>
414 tar xzvf opus_source.tar.gz
415 </t>
416 </list>
417
418 </t>
419 </section>
420
421 <section title="Base64-encoded source code">
422 <t>
423 <?rfc include="opus_source.base64"?>
424 </t>
425 </section>
426
427 </section>
428
429 </back>
430
431 </rfc>