Libav
libmp3lame.c
Go to the documentation of this file.
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 
27 #include <lame/lame.h>
28 
30 #include "libavutil/common.h"
31 #include "libavutil/float_dsp.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
35 #include "avcodec.h"
36 #include "audio_frame_queue.h"
37 #include "internal.h"
38 #include "mpegaudio.h"
39 #include "mpegaudiodecheader.h"
40 
41 #define BUFFER_SIZE (7200 + 2 * MPA_FRAME_SIZE + MPA_FRAME_SIZE / 4)
42 
43 typedef struct LAMEContext {
44  AVClass *class;
46  lame_global_flags *gfp;
50  int reservoir;
51  float *samples_flt[2];
54 } LAMEContext;
55 
56 
58 {
59  if (!s->buffer || s->buffer_size - s->buffer_index < BUFFER_SIZE) {
60  int new_size = s->buffer_index + 2 * BUFFER_SIZE, err;
61 
62  av_dlog(s->avctx, "resizing output buffer: %d -> %d\n", s->buffer_size,
63  new_size);
64  if ((err = av_reallocp(&s->buffer, new_size)) < 0) {
65  s->buffer_size = s->buffer_index = 0;
66  return err;
67  }
68  s->buffer_size = new_size;
69  }
70  return 0;
71 }
72 
74 {
75  LAMEContext *s = avctx->priv_data;
76 
77  av_freep(&s->samples_flt[0]);
78  av_freep(&s->samples_flt[1]);
79  av_freep(&s->buffer);
80 
82 
83  lame_close(s->gfp);
84  return 0;
85 }
86 
88 {
89  LAMEContext *s = avctx->priv_data;
90  int ret;
91 
92  s->avctx = avctx;
93 
94  /* initialize LAME and get defaults */
95  if ((s->gfp = lame_init()) == NULL)
96  return AVERROR(ENOMEM);
97 
98  lame_set_num_channels(s->gfp, avctx->channels);
99  lame_set_mode(s->gfp, avctx->channels > 1 ? JOINT_STEREO : MONO);
100 
101  /* sample rate */
102  lame_set_in_samplerate (s->gfp, avctx->sample_rate);
103  lame_set_out_samplerate(s->gfp, avctx->sample_rate);
104 
105  /* algorithmic quality */
107  lame_set_quality(s->gfp, 5);
108  else
109  lame_set_quality(s->gfp, avctx->compression_level);
110 
111  /* rate control */
112  if (avctx->flags & CODEC_FLAG_QSCALE) {
113  lame_set_VBR(s->gfp, vbr_default);
114  lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
115  } else {
116  if (avctx->bit_rate)
117  lame_set_brate(s->gfp, avctx->bit_rate / 1000);
118  }
119 
120  /* do not get a Xing VBR header frame from LAME */
121  lame_set_bWriteVbrTag(s->gfp,0);
122 
123  /* bit reservoir usage */
124  lame_set_disable_reservoir(s->gfp, !s->reservoir);
125 
126  /* set specified parameters */
127  if (lame_init_params(s->gfp) < 0) {
128  ret = -1;
129  goto error;
130  }
131 
132  /* get encoder delay */
133  avctx->delay = lame_get_encoder_delay(s->gfp) + 528 + 1;
134  ff_af_queue_init(avctx, &s->afq);
135 
136  avctx->frame_size = lame_get_framesize(s->gfp);
137 
138  /* allocate float sample buffers */
139  if (avctx->sample_fmt == AV_SAMPLE_FMT_FLTP) {
140  int ch;
141  for (ch = 0; ch < avctx->channels; ch++) {
142  s->samples_flt[ch] = av_malloc(avctx->frame_size *
143  sizeof(*s->samples_flt[ch]));
144  if (!s->samples_flt[ch]) {
145  ret = AVERROR(ENOMEM);
146  goto error;
147  }
148  }
149  }
150 
151  ret = realloc_buffer(s);
152  if (ret < 0)
153  goto error;
154 
156 
157  return 0;
158 error:
159  mp3lame_encode_close(avctx);
160  return ret;
161 }
162 
163 #define ENCODE_BUFFER(func, buf_type, buf_name) do { \
164  lame_result = func(s->gfp, \
165  (const buf_type *)buf_name[0], \
166  (const buf_type *)buf_name[1], frame->nb_samples, \
167  s->buffer + s->buffer_index, \
168  s->buffer_size - s->buffer_index); \
169 } while (0)
170 
171 static int mp3lame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
172  const AVFrame *frame, int *got_packet_ptr)
173 {
174  LAMEContext *s = avctx->priv_data;
175  MPADecodeHeader hdr;
176  int len, ret, ch;
177  int lame_result;
178  uint32_t h;
179 
180  if (frame) {
181  switch (avctx->sample_fmt) {
182  case AV_SAMPLE_FMT_S16P:
183  ENCODE_BUFFER(lame_encode_buffer, int16_t, frame->data);
184  break;
185  case AV_SAMPLE_FMT_S32P:
186  ENCODE_BUFFER(lame_encode_buffer_int, int32_t, frame->data);
187  break;
188  case AV_SAMPLE_FMT_FLTP:
189  if (frame->linesize[0] < 4 * FFALIGN(frame->nb_samples, 8)) {
190  av_log(avctx, AV_LOG_ERROR, "inadequate AVFrame plane padding\n");
191  return AVERROR(EINVAL);
192  }
193  for (ch = 0; ch < avctx->channels; ch++) {
195  (const float *)frame->data[ch],
196  32768.0f,
197  FFALIGN(frame->nb_samples, 8));
198  }
199  ENCODE_BUFFER(lame_encode_buffer_float, float, s->samples_flt);
200  break;
201  default:
202  return AVERROR_BUG;
203  }
204  } else {
205  lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
206  s->buffer_size - s->buffer_index);
207  }
208  if (lame_result < 0) {
209  if (lame_result == -1) {
210  av_log(avctx, AV_LOG_ERROR,
211  "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
213  }
214  return -1;
215  }
216  s->buffer_index += lame_result;
217  ret = realloc_buffer(s);
218  if (ret < 0) {
219  av_log(avctx, AV_LOG_ERROR, "error reallocating output buffer\n");
220  return ret;
221  }
222 
223  /* add current frame to the queue */
224  if (frame) {
225  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
226  return ret;
227  }
228 
229  /* Move 1 frame from the LAME buffer to the output packet, if available.
230  We have to parse the first frame header in the output buffer to
231  determine the frame size. */
232  if (s->buffer_index < 4)
233  return 0;
234  h = AV_RB32(s->buffer);
235  if (ff_mpa_check_header(h) < 0) {
236  av_log(avctx, AV_LOG_ERROR, "Invalid mp3 header at start of buffer\n");
237  return AVERROR_BUG;
238  }
239  if (avpriv_mpegaudio_decode_header(&hdr, h)) {
240  av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
241  return -1;
242  }
243  len = hdr.frame_size;
244  av_dlog(avctx, "in:%d packet-len:%d index:%d\n", avctx->frame_size, len,
245  s->buffer_index);
246  if (len <= s->buffer_index) {
247  if ((ret = ff_alloc_packet(avpkt, len))) {
248  av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
249  return ret;
250  }
251  memcpy(avpkt->data, s->buffer, len);
252  s->buffer_index -= len;
253  memmove(s->buffer, s->buffer + len, s->buffer_index);
254 
255  /* Get the next frame pts/duration */
256  ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
257  &avpkt->duration);
258 
259  avpkt->size = len;
260  *got_packet_ptr = 1;
261  }
262  return 0;
263 }
264 
265 #define OFFSET(x) offsetof(LAMEContext, x)
266 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
267 static const AVOption options[] = {
268  { "reservoir", "Use bit reservoir.", OFFSET(reservoir), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, AE },
269  { NULL },
270 };
271 
272 static const AVClass libmp3lame_class = {
273  .class_name = "libmp3lame encoder",
274  .item_name = av_default_item_name,
275  .option = options,
276  .version = LIBAVUTIL_VERSION_INT,
277 };
278 
280  { "b", "0" },
281  { NULL },
282 };
283 
284 static const int libmp3lame_sample_rates[] = {
285  44100, 48000, 32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
286 };
287 
289  .name = "libmp3lame",
290  .long_name = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
291  .type = AVMEDIA_TYPE_AUDIO,
292  .id = AV_CODEC_ID_MP3,
293  .priv_data_size = sizeof(LAMEContext),
295  .encode2 = mp3lame_encode_frame,
298  .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S32P,
302  .supported_samplerates = libmp3lame_sample_rates,
303  .channel_layouts = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
305  0 },
306  .priv_class = &libmp3lame_class,
307  .defaults = libmp3lame_defaults,
308 };
static int mp3lame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libmp3lame.c:171
static const AVClass libmp3lame_class
Definition: libmp3lame.c:272
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:62
#define FF_COMPRESSION_DEFAULT
Definition: avcodec.h:1135
This structure describes decoded (raw) audio or video data.
Definition: frame.h:107
AVOption.
Definition: opt.h:233
#define JOINT_STEREO
Definition: atrac3.c:51
static av_cold int mp3lame_encode_init(AVCodecContext *avctx)
Definition: libmp3lame.c:87
AudioFrameQueue afq
Definition: libmp3lame.c:52
int size
Definition: avcodec.h:974
static const int libmp3lame_sample_rates[]
Definition: libmp3lame.c:284
AVCodec ff_libmp3lame_encoder
Definition: libmp3lame.c:288
av_dlog(ac->avr,"%d samples - audio_convert: %s to %s (%s)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt), use_generic?ac->func_descr_generic:ac->func_descr)
#define AV_CH_LAYOUT_STEREO
AVCodec.
Definition: avcodec.h:2755
#define FFALIGN(x, a)
Definition: common.h:62
static av_cold int mp3lame_encode_close(AVCodecContext *avctx)
Definition: libmp3lame.c:73
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:198
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:38
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1787
uint8_t
#define av_cold
Definition: attributes.h:66
AVOptions.
int buffer_size
Definition: libmp3lame.c:49
#define AV_RB32
Definition: intreadwrite.h:130
av_cold void ff_af_queue_init(AVCodecContext *avctx, AudioFrameQueue *afq)
Initialize AudioFrameQueue.
#define BUFFER_SIZE
Definition: libmp3lame.c:41
#define AE
Definition: libmp3lame.c:266
int reservoir
Definition: libmp3lame.c:50
uint8_t * data
Definition: avcodec.h:973
int avpriv_mpegaudio_decode_header(MPADecodeHeader *s, uint32_t header)
int av_reallocp(void *ptr, size_t size)
Allocate or reallocate a block of memory.
Definition: mem.c:140
#define CODEC_FLAG_BITEXACT
Use only bitexact stuff (except (I)DCT).
Definition: avcodec.h:685
signed 32 bits, planar
Definition: samplefmt.h:59
int duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:995
float, planar
Definition: samplefmt.h:60
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:123
uint8_t * buffer
Definition: libmp3lame.c:47
#define CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: avcodec.h:740
#define AVERROR(e)
Definition: error.h:43
sample_fmts
Definition: avconv_filter.c:68
#define CODEC_CAP_SMALL_LAST_FRAME
Codec can be fed a final frame with a smaller size.
Definition: avcodec.h:745
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:142
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: avcodec.h:369
int flags
CODEC_FLAG_*.
Definition: avcodec.h:1142
#define CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:656
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:148
const char * name
Name of the codec implementation.
Definition: avcodec.h:2762
static const AVOption options[]
Definition: libmp3lame.c:267
static int ff_mpa_check_header(uint32_t header)
static const AVCodecDefault libmp3lame_defaults[]
Definition: libmp3lame.c:279
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
static int realloc_buffer(LAMEContext *s)
Definition: libmp3lame.c:57
int bit_rate
the average bitrate
Definition: avcodec.h:1112
audio channel layout utility functions
int32_t
int buffer_index
Definition: libmp3lame.c:48
int ff_alloc_packet(AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1125
void(* vector_fmul_scalar)(float *dst, const float *src, float mul, int len)
Multiply a vector of floats by a scalar float.
Definition: float_dsp.h:69
AVCodecContext * avctx
Definition: libmp3lame.c:45
AVFloatDSPContext fdsp
Definition: libmp3lame.c:53
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1799
NULL
Definition: eval.c:55
Libavcodec external API header.
int compression_level
Definition: avcodec.h:1134
AV_SAMPLE_FMT_NONE
Definition: avconv_filter.c:68
int sample_rate
samples per second
Definition: avcodec.h:1779
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:125
av_default_item_name
Definition: dnxhdenc.c:45
main external API structure.
Definition: avcodec.h:1054
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:489
#define AVERROR_BUG
Bug detected, please report the issue.
Definition: error.h:60
Describe the class of an AVClass context structure.
Definition: log.h:33
#define MONO
Definition: cook.c:58
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:1128
av_cold void avpriv_float_dsp_init(AVFloatDSPContext *fdsp, int bit_exact)
Initialize a float DSP context.
Definition: float_dsp.c:115
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:113
MPEG Audio header decoder.
common internal api header.
common internal and external API header
AVSampleFormat
Audio Sample Formats.
Definition: samplefmt.h:49
mpeg audio declarations for both encoder and decoder.
static av_cold int init(AVCodecParserContext *s)
Definition: h264_parser.c:498
#define ENCODE_BUFFER(func, buf_type, buf_name)
Definition: libmp3lame.c:163
void * priv_data
Definition: avcodec.h:1090
float * samples_flt[2]
Definition: libmp3lame.c:51
int len
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int *duration)
Remove frame(s) from the queue.
int channels
number of audio channels
Definition: avcodec.h:1780
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:207
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
#define OFFSET(x)
Definition: libmp3lame.c:265
signed 16 bits, planar
Definition: samplefmt.h:58
lame_global_flags * gfp
Definition: libmp3lame.c:46
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
Definition: avcodec.h:950
int delay
Codec delay.
Definition: avcodec.h:1205
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:151
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:966