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