libmp3lame.c 11.9 KB
Newer Older
1 2 3 4
/*
 * Interface to libmp3lame for mp3 encoding
 * Copyright (c) 2002 Lennert Buytenhek <buytenh@gnu.org>
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * 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
 * FFmpeg is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * 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 FFmpeg; if not, write to the Free Software
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
 */
21

Michael Niedermayer's avatar
Michael Niedermayer committed
22
/**
23
 * @file
Michael Niedermayer's avatar
Michael Niedermayer committed
24 25
 * Interface to libmp3lame for mp3 encoding.
 */
26

27 28
#include <lame/lame.h>

29
#include "libavutil/channel_layout.h"
30
#include "libavutil/common.h"
31
#include "libavutil/float_dsp.h"
32
#include "libavutil/intreadwrite.h"
33 34
#include "libavutil/log.h"
#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+1000) // FIXME: Buffer size to small? Adding 1000 to make up for it.
42 43

typedef struct LAMEContext {
44
    AVClass *class;
45
    AVCodecContext *avctx;
46
    lame_global_flags *gfp;
47
    uint8_t *buffer;
48
    int buffer_index;
49
    int buffer_size;
50
    int reservoir;
51
    int joint_stereo;
52
    int abr;
53
    int delay_sent;
54
    float *samples_flt[2];
55
    AudioFrameQueue afq;
56
    AVFloatDSPContext *fdsp;
57
} LAMEContext;
58 59


60 61 62
static int realloc_buffer(LAMEContext *s)
{
    if (!s->buffer || s->buffer_size - s->buffer_index < BUFFER_SIZE) {
63
        int new_size = s->buffer_index + 2 * BUFFER_SIZE, err;
64

65
        ff_dlog(s->avctx, "resizing output buffer: %d -> %d\n", s->buffer_size,
66
                new_size);
67
        if ((err = av_reallocp(&s->buffer, new_size)) < 0) {
68
            s->buffer_size = s->buffer_index = 0;
69
            return err;
70 71 72 73 74 75
        }
        s->buffer_size = new_size;
    }
    return 0;
}

76
static av_cold int mp3lame_encode_close(AVCodecContext *avctx)
77
{
78
    LAMEContext *s = avctx->priv_data;
79

80 81
    av_freep(&s->samples_flt[0]);
    av_freep(&s->samples_flt[1]);
82
    av_freep(&s->buffer);
83
    av_freep(&s->fdsp);
84

85 86
    ff_af_queue_close(&s->afq);

87 88 89 90
    lame_close(s->gfp);
    return 0;
}

91
static av_cold int mp3lame_encode_init(AVCodecContext *avctx)
92
{
93
    LAMEContext *s = avctx->priv_data;
94
    int ret;
95

96 97
    s->avctx = avctx;

98
    /* initialize LAME and get defaults */
99
    if (!(s->gfp = lame_init()))
100
        return AVERROR(ENOMEM);
101

102

103
    lame_set_num_channels(s->gfp, avctx->channels);
104
    lame_set_mode(s->gfp, avctx->channels > 1 ? s->joint_stereo ? JOINT_STEREO : STEREO : MONO);
105

106 107
    /* sample rate */
    lame_set_in_samplerate (s->gfp, avctx->sample_rate);
108
    lame_set_out_samplerate(s->gfp, avctx->sample_rate);
109 110

    /* algorithmic quality */
111
    if (avctx->compression_level != FF_COMPRESSION_DEFAULT)
112
        lame_set_quality(s->gfp, avctx->compression_level);
113 114

    /* rate control */
115
    if (avctx->flags & AV_CODEC_FLAG_QSCALE) { // VBR
116
        lame_set_VBR(s->gfp, vbr_default);
117
        lame_set_VBR_quality(s->gfp, avctx->global_quality / (float)FF_QP2LAMBDA);
118
    } else {
119 120 121 122 123 124 125
        if (avctx->bit_rate) {
            if (s->abr) {                   // ABR
                lame_set_VBR(s->gfp, vbr_abr);
                lame_set_VBR_mean_bitrate_kbps(s->gfp, avctx->bit_rate / 1000);
            } else                          // CBR
                lame_set_brate(s->gfp, avctx->bit_rate / 1000);
        }
126
    }
127

128 129 130 131
    /* lowpass cutoff frequency */
    if (avctx->cutoff)
        lame_set_lowpassfreq(s->gfp, avctx->cutoff);

132
    /* do not get a Xing VBR header frame from LAME */
133
    lame_set_bWriteVbrTag(s->gfp,0);
134

135
    /* bit reservoir usage */
136
    lame_set_disable_reservoir(s->gfp, !s->reservoir);
137

138
    /* set specified parameters */
139 140 141
    if (lame_init_params(s->gfp) < 0) {
        ret = -1;
        goto error;
142
    }
143

144
    /* get encoder delay */
145
    avctx->initial_padding = lame_get_encoder_delay(s->gfp) + 528 + 1;
146 147
    ff_af_queue_init(avctx, &s->afq);

148
    avctx->frame_size  = lame_get_framesize(s->gfp);
149

150 151
    /* allocate float sample buffers */
    if (avctx->sample_fmt == AV_SAMPLE_FMT_FLTP) {
152 153
        int ch;
        for (ch = 0; ch < avctx->channels; ch++) {
154
            s->samples_flt[ch] = av_malloc_array(avctx->frame_size,
155 156
                                           sizeof(*s->samples_flt[ch]));
            if (!s->samples_flt[ch]) {
157 158 159
                ret = AVERROR(ENOMEM);
                goto error;
            }
160 161 162
        }
    }

163 164 165 166
    ret = realloc_buffer(s);
    if (ret < 0)
        goto error;

167
    s->fdsp = avpriv_float_dsp_alloc(avctx->flags & AV_CODEC_FLAG_BITEXACT);
168 169 170 171 172
    if (!s->fdsp) {
        ret = AVERROR(ENOMEM);
        goto error;
    }

173

174
    return 0;
175
error:
176
    mp3lame_encode_close(avctx);
177
    return ret;
178 179
}

180 181 182 183 184
#define ENCODE_BUFFER(func, buf_type, buf_name) do {                        \
    lame_result = func(s->gfp,                                              \
                       (const buf_type *)buf_name[0],                       \
                       (const buf_type *)buf_name[1], frame->nb_samples,    \
                       s->buffer + s->buffer_index,                         \
185
                       s->buffer_size - s->buffer_index);                   \
186 187
} while (0)

188 189
static int mp3lame_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
                                const AVFrame *frame, int *got_packet_ptr)
190
{
191
    LAMEContext *s = avctx->priv_data;
192
    MPADecodeHeader hdr;
193
    int len, ret, ch, discard_padding;
194
    int lame_result;
195
    uint32_t h;
196

197
    if (frame) {
198
        switch (avctx->sample_fmt) {
199 200
        case AV_SAMPLE_FMT_S16P:
            ENCODE_BUFFER(lame_encode_buffer, int16_t, frame->data);
201
            break;
202 203
        case AV_SAMPLE_FMT_S32P:
            ENCODE_BUFFER(lame_encode_buffer_int, int32_t, frame->data);
204
            break;
205 206 207 208 209 210
        case AV_SAMPLE_FMT_FLTP:
            if (frame->linesize[0] < 4 * FFALIGN(frame->nb_samples, 8)) {
                av_log(avctx, AV_LOG_ERROR, "inadequate AVFrame plane padding\n");
                return AVERROR(EINVAL);
            }
            for (ch = 0; ch < avctx->channels; ch++) {
211
                s->fdsp->vector_fmul_scalar(s->samples_flt[ch],
212 213 214
                                           (const float *)frame->data[ch],
                                           32768.0f,
                                           FFALIGN(frame->nb_samples, 8));
215 216
            }
            ENCODE_BUFFER(lame_encode_buffer_float, float, s->samples_flt);
217 218 219
            break;
        default:
            return AVERROR_BUG;
220
        }
221 222
    } else if (!s->afq.frame_alloc) {
        lame_result = 0;
223 224
    } else {
        lame_result = lame_encode_flush(s->gfp, s->buffer + s->buffer_index,
225
                                        s->buffer_size - s->buffer_index);
226
    }
227 228 229 230
    if (lame_result < 0) {
        if (lame_result == -1) {
            av_log(avctx, AV_LOG_ERROR,
                   "lame: output buffer too small (buffer index: %d, free bytes: %d)\n",
231
                   s->buffer_index, s->buffer_size - s->buffer_index);
Michael Niedermayer's avatar
Michael Niedermayer committed
232
        }
233
        return -1;
234 235
    }
    s->buffer_index += lame_result;
236 237 238 239 240
    ret = realloc_buffer(s);
    if (ret < 0) {
        av_log(avctx, AV_LOG_ERROR, "error reallocating output buffer\n");
        return ret;
    }
241

242 243
    /* add current frame to the queue */
    if (frame) {
244
        if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
245 246 247
            return ret;
    }

248 249 250
    /* Move 1 frame from the LAME buffer to the output packet, if available.
       We have to parse the first frame header in the output buffer to
       determine the frame size. */
251
    if (s->buffer_index < 4)
252
        return 0;
253
    h = AV_RB32(s->buffer);
254 255 256

    ret = avpriv_mpegaudio_decode_header(&hdr, h);
    if (ret < 0) {
257 258
        av_log(avctx, AV_LOG_ERROR, "Invalid mp3 header at start of buffer\n");
        return AVERROR_BUG;
259
    } else if (ret) {
260 261 262 263
        av_log(avctx, AV_LOG_ERROR, "free format output not supported\n");
        return -1;
    }
    len = hdr.frame_size;
264
    ff_dlog(avctx, "in:%d packet-len:%d index:%d\n", avctx->frame_size, len,
265
            s->buffer_index);
266
    if (len <= s->buffer_index) {
267
        if ((ret = ff_alloc_packet2(avctx, avpkt, len, 0)) < 0)
268 269
            return ret;
        memcpy(avpkt->data, s->buffer, len);
Michael Niedermayer's avatar
Michael Niedermayer committed
270
        s->buffer_index -= len;
271
        memmove(s->buffer, s->buffer + len, s->buffer_index);
272 273 274 275 276

        /* Get the next frame pts/duration */
        ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
                           &avpkt->duration);

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
        discard_padding = avctx->frame_size - avpkt->duration;
        // Check if subtraction resulted in an overflow
        if ((discard_padding < avctx->frame_size) != (avpkt->duration > 0)) {
            av_log(avctx, AV_LOG_ERROR, "discard padding overflow\n");
            av_packet_unref(avpkt);
            av_free(avpkt);
            return AVERROR(EINVAL);
        }
        if ((!s->delay_sent && avctx->initial_padding > 0) || discard_padding > 0) {
            uint8_t* side_data = av_packet_new_side_data(avpkt,
                                                         AV_PKT_DATA_SKIP_SAMPLES,
                                                         10);
            if(!side_data) {
                av_packet_unref(avpkt);
                av_free(avpkt);
                return AVERROR(ENOMEM);
            }
            if (!s->delay_sent) {
                AV_WL32(side_data, avctx->initial_padding);
                s->delay_sent = 1;
            }
            AV_WL32(side_data + 4, discard_padding);
        }

301 302 303 304
        avpkt->size = len;
        *got_packet_ptr = 1;
    }
    return 0;
305 306
}

307
#define OFFSET(x) offsetof(LAMEContext, x)
308 309
#define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
static const AVOption options[] = {
310 311 312
    { "reservoir",    "use bit reservoir", OFFSET(reservoir),    AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, AE },
    { "joint_stereo", "use joint stereo",  OFFSET(joint_stereo), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, AE },
    { "abr",          "use ABR",           OFFSET(abr),          AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, AE },
313 314 315 316 317 318 319 320 321
    { NULL },
};

static const AVClass libmp3lame_class = {
    .class_name = "libmp3lame encoder",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};
322

323 324 325 326 327
static const AVCodecDefault libmp3lame_defaults[] = {
    { "b",          "0" },
    { NULL },
};

328 329 330 331
static const int libmp3lame_sample_rates[] = {
    44100, 48000,  32000, 22050, 24000, 16000, 11025, 12000, 8000, 0
};

332
AVCodec ff_libmp3lame_encoder = {
333
    .name                  = "libmp3lame",
334
    .long_name             = NULL_IF_CONFIG_SMALL("libmp3lame MP3 (MPEG audio layer 3)"),
335
    .type                  = AVMEDIA_TYPE_AUDIO,
336
    .id                    = AV_CODEC_ID_MP3,
337 338
    .priv_data_size        = sizeof(LAMEContext),
    .init                  = mp3lame_encode_init,
339
    .encode2               = mp3lame_encode_frame,
340
    .close                 = mp3lame_encode_close,
341
    .capabilities          = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_SMALL_LAST_FRAME,
342 343 344
    .sample_fmts           = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_S32P,
                                                             AV_SAMPLE_FMT_FLTP,
                                                             AV_SAMPLE_FMT_S16P,
345
                                                             AV_SAMPLE_FMT_NONE },
346
    .supported_samplerates = libmp3lame_sample_rates,
347
    .channel_layouts       = (const uint64_t[]) { AV_CH_LAYOUT_MONO,
348
                                                  AV_CH_LAYOUT_STEREO,
349
                                                  0 },
350
    .priv_class            = &libmp3lame_class,
351
    .defaults              = libmp3lame_defaults,
352
    .wrapper_name          = "libmp3lame",
353
};