libmp3lame: renaming, rearrangement, alignment, and comments
[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/intreadwrite.h"
30 #include "libavutil/log.h"
31 #include "libavutil/opt.h"
32 #include "avcodec.h"
33 #include "internal.h"
34 #include "mpegaudio.h"
35 #include "mpegaudiodecheader.h"
36
37 #define BUFFER_SIZE (7200 + 2 * MPA_FRAME_SIZE + MPA_FRAME_SIZE / 4)
38
39 typedef struct LAMEContext {
40     AVClass *class;
41     lame_global_flags *gfp;
42     uint8_t buffer[BUFFER_SIZE];
43     int buffer_index;
44     int reservoir;
45 } LAMEContext;
46
47
48 static av_cold int mp3lame_encode_close(AVCodecContext *avctx)
49 {
50     LAMEContext *s = avctx->priv_data;
51
52     av_freep(&avctx->coded_frame);
53
54     lame_close(s->gfp);
55     return 0;
56 }
57
58 static av_cold int mp3lame_encode_init(AVCodecContext *avctx)
59 {
60     LAMEContext *s = avctx->priv_data;
61     int ret;
62
63     /* initialize LAME and get defaults */
64     if ((s->gfp = lame_init()) == NULL)
65         return AVERROR(ENOMEM);
66
67     /* channels */
68     if (avctx->channels > 2) {
69         ret =  AVERROR(EINVAL);
70         goto error;
71     }
72     lame_set_num_channels(s->gfp, avctx->channels);
73     lame_set_mode(s->gfp, avctx->channels > 1 ? JOINT_STEREO : MONO);
74
75     /* sample rate */
76     lame_set_in_samplerate (s->gfp, avctx->sample_rate);
77     lame_set_out_samplerate(s->gfp, avctx->sample_rate);
78
79     /* algorithmic quality */
80     if (avctx->compression_level == FF_COMPRESSION_DEFAULT)
81         lame_set_quality(s->gfp, 5);
82     else
83         lame_set_quality(s->gfp, avctx->compression_level);
84
85     /* rate control */
86     if (avctx->flags & CODEC_FLAG_QSCALE) {
87         lame_set_VBR(s->gfp, vbr_default);
88         lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
89     } else {
90         if (avctx->bit_rate)
91             lame_set_brate(s->gfp, avctx->bit_rate / 1000);
92     }
93
94     /* do not get a Xing VBR header frame from LAME */
95     lame_set_bWriteVbrTag(s->gfp,0);
96
97     /* bit reservoir usage */
98     lame_set_disable_reservoir(s->gfp, !s->reservoir);
99
100     /* set specified parameters */
101     if (lame_init_params(s->gfp) < 0) {
102         ret = -1;
103         goto error;
104     }
105
106     avctx->frame_size  = lame_get_framesize(s->gfp);
107     avctx->coded_frame = avcodec_alloc_frame();
108     if (!avctx->coded_frame) {
109         ret = AVERROR(ENOMEM);
110         goto error;
111     }
112
113     return 0;
114 error:
115     mp3lame_encode_close(avctx);
116     return ret;
117 }
118
119 static int mp3lame_encode_frame(AVCodecContext *avctx, unsigned char *frame,
120                                 int buf_size, void *data)
121 {
122     LAMEContext *s = avctx->priv_data;
123     MPADecodeHeader hdr;
124     int len;
125     int lame_result;
126
127     if (data) {
128         if (avctx->channels > 1) {
129             lame_result = lame_encode_buffer_interleaved(s->gfp, data,
130                                                          avctx->frame_size,
131                                                          s->buffer + s->buffer_index,
132                                                          BUFFER_SIZE - s->buffer_index);
133         } else {
134             lame_result = lame_encode_buffer(s->gfp, data, data,
135                                              avctx->frame_size, s->buffer +
136                                              s->buffer_index, BUFFER_SIZE -
137                                              s->buffer_index);
138         }
139     } else {
140         lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
141                                         BUFFER_SIZE - s->buffer_index);
142     }
143     if (lame_result < 0) {
144         if (lame_result == -1) {
145             av_log(avctx, AV_LOG_ERROR,
146                    "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
147                    s->buffer_index, BUFFER_SIZE - s->buffer_index);
148         }
149         return -1;
150     }
151     s->buffer_index += lame_result;
152
153     /* Move 1 frame from the LAME buffer to the output packet, if available.
154        We have to parse the first frame header in the output buffer to
155        determine the frame size. */
156     if (s->buffer_index < 4)
157         return 0;
158     if (avpriv_mpegaudio_decode_header(&hdr, AV_RB32(s->buffer))) {
159         av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
160         return -1;
161     }
162     len = hdr.frame_size;
163     av_dlog(avctx, "in:%d packet-len:%d index:%d\n", avctx->frame_size, len,
164             s->buffer_index);
165     if (len <= s->buffer_index) {
166         memcpy(frame, s->buffer, len);
167         s->buffer_index -= len;
168         memmove(s->buffer, s->buffer + len, s->buffer_index);
169         return len;
170     } else
171         return 0;
172 }
173
174 #define OFFSET(x) offsetof(LAMEContext, x)
175 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
176 static const AVOption options[] = {
177     { "reservoir", "Use bit reservoir.", OFFSET(reservoir), AV_OPT_TYPE_INT, { 1 }, 0, 1, AE },
178     { NULL },
179 };
180
181 static const AVClass libmp3lame_class = {
182     .class_name = "libmp3lame encoder",
183     .item_name  = av_default_item_name,
184     .option     = options,
185     .version    = LIBAVUTIL_VERSION_INT,
186 };
187
188 static const AVCodecDefault libmp3lame_defaults[] = {
189     { "b",          "0" },
190     { NULL },
191 };
192
193 static const int libmp3lame_sample_rates[] = {
194     44100, 48000,  32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
195 };
196
197 AVCodec ff_libmp3lame_encoder = {
198     .name                  = "libmp3lame",
199     .type                  = AVMEDIA_TYPE_AUDIO,
200     .id                    = CODEC_ID_MP3,
201     .priv_data_size        = sizeof(LAMEContext),
202     .init                  = mp3lame_encode_init,
203     .encode                = mp3lame_encode_frame,
204     .close                 = mp3lame_encode_close,
205     .capabilities          = CODEC_CAP_DELAY,
206     .sample_fmts           = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S16,
207                                                              AV_SAMPLE_FMT_NONE },
208     .supported_samplerates = libmp3lame_sample_rates,
209     .long_name             = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
210     .priv_class            = &libmp3lame_class,
211     .defaults              = libmp3lame_defaults,
212 };