Koen's decoder updates
[opus.git] / src / opus_decoder.c
1 /* Copyright (c) 2010 Xiph.Org Foundation, Skype Limited
2    Written by Jean-Marc Valin and Koen Vos */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include <stdlib.h>
37 #include <stdio.h>
38 #include <stdarg.h>
39 #include "opus_decoder.h"
40 #include "entdec.h"
41 #include "modes.h"
42 #include "SKP_Silk_SDK_API.h"
43
44
45 OpusDecoder *opus_decoder_create(int Fs, int channels)
46 {
47     char *raw_state;
48         int ret, silkDecSizeBytes, celtDecSizeBytes;
49         OpusDecoder *st;
50
51         /* Initialize SILK encoder */
52     ret = SKP_Silk_SDK_Get_Decoder_Size( &silkDecSizeBytes );
53     if( ret ) {
54         /* Handle error */
55     }
56     celtDecSizeBytes = celt_decoder_get_size(channels);
57     raw_state = calloc(sizeof(OpusDecoder)+silkDecSizeBytes+celtDecSizeBytes, 1);
58     st = (OpusDecoder*)raw_state;
59     st->silk_dec = (void*)(raw_state+sizeof(OpusDecoder));
60     st->celt_dec = (CELTDecoder*)(raw_state+sizeof(OpusDecoder)+silkDecSizeBytes);
61     st->stream_channels = st->channels = channels;
62
63     st->Fs = Fs;
64
65     /* Reset decoder */
66     ret = SKP_Silk_SDK_InitDecoder( st->silk_dec );
67     if( ret ) {
68         /* Handle error */
69     }
70
71         /* Initialize CELT decoder */
72         st->celt_dec = celt_decoder_init(st->celt_dec, Fs, channels, NULL);
73
74         return st;
75
76 }
77 int opus_decode(OpusDecoder *st, const unsigned char *data,
78                 int len, short *pcm, int frame_size)
79 {
80         int i, silk_ret=0, celt_ret=0;
81         ec_dec dec;
82         ec_byte_buffer buf;
83     SKP_SILK_SDK_DecControlStruct DecControl;
84     SKP_int32 silk_frame_size;
85     short pcm_celt[960*2];
86     int audiosize;
87
88     if (data != NULL)
89     {
90         /* Decoding mode/bandwidth/framesize from first byte */
91         if (data[0]&0x80)
92         {
93             st->mode = MODE_CELT_ONLY;
94             st->bandwidth = BANDWIDTH_MEDIUMBAND + ((data[0]>>5)&0x3);
95             if (st->bandwidth == BANDWIDTH_MEDIUMBAND)
96                 st->bandwidth = BANDWIDTH_NARROWBAND;
97             audiosize = ((data[0]>>3)&0x3);
98             audiosize = (st->Fs<<audiosize)/400;
99         } else if ((data[0]&0x60) == 0x60)
100         {
101             st->mode = MODE_HYBRID;
102             st->bandwidth = (data[0]&0x10) ? BANDWIDTH_FULLBAND : BANDWIDTH_SUPERWIDEBAND;
103             audiosize = (data[0]&0x08) ? st->Fs/50 : st->Fs/100;
104         } else {
105
106             st->mode = MODE_SILK_ONLY;
107             st->bandwidth = BANDWIDTH_NARROWBAND + ((data[0]>>5)&0x3);
108             audiosize = ((data[0]>>3)&0x3);
109             if (audiosize == 3)
110                 audiosize = st->Fs*60/1000;
111             else
112                 audiosize = (st->Fs<<audiosize)/100;
113         }
114         st->stream_channels = (data[0]&0x4) ? 2 : 1;
115         /*printf ("%d %d %d\n", st->mode, st->bandwidth, audiosize);*/
116
117         len -= 1;
118         data += 1;
119         ec_byte_readinit(&buf,(unsigned char*)data,len);
120         ec_dec_init(&dec,&buf);
121     }
122
123     if (audiosize > frame_size)
124     {
125         fprintf(stderr, "PCM buffer too small");
126         return -1;
127     } else {
128         frame_size = audiosize;
129     }
130
131     if (st->mode != MODE_CELT_ONLY)
132     {
133         SKP_int16 *pcm_ptr = pcm;
134         DecControl.API_sampleRate = st->Fs;
135         DecControl.payloadSize_ms = 1000 * audiosize / st->Fs;
136         if( st->mode == MODE_SILK_ONLY ) {
137             if( st->bandwidth == BANDWIDTH_NARROWBAND ) {
138                 DecControl.internalSampleRate = 8000;
139             } else if( st->bandwidth == BANDWIDTH_MEDIUMBAND ) {
140                 DecControl.internalSampleRate = 12000;
141             } else if( st->bandwidth == BANDWIDTH_WIDEBAND ) {
142                 DecControl.internalSampleRate = 16000;
143             } else {
144                 SKP_assert( 0 );
145             }
146         } else {
147             /* Hybrid mode */
148             DecControl.internalSampleRate = 16000;
149         }
150
151         /* FIXME: Add a check here to avoid a buffer overflow if there are more
152            samples in the SILK frame. In fact the TOC byte should tell us how many
153            frames there are */
154         do {
155             /* Call SILK decoder */
156             silk_ret = SKP_Silk_SDK_Decode( st->silk_dec, &DecControl, data == NULL, &dec, len, pcm_ptr, &silk_frame_size );
157             if( silk_ret ) {
158                 fprintf (stderr, "SILK decode error\n");
159                 /* Handle error */
160             }
161             pcm_ptr += silk_frame_size;
162         } while( DecControl.moreInternalDecoderFrames );
163     } else {
164         for (i=0;i<frame_size*st->channels;i++)
165             pcm[i] = 0;
166     }
167
168     if (st->mode == MODE_HYBRID)
169     {
170         /* This should be adjusted based on the SILK bandwidth */
171         celt_decoder_ctl(st->celt_dec, CELT_SET_START_BAND(17));
172     } else {
173         celt_decoder_ctl(st->celt_dec, CELT_SET_START_BAND(0));
174     }
175
176     if (st->mode != MODE_SILK_ONLY)
177     {
178         int endband;
179
180             switch(st->bandwidth)
181             {
182             case BANDWIDTH_NARROWBAND:
183                 endband = 13;
184                 break;
185             case BANDWIDTH_WIDEBAND:
186                 endband = 17;
187                 break;
188             case BANDWIDTH_SUPERWIDEBAND:
189                 endband = 19;
190                 break;
191             case BANDWIDTH_FULLBAND:
192                 endband = 21;
193                 break;
194             }
195             celt_decoder_ctl(st->celt_dec, CELT_SET_END_BAND(endband));
196             celt_decoder_ctl(st->celt_dec, CELT_SET_CHANNELS(st->stream_channels));
197
198         /* Encode high band with CELT */
199         celt_ret = celt_decode_with_ec(st->celt_dec, data, len, pcm_celt, frame_size, &dec);
200         for (i=0;i<frame_size*st->channels;i++)
201             pcm[i] = ADD_SAT16(pcm[i], pcm_celt[i]);
202     }
203         return celt_ret<0 ? celt_ret : audiosize;
204
205 }
206
207 void opus_decoder_ctl(OpusDecoder *st, int request, ...)
208 {
209     va_list ap;
210
211     va_start(ap, request);
212
213     switch (request)
214     {
215         case OPUS_SET_MODE_REQUEST:
216         {
217             int value = va_arg(ap, int);
218             st->mode = value;
219         }
220         break;
221         case OPUS_GET_MODE_REQUEST:
222         {
223             int *value = va_arg(ap, int*);
224             *value = st->mode;
225         }
226         break;
227         case OPUS_SET_BANDWIDTH_REQUEST:
228         {
229             int value = va_arg(ap, int);
230             st->bandwidth = value;
231         }
232         break;
233         case OPUS_GET_BANDWIDTH_REQUEST:
234         {
235             int *value = va_arg(ap, int*);
236             *value = st->bandwidth;
237         }
238         break;
239         default:
240             fprintf(stderr, "unknown opus_decoder_ctl() request: %d", request);
241             break;
242     }
243
244     va_end(ap);
245 }
246
247 void opus_decoder_destroy(OpusDecoder *st)
248 {
249         free(st);
250 }