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