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