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