2 * Interface to libmp3lame for mp3 encoding
3 * Copyright (c) 2002 Lennert Buytenhek <buytenh@gnu.org>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Interface to libmp3lame for mp3 encoding.
27 #include <lame/lame.h>
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/common.h"
31 #include "libavutil/float_dsp.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
36 #include "audio_frame_queue.h"
38 #include "mpegaudio.h"
39 #include "mpegaudiodecheader.h"
41 #define BUFFER_SIZE (7200 + 2 * MPA_FRAME_SIZE + MPA_FRAME_SIZE / 4+1000) // FIXME: Buffer size to small? Adding 1000 to make up for it.
43 typedef struct LAMEContext {
45 AVCodecContext *avctx;
46 lame_global_flags *gfp;
53 float *samples_flt[2];
55 AVFloatDSPContext fdsp;
59 static int realloc_buffer(LAMEContext *s)
61 if (!s->buffer || s->buffer_size - s->buffer_index < BUFFER_SIZE) {
63 int new_size = s->buffer_index + 2 * BUFFER_SIZE;
65 av_dlog(s->avctx, "resizing output buffer: %d -> %d\n", s->buffer_size,
67 tmp = av_realloc(s->buffer, new_size);
70 s->buffer_size = s->buffer_index = 0;
71 return AVERROR(ENOMEM);
74 s->buffer_size = new_size;
79 static av_cold int mp3lame_encode_close(AVCodecContext *avctx)
81 LAMEContext *s = avctx->priv_data;
83 av_freep(&s->samples_flt[0]);
84 av_freep(&s->samples_flt[1]);
87 ff_af_queue_close(&s->afq);
93 static av_cold int mp3lame_encode_init(AVCodecContext *avctx)
95 LAMEContext *s = avctx->priv_data;
100 /* initialize LAME and get defaults */
101 if ((s->gfp = lame_init()) == NULL)
102 return AVERROR(ENOMEM);
105 lame_set_num_channels(s->gfp, avctx->channels);
106 lame_set_mode(s->gfp, avctx->channels > 1 ? s->joint_stereo ? JOINT_STEREO : STEREO : MONO);
109 lame_set_in_samplerate (s->gfp, avctx->sample_rate);
110 lame_set_out_samplerate(s->gfp, avctx->sample_rate);
112 /* algorithmic quality */
113 if (avctx->compression_level == FF_COMPRESSION_DEFAULT)
114 lame_set_quality(s->gfp, 5);
116 lame_set_quality(s->gfp, avctx->compression_level);
119 if (avctx->flags & CODEC_FLAG_QSCALE) { // VBR
120 lame_set_VBR(s->gfp, vbr_default);
121 lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
123 if (avctx->bit_rate) {
125 lame_set_VBR(s->gfp, vbr_abr);
126 lame_set_VBR_mean_bitrate_kbps(s->gfp, avctx->bit_rate / 1000);
128 lame_set_brate(s->gfp, avctx->bit_rate / 1000);
132 /* do not get a Xing VBR header frame from LAME */
133 lame_set_bWriteVbrTag(s->gfp,0);
135 /* bit reservoir usage */
136 lame_set_disable_reservoir(s->gfp, !s->reservoir);
138 /* set specified parameters */
139 if (lame_init_params(s->gfp) < 0) {
144 /* get encoder delay */
145 avctx->delay = lame_get_encoder_delay(s->gfp) + 528 + 1;
146 ff_af_queue_init(avctx, &s->afq);
148 avctx->frame_size = lame_get_framesize(s->gfp);
150 /* allocate float sample buffers */
151 if (avctx->sample_fmt == AV_SAMPLE_FMT_FLTP) {
153 for (ch = 0; ch < avctx->channels; ch++) {
154 s->samples_flt[ch] = av_malloc(avctx->frame_size *
155 sizeof(*s->samples_flt[ch]));
156 if (!s->samples_flt[ch]) {
157 ret = AVERROR(ENOMEM);
163 ret = realloc_buffer(s);
167 avpriv_float_dsp_init(&s->fdsp, avctx->flags & CODEC_FLAG_BITEXACT);
171 mp3lame_encode_close(avctx);
175 #define ENCODE_BUFFER(func, buf_type, buf_name) do { \
176 lame_result = func(s->gfp, \
177 (const buf_type *)buf_name[0], \
178 (const buf_type *)buf_name[1], frame->nb_samples, \
179 s->buffer + s->buffer_index, \
180 s->buffer_size - s->buffer_index); \
183 static int mp3lame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
184 const AVFrame *frame, int *got_packet_ptr)
186 LAMEContext *s = avctx->priv_data;
192 switch (avctx->sample_fmt) {
193 case AV_SAMPLE_FMT_S16P:
194 ENCODE_BUFFER(lame_encode_buffer, int16_t, frame->data);
196 case AV_SAMPLE_FMT_S32P:
197 ENCODE_BUFFER(lame_encode_buffer_int, int32_t, frame->data);
199 case AV_SAMPLE_FMT_FLTP:
200 if (frame->linesize[0] < 4 * FFALIGN(frame->nb_samples, 8)) {
201 av_log(avctx, AV_LOG_ERROR, "inadequate AVFrame plane padding\n");
202 return AVERROR(EINVAL);
204 for (ch = 0; ch < avctx->channels; ch++) {
205 s->fdsp.vector_fmul_scalar(s->samples_flt[ch],
206 (const float *)frame->data[ch],
208 FFALIGN(frame->nb_samples, 8));
210 ENCODE_BUFFER(lame_encode_buffer_float, float, s->samples_flt);
216 lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
217 s->buffer_size - s->buffer_index);
219 if (lame_result < 0) {
220 if (lame_result == -1) {
221 av_log(avctx, AV_LOG_ERROR,
222 "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
223 s->buffer_index, s->buffer_size - s->buffer_index);
227 s->buffer_index += lame_result;
228 ret = realloc_buffer(s);
230 av_log(avctx, AV_LOG_ERROR, "error reallocating output buffer\n");
234 /* add current frame to the queue */
236 if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
240 /* Move 1 frame from the LAME buffer to the output packet, if available.
241 We have to parse the first frame header in the output buffer to
242 determine the frame size. */
243 if (s->buffer_index < 4)
245 if (avpriv_mpegaudio_decode_header(&hdr, AV_RB32(s->buffer))) {
246 av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
249 len = hdr.frame_size;
250 av_dlog(avctx, "in:%d packet-len:%d index:%d\n", avctx->frame_size, len,
252 if (len <= s->buffer_index) {
253 if ((ret = ff_alloc_packet2(avctx, avpkt, len)) < 0)
255 memcpy(avpkt->data, s->buffer, len);
256 s->buffer_index -= len;
257 memmove(s->buffer, s->buffer + len, s->buffer_index);
259 /* Get the next frame pts/duration */
260 ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
269 #define OFFSET(x) offsetof(LAMEContext, x)
270 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
271 static const AVOption options[] = {
272 { "reservoir", "use bit reservoir", OFFSET(reservoir), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, AE },
273 { "joint_stereo", "use joint stereo", OFFSET(joint_stereo), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, AE },
274 { "abr", "use ABR", OFFSET(abr), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AE },
278 static const AVClass libmp3lame_class = {
279 .class_name = "libmp3lame encoder",
280 .item_name = av_default_item_name,
282 .version = LIBAVUTIL_VERSION_INT,
285 static const AVCodecDefault libmp3lame_defaults[] = {
290 static const int libmp3lame_sample_rates[] = {
291 44100, 48000, 32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
294 AVCodec ff_libmp3lame_encoder = {
295 .name = "libmp3lame",
296 .long_name = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
297 .type = AVMEDIA_TYPE_AUDIO,
298 .id = AV_CODEC_ID_MP3,
299 .priv_data_size = sizeof(LAMEContext),
300 .init = mp3lame_encode_init,
301 .encode2 = mp3lame_encode_frame,
302 .close = mp3lame_encode_close,
303 .capabilities = CODEC_CAP_DELAY | CODEC_CAP_SMALL_LAST_FRAME,
304 .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S32P,
307 AV_SAMPLE_FMT_NONE },
308 .supported_samplerates = libmp3lame_sample_rates,
309 .channel_layouts = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
312 .priv_class = &libmp3lame_class,
313 .defaults = libmp3lame_defaults,