Merge commit '0f24a3ca999a702f83af9307f9f47b6fdeb546a5'
[ffmpeg.git] / libavcodec / libmp3lame.c
1 /*
2  * Interface to libmp3lame for mp3 encoding
3  * Copyright (c) 2002 Lennert Buytenhek <buytenh@gnu.org>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * Interface to libmp3lame for mp3 encoding.
25  */
26
27 #include <lame/lame.h>
28
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"
35 #include "avcodec.h"
36 #include "audio_frame_queue.h"
37 #include "internal.h"
38 #include "mpegaudio.h"
39 #include "mpegaudiodecheader.h"
40
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.
42
43 typedef struct LAMEContext {
44     AVClass *class;
45     AVCodecContext *avctx;
46     lame_global_flags *gfp;
47     uint8_t *buffer;
48     int buffer_index;
49     int buffer_size;
50     int reservoir;
51     float *samples_flt[2];
52     AudioFrameQueue afq;
53     AVFloatDSPContext fdsp;
54 } LAMEContext;
55
56
57 static int realloc_buffer(LAMEContext *s)
58 {
59     if (!s->buffer || s->buffer_size - s->buffer_index < BUFFER_SIZE) {
60         uint8_t *tmp;
61         int new_size = s->buffer_index + 2 * BUFFER_SIZE;
62
63         av_dlog(s->avctx, "resizing output buffer: %d -> %d\n", s->buffer_size,
64                 new_size);
65         tmp = av_realloc(s->buffer, new_size);
66         if (!tmp) {
67             av_freep(&s->buffer);
68             s->buffer_size = s->buffer_index = 0;
69             return AVERROR(ENOMEM);
70         }
71         s->buffer      = tmp;
72         s->buffer_size = new_size;
73     }
74     return 0;
75 }
76
77 static av_cold int mp3lame_encode_close(AVCodecContext *avctx)
78 {
79     LAMEContext *s = avctx->priv_data;
80
81     av_freep(&s->samples_flt[0]);
82     av_freep(&s->samples_flt[1]);
83     av_freep(&s->buffer);
84
85     ff_af_queue_close(&s->afq);
86
87     lame_close(s->gfp);
88     return 0;
89 }
90
91 static av_cold int mp3lame_encode_init(AVCodecContext *avctx)
92 {
93     LAMEContext *s = avctx->priv_data;
94     int ret;
95
96     s->avctx = avctx;
97
98     /* initialize LAME and get defaults */
99     if ((s->gfp = lame_init()) == NULL)
100         return AVERROR(ENOMEM);
101
102
103     lame_set_num_channels(s->gfp, avctx->channels);
104     lame_set_mode(s->gfp, avctx->channels > 1 ? JOINT_STEREO : MONO);
105
106     /* sample rate */
107     lame_set_in_samplerate (s->gfp, avctx->sample_rate);
108     lame_set_out_samplerate(s->gfp, avctx->sample_rate);
109
110     /* algorithmic quality */
111     if (avctx->compression_level == FF_COMPRESSION_DEFAULT)
112         lame_set_quality(s->gfp, 5);
113     else
114         lame_set_quality(s->gfp, avctx->compression_level);
115
116     /* rate control */
117     if (avctx->flags & CODEC_FLAG_QSCALE) {
118         lame_set_VBR(s->gfp, vbr_default);
119         lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
120     } else {
121         if (avctx->bit_rate)
122             lame_set_brate(s->gfp, avctx->bit_rate / 1000);
123     }
124
125     /* do not get a Xing VBR header frame from LAME */
126     lame_set_bWriteVbrTag(s->gfp,0);
127
128     /* bit reservoir usage */
129     lame_set_disable_reservoir(s->gfp, !s->reservoir);
130
131     /* set specified parameters */
132     if (lame_init_params(s->gfp) < 0) {
133         ret = -1;
134         goto error;
135     }
136
137     /* get encoder delay */
138     avctx->delay = lame_get_encoder_delay(s->gfp) + 528 + 1;
139     ff_af_queue_init(avctx, &s->afq);
140
141     avctx->frame_size  = lame_get_framesize(s->gfp);
142
143     /* allocate float sample buffers */
144     if (avctx->sample_fmt == AV_SAMPLE_FMT_FLTP) {
145         int ch;
146         for (ch = 0; ch < avctx->channels; ch++) {
147             s->samples_flt[ch] = av_malloc(avctx->frame_size *
148                                            sizeof(*s->samples_flt[ch]));
149             if (!s->samples_flt[ch]) {
150                 ret = AVERROR(ENOMEM);
151                 goto error;
152             }
153         }
154     }
155
156     ret = realloc_buffer(s);
157     if (ret < 0)
158         goto error;
159
160     avpriv_float_dsp_init(&s->fdsp, avctx->flags & CODEC_FLAG_BITEXACT);
161
162     return 0;
163 error:
164     mp3lame_encode_close(avctx);
165     return ret;
166 }
167
168 #define ENCODE_BUFFER(func, buf_type, buf_name) do {                        \
169     lame_result = func(s->gfp,                                              \
170                        (const buf_type *)buf_name[0],                       \
171                        (const buf_type *)buf_name[1], frame->nb_samples,    \
172                        s->buffer + s->buffer_index,                         \
173                        s->buffer_size - s->buffer_index);                   \
174 } while (0)
175
176 static int mp3lame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
177                                 const AVFrame *frame, int *got_packet_ptr)
178 {
179     LAMEContext *s = avctx->priv_data;
180     MPADecodeHeader hdr;
181     int len, ret, ch;
182     int lame_result;
183
184     if (frame) {
185         switch (avctx->sample_fmt) {
186         case AV_SAMPLE_FMT_S16P:
187             ENCODE_BUFFER(lame_encode_buffer, int16_t, frame->data);
188             break;
189         case AV_SAMPLE_FMT_S32P:
190             ENCODE_BUFFER(lame_encode_buffer_int, int32_t, frame->data);
191             break;
192         case AV_SAMPLE_FMT_FLTP:
193             if (frame->linesize[0] < 4 * FFALIGN(frame->nb_samples, 8)) {
194                 av_log(avctx, AV_LOG_ERROR, "inadequate AVFrame plane padding\n");
195                 return AVERROR(EINVAL);
196             }
197             for (ch = 0; ch < avctx->channels; ch++) {
198                 s->fdsp.vector_fmul_scalar(s->samples_flt[ch],
199                                            (const float *)frame->data[ch],
200                                            32768.0f,
201                                            FFALIGN(frame->nb_samples, 8));
202             }
203             ENCODE_BUFFER(lame_encode_buffer_float, float, s->samples_flt);
204             break;
205         default:
206             return AVERROR_BUG;
207         }
208     } else {
209         lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
210                                         s->buffer_size - s->buffer_index);
211     }
212     if (lame_result < 0) {
213         if (lame_result == -1) {
214             av_log(avctx, AV_LOG_ERROR,
215                    "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
216                    s->buffer_index, s->buffer_size - s->buffer_index);
217         }
218         return -1;
219     }
220     s->buffer_index += lame_result;
221     ret = realloc_buffer(s);
222     if (ret < 0) {
223         av_log(avctx, AV_LOG_ERROR, "error reallocating output buffer\n");
224         return ret;
225     }
226
227     /* add current frame to the queue */
228     if (frame) {
229         if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
230             return ret;
231     }
232
233     /* Move 1 frame from the LAME buffer to the output packet, if available.
234        We have to parse the first frame header in the output buffer to
235        determine the frame size. */
236     if (s->buffer_index < 4)
237         return 0;
238     if (avpriv_mpegaudio_decode_header(&hdr, AV_RB32(s->buffer))) {
239         av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
240         return -1;
241     }
242     len = hdr.frame_size;
243     av_dlog(avctx, "in:%d packet-len:%d index:%d\n", avctx->frame_size, len,
244             s->buffer_index);
245     if (len <= s->buffer_index) {
246         if ((ret = ff_alloc_packet2(avctx, avpkt, len)) < 0)
247             return ret;
248         memcpy(avpkt->data, s->buffer, len);
249         s->buffer_index -= len;
250         memmove(s->buffer, s->buffer + len, s->buffer_index);
251
252         /* Get the next frame pts/duration */
253         ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
254                            &avpkt->duration);
255
256         avpkt->size = len;
257         *got_packet_ptr = 1;
258     }
259     return 0;
260 }
261
262 #define OFFSET(x) offsetof(LAMEContext, x)
263 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
264 static const AVOption options[] = {
265     { "reservoir", "Use bit reservoir.", OFFSET(reservoir), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, AE },
266     { NULL },
267 };
268
269 static const AVClass libmp3lame_class = {
270     .class_name = "libmp3lame encoder",
271     .item_name  = av_default_item_name,
272     .option     = options,
273     .version    = LIBAVUTIL_VERSION_INT,
274 };
275
276 static const AVCodecDefault libmp3lame_defaults[] = {
277     { "b",          "0" },
278     { NULL },
279 };
280
281 static const int libmp3lame_sample_rates[] = {
282     44100, 48000,  32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
283 };
284
285 AVCodec ff_libmp3lame_encoder = {
286     .name                  = "libmp3lame",
287     .type                  = AVMEDIA_TYPE_AUDIO,
288     .id                    = AV_CODEC_ID_MP3,
289     .priv_data_size        = sizeof(LAMEContext),
290     .init                  = mp3lame_encode_init,
291     .encode2               = mp3lame_encode_frame,
292     .close                 = mp3lame_encode_close,
293     .capabilities          = CODEC_CAP_DELAY | CODEC_CAP_SMALL_LAST_FRAME,
294     .sample_fmts           = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S32P,
295                                                              AV_SAMPLE_FMT_FLTP,
296                                                              AV_SAMPLE_FMT_S16P,
297                                                              AV_SAMPLE_FMT_NONE },
298     .supported_samplerates = libmp3lame_sample_rates,
299     .channel_layouts       = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
300                                                   AV_CH_LAYOUT_STEREO,
301                                                   0 },
302     .long_name             = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
303     .priv_class            = &libmp3lame_class,
304     .defaults              = libmp3lame_defaults,
305 };