b8ccb2611553778ae23e38ec8a8e32bf5c611acf
[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 "libavutil/intreadwrite.h"
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
30 #include "avcodec.h"
31 #include "mpegaudio.h"
32 #include <lame/lame.h>
33
34 #define BUFFER_SIZE (7200 + 2 * MPA_FRAME_SIZE + MPA_FRAME_SIZE / 4)
35 typedef struct Mp3AudioContext {
36     AVClass *class;
37     lame_global_flags *gfp;
38     uint8_t buffer[BUFFER_SIZE];
39     int buffer_index;
40     int reservoir;
41 } Mp3AudioContext;
42
43 static av_cold int MP3lame_encode_init(AVCodecContext *avctx)
44 {
45     Mp3AudioContext *s = avctx->priv_data;
46
47     if (avctx->channels > 2)
48         return -1;
49
50     if ((s->gfp = lame_init()) == NULL)
51         goto err;
52     lame_set_in_samplerate(s->gfp, avctx->sample_rate);
53     lame_set_out_samplerate(s->gfp, avctx->sample_rate);
54     lame_set_num_channels(s->gfp, avctx->channels);
55     if (avctx->compression_level == FF_COMPRESSION_DEFAULT) {
56         lame_set_quality(s->gfp, 5);
57     } else {
58         lame_set_quality(s->gfp, avctx->compression_level);
59     }
60     lame_set_mode(s->gfp, avctx->channels > 1 ? JOINT_STEREO : MONO);
61     lame_set_brate(s->gfp, avctx->bit_rate / 1000);
62     if (avctx->flags & CODEC_FLAG_QSCALE) {
63         lame_set_brate(s->gfp, 0);
64         lame_set_VBR(s->gfp, vbr_default);
65         lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
66     }
67     lame_set_bWriteVbrTag(s->gfp,0);
68     lame_set_disable_reservoir(s->gfp, !s->reservoir);
69     if (lame_init_params(s->gfp) < 0)
70         goto err_close;
71
72     avctx->frame_size             = lame_get_framesize(s->gfp);
73     avctx->coded_frame            = avcodec_alloc_frame();
74     avctx->coded_frame->key_frame = 1;
75
76     return 0;
77
78 err_close:
79     lame_close(s->gfp);
80 err:
81     return -1;
82 }
83
84 static const int sSampleRates[] = {
85     44100, 48000,  32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
86 };
87
88 static const int sBitRates[2][3][15] = {
89     {
90         { 0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384, 416, 448 },
91         { 0, 32, 48, 56, 64,  80,  96,  112, 128, 160, 192, 224, 256, 320, 384 },
92         { 0, 32, 40, 48, 56,  64,  80,  96,  112, 128, 160, 192, 224, 256, 320 }
93     },
94     {
95         { 0, 32, 48, 56, 64, 80, 96, 112, 128, 144, 160, 176, 192, 224, 256 },
96         { 0,  8, 16, 24, 32, 40, 48,  56,  64,  80,  96, 112, 128, 144, 160 },
97         { 0,  8, 16, 24, 32, 40, 48,  56,  64,  80,  96, 112, 128, 144, 160 }
98     },
99 };
100
101 static const int sSamplesPerFrame[2][3] = {
102     { 384, 1152, 1152 },
103     { 384, 1152,  576 }
104 };
105
106 static const int sBitsPerSlot[3] = { 32, 8, 8 };
107
108 static int mp3len(void *data, int *samplesPerFrame, int *sampleRate)
109 {
110     uint32_t header  = AV_RB32(data);
111     int layerID      = 3 - ((header >> 17) & 0x03);
112     int bitRateID    = ((header >> 12) & 0x0f);
113     int sampleRateID = ((header >> 10) & 0x03);
114     int bitsPerSlot  = sBitsPerSlot[layerID];
115     int isPadded     = ((header >> 9) & 0x01);
116     static int const mode_tab[4] = { 2, 3, 1, 0 };
117     int mode    = mode_tab[(header >> 19) & 0x03];
118     int mpeg_id = mode > 0;
119     int temp0, temp1, bitRate;
120
121     if (((header >> 21) & 0x7ff) != 0x7ff || mode == 3 || layerID == 3 ||
122         sampleRateID == 3) {
123         return -1;
124     }
125
126     if (!samplesPerFrame)
127         samplesPerFrame = &temp0;
128     if (!sampleRate)
129         sampleRate      = &temp1;
130
131     //*isMono = ((header >>  6) & 0x03) == 0x03;
132
133     *sampleRate      = sSampleRates[sampleRateID] >> mode;
134     bitRate          = sBitRates[mpeg_id][layerID][bitRateID] * 1000;
135     *samplesPerFrame = sSamplesPerFrame[mpeg_id][layerID];
136     //av_log(NULL, AV_LOG_DEBUG,
137     //       "sr:%d br:%d spf:%d l:%d m:%d\n",
138     //       *sampleRate, bitRate, *samplesPerFrame, layerID, mode);
139
140     return *samplesPerFrame * bitRate / (bitsPerSlot * *sampleRate) + isPadded;
141 }
142
143 static int MP3lame_encode_frame(AVCodecContext *avctx, unsigned char *frame,
144                                 int buf_size, void *data)
145 {
146     Mp3AudioContext *s = avctx->priv_data;
147     int len;
148     int lame_result;
149
150     /* lame 3.91 dies on '1-channel interleaved' data */
151
152     if (data) {
153         if (avctx->channels > 1) {
154             lame_result = lame_encode_buffer_interleaved(s->gfp, data,
155                                                          avctx->frame_size,
156                                                          s->buffer + s->buffer_index,
157                                                          BUFFER_SIZE - s->buffer_index);
158         } else {
159             lame_result = lame_encode_buffer(s->gfp, data, data,
160                                              avctx->frame_size, s->buffer +
161                                              s->buffer_index, BUFFER_SIZE -
162                                              s->buffer_index);
163         }
164     } else {
165         lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
166                                         BUFFER_SIZE - s->buffer_index);
167     }
168
169     if (lame_result < 0) {
170         if (lame_result == -1) {
171             /* output buffer too small */
172             av_log(avctx, AV_LOG_ERROR,
173                    "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
174                    s->buffer_index, BUFFER_SIZE - s->buffer_index);
175         }
176         return -1;
177     }
178
179     s->buffer_index += lame_result;
180
181     if (s->buffer_index < 4)
182         return 0;
183
184     len = mp3len(s->buffer, NULL, NULL);
185     //av_log(avctx, AV_LOG_DEBUG, "in:%d packet-len:%d index:%d\n",
186     //       avctx->frame_size, len, s->buffer_index);
187     if (len <= s->buffer_index) {
188         memcpy(frame, s->buffer, len);
189         s->buffer_index -= len;
190
191         memmove(s->buffer, s->buffer + len, s->buffer_index);
192         // FIXME fix the audio codec API, so we do not need the memcpy()
193         /*for(i=0; i<len; i++) {
194             av_log(avctx, AV_LOG_DEBUG, "%2X ", frame[i]);
195         }*/
196         return len;
197     } else
198         return 0;
199 }
200
201 static av_cold int MP3lame_encode_close(AVCodecContext *avctx)
202 {
203     Mp3AudioContext *s = avctx->priv_data;
204
205     av_freep(&avctx->coded_frame);
206
207     lame_close(s->gfp);
208     return 0;
209 }
210
211 #define OFFSET(x) offsetof(Mp3AudioContext, x)
212 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
213 static const AVOption options[] = {
214     { "reservoir", "Use bit reservoir.", OFFSET(reservoir), AV_OPT_TYPE_INT, { 1 }, 0, 1, AE },
215     { NULL },
216 };
217
218 static const AVClass libmp3lame_class = {
219     .class_name = "libmp3lame encoder",
220     .item_name  = av_default_item_name,
221     .option     = options,
222     .version    = LIBAVUTIL_VERSION_INT,
223 };
224
225 AVCodec ff_libmp3lame_encoder = {
226     .name                  = "libmp3lame",
227     .type                  = AVMEDIA_TYPE_AUDIO,
228     .id                    = CODEC_ID_MP3,
229     .priv_data_size        = sizeof(Mp3AudioContext),
230     .init                  = MP3lame_encode_init,
231     .encode                = MP3lame_encode_frame,
232     .close                 = MP3lame_encode_close,
233     .capabilities          = CODEC_CAP_DELAY,
234     .sample_fmts           = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S16,
235                                                              AV_SAMPLE_FMT_NONE },
236     .supported_samplerates = sSampleRates,
237     .long_name             = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
238     .priv_class            = &libmp3lame_class,
239 };