libmp3lame: use planar sample formats
[libav.git] / libavcodec / libvorbis.c
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
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
2912e87a 17 * License along with Libav; if not, write to the Free Software
e5a389a1 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
04d7f601
DB
19 */
20
983e3246 21/**
ba87f080 22 * @file
eb35ef29 23 * Vorbis encoding support via libvorbisenc.
983e3246 24 * @author Mark Hills <mark@pogo.org.uk>
81e0d0b4
MH
25 */
26
81e0d0b4
MH
27#include <vorbis/vorbisenc.h>
28
592c4dbc 29#include "libavutil/fifo.h"
77336a5e 30#include "libavutil/opt.h"
81e0d0b4 31#include "avcodec.h"
e5aab2d7 32#include "audio_frame_queue.h"
2c124cb6 33#include "bytestream.h"
91a28b0e 34#include "internal.h"
9577838f 35#include "vorbis.h"
e5aab2d7 36#include "vorbis_parser.h"
81e0d0b4 37
3f4993f1
MN
38#undef NDEBUG
39#include <assert.h>
40
eb35ef29
JR
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 */
6d8f985e 46#define OGGVORBIS_FRAME_SIZE 64
81e0d0b4 47
ca5ab8cd 48#define BUFFER_SIZE (1024 * 64)
81e0d0b4
MH
49
50typedef struct OggVorbisContext {
eb35ef29
JR
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 */
592c4dbc 55 AVFifoBuffer *pkt_fifo; /**< output packet buffer */
eb35ef29 56 int eof; /**< end-of-file flag */
f15c4281 57 int dsp_initialized; /**< vd has been initialized */
eb35ef29
JR
58 vorbis_comment vc; /**< VorbisComment info */
59 ogg_packet op; /**< ogg packet */
60 double iblock; /**< impulse block bias option */
e5aab2d7
JR
61 VorbisParseContext vp; /**< parse context to get durations */
62 AudioFrameQueue afq; /**< frame queue for timestamps */
ca5ab8cd 63} OggVorbisContext;
81e0d0b4 64
ca5ab8cd
DB
65static const AVOption options[] = {
66 { "iblock", "Sets the impulse block bias", offsetof(OggVorbisContext, iblock), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -15, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
67 { NULL }
77336a5e 68};
147ff24a
JR
69
70static const AVCodecDefault defaults[] = {
71 { "b", "0" },
72 { NULL },
73};
74
da754858 75static const AVClass class = { "libvorbis", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
81e0d0b4 76
eb35ef29 77
6f600ab3
JR
78static 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
eb35ef29
JR
88static av_cold int oggvorbis_init_encoder(vorbis_info *vi,
89 AVCodecContext *avctx)
ca5ab8cd 90{
eb35ef29 91 OggVorbisContext *s = avctx->priv_data;
13c71451 92 double cfreq;
6f600ab3 93 int ret;
c55427f8 94
147ff24a 95 if (avctx->flags & CODEC_FLAG_QSCALE || !avctx->bit_rate) {
eb35ef29
JR
96 /* variable bitrate
97 * NOTE: we use the oggenc range of -1 to 10 for global_quality for
147ff24a 98 * user convenience, but libvorbis uses -0.1 to 1.0.
eb35ef29
JR
99 */
100 float q = avctx->global_quality / (float)FF_QP2LAMBDA;
147ff24a
JR
101 /* default to 3 if the user did not set quality or bitrate */
102 if (!(avctx->flags & CODEC_FLAG_QSCALE))
103 q = 3.0;
eb35ef29
JR
104 if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
105 avctx->sample_rate,
6f600ab3
JR
106 q / 10.0)))
107 goto error;
13c71451 108 } else {
eb35ef29 109 int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
182d4f1f 110 int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
e5a5ea9e 111
eb35ef29
JR
112 /* average bitrate */
113 if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
182d4f1f
JR
114 avctx->sample_rate, maxrate,
115 avctx->bit_rate, minrate)))
6f600ab3 116 goto error;
13c71451 117
57ebbccf 118 /* variable bitrate by estimate, disable slow rate management */
ca5ab8cd 119 if (minrate == -1 && maxrate == -1)
6f600ab3
JR
120 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
121 goto error;
13c71451 122 }
c55427f8 123
13c71451 124 /* cutoff frequency */
eb35ef29
JR
125 if (avctx->cutoff > 0) {
126 cfreq = avctx->cutoff / 1000.0;
6f600ab3
JR
127 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
128 goto error;
13c71451 129 }
81e0d0b4 130
eb35ef29
JR
131 /* impulse block bias */
132 if (s->iblock) {
133 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
6f600ab3 134 goto error;
77336a5e
MN
135 }
136
6f600ab3
JR
137 if ((ret = vorbis_encode_setup_init(vi)))
138 goto error;
139
140 return 0;
141error:
142 return vorbis_error_to_averror(ret);
81e0d0b4
MH
143}
144
fd7242dd 145/* How many bytes are needed for a buffer of length 'l' */
ca5ab8cd
DB
146static int xiph_len(int l)
147{
d4b63054 148 return 1 + l / 255 + l;
ca5ab8cd 149}
fd7242dd 150
eb35ef29 151static av_cold int oggvorbis_encode_close(AVCodecContext *avctx)
6f600ab3 152{
eb35ef29 153 OggVorbisContext *s = avctx->priv_data;
6f600ab3 154
eb35ef29 155 /* notify vorbisenc this is EOF */
f15c4281
JR
156 if (s->dsp_initialized)
157 vorbis_analysis_wrote(&s->vd, 0);
6f600ab3 158
eb35ef29
JR
159 vorbis_block_clear(&s->vb);
160 vorbis_dsp_clear(&s->vd);
161 vorbis_info_clear(&s->vi);
6f600ab3 162
592c4dbc 163 av_fifo_free(s->pkt_fifo);
e5aab2d7
JR
164 ff_af_queue_close(&s->afq);
165#if FF_API_OLD_ENCODE_AUDIO
eb35ef29 166 av_freep(&avctx->coded_frame);
e5aab2d7 167#endif
eb35ef29 168 av_freep(&avctx->extradata);
6f600ab3
JR
169
170 return 0;
171}
172
eb35ef29 173static av_cold int oggvorbis_encode_init(AVCodecContext *avctx)
ca5ab8cd 174{
eb35ef29 175 OggVorbisContext *s = avctx->priv_data;
bbb77e7c
MN
176 ogg_packet header, header_comm, header_code;
177 uint8_t *p;
fd7242dd 178 unsigned int offset;
6f600ab3 179 int ret;
81e0d0b4 180
eb35ef29
JR
181 vorbis_info_init(&s->vi);
182 if ((ret = oggvorbis_init_encoder(&s->vi, avctx))) {
a45a1ea5 183 av_log(avctx, AV_LOG_ERROR, "encoder setup failed\n");
6f600ab3
JR
184 goto error;
185 }
eb35ef29 186 if ((ret = vorbis_analysis_init(&s->vd, &s->vi))) {
a45a1ea5 187 av_log(avctx, AV_LOG_ERROR, "analysis init failed\n");
6f600ab3
JR
188 ret = vorbis_error_to_averror(ret);
189 goto error;
190 }
f15c4281 191 s->dsp_initialized = 1;
eb35ef29 192 if ((ret = vorbis_block_init(&s->vd, &s->vb))) {
a45a1ea5 193 av_log(avctx, AV_LOG_ERROR, "dsp init failed\n");
6f600ab3
JR
194 ret = vorbis_error_to_averror(ret);
195 goto error;
81e0d0b4 196 }
81e0d0b4 197
eb35ef29
JR
198 vorbis_comment_init(&s->vc);
199 vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
bbb77e7c 200
eb35ef29
JR
201 if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
202 &header_code))) {
6f600ab3
JR
203 ret = vorbis_error_to_averror(ret);
204 goto error;
205 }
115329f1 206
eb35ef29
JR
207 avctx->extradata_size = 1 + xiph_len(header.bytes) +
208 xiph_len(header_comm.bytes) +
209 header_code.bytes;
210 p = avctx->extradata = av_malloc(avctx->extradata_size +
211 FF_INPUT_BUFFER_PADDING_SIZE);
6f600ab3
JR
212 if (!p) {
213 ret = AVERROR(ENOMEM);
214 goto error;
215 }
ca5ab8cd
DB
216 p[0] = 2;
217 offset = 1;
ad2b531d
MR
218 offset += av_xiphlacing(&p[offset], header.bytes);
219 offset += av_xiphlacing(&p[offset], header_comm.bytes);
220 memcpy(&p[offset], header.packet, header.bytes);
221 offset += header.bytes;
222 memcpy(&p[offset], header_comm.packet, header_comm.bytes);
223 offset += header_comm.bytes;
224 memcpy(&p[offset], header_code.packet, header_code.bytes);
225 offset += header_code.bytes;
eb35ef29 226 assert(offset == avctx->extradata_size);
115329f1 227
e5aab2d7
JR
228 if ((ret = avpriv_vorbis_parse_extradata(avctx, &s->vp)) < 0) {
229 av_log(avctx, AV_LOG_ERROR, "invalid extradata\n");
230 return ret;
231 }
232
eb35ef29 233 vorbis_comment_clear(&s->vc);
115329f1 234
eb35ef29 235 avctx->frame_size = OGGVORBIS_FRAME_SIZE;
e5aab2d7 236 ff_af_queue_init(avctx, &s->afq);
115329f1 237
592c4dbc
JR
238 s->pkt_fifo = av_fifo_alloc(BUFFER_SIZE);
239 if (!s->pkt_fifo) {
240 ret = AVERROR(ENOMEM);
241 goto error;
242 }
243
e5aab2d7 244#if FF_API_OLD_ENCODE_AUDIO
eb35ef29
JR
245 avctx->coded_frame = avcodec_alloc_frame();
246 if (!avctx->coded_frame) {
6f600ab3
JR
247 ret = AVERROR(ENOMEM);
248 goto error;
249 }
e5aab2d7 250#endif
115329f1 251
ca5ab8cd 252 return 0;
6f600ab3 253error:
eb35ef29 254 oggvorbis_encode_close(avctx);
6f600ab3 255 return ret;
81e0d0b4
MH
256}
257
e5aab2d7
JR
258static int oggvorbis_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
259 const AVFrame *frame, int *got_packet_ptr)
81e0d0b4 260{
eb35ef29 261 OggVorbisContext *s = avctx->priv_data;
ca5ab8cd 262 ogg_packet op;
e5aab2d7 263 int ret, duration;
9c8f0768 264
eb35ef29 265 /* send samples to libvorbis */
e5aab2d7
JR
266 if (frame) {
267 const float *audio = (const float *)frame->data[0];
268 const int samples = frame->nb_samples;
ca5ab8cd 269 float **buffer;
eb35ef29 270 int c, channels = s->vi.channels;
81e0d0b4 271
eb35ef29 272 buffer = vorbis_analysis_buffer(&s->vd, samples);
9577838f 273 for (c = 0; c < channels; c++) {
eb35ef29 274 int i;
9577838f 275 int co = (channels > 8) ? c :
ca5ab8cd 276 ff_vorbis_encoding_channel_layout_offsets[channels - 1][c];
eb35ef29 277 for (i = 0; i < samples; i++)
c5063e03 278 buffer[c][i] = audio[i * channels + co];
bb270c08 279 }
a45a1ea5
JR
280 if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
281 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
94025d8a 282 return vorbis_error_to_averror(ret);
a45a1ea5 283 }
e5aab2d7
JR
284 if ((ret = ff_af_queue_add(&s->afq, frame) < 0))
285 return ret;
9c8f0768 286 } else {
eb35ef29 287 if (!s->eof)
a45a1ea5
JR
288 if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
289 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
94025d8a 290 return vorbis_error_to_averror(ret);
a45a1ea5 291 }
eb35ef29 292 s->eof = 1;
9c8f0768 293 }
81e0d0b4 294
eb35ef29 295 /* retrieve available packets from libvorbis */
94025d8a
JR
296 while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
297 if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
298 break;
299 if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
300 break;
81e0d0b4 301
eb35ef29 302 /* add any available packets to the output packet buffer */
94025d8a 303 while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
592c4dbc 304 if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
a45a1ea5
JR
305 av_log(avctx, AV_LOG_ERROR, "packet buffer is too small");
306 return AVERROR_BUG;
c426562c 307 }
592c4dbc
JR
308 av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
309 av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
bb270c08 310 }
a45a1ea5
JR
311 if (ret < 0) {
312 av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
94025d8a 313 break;
a45a1ea5 314 }
81e0d0b4 315 }
a45a1ea5
JR
316 if (ret < 0) {
317 av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
94025d8a 318 return vorbis_error_to_averror(ret);
a45a1ea5 319 }
81e0d0b4 320
e5aab2d7
JR
321 /* check for available packets */
322 if (av_fifo_size(s->pkt_fifo) < sizeof(ogg_packet))
323 return 0;
324
325 av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
326
327 if ((ret = ff_alloc_packet(avpkt, op.bytes))) {
328 av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
329 return ret;
330 }
331 av_fifo_generic_read(s->pkt_fifo, avpkt->data, op.bytes, NULL);
332
333 avpkt->pts = ff_samples_to_time_base(avctx, op.granulepos);
334
335 duration = avpriv_vorbis_parse_frame(&s->vp, avpkt->data, avpkt->size);
336 if (duration > 0) {
337 /* we do not know encoder delay until we get the first packet from
338 * libvorbis, so we have to update the AudioFrameQueue counts */
339 if (!avctx->delay) {
340 avctx->delay = duration;
341 s->afq.remaining_delay += duration;
342 s->afq.remaining_samples += duration;
c426562c 343 }
e5aab2d7 344 ff_af_queue_remove(&s->afq, duration, &avpkt->pts, &avpkt->duration);
6d8f985e
MN
345 }
346
e5aab2d7
JR
347 *got_packet_ptr = 1;
348 return 0;
81e0d0b4
MH
349}
350
d36beb3f 351AVCodec ff_libvorbis_encoder = {
86714887
DB
352 .name = "libvorbis",
353 .type = AVMEDIA_TYPE_AUDIO,
36ef5369 354 .id = AV_CODEC_ID_VORBIS,
86714887
DB
355 .priv_data_size = sizeof(OggVorbisContext),
356 .init = oggvorbis_encode_init,
e5aab2d7 357 .encode2 = oggvorbis_encode_frame,
86714887
DB
358 .close = oggvorbis_encode_close,
359 .capabilities = CODEC_CAP_DELAY,
c5063e03 360 .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLT,
eb35ef29 361 AV_SAMPLE_FMT_NONE },
86714887
DB
362 .long_name = NULL_IF_CONFIG_SMALL("libvorbis Vorbis"),
363 .priv_class = &class,
147ff24a 364 .defaults = defaults,
86714887 365};