Updated to CELT's new API
[opus.git] / src / opus_encoder.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_encoder.h"
40 #include "entenc.h"
41 #include "modes.h"
42 #include "SKP_Silk_SDK_API.h"
43
44 OpusEncoder *opus_encoder_create(int Fs)
45 {
46     char *raw_state;
47         OpusEncoder *st;
48         int ret, silkEncSizeBytes, celtEncSizeBytes;
49     SKP_SILK_SDK_EncControlStruct encControl;
50
51     /* Create SILK encoder */
52     ret = SKP_Silk_SDK_Get_Encoder_Size( &silkEncSizeBytes );
53     if( ret ) {
54         /* Handle error */
55     }
56     celtEncSizeBytes = celt_encoder_get_size(1);
57     raw_state = calloc(sizeof(OpusEncoder)+silkEncSizeBytes+celtEncSizeBytes, 1);
58     st = (OpusEncoder*)raw_state;
59     st->silk_enc = (void*)(raw_state+sizeof(OpusEncoder));
60     st->celt_enc = (CELTEncoder*)(raw_state+sizeof(OpusEncoder)+silkEncSizeBytes);
61
62     st->Fs = Fs;
63
64     /*encControl.API_sampleRate        = st->Fs;
65     encControl.packetLossPercentage  = 0;
66     encControl.useInBandFEC          = 0;
67     encControl.useDTX                = 0;
68     encControl.complexity            = 2;*/
69     ret = SKP_Silk_SDK_InitEncoder( st->silk_enc, &encControl );
70     if( ret ) {
71         /* Handle error */
72     }
73
74     /* Create CELT encoder */
75         /* Initialize CELT encoder */
76         st->celt_enc = celt_encoder_init(st->celt_enc, Fs, 1, NULL);
77
78         st->mode = MODE_HYBRID;
79         st->bandwidth = BANDWIDTH_FULLBAND;
80         st->vbr_rate = 0;
81
82         return st;
83 }
84
85 int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
86                 unsigned char *data, int bytes_per_packet)
87 {
88     int i;
89         int ret=0;
90         SKP_int32 nBytes;
91         ec_enc enc;
92         ec_byte_buffer buf;
93         SKP_SILK_SDK_EncControlStruct encControl;
94         int framerate, period;
95
96         bytes_per_packet -= 1;
97         data += 1;
98         ec_byte_writeinit_buffer(&buf, data, bytes_per_packet);
99         ec_enc_init(&enc,&buf);
100
101         if (st->mode != MODE_CELT_ONLY)
102         {
103             /* Set Encoder parameters */
104             encControl.API_sampleRate        = st->Fs;
105             encControl.packetLossPercentage  = 2;
106             encControl.useInBandFEC          = 0;
107             encControl.useDTX                = 0;
108             encControl.complexity            = 2;
109
110             if (st->vbr_rate != 0)
111             encControl.bitRate = (st->vbr_rate+6000)/2;
112             else {
113                 encControl.bitRate = (bytes_per_packet*8*(celt_int32)st->Fs/frame_size+6000)/2;
114                 if (st->Fs  == 100 * frame_size)
115                     encControl.bitRate -= 5000;
116             }
117             encControl.payloadSize_ms = 1000 * frame_size / st->Fs;
118
119             if (st->mode == MODE_HYBRID)
120                 encControl.minInternalSampleRate = 16000;
121             else
122                 encControl.minInternalSampleRate = 8000;
123
124             if (st->bandwidth == BANDWIDTH_NARROWBAND)
125                 encControl.maxInternalSampleRate = 8000;
126             else if (st->bandwidth == BANDWIDTH_MEDIUMBAND)
127                 encControl.maxInternalSampleRate = 12000;
128             else
129                 encControl.maxInternalSampleRate = 16000;
130
131             /* Call SILK encoder for the low band */
132             nBytes = bytes_per_packet;
133             ret = SKP_Silk_SDK_Encode( st->silk_enc, &encControl, pcm, frame_size, &enc, &nBytes );
134             if( ret ) {
135                 fprintf (stderr, "SILK encode error %d\n", ret);
136                 /* Handle error */
137             }
138             ret = (ec_enc_tell(&enc, 0)+7)>>3;
139         }
140
141         if (st->mode == MODE_HYBRID)
142         {
143             /* This should be adjusted based on the SILK bandwidth */
144             celt_encoder_ctl(st->celt_enc, CELT_SET_START_BAND(17));
145         } else {
146         celt_encoder_ctl(st->celt_enc, CELT_SET_START_BAND(0));
147         }
148
149         if (st->mode != MODE_SILK_ONLY && st->bandwidth > BANDWIDTH_WIDEBAND)
150         {
151                 int endband;
152             short pcm_buf[960];
153
154             switch(st->bandwidth)
155             {
156             case BANDWIDTH_NARROWBAND:
157                 endband = 13;
158                 break;
159             case BANDWIDTH_WIDEBAND:
160                 endband = 17;
161                 break;
162             case BANDWIDTH_SUPERWIDEBAND:
163                 endband = 19;
164                 break;
165             case BANDWIDTH_FULLBAND:
166                 endband = 21;
167                 break;
168             }
169             celt_encoder_ctl(st->celt_enc, CELT_SET_END_BAND(endband));
170
171             for (i=0;i<ENCODER_DELAY_COMPENSATION;i++)
172                 pcm_buf[i] = st->delay_buffer[i];
173         for (;i<frame_size;i++)
174             pcm_buf[i] = pcm[i-ENCODER_DELAY_COMPENSATION];
175
176         celt_encoder_ctl(st->celt_enc, CELT_SET_PREDICTION(1));
177
178         if (st->vbr_rate != 0)
179         {
180             int tmp = (st->vbr_rate-6000)/2;
181             tmp = ((ec_enc_tell(&enc, 0)+4)>>3) + tmp * frame_size/(8*st->Fs);
182             if (tmp <= bytes_per_packet)
183                 bytes_per_packet = tmp;
184             ec_byte_shrink(&buf, bytes_per_packet);
185         }
186             /* Encode high band with CELT */
187             ret = celt_encode_with_ec(st->celt_enc, pcm_buf, frame_size, NULL, bytes_per_packet, &enc);
188             for (i=0;i<ENCODER_DELAY_COMPENSATION;i++)
189                 st->delay_buffer[i] = pcm[frame_size-ENCODER_DELAY_COMPENSATION+i];
190         } else {
191             ec_enc_done(&enc);
192         }
193
194         /* Signalling the mode in the first byte */
195         data--;
196         framerate = st->Fs/frame_size;
197         period = 0;
198         while (framerate < 400)
199         {
200             framerate <<= 1;
201             period++;
202         }
203     if (st->mode == MODE_SILK_ONLY)
204     {
205         data[0] = (st->bandwidth-BANDWIDTH_NARROWBAND)<<5;
206         data[0] |= (period-2)<<3;
207     } else if (st->mode == MODE_CELT_ONLY)
208     {
209         int tmp = st->bandwidth-BANDWIDTH_MEDIUMBAND;
210         if (tmp < 0)
211             tmp = 0;
212         data[0] = 0x80;
213         data[0] |= tmp << 5;
214         data[0] |= period<<3;
215     } else /* Opus */
216     {
217         data[0] = 0x60;
218         data[0] |= (st->bandwidth-BANDWIDTH_SUPERWIDEBAND)<<4;
219         data[0] |= (period-2)<<3;
220     }
221     /*printf ("%x\n", (int)data[0]);*/
222
223     return ret+1;
224 }
225
226 void opus_encoder_ctl(OpusEncoder *st, int request, ...)
227 {
228     va_list ap;
229
230     va_start(ap, request);
231
232     switch (request)
233     {
234         case OPUS_SET_MODE_REQUEST:
235         {
236             int value = va_arg(ap, int);
237             st->mode = value;
238         }
239         break;
240         case OPUS_GET_MODE_REQUEST:
241         {
242             int *value = va_arg(ap, int*);
243             *value = st->mode;
244         }
245         break;
246         case OPUS_SET_BANDWIDTH_REQUEST:
247         {
248             int value = va_arg(ap, int);
249             st->bandwidth = value;
250         }
251         break;
252         case OPUS_GET_BANDWIDTH_REQUEST:
253         {
254             int *value = va_arg(ap, int*);
255             *value = st->bandwidth;
256         }
257         break;
258         case OPUS_SET_VBR_RATE_REQUEST:
259         {
260             int value = va_arg(ap, int);
261             st->vbr_rate = value;
262         }
263         break;
264         case OPUS_GET_VBR_RATE_REQUEST:
265         {
266             int *value = va_arg(ap, int*);
267             *value = st->vbr_rate;
268         }
269         break;
270         default:
271             fprintf(stderr, "unknown opus_encoder_ctl() request: %d", request);
272             break;
273     }
274
275     va_end(ap);
276 }
277
278 void opus_encoder_destroy(OpusEncoder *st)
279 {
280         free(st);
281 }
282