Change license headers to say 'FFmpeg' instead of 'this program/this library'
[ffmpeg.git] / libavcodec / oggvorbis.c
1 /*
2  * copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  */
20
21 /**
22  * @file oggvorbis.c
23  * Ogg Vorbis codec support via libvorbisenc.
24  * @author Mark Hills <mark@pogo.org.uk>
25  */
26
27 #include <vorbis/vorbisenc.h>
28
29 #include "avcodec.h"
30
31 #undef NDEBUG
32 #include <assert.h>
33
34 #define OGGVORBIS_FRAME_SIZE 64
35
36 #define BUFFER_SIZE (1024*64)
37
38 typedef struct OggVorbisContext {
39     vorbis_info vi ;
40     vorbis_dsp_state vd ;
41     vorbis_block vb ;
42     uint8_t buffer[BUFFER_SIZE];
43     int buffer_index;
44
45     /* decoder */
46     vorbis_comment vc ;
47     ogg_packet op;
48 } OggVorbisContext ;
49
50
51 static int oggvorbis_init_encoder(vorbis_info *vi, AVCodecContext *avccontext) {
52     double cfreq;
53
54     if(avccontext->flags & CODEC_FLAG_QSCALE) {
55         /* variable bitrate */
56         if(vorbis_encode_setup_vbr(vi, avccontext->channels,
57                 avccontext->sample_rate,
58                 avccontext->global_quality / (float)FF_QP2LAMBDA))
59             return -1;
60     } else {
61         /* constant bitrate */
62         if(vorbis_encode_setup_managed(vi, avccontext->channels,
63                 avccontext->sample_rate, -1, avccontext->bit_rate, -1))
64             return -1;
65
66 #ifdef OGGVORBIS_VBR_BY_ESTIMATE
67         /* variable bitrate by estimate */
68         if(vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE_AVG, NULL))
69             return -1;
70 #endif
71     }
72
73     /* cutoff frequency */
74     if(avccontext->cutoff > 0) {
75         cfreq = avccontext->cutoff / 1000.0;
76         if(vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq))
77             return -1;
78     }
79
80     return vorbis_encode_setup_init(vi);
81 }
82
83 static int oggvorbis_encode_init(AVCodecContext *avccontext) {
84     OggVorbisContext *context = avccontext->priv_data ;
85     ogg_packet header, header_comm, header_code;
86     uint8_t *p;
87     unsigned int offset, len;
88
89     vorbis_info_init(&context->vi) ;
90     if(oggvorbis_init_encoder(&context->vi, avccontext) < 0) {
91         av_log(avccontext, AV_LOG_ERROR, "oggvorbis_encode_init: init_encoder failed") ;
92         return -1 ;
93     }
94     vorbis_analysis_init(&context->vd, &context->vi) ;
95     vorbis_block_init(&context->vd, &context->vb) ;
96
97     vorbis_comment_init(&context->vc);
98     vorbis_comment_add_tag(&context->vc, "encoder", LIBAVCODEC_IDENT) ;
99
100     vorbis_analysis_headerout(&context->vd, &context->vc, &header,
101                                 &header_comm, &header_code);
102
103     len = header.bytes + header_comm.bytes +  header_code.bytes;
104     avccontext->extradata_size= 64 + len + len/255;
105     p = avccontext->extradata= av_mallocz(avccontext->extradata_size);
106     p[0] = 2;
107     offset = 1;
108     offset += av_xiphlacing(&p[offset], header.bytes);
109     offset += av_xiphlacing(&p[offset], header_comm.bytes);
110     memcpy(&p[offset], header.packet, header.bytes);
111     offset += header.bytes;
112     memcpy(&p[offset], header_comm.packet, header_comm.bytes);
113     offset += header_comm.bytes;
114     memcpy(&p[offset], header_code.packet, header_code.bytes);
115     offset += header_code.bytes;
116     avccontext->extradata_size = offset;
117     avccontext->extradata= av_realloc(avccontext->extradata, avccontext->extradata_size);
118
119 /*    vorbis_block_clear(&context->vb);
120     vorbis_dsp_clear(&context->vd);
121     vorbis_info_clear(&context->vi);*/
122     vorbis_comment_clear(&context->vc);
123
124     avccontext->frame_size = OGGVORBIS_FRAME_SIZE ;
125
126     avccontext->coded_frame= avcodec_alloc_frame();
127     avccontext->coded_frame->key_frame= 1;
128
129     return 0 ;
130 }
131
132
133 static int oggvorbis_encode_frame(AVCodecContext *avccontext,
134                                   unsigned char *packets,
135                            int buf_size, void *data)
136 {
137     OggVorbisContext *context = avccontext->priv_data ;
138     float **buffer ;
139     ogg_packet op ;
140     signed short *audio = data ;
141     int l, samples = data ? OGGVORBIS_FRAME_SIZE : 0;
142
143     buffer = vorbis_analysis_buffer(&context->vd, samples) ;
144
145     if(context->vi.channels == 1) {
146         for(l = 0 ; l < samples ; l++)
147             buffer[0][l]=audio[l]/32768.f;
148     } else {
149         for(l = 0 ; l < samples ; l++){
150             buffer[0][l]=audio[l*2]/32768.f;
151             buffer[1][l]=audio[l*2+1]/32768.f;
152         }
153     }
154
155     vorbis_analysis_wrote(&context->vd, samples) ;
156
157     while(vorbis_analysis_blockout(&context->vd, &context->vb) == 1) {
158         vorbis_analysis(&context->vb, NULL);
159         vorbis_bitrate_addblock(&context->vb) ;
160
161         while(vorbis_bitrate_flushpacket(&context->vd, &op)) {
162             if(op.bytes==1) //id love to say this is a hack, bad sadly its not, appearently the end of stream decission is in libogg
163                 continue;
164             memcpy(context->buffer + context->buffer_index, &op, sizeof(ogg_packet));
165             context->buffer_index += sizeof(ogg_packet);
166             memcpy(context->buffer + context->buffer_index, op.packet, op.bytes);
167             context->buffer_index += op.bytes;
168 //            av_log(avccontext, AV_LOG_DEBUG, "e%d / %d\n", context->buffer_index, op.bytes);
169         }
170     }
171
172     l=0;
173     if(context->buffer_index){
174         ogg_packet *op2= (ogg_packet*)context->buffer;
175         op2->packet = context->buffer + sizeof(ogg_packet);
176
177         l=  op2->bytes;
178         avccontext->coded_frame->pts= av_rescale_q(op2->granulepos, (AVRational){1, avccontext->sample_rate}, avccontext->time_base);
179         //FIXME we should reorder the user supplied pts and not assume that they are spaced by 1/sample_rate
180
181         memcpy(packets, op2->packet, l);
182         context->buffer_index -= l + sizeof(ogg_packet);
183         memcpy(context->buffer, context->buffer + l + sizeof(ogg_packet), context->buffer_index);
184 //        av_log(avccontext, AV_LOG_DEBUG, "E%d\n", l);
185     }
186
187     return l;
188 }
189
190
191 static int oggvorbis_encode_close(AVCodecContext *avccontext) {
192     OggVorbisContext *context = avccontext->priv_data ;
193 /*  ogg_packet op ; */
194
195     vorbis_analysis_wrote(&context->vd, 0) ; /* notify vorbisenc this is EOF */
196
197     vorbis_block_clear(&context->vb);
198     vorbis_dsp_clear(&context->vd);
199     vorbis_info_clear(&context->vi);
200
201     av_freep(&avccontext->coded_frame);
202     av_freep(&avccontext->extradata);
203
204     return 0 ;
205 }
206
207
208 AVCodec oggvorbis_encoder = {
209     "vorbis",
210     CODEC_TYPE_AUDIO,
211     CODEC_ID_VORBIS,
212     sizeof(OggVorbisContext),
213     oggvorbis_encode_init,
214     oggvorbis_encode_frame,
215     oggvorbis_encode_close,
216     .capabilities= CODEC_CAP_DELAY,
217 } ;
218
219 static int oggvorbis_decode_init(AVCodecContext *avccontext) {
220     OggVorbisContext *context = avccontext->priv_data ;
221     uint8_t *p= avccontext->extradata;
222     int i, hsizes[3];
223     unsigned char *headers[3], *extradata = avccontext->extradata;
224
225     vorbis_info_init(&context->vi) ;
226     vorbis_comment_init(&context->vc) ;
227
228     if(! avccontext->extradata_size || ! p) {
229         av_log(avccontext, AV_LOG_ERROR, "vorbis extradata absent\n");
230         return -1;
231     }
232
233     if(p[0] == 0 && p[1] == 30) {
234         for(i = 0; i < 3; i++){
235             hsizes[i] = *p++ << 8;
236             hsizes[i] += *p++;
237             headers[i] = p;
238             p += hsizes[i];
239         }
240     } else if(*p == 2) {
241         unsigned int offset = 1;
242         p++;
243         for(i=0; i<2; i++) {
244             hsizes[i] = 0;
245             while((*p == 0xFF) && (offset < avccontext->extradata_size)) {
246                 hsizes[i] += 0xFF;
247                 offset++;
248                 p++;
249             }
250             if(offset >= avccontext->extradata_size - 1) {
251                 av_log(avccontext, AV_LOG_ERROR,
252                        "vorbis header sizes damaged\n");
253                 return -1;
254             }
255             hsizes[i] += *p;
256             offset++;
257             p++;
258         }
259         hsizes[2] = avccontext->extradata_size - hsizes[0]-hsizes[1]-offset;
260 #if 0
261         av_log(avccontext, AV_LOG_DEBUG,
262                "vorbis header sizes: %d, %d, %d, / extradata_len is %d \n",
263                hsizes[0], hsizes[1], hsizes[2], avccontext->extradata_size);
264 #endif
265         headers[0] = extradata + offset;
266         headers[1] = extradata + offset + hsizes[0];
267         headers[2] = extradata + offset + hsizes[0] + hsizes[1];
268     } else {
269         av_log(avccontext, AV_LOG_ERROR,
270                "vorbis initial header len is wrong: %d\n", *p);
271         return -1;
272     }
273
274     for(i=0; i<3; i++){
275         context->op.b_o_s= i==0;
276         context->op.bytes = hsizes[i];
277         context->op.packet = headers[i];
278         if(vorbis_synthesis_headerin(&context->vi, &context->vc, &context->op)<0){
279             av_log(avccontext, AV_LOG_ERROR, "%d. vorbis header damaged\n", i+1);
280             return -1;
281         }
282     }
283
284     avccontext->channels = context->vi.channels;
285     avccontext->sample_rate = context->vi.rate;
286     avccontext->time_base= (AVRational){1, avccontext->sample_rate};
287
288     vorbis_synthesis_init(&context->vd, &context->vi);
289     vorbis_block_init(&context->vd, &context->vb);
290
291     return 0 ;
292 }
293
294
295 static inline int conv(int samples, float **pcm, char *buf, int channels) {
296     int i, j, val ;
297     ogg_int16_t *ptr, *data = (ogg_int16_t*)buf ;
298     float *mono ;
299
300     for(i = 0 ; i < channels ; i++){
301         ptr = &data[i];
302         mono = pcm[i] ;
303
304         for(j = 0 ; j < samples ; j++) {
305
306             val = mono[j] * 32767.f;
307
308             if(val > 32767) val = 32767 ;
309             if(val < -32768) val = -32768 ;
310
311             *ptr = val ;
312             ptr += channels;
313         }
314     }
315
316     return 0 ;
317 }
318
319
320 static int oggvorbis_decode_frame(AVCodecContext *avccontext,
321                         void *data, int *data_size,
322                         uint8_t *buf, int buf_size)
323 {
324     OggVorbisContext *context = avccontext->priv_data ;
325     float **pcm ;
326     ogg_packet *op= &context->op;
327     int samples, total_samples, total_bytes;
328
329     if(!buf_size){
330     //FIXME flush
331         return 0;
332     }
333
334     op->packet = buf;
335     op->bytes  = buf_size;
336
337 //    av_log(avccontext, AV_LOG_DEBUG, "%d %d %d %lld %lld %d %d\n", op->bytes, op->b_o_s, op->e_o_s, op->granulepos, op->packetno, buf_size, context->vi.rate);
338
339 /*    for(i=0; i<op->bytes; i++)
340       av_log(avccontext, AV_LOG_DEBUG, "%02X ", op->packet[i]);
341     av_log(avccontext, AV_LOG_DEBUG, "\n");*/
342
343     if(vorbis_synthesis(&context->vb, op) == 0)
344         vorbis_synthesis_blockin(&context->vd, &context->vb) ;
345
346     total_samples = 0 ;
347     total_bytes = 0 ;
348
349     while((samples = vorbis_synthesis_pcmout(&context->vd, &pcm)) > 0) {
350         conv(samples, pcm, (char*)data + total_bytes, context->vi.channels) ;
351         total_bytes += samples * 2 * context->vi.channels ;
352         total_samples += samples ;
353         vorbis_synthesis_read(&context->vd, samples) ;
354     }
355
356     *data_size = total_bytes ;
357     return buf_size ;
358 }
359
360
361 static int oggvorbis_decode_close(AVCodecContext *avccontext) {
362     OggVorbisContext *context = avccontext->priv_data ;
363
364     vorbis_info_clear(&context->vi) ;
365     vorbis_comment_clear(&context->vc) ;
366
367     return 0 ;
368 }
369
370
371 AVCodec oggvorbis_decoder = {
372     "vorbis",
373     CODEC_TYPE_AUDIO,
374     CODEC_ID_VORBIS,
375     sizeof(OggVorbisContext),
376     oggvorbis_decode_init,
377     NULL,
378     oggvorbis_decode_close,
379     oggvorbis_decode_frame,
380     .capabilities= CODEC_CAP_DELAY,
381 } ;