git.sesse.net Git - ffmpeg/blob - libavformat/mp3enc.c

   1 /*
   2  * MP3 muxer
   3  * Copyright (c) 2003 Fabrice Bellard
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include "avformat.h"
  23 #include "avio_internal.h"
  24 #include "id3v1.h"
  25 #include "id3v2.h"
  26 #include "rawenc.h"
  27 #include "libavutil/avstring.h"
  28 #include "libavcodec/mpegaudio.h"
  29 #include "libavcodec/mpegaudiodata.h"
  30 #include "libavcodec/mpegaudiodecheader.h"
  31 #include "libavutil/intreadwrite.h"
  32 #include "libavutil/opt.h"
  33 #include "libavcodec/mpegaudio.h"
  34 #include "libavcodec/mpegaudiodata.h"
  35 #include "libavcodec/mpegaudiodecheader.h"
  36 #include "libavformat/avio_internal.h"
  37 #include "libavutil/dict.h"
  38 #include "libavutil/avassert.h"
  39
  40 static int id3v1_set_string(AVFormatContext *s, const char *key,
  41                             uint8_t *buf, int buf_size)
  42 {
  43     AVDictionaryEntry *tag;
  44     if ((tag = av_dict_get(s->metadata, key, NULL, 0)))
  45         av_strlcpy(buf, tag->value, buf_size);
  46     return !!tag;
  47 }
  48
  49 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
  50 {
  51     AVDictionaryEntry *tag;
  52     int i, count = 0;
  53
  54     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
  55     buf[0] = 'T';
  56     buf[1] = 'A';
  57     buf[2] = 'G';
  58     /* we knowingly overspecify each tag length by one byte to compensate for the mandatory null byte added by av_strlcpy */
  59     count += id3v1_set_string(s, "TIT2",    buf +  3, 30 + 1);       //title
  60     count += id3v1_set_string(s, "TPE1",    buf + 33, 30 + 1);       //author|artist
  61     count += id3v1_set_string(s, "TALB",    buf + 63, 30 + 1);       //album
  62     count += id3v1_set_string(s, "TDRL",    buf + 93,  4 + 1);       //date
  63     count += id3v1_set_string(s, "comment", buf + 97, 30 + 1);
  64     if ((tag = av_dict_get(s->metadata, "TRCK", NULL, 0))) { //track
  65         buf[125] = 0;
  66         buf[126] = atoi(tag->value);
  67         count++;
  68     }
  69     buf[127] = 0xFF; /* default to unknown genre */
  70     if ((tag = av_dict_get(s->metadata, "TCON", NULL, 0))) { //genre
  71         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
  72             if (!av_strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
  73                 buf[127] = i;
  74                 count++;
  75                 break;
  76             }
  77         }
  78     }
  79     return count;
  80 }
  81
  82 #define VBR_NUM_BAGS 400
  83 #define VBR_TOC_SIZE 100
  84
  85 typedef struct MP3Context {
  86     const AVClass *class;
  87     ID3v2EncContext id3;
  88     int id3v2_version;
  89     int write_id3v1;
  90     int64_t frames_offset;
  91     int32_t frames;
  92     int32_t size;
  93     uint32_t want;
  94     uint32_t seen;
  95     uint32_t pos;
  96     uint64_t bag[VBR_NUM_BAGS];
  97
  98     /* index of the audio stream */
  99     int audio_stream_idx;
 100     /* number of attached pictures we still need to write */
 101     int pics_to_write;
 102
 103     /* audio packets are queued here until we get all the attached pictures */
 104     AVPacketList *queue, *queue_end;
 105 } MP3Context;
 106
 107 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
 108
 109 /*
 110  * Write an empty XING header and initialize respective data.
 111  */
 112 static int mp3_write_xing(AVFormatContext *s)
 113 {
 114     MP3Context       *mp3 = s->priv_data;
 115     AVCodecContext *codec = s->streams[mp3->audio_stream_idx]->codec;
 116     int              bitrate_idx;
 117     int              best_bitrate_idx = -1;
 118     int              best_bitrate_error= INT_MAX;
 119     int64_t          xing_offset;
 120     int32_t          header, mask;
 121     MPADecodeHeader  c;
 122     int              srate_idx, i, channels;
 123     int              needed;
 124
 125     if (!s->pb->seekable)
 126         return 0;
 127
 128     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++)
 129         if (avpriv_mpa_freq_tab[i] == codec->sample_rate) {
 130             srate_idx = i;
 131             break;
 132         }
 133     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
 134         av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
 135         return -1;
 136     }
 137
 138     switch (codec->channels) {
 139     case 1:  channels = MPA_MONO;                                          break;
 140     case 2:  channels = MPA_STEREO;                                        break;
 141     default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
 142     }
 143
 144     /* dummy MPEG audio header */
 145     header  =  0xff                                  << 24; // sync
 146     header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
 147     header |= (srate_idx << 2) <<  8;
 148     header |= channels << 6;
 149
 150     for (bitrate_idx=1; bitrate_idx<15; bitrate_idx++) {
 151         int error;
 152         avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
 153         error= FFABS(c.bit_rate - codec->bit_rate);
 154         if(error < best_bitrate_error){
 155             best_bitrate_error= error;
 156             best_bitrate_idx  = bitrate_idx;
 157         }
 158     }
 159     av_assert0(best_bitrate_idx >= 0);
 160
 161     for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
 162         if (15 == bitrate_idx)
 163             return -1;
 164         mask = bitrate_idx << (4+8);
 165         header |= mask;
 166         avpriv_mpegaudio_decode_header(&c, header);
 167         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 168         needed = 4              // header
 169                + xing_offset
 170                + 4              // xing tag
 171                + 4              // frames/size/toc flags
 172                + 4              // frames
 173                + 4              // size
 174                + VBR_TOC_SIZE;  // toc
 175
 176         if (needed <= c.frame_size)
 177             break;
 178         header &= ~mask;
 179     }
 180
 181     avio_wb32(s->pb, header);
 182     ffio_fill(s->pb, 0, xing_offset);
 183     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
 184     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
 185
 186     mp3->frames_offset = avio_tell(s->pb);
 187     mp3->size = c.frame_size;
 188     mp3->want=1;
 189     mp3->seen=0;
 190     mp3->pos=0;
 191
 192     avio_wb32(s->pb, 0);  // frames
 193     avio_wb32(s->pb, 0);  // size
 194
 195     // toc
 196     for (i = 0; i < VBR_TOC_SIZE; ++i)
 197         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
 198
 199     ffio_fill(s->pb, 0, c.frame_size - needed);
 200     avio_flush(s->pb);
 201
 202     return 0;
 203 }
 204
 205 /*
 206  * Add a frame to XING data.
 207  * Following lame's "VbrTag.c".
 208  */
 209 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
 210 {
 211     MP3Context  *mp3 = s->priv_data;
 212     int i;
 213
 214     ++mp3->frames;
 215     mp3->size += pkt->size;
 216
 217     if (mp3->want == ++mp3->seen) {
 218         mp3->bag[mp3->pos] = mp3->size;
 219
 220         if (VBR_NUM_BAGS == ++mp3->pos) {
 221             /* shrink table to half size by throwing away each second bag. */
 222             for (i = 1; i < VBR_NUM_BAGS; i += 2)
 223                 mp3->bag[i >> 1] = mp3->bag[i];
 224
 225             /* double wanted amount per bag. */
 226             mp3->want <<= 1;
 227             /* adjust current position to half of table size. */
 228             mp3->pos >>= 1;
 229         }
 230
 231         mp3->seen = 0;
 232     }
 233 }
 234
 235 static void mp3_fix_xing(AVFormatContext *s)
 236 {
 237     MP3Context  *mp3 = s->priv_data;
 238     int i;
 239
 240     avio_flush(s->pb);
 241     avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
 242     avio_wb32(s->pb, mp3->frames);
 243     avio_wb32(s->pb, mp3->size);
 244
 245     avio_w8(s->pb, 0);  // first toc entry has to be zero.
 246
 247     for (i = 1; i < VBR_TOC_SIZE; ++i) {
 248         int j = i * mp3->pos / VBR_TOC_SIZE;
 249         int seek_point = 256LL * mp3->bag[j] / mp3->size;
 250         avio_w8(s->pb, FFMIN(seek_point, 255));
 251     }
 252
 253     avio_flush(s->pb);
 254     avio_seek(s->pb, 0, SEEK_END);
 255 }
 256
 257 static int mp3_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
 258 {
 259     if (! pkt || ! pkt->data || pkt->size < 4)
 260         return ff_raw_write_packet(s, pkt);
 261     else {
 262         MP3Context  *mp3 = s->priv_data;
 263 #ifdef FILTER_VBR_HEADERS
 264         MPADecodeHeader c;
 265         int base;
 266
 267         ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
 268
 269         /* filter out XING and INFO headers. */
 270         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 271
 272         if (base + 4 <= pkt->size) {
 273             uint32_t v = AV_RB32(pkt->data + base);
 274
 275             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
 276                 return 0;
 277         }
 278
 279         /* filter out VBRI headers. */
 280         base = 4 + 32;
 281
 282         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
 283             return 0;
 284 #endif
 285
 286         if (mp3->frames_offset)
 287             mp3_xing_add_frame(s, pkt);
 288
 289         return ff_raw_write_packet(s, pkt);
 290     }
 291 }
 292
 293 static int mp3_queue_flush(AVFormatContext *s)
 294 {
 295     MP3Context *mp3 = s->priv_data;
 296     AVPacketList *pktl;
 297     int ret = 0, write = 1;
 298
 299     ff_id3v2_finish(&mp3->id3, s->pb);
 300     mp3_write_xing(s);
 301
 302     while ((pktl = mp3->queue)) {
 303         if (write && (ret = mp3_write_packet_internal(s, &pktl->pkt)) < 0)
 304             write = 0;
 305         av_free_packet(&pktl->pkt);
 306         mp3->queue = pktl->next;
 307         av_freep(&pktl);
 308     }
 309     mp3->queue_end = NULL;
 310     return ret;
 311 }
 312
 313 static int mp2_write_trailer(struct AVFormatContext *s)
 314 {
 315     uint8_t buf[ID3v1_TAG_SIZE];
 316     MP3Context *mp3 = s->priv_data;
 317
 318     if (mp3 && mp3->pics_to_write) {
 319         av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
 320                "attached pictures.\n");
 321         mp3_queue_flush(s);
 322     }
 323
 324     /* write the id3v1 tag */
 325     if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
 326         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
 327     }
 328
 329     /* write number of frames */
 330     if (mp3 && mp3->frames_offset) {
 331         avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
 332         avio_wb32(s->pb, s->streams[mp3->audio_stream_idx]->nb_frames);
 333         avio_seek(s->pb, 0, SEEK_END);
 334     }
 335
 336     avio_flush(s->pb);
 337
 338     return 0;
 339 }
 340
 341 #if CONFIG_MP2_MUXER
 342 AVOutputFormat ff_mp2_muxer = {
 343     .name              = "mp2",
 344     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
 345     .mime_type         = "audio/x-mpeg",
 346     .extensions        = "mp2,m2a",
 347     .audio_codec       = CODEC_ID_MP2,
 348     .video_codec       = CODEC_ID_NONE,
 349     .write_packet      = ff_raw_write_packet,
 350     .write_trailer     = mp2_write_trailer,
 351     .flags             = AVFMT_NOTIMESTAMPS,
 352 };
 353 #endif
 354
 355 #if CONFIG_MP3_MUXER
 356
 357 static const AVOption options[] = {
 358     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
 359       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
 360     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
 361       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
 362     { NULL },
 363 };
 364
 365 static const AVClass mp3_muxer_class = {
 366     .class_name     = "MP3 muxer",
 367     .item_name      = av_default_item_name,
 368     .option         = options,
 369     .version        = LIBAVUTIL_VERSION_INT,
 370 };
 371
 372 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
 373 {
 374     MP3Context *mp3 = s->priv_data;
 375
 376     if (pkt->stream_index == mp3->audio_stream_idx) {
 377         if (mp3->pics_to_write) {
 378             /* buffer audio packets until we get all the pictures */
 379             AVPacketList *pktl = av_mallocz(sizeof(*pktl));
 380             if (!pktl)
 381                 return AVERROR(ENOMEM);
 382
 383             pktl->pkt     = *pkt;
 384             pkt->destruct = NULL;
 385
 386             if (mp3->queue_end)
 387                 mp3->queue_end->next = pktl;
 388             else
 389                 mp3->queue = pktl;
 390             mp3->queue_end = pktl;
 391         } else
 392             return mp3_write_packet_internal(s, pkt);
 393     } else {
 394         int ret;
 395
 396         /* warn only once for each stream */
 397         if (s->streams[pkt->stream_index]->nb_frames == 1) {
 398             av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
 399                    " ignoring.\n", pkt->stream_index);
 400         }
 401         if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
 402             return 0;
 403
 404         if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
 405             return ret;
 406         mp3->pics_to_write--;
 407
 408         /* flush the buffered audio packets */
 409         if (!mp3->pics_to_write &&
 410             (ret = mp3_queue_flush(s)) < 0)
 411             return ret;
 412     }
 413
 414     return 0;
 415 }
 416
 417 /**
 418  * Write an ID3v2 header at beginning of stream
 419  */
 420
 421 static int mp3_write_header(struct AVFormatContext *s)
 422 {
 423     MP3Context  *mp3 = s->priv_data;
 424     int ret, i;
 425
 426     /* check the streams -- we want exactly one audio and arbitrary number of
 427      * video (attached pictures) */
 428     mp3->audio_stream_idx = -1;
 429     for (i = 0; i < s->nb_streams; i++) {
 430         AVStream *st = s->streams[i];
 431         if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 432             if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != CODEC_ID_MP3) {
 433                 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
 434                        "audio stream is required.\n");
 435                 return AVERROR(EINVAL);
 436             }
 437             mp3->audio_stream_idx = i;
 438         } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
 439             av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
 440             return AVERROR(EINVAL);
 441         }
 442     }
 443     if (mp3->audio_stream_idx < 0) {
 444         av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
 445         return AVERROR(EINVAL);
 446     }
 447     mp3->pics_to_write = s->nb_streams - 1;
 448
 449     ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
 450     ret = ff_id3v2_write_metadata(s, &mp3->id3);
 451     if (ret < 0)
 452         return ret;
 453
 454     if (!mp3->pics_to_write) {
 455         ff_id3v2_finish(&mp3->id3, s->pb);
 456         mp3_write_xing(s);
 457     }
 458
 459     return 0;
 460 }
 461
 462 static int mp3_write_trailer(AVFormatContext *s)
 463 {
 464     MP3Context  *mp3 = s->priv_data;
 465     int ret=mp2_write_trailer(s);
 466
 467     if (ret < 0)
 468         return ret;
 469
 470     if (mp3->frames_offset)
 471         mp3_fix_xing(s);
 472
 473     return 0;
 474 }
 475
 476 AVOutputFormat ff_mp3_muxer = {
 477     .name              = "mp3",
 478     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
 479     .mime_type         = "audio/x-mpeg",
 480     .extensions        = "mp3",
 481     .priv_data_size    = sizeof(MP3Context),
 482     .audio_codec       = CODEC_ID_MP3,
 483     .video_codec       = CODEC_ID_PNG,
 484     .write_header      = mp3_write_header,
 485     .write_packet      = mp3_write_packet,
 486     .write_trailer     = mp3_write_trailer,
 487     .flags             = AVFMT_NOTIMESTAMPS,
 488     .priv_class        = &mp3_muxer_class,
 489 };
 490 #endif