Handling auto-detecting of frame size in decoder
[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         DecControl.API_sampleRate = st->Fs;
134         DecControl.payloadSize_ms = 1000 * audiosize / st->Fs;
135         if( st->mode == MODE_SILK_ONLY ) {
136             if( st->bandwidth == BANDWIDTH_NARROWBAND ) {
137                 DecControl.internalSampleRate = 8000;
138             } else if( st->bandwidth == BANDWIDTH_MEDIUMBAND ) {
139                 DecControl.internalSampleRate = 12000;
140             } else if( st->bandwidth == BANDWIDTH_WIDEBAND ) {
141                 DecControl.internalSampleRate = 16000;
142             } else {
143                 SKP_assert( 0 );
144             }
145         } else {
146             /* Hybrid mode */
147             DecControl.internalSampleRate = 16000;
148         }
149
150         /* We Should eventually have to set the bandwidth here */
151
152         /* Call SILK encoder for the low band */
153         silk_ret = SKP_Silk_SDK_Decode( st->silk_dec, &DecControl, data == NULL, &dec, len, pcm, &silk_frame_size );
154         if (silk_ret)
155         {
156             fprintf (stderr, "SILK decode error\n");
157             /* Handle error */
158         }
159     } else {
160         for (i=0;i<frame_size*st->channels;i++)
161             pcm[i] = 0;
162     }
163
164     if (st->mode == MODE_HYBRID)
165     {
166         /* This should be adjusted based on the SILK bandwidth */
167         celt_decoder_ctl(st->celt_dec, CELT_SET_START_BAND(17));
168     } else {
169         celt_decoder_ctl(st->celt_dec, CELT_SET_START_BAND(0));
170     }
171
172     if (st->mode != MODE_SILK_ONLY && st->bandwidth > BANDWIDTH_WIDEBAND)
173     {
174         int endband;
175
176             switch(st->bandwidth)
177             {
178             case BANDWIDTH_NARROWBAND:
179                 endband = 13;
180                 break;
181             case BANDWIDTH_WIDEBAND:
182                 endband = 17;
183                 break;
184             case BANDWIDTH_SUPERWIDEBAND:
185                 endband = 19;
186                 break;
187             case BANDWIDTH_FULLBAND:
188                 endband = 21;
189                 break;
190             }
191             celt_decoder_ctl(st->celt_dec, CELT_SET_END_BAND(endband));
192             celt_decoder_ctl(st->celt_dec, CELT_SET_CHANNELS(st->stream_channels));
193
194         /* Encode high band with CELT */
195         celt_ret = celt_decode_with_ec(st->celt_dec, data, len, pcm_celt, frame_size, &dec);
196         for (i=0;i<frame_size*st->channels;i++)
197             pcm[i] += pcm_celt[i];
198     }
199         return celt_ret<0 ? celt_ret : audiosize;
200
201 }
202
203 void opus_decoder_ctl(OpusDecoder *st, int request, ...)
204 {
205     va_list ap;
206
207     va_start(ap, request);
208
209     switch (request)
210     {
211         case OPUS_SET_MODE_REQUEST:
212         {
213             int value = va_arg(ap, int);
214             st->mode = value;
215         }
216         break;
217         case OPUS_GET_MODE_REQUEST:
218         {
219             int *value = va_arg(ap, int*);
220             *value = st->mode;
221         }
222         break;
223         case OPUS_SET_BANDWIDTH_REQUEST:
224         {
225             int value = va_arg(ap, int);
226             st->bandwidth = value;
227         }
228         break;
229         case OPUS_GET_BANDWIDTH_REQUEST:
230         {
231             int *value = va_arg(ap, int*);
232             *value = st->bandwidth;
233         }
234         break;
235         default:
236             fprintf(stderr, "unknown opus_decoder_ctl() request: %d", request);
237             break;
238     }
239
240     va_end(ap);
241 }
242
243 void opus_decoder_destroy(OpusDecoder *st)
244 {
245         free(st);
246 }