h261: Signal freeze picture release for intra frames
[ffmpeg.git] / libavcodec / libvorbis.c
1 /*
2  * copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * Vorbis encoding support via libvorbisenc.
24  * @author Mark Hills <mark@pogo.org.uk>
25  */
26
27 #include <vorbis/vorbisenc.h>
28
29 #include "libavutil/fifo.h"
30 #include "libavutil/opt.h"
31 #include "avcodec.h"
32 #include "audio_frame_queue.h"
33 #include "bytestream.h"
34 #include "internal.h"
35 #include "vorbis.h"
36 #include "vorbis_parser.h"
37
38 #undef NDEBUG
39 #include <assert.h>
40
41 /* Number of samples the user should send in each call.
42  * This value is used because it is the LCD of all possible frame sizes, so
43  * an output packet will always start at the same point as one of the input
44  * packets.
45  */
46 #define LIBVORBIS_FRAME_SIZE 64
47
48 #define BUFFER_SIZE (1024 * 64)
49
50 typedef struct LibvorbisContext {
51     AVClass *av_class;                  /**< class for AVOptions            */
52     vorbis_info vi;                     /**< vorbis_info used during init   */
53     vorbis_dsp_state vd;                /**< DSP state used for analysis    */
54     vorbis_block vb;                    /**< vorbis_block used for analysis */
55     AVFifoBuffer *pkt_fifo;             /**< output packet buffer           */
56     int eof;                            /**< end-of-file flag               */
57     int dsp_initialized;                /**< vd has been initialized        */
58     vorbis_comment vc;                  /**< VorbisComment info             */
59     ogg_packet op;                      /**< ogg packet                     */
60     double iblock;                      /**< impulse block bias option      */
61     AVVorbisParseContext *vp;           /**< parse context to get durations */
62     AudioFrameQueue afq;                /**< frame queue for timestamps     */
63 } LibvorbisContext;
64
65 static const AVOption options[] = {
66     { "iblock", "Sets the impulse block bias", offsetof(LibvorbisContext, iblock), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -15, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
67     { NULL }
68 };
69
70 static const AVCodecDefault defaults[] = {
71     { "b",  "0" },
72     { NULL },
73 };
74
75 static const AVClass class = { "libvorbis", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
76
77
78 static int vorbis_error_to_averror(int ov_err)
79 {
80     switch (ov_err) {
81     case OV_EFAULT: return AVERROR_BUG;
82     case OV_EINVAL: return AVERROR(EINVAL);
83     case OV_EIMPL:  return AVERROR(EINVAL);
84     default:        return AVERROR_UNKNOWN;
85     }
86 }
87
88 static av_cold int libvorbis_setup(vorbis_info *vi, AVCodecContext *avctx)
89 {
90     LibvorbisContext *s = avctx->priv_data;
91     double cfreq;
92     int ret;
93
94     if (avctx->flags & CODEC_FLAG_QSCALE || !avctx->bit_rate) {
95         /* variable bitrate
96          * NOTE: we use the oggenc range of -1 to 10 for global_quality for
97          *       user convenience, but libvorbis uses -0.1 to 1.0.
98          */
99         float q = avctx->global_quality / (float)FF_QP2LAMBDA;
100         /* default to 3 if the user did not set quality or bitrate */
101         if (!(avctx->flags & CODEC_FLAG_QSCALE))
102             q = 3.0;
103         if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
104                                            avctx->sample_rate,
105                                            q / 10.0)))
106             goto error;
107     } else {
108         int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
109         int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
110
111         /* average bitrate */
112         if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
113                                                avctx->sample_rate, maxrate,
114                                                avctx->bit_rate, minrate)))
115             goto error;
116
117         /* variable bitrate by estimate, disable slow rate management */
118         if (minrate == -1 && maxrate == -1)
119             if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
120                 goto error;
121     }
122
123     /* cutoff frequency */
124     if (avctx->cutoff > 0) {
125         cfreq = avctx->cutoff / 1000.0;
126         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
127             goto error;
128     }
129
130     /* impulse block bias */
131     if (s->iblock) {
132         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
133             goto error;
134     }
135
136     if ((ret = vorbis_encode_setup_init(vi)))
137         goto error;
138
139     return 0;
140 error:
141     return vorbis_error_to_averror(ret);
142 }
143
144 /* How many bytes are needed for a buffer of length 'l' */
145 static int xiph_len(int l)
146 {
147     return 1 + l / 255 + l;
148 }
149
150 static av_cold int libvorbis_encode_close(AVCodecContext *avctx)
151 {
152     LibvorbisContext *s = avctx->priv_data;
153
154     /* notify vorbisenc this is EOF */
155     if (s->dsp_initialized)
156         vorbis_analysis_wrote(&s->vd, 0);
157
158     vorbis_block_clear(&s->vb);
159     vorbis_dsp_clear(&s->vd);
160     vorbis_info_clear(&s->vi);
161
162     av_fifo_free(s->pkt_fifo);
163     ff_af_queue_close(&s->afq);
164     av_freep(&avctx->extradata);
165
166     av_vorbis_parse_free(&s->vp);
167
168     return 0;
169 }
170
171 static av_cold int libvorbis_encode_init(AVCodecContext *avctx)
172 {
173     LibvorbisContext *s = avctx->priv_data;
174     ogg_packet header, header_comm, header_code;
175     uint8_t *p;
176     unsigned int offset;
177     int ret;
178
179     vorbis_info_init(&s->vi);
180     if ((ret = libvorbis_setup(&s->vi, avctx))) {
181         av_log(avctx, AV_LOG_ERROR, "encoder setup failed\n");
182         goto error;
183     }
184     if ((ret = vorbis_analysis_init(&s->vd, &s->vi))) {
185         av_log(avctx, AV_LOG_ERROR, "analysis init failed\n");
186         ret = vorbis_error_to_averror(ret);
187         goto error;
188     }
189     s->dsp_initialized = 1;
190     if ((ret = vorbis_block_init(&s->vd, &s->vb))) {
191         av_log(avctx, AV_LOG_ERROR, "dsp init failed\n");
192         ret = vorbis_error_to_averror(ret);
193         goto error;
194     }
195
196     vorbis_comment_init(&s->vc);
197     vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
198
199     if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
200                                          &header_code))) {
201         ret = vorbis_error_to_averror(ret);
202         goto error;
203     }
204
205     avctx->extradata_size = 1 + xiph_len(header.bytes)      +
206                                 xiph_len(header_comm.bytes) +
207                                 header_code.bytes;
208     p = avctx->extradata = av_malloc(avctx->extradata_size +
209                                      FF_INPUT_BUFFER_PADDING_SIZE);
210     if (!p) {
211         ret = AVERROR(ENOMEM);
212         goto error;
213     }
214     p[0]    = 2;
215     offset  = 1;
216     offset += av_xiphlacing(&p[offset], header.bytes);
217     offset += av_xiphlacing(&p[offset], header_comm.bytes);
218     memcpy(&p[offset], header.packet, header.bytes);
219     offset += header.bytes;
220     memcpy(&p[offset], header_comm.packet, header_comm.bytes);
221     offset += header_comm.bytes;
222     memcpy(&p[offset], header_code.packet, header_code.bytes);
223     offset += header_code.bytes;
224     assert(offset == avctx->extradata_size);
225
226     s->vp = av_vorbis_parse_init(avctx->extradata, avctx->extradata_size);
227     if (!s->vp) {
228         av_log(avctx, AV_LOG_ERROR, "invalid extradata\n");
229         return ret;
230     }
231
232     vorbis_comment_clear(&s->vc);
233
234     avctx->frame_size = LIBVORBIS_FRAME_SIZE;
235     ff_af_queue_init(avctx, &s->afq);
236
237     s->pkt_fifo = av_fifo_alloc(BUFFER_SIZE);
238     if (!s->pkt_fifo) {
239         ret = AVERROR(ENOMEM);
240         goto error;
241     }
242
243     return 0;
244 error:
245     libvorbis_encode_close(avctx);
246     return ret;
247 }
248
249 static int libvorbis_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
250                                   const AVFrame *frame, int *got_packet_ptr)
251 {
252     LibvorbisContext *s = avctx->priv_data;
253     ogg_packet op;
254     int ret, duration;
255
256     /* send samples to libvorbis */
257     if (frame) {
258         const int samples = frame->nb_samples;
259         float **buffer;
260         int c, channels = s->vi.channels;
261
262         buffer = vorbis_analysis_buffer(&s->vd, samples);
263         for (c = 0; c < channels; c++) {
264             int co = (channels > 8) ? c :
265                      ff_vorbis_encoding_channel_layout_offsets[channels - 1][c];
266             memcpy(buffer[c], frame->extended_data[co],
267                    samples * sizeof(*buffer[c]));
268         }
269         if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
270             av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
271             return vorbis_error_to_averror(ret);
272         }
273         if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
274             return ret;
275     } else {
276         if (!s->eof)
277             if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
278                 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
279                 return vorbis_error_to_averror(ret);
280             }
281         s->eof = 1;
282     }
283
284     /* retrieve available packets from libvorbis */
285     while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
286         if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
287             break;
288         if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
289             break;
290
291         /* add any available packets to the output packet buffer */
292         while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
293             if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
294                 av_log(avctx, AV_LOG_ERROR, "packet buffer is too small");
295                 return AVERROR_BUG;
296             }
297             av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
298             av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
299         }
300         if (ret < 0) {
301             av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
302             break;
303         }
304     }
305     if (ret < 0) {
306         av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
307         return vorbis_error_to_averror(ret);
308     }
309
310     /* check for available packets */
311     if (av_fifo_size(s->pkt_fifo) < sizeof(ogg_packet))
312         return 0;
313
314     av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
315
316     if ((ret = ff_alloc_packet(avpkt, op.bytes))) {
317         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
318         return ret;
319     }
320     av_fifo_generic_read(s->pkt_fifo, avpkt->data, op.bytes, NULL);
321
322     avpkt->pts = ff_samples_to_time_base(avctx, op.granulepos);
323
324     duration = av_vorbis_parse_frame(s->vp, avpkt->data, avpkt->size);
325     if (duration > 0) {
326         /* we do not know encoder delay until we get the first packet from
327          * libvorbis, so we have to update the AudioFrameQueue counts */
328         if (!avctx->initial_padding) {
329             avctx->initial_padding    = duration;
330             s->afq.remaining_delay   += duration;
331             s->afq.remaining_samples += duration;
332         }
333         ff_af_queue_remove(&s->afq, duration, &avpkt->pts, &avpkt->duration);
334     }
335
336     *got_packet_ptr = 1;
337     return 0;
338 }
339
340 AVCodec ff_libvorbis_encoder = {
341     .name           = "libvorbis",
342     .long_name      = NULL_IF_CONFIG_SMALL("libvorbis Vorbis"),
343     .type           = AVMEDIA_TYPE_AUDIO,
344     .id             = AV_CODEC_ID_VORBIS,
345     .priv_data_size = sizeof(LibvorbisContext),
346     .init           = libvorbis_encode_init,
347     .encode2        = libvorbis_encode_frame,
348     .close          = libvorbis_encode_close,
349     .capabilities   = CODEC_CAP_DELAY,
350     .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLTP,
351                                                       AV_SAMPLE_FMT_NONE },
352     .priv_class     = &class,
353     .defaults       = defaults,
354 };