API renamed to Opus
[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     CELTMode *celtMode;
48         OpusEncoder *st;
49         int ret, silkEncSizeBytes, celtEncSizeBytes;
50     SKP_SILK_SDK_EncControlStruct encControl;
51
52     /* We should not have to create a CELT mode for each encoder state */
53     celtMode = celt_mode_create(Fs, Fs/50, NULL);
54
55     /* Create SILK encoder */
56     ret = SKP_Silk_SDK_Get_Encoder_Size( &silkEncSizeBytes );
57     if( ret ) {
58         /* Handle error */
59     }
60     celtEncSizeBytes = celt_encoder_get_size(celtMode, 1);
61     raw_state = calloc(sizeof(OpusEncoder)+silkEncSizeBytes+celtEncSizeBytes, 1);
62     st = (OpusEncoder*)raw_state;
63     st->silk_enc = (void*)(raw_state+sizeof(OpusEncoder));
64     st->celt_enc = (CELTEncoder*)(raw_state+sizeof(OpusEncoder)+silkEncSizeBytes);
65
66     st->Fs = Fs;
67     st->celt_mode = celtMode;
68
69     /*encControl.API_sampleRate        = st->Fs;
70     encControl.packetLossPercentage  = 0;
71     encControl.useInBandFEC          = 0;
72     encControl.useDTX                = 0;
73     encControl.complexity            = 2;*/
74     ret = SKP_Silk_SDK_InitEncoder( st->silk_enc, &encControl );
75     if( ret ) {
76         /* Handle error */
77     }
78
79     /* Create CELT encoder */
80         /* Initialize CELT encoder */
81         st->celt_enc = celt_encoder_init(st->celt_enc, st->celt_mode, 1, NULL);
82
83         st->mode = MODE_HYBRID;
84         st->bandwidth = BANDWIDTH_FULLBAND;
85         st->vbr_rate = 0;
86
87         return st;
88 }
89
90 int opus_encode(OpusEncoder *st, const short *pcm, int frame_size,
91                 unsigned char *data, int bytes_per_packet)
92 {
93     int i;
94         int ret=0;
95         SKP_int16 nBytes;
96         ec_enc enc;
97         ec_byte_buffer buf;
98         SKP_SILK_SDK_EncControlStruct encControl;
99         int framerate, period;
100
101         bytes_per_packet -= 1;
102         data += 1;
103         ec_byte_writeinit_buffer(&buf, data, bytes_per_packet);
104         ec_enc_init(&enc,&buf);
105
106         if (st->mode != MODE_CELT_ONLY)
107         {
108             /* Set Encoder parameters */
109             encControl.API_sampleRate        = st->Fs;
110             encControl.packetLossPercentage  = 2;
111             encControl.useInBandFEC          = 0;
112             encControl.useDTX                = 0;
113             encControl.complexity            = 2;
114
115             if (st->vbr_rate != 0)
116             encControl.bitRate = (st->vbr_rate+6000)/2;
117             else {
118                 encControl.bitRate = (bytes_per_packet*8*(celt_int32)st->Fs/frame_size+6000)/2;
119                 if (st->Fs  == 100 * frame_size)
120                     encControl.bitRate -= 5000;
121             }
122             encControl.packetSize = frame_size;
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\n");
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             short pcm_buf[960];
152
153         if (st->bandwidth == BANDWIDTH_SUPERWIDEBAND)
154             celt_encoder_ctl(st->celt_enc, CELT_SET_END_BAND(20));
155         else
156             celt_encoder_ctl(st->celt_enc, CELT_SET_END_BAND(21));
157
158             for (i=0;i<ENCODER_DELAY_COMPENSATION;i++)
159                 pcm_buf[i] = st->delay_buffer[i];
160         for (;i<frame_size;i++)
161             pcm_buf[i] = pcm[i-ENCODER_DELAY_COMPENSATION];
162
163         celt_encoder_ctl(st->celt_enc, CELT_SET_PREDICTION(1));
164
165         if (st->vbr_rate != 0)
166         {
167             int tmp = (st->vbr_rate-6000)/2;
168             tmp = ((ec_enc_tell(&enc, 0)+4)>>3) + tmp * frame_size/(8*st->Fs);
169             if (tmp <= bytes_per_packet)
170                 bytes_per_packet = tmp;
171             ec_byte_shrink(&buf, bytes_per_packet);
172         }
173             /* Encode high band with CELT */
174             ret = celt_encode_with_ec(st->celt_enc, pcm_buf, NULL, frame_size, NULL, bytes_per_packet, &enc);
175             for (i=0;i<ENCODER_DELAY_COMPENSATION;i++)
176                 st->delay_buffer[i] = pcm[frame_size-ENCODER_DELAY_COMPENSATION+i];
177         } else {
178             ec_enc_done(&enc);
179         }
180
181         /* Signalling the mode in the first byte */
182         data--;
183         framerate = st->Fs/frame_size;
184         period = 0;
185         while (framerate < 400)
186         {
187             framerate <<= 1;
188             period++;
189         }
190     if (st->mode == MODE_SILK_ONLY)
191     {
192         data[0] = (st->bandwidth-BANDWIDTH_NARROWBAND)<<5;
193         data[0] |= (period-2)<<3;
194     } else if (st->mode == MODE_CELT_ONLY)
195     {
196         int tmp = st->bandwidth-BANDWIDTH_MEDIUMBAND;
197         if (tmp < 0)
198             tmp = 0;
199         data[0] = 0x80;
200         data[0] |= tmp << 5;
201         data[0] |= period<<3;
202     } else /* Opus */
203     {
204         data[0] = 0x60;
205         data[0] |= (st->bandwidth-BANDWIDTH_SUPERWIDEBAND)<<4;
206         data[0] |= (period-2)<<3;
207     }
208     /*printf ("%x\n", (int)data[0]);*/
209
210     return ret+1;
211 }
212
213 void opus_encoder_ctl(OpusEncoder *st, int request, ...)
214 {
215     va_list ap;
216
217     va_start(ap, request);
218
219     switch (request)
220     {
221         case OPUS_SET_MODE_REQUEST:
222         {
223             int value = va_arg(ap, int);
224             st->mode = value;
225         }
226         break;
227         case OPUS_GET_MODE_REQUEST:
228         {
229             int *value = va_arg(ap, int*);
230             *value = st->mode;
231         }
232         break;
233         case OPUS_SET_BANDWIDTH_REQUEST:
234         {
235             int value = va_arg(ap, int);
236             st->bandwidth = value;
237         }
238         break;
239         case OPUS_GET_BANDWIDTH_REQUEST:
240         {
241             int *value = va_arg(ap, int*);
242             *value = st->bandwidth;
243         }
244         break;
245         case OPUS_SET_VBR_RATE_REQUEST:
246         {
247             int value = va_arg(ap, int);
248             st->vbr_rate = value;
249         }
250         break;
251         case OPUS_GET_VBR_RATE_REQUEST:
252         {
253             int *value = va_arg(ap, int*);
254             *value = st->vbr_rate;
255         }
256         break;
257         default:
258             fprintf(stderr, "unknown opus_encoder_ctl() request: %d", request);
259             break;
260     }
261
262     va_end(ap);
263 }
264
265 void opus_encoder_destroy(OpusEncoder *st)
266 {
267         celt_mode_destroy(st->celt_mode);
268         free(st);
269 }
270