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