2 * copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
4 * This file is part of FFmpeg.
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.
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.
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
23 * Vorbis encoding support via libvorbisenc.
24 * @author Mark Hills <mark@pogo.org.uk>
27 #include <vorbis/vorbisenc.h>
29 #include "libavutil/fifo.h"
30 #include "libavutil/opt.h"
32 #include "bytestream.h"
39 /* Number of samples the user should send in each call.
40 * This value is used because it is the LCD of all possible frame sizes, so
41 * an output packet will always start at the same point as one of the input
44 #define OGGVORBIS_FRAME_SIZE 64
46 #define BUFFER_SIZE (1024 * 64)
48 typedef struct OggVorbisContext {
49 AVClass *av_class; /**< class for AVOptions */
50 vorbis_info vi; /**< vorbis_info used during init */
51 vorbis_dsp_state vd; /**< DSP state used for analysis */
52 vorbis_block vb; /**< vorbis_block used for analysis */
53 AVFifoBuffer *pkt_fifo; /**< output packet buffer */
54 int eof; /**< end-of-file flag */
55 int dsp_initialized; /**< vd has been initialized */
56 vorbis_comment vc; /**< VorbisComment info */
57 ogg_packet op; /**< ogg packet */
58 double iblock; /**< impulse block bias option */
61 static const AVOption options[] = {
62 { "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 },
66 static const AVCodecDefault defaults[] = {
71 static const AVClass class = { "libvorbis", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
74 static int vorbis_error_to_averror(int ov_err)
77 case OV_EFAULT: return AVERROR_BUG;
78 case OV_EINVAL: return AVERROR(EINVAL);
79 case OV_EIMPL: return AVERROR(EINVAL);
80 default: return AVERROR_UNKNOWN;
84 static av_cold int oggvorbis_init_encoder(vorbis_info *vi,
85 AVCodecContext *avctx)
87 OggVorbisContext *s = avctx->priv_data;
91 if (avctx->flags & CODEC_FLAG_QSCALE || !avctx->bit_rate) {
93 * NOTE: we use the oggenc range of -1 to 10 for global_quality for
94 * user convenience, but libvorbis uses -0.1 to 1.0.
96 float q = avctx->global_quality / (float)FF_QP2LAMBDA;
97 /* default to 3 if the user did not set quality or bitrate */
98 if (!(avctx->flags & CODEC_FLAG_QSCALE))
100 if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
105 int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
106 int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
108 /* average bitrate */
109 if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
110 avctx->sample_rate, maxrate,
111 avctx->bit_rate, minrate)))
114 /* variable bitrate by estimate, disable slow rate management */
115 if (minrate == -1 && maxrate == -1)
116 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
117 goto error; /* should not happen */
120 /* cutoff frequency */
121 if (avctx->cutoff > 0) {
122 cfreq = avctx->cutoff / 1000.0;
123 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
124 goto error; /* should not happen */
127 /* impulse block bias */
129 if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
133 if (avctx->channels == 3 &&
134 avctx->channel_layout != (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) ||
135 avctx->channels == 4 &&
136 avctx->channel_layout != AV_CH_LAYOUT_2_2 &&
137 avctx->channel_layout != AV_CH_LAYOUT_QUAD ||
138 avctx->channels == 5 &&
139 avctx->channel_layout != AV_CH_LAYOUT_5POINT0 &&
140 avctx->channel_layout != AV_CH_LAYOUT_5POINT0_BACK ||
141 avctx->channels == 6 &&
142 avctx->channel_layout != AV_CH_LAYOUT_5POINT1 &&
143 avctx->channel_layout != AV_CH_LAYOUT_5POINT1_BACK ||
144 avctx->channels == 7 &&
145 avctx->channel_layout != (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER) ||
146 avctx->channels == 8 &&
147 avctx->channel_layout != AV_CH_LAYOUT_7POINT1) {
148 if (avctx->channel_layout) {
150 av_get_channel_layout_string(name, sizeof(name), avctx->channels,
151 avctx->channel_layout);
152 av_log(avctx, AV_LOG_ERROR, "%s not supported by Vorbis: "
153 "output stream will have incorrect "
154 "channel layout.\n", name);
156 av_log(avctx, AV_LOG_WARNING, "No channel layout specified. The encoder "
157 "will use Vorbis channel layout for "
158 "%d channels.\n", avctx->channels);
162 if ((ret = vorbis_encode_setup_init(vi)))
167 return vorbis_error_to_averror(ret);
170 /* How many bytes are needed for a buffer of length 'l' */
171 static int xiph_len(int l)
173 return 1 + l / 255 + l;
176 static av_cold int oggvorbis_encode_close(AVCodecContext *avctx)
178 OggVorbisContext *s = avctx->priv_data;
180 /* notify vorbisenc this is EOF */
181 if (s->dsp_initialized)
182 vorbis_analysis_wrote(&s->vd, 0);
184 vorbis_block_clear(&s->vb);
185 vorbis_dsp_clear(&s->vd);
186 vorbis_info_clear(&s->vi);
188 av_fifo_free(s->pkt_fifo);
189 av_freep(&avctx->coded_frame);
190 av_freep(&avctx->extradata);
195 static av_cold int oggvorbis_encode_init(AVCodecContext *avctx)
197 OggVorbisContext *s = avctx->priv_data;
198 ogg_packet header, header_comm, header_code;
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");
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);
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);
220 vorbis_comment_init(&s->vc);
221 vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
223 if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
225 ret = vorbis_error_to_averror(ret);
229 avctx->extradata_size = 1 + xiph_len(header.bytes) +
230 xiph_len(header_comm.bytes) +
232 p = avctx->extradata = av_malloc(avctx->extradata_size +
233 FF_INPUT_BUFFER_PADDING_SIZE);
235 ret = AVERROR(ENOMEM);
240 offset += av_xiphlacing(&p[offset], header.bytes);
241 offset += av_xiphlacing(&p[offset], header_comm.bytes);
242 memcpy(&p[offset], header.packet, header.bytes);
243 offset += header.bytes;
244 memcpy(&p[offset], header_comm.packet, header_comm.bytes);
245 offset += header_comm.bytes;
246 memcpy(&p[offset], header_code.packet, header_code.bytes);
247 offset += header_code.bytes;
248 assert(offset == avctx->extradata_size);
250 vorbis_comment_clear(&s->vc);
252 avctx->frame_size = OGGVORBIS_FRAME_SIZE;
254 s->pkt_fifo = av_fifo_alloc(BUFFER_SIZE);
256 ret = AVERROR(ENOMEM);
260 avctx->coded_frame = avcodec_alloc_frame();
261 if (!avctx->coded_frame) {
262 ret = AVERROR(ENOMEM);
268 oggvorbis_encode_close(avctx);
272 static int oggvorbis_encode_frame(AVCodecContext *avctx, unsigned char *packets,
273 int buf_size, void *data)
275 OggVorbisContext *s = avctx->priv_data;
280 /* send samples to libvorbis */
282 const int samples = avctx->frame_size;
284 int c, channels = s->vi.channels;
286 buffer = vorbis_analysis_buffer(&s->vd, samples);
287 for (c = 0; c < channels; c++) {
289 int co = (channels > 8) ? c :
290 ff_vorbis_encoding_channel_layout_offsets[channels - 1][c];
291 for (i = 0; i < samples; i++)
292 buffer[c][i] = audio[i * channels + co];
294 if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
295 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
296 return vorbis_error_to_averror(ret);
300 if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
301 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
302 return vorbis_error_to_averror(ret);
307 /* retrieve available packets from libvorbis */
308 while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
309 if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
311 if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
314 /* add any available packets to the output packet buffer */
315 while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
316 if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
317 av_log(avctx, AV_LOG_ERROR, "packet buffer is too small\n");
320 av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
321 av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
324 av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
329 av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
330 return vorbis_error_to_averror(ret);
333 /* output then next packet from the output buffer, if available */
335 if (av_fifo_size(s->pkt_fifo) >= sizeof(ogg_packet)) {
336 av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
338 // FIXME: we should use the user-supplied pts and duration
339 avctx->coded_frame->pts = ff_samples_to_time_base(avctx,
341 if (pkt_size > buf_size) {
342 av_log(avctx, AV_LOG_ERROR, "output buffer is too small\n");
343 return AVERROR(EINVAL);
345 av_fifo_generic_read(s->pkt_fifo, packets, pkt_size, NULL);
351 AVCodec ff_libvorbis_encoder = {
353 .type = AVMEDIA_TYPE_AUDIO,
354 .id = CODEC_ID_VORBIS,
355 .priv_data_size = sizeof(OggVorbisContext),
356 .init = oggvorbis_encode_init,
357 .encode = oggvorbis_encode_frame,
358 .close = oggvorbis_encode_close,
359 .capabilities = CODEC_CAP_DELAY,
360 .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLT,
361 AV_SAMPLE_FMT_NONE },
362 .long_name = NULL_IF_CONFIG_SMALL("libvorbis Vorbis"),
363 .priv_class = &class,
364 .defaults = defaults,