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     int initial_bitrate;
  98     int has_variable_bitrate;
  99
 100     /* index of the audio stream */
 101     int audio_stream_idx;
 102     /* number of attached pictures we still need to write */
 103     int pics_to_write;
 104
 105     /* audio packets are queued here until we get all the attached pictures */
 106     AVPacketList *queue, *queue_end;
 107 } MP3Context;
 108
 109 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
 110
 111 /*
 112  * Write an empty XING header and initialize respective data.
 113  */
 114 static int mp3_write_xing(AVFormatContext *s)
 115 {
 116     MP3Context       *mp3 = s->priv_data;
 117     AVCodecContext *codec = s->streams[mp3->audio_stream_idx]->codec;
 118     int              bitrate_idx;
 119     int              best_bitrate_idx = -1;
 120     int              best_bitrate_error= INT_MAX;
 121     int64_t          xing_offset;
 122     int32_t          header, mask;
 123     MPADecodeHeader  c;
 124     int              srate_idx, ver = 0, i, channels;
 125     int              needed;
 126
 127     if (!s->pb->seekable)
 128         return 0;
 129
 130     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++) {
 131         const uint16_t base_freq = avpriv_mpa_freq_tab[i];
 132         if      (codec->sample_rate == base_freq)     ver = 0x3; // MPEG 1
 133         else if (codec->sample_rate == base_freq / 2) ver = 0x2; // MPEG 2
 134         else if (codec->sample_rate == base_freq / 4) ver = 0x0; // MPEG 2.5
 135         else continue;
 136         srate_idx = i;
 137         break;
 138     }
 139     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
 140         av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
 141         return -1;
 142     }
 143
 144     switch (codec->channels) {
 145     case 1:  channels = MPA_MONO;                                          break;
 146     case 2:  channels = MPA_STEREO;                                        break;
 147     default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, not writing Xing header.\n"); return -1;
 148     }
 149
 150     /* dummy MPEG audio header */
 151     header  =  0xff                                  << 24; // sync
 152     header |= (0x7 << 5 | ver << 3 | 0x1 << 1 | 0x1) << 16; // sync/audio-version/layer 3/no crc*/
 153     header |= (srate_idx << 2) <<  8;
 154     header |= channels << 6;
 155
 156     for (bitrate_idx=1; bitrate_idx<15; bitrate_idx++) {
 157         int error;
 158         avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
 159         error= FFABS(c.bit_rate - codec->bit_rate);
 160         if(error < best_bitrate_error){
 161             best_bitrate_error= error;
 162             best_bitrate_idx  = bitrate_idx;
 163         }
 164     }
 165     av_assert0(best_bitrate_idx >= 0);
 166
 167     for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
 168         if (15 == bitrate_idx)
 169             return -1;
 170         mask = bitrate_idx << (4+8);
 171         header |= mask;
 172         avpriv_mpegaudio_decode_header(&c, header);
 173         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 174         needed = 4              // header
 175                + xing_offset
 176                + 4              // xing tag
 177                + 4              // frames/size/toc flags
 178                + 4              // frames
 179                + 4              // size
 180                + VBR_TOC_SIZE;  // toc
 181
 182         if (needed <= c.frame_size)
 183             break;
 184         header &= ~mask;
 185     }
 186
 187     avio_wb32(s->pb, header);
 188     ffio_fill(s->pb, 0, xing_offset);
 189     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
 190     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
 191
 192     mp3->frames_offset = avio_tell(s->pb);
 193     mp3->size = c.frame_size;
 194     mp3->want=1;
 195     mp3->seen=0;
 196     mp3->pos=0;
 197
 198     avio_wb32(s->pb, 0);  // frames
 199     avio_wb32(s->pb, 0);  // size
 200
 201     // toc
 202     for (i = 0; i < VBR_TOC_SIZE; ++i)
 203         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
 204
 205     ffio_fill(s->pb, 0, c.frame_size - needed);
 206     avio_flush(s->pb);
 207
 208     return 0;
 209 }
 210
 211 /*
 212  * Add a frame to XING data.
 213  * Following lame's "VbrTag.c".
 214  */
 215 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
 216 {
 217     MP3Context  *mp3 = s->priv_data;
 218     int i;
 219
 220     ++mp3->frames;
 221     mp3->size += pkt->size;
 222
 223     if (mp3->want == ++mp3->seen) {
 224         mp3->bag[mp3->pos] = mp3->size;
 225
 226         if (VBR_NUM_BAGS == ++mp3->pos) {
 227             /* shrink table to half size by throwing away each second bag. */
 228             for (i = 1; i < VBR_NUM_BAGS; i += 2)
 229                 mp3->bag[i >> 1] = mp3->bag[i];
 230
 231             /* double wanted amount per bag. */
 232             mp3->want <<= 1;
 233             /* adjust current position to half of table size. */
 234             mp3->pos >>= 1;
 235         }
 236
 237         mp3->seen = 0;
 238     }
 239 }
 240
 241 static void mp3_fix_xing(AVFormatContext *s)
 242 {
 243     MP3Context  *mp3 = s->priv_data;
 244     int i;
 245
 246     avio_flush(s->pb);
 247
 248     /* replace "Xing" identification string with "Info" for CBR files. */
 249     if (!mp3->has_variable_bitrate) {
 250         int64_t tag_offset = mp3->frames_offset
 251             - 4   // frames/size/toc flags
 252             - 4;  // xing tag
 253         avio_seek(s->pb, tag_offset, SEEK_SET);
 254         avio_wb32(s->pb, MKBETAG('I', 'n', 'f', 'o'));
 255     }
 256
 257     avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
 258     avio_wb32(s->pb, mp3->frames);
 259     avio_wb32(s->pb, mp3->size);
 260
 261     avio_w8(s->pb, 0);  // first toc entry has to be zero.
 262
 263     for (i = 1; i < VBR_TOC_SIZE; ++i) {
 264         int j = i * mp3->pos / VBR_TOC_SIZE;
 265         int seek_point = 256LL * mp3->bag[j] / mp3->size;
 266         avio_w8(s->pb, FFMIN(seek_point, 255));
 267     }
 268
 269     avio_flush(s->pb);
 270     avio_seek(s->pb, 0, SEEK_END);
 271 }
 272
 273 static int mp3_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
 274 {
 275     if (! pkt || ! pkt->data || pkt->size < 4)
 276         return ff_raw_write_packet(s, pkt);
 277     else {
 278         MP3Context  *mp3 = s->priv_data;
 279         MPADecodeHeader c;
 280         int av_unused base;
 281
 282         avpriv_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
 283
 284         if (!mp3->initial_bitrate)
 285             mp3->initial_bitrate = c.bit_rate;
 286         if (!mp3->has_variable_bitrate) {
 287             if ((c.bit_rate == 0) || (mp3->initial_bitrate != c.bit_rate))
 288                 mp3->has_variable_bitrate = 1;
 289         }
 290
 291 #ifdef FILTER_VBR_HEADERS
 292         /* filter out XING and INFO headers. */
 293         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 294
 295         if (base + 4 <= pkt->size) {
 296             uint32_t v = AV_RB32(pkt->data + base);
 297
 298             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
 299                 return 0;
 300         }
 301
 302         /* filter out VBRI headers. */
 303         base = 4 + 32;
 304
 305         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
 306             return 0;
 307 #endif
 308
 309         if (mp3->frames_offset)
 310             mp3_xing_add_frame(s, pkt);
 311
 312         return ff_raw_write_packet(s, pkt);
 313     }
 314 }
 315
 316 static int mp3_queue_flush(AVFormatContext *s)
 317 {
 318     MP3Context *mp3 = s->priv_data;
 319     AVPacketList *pktl;
 320     int ret = 0, write = 1;
 321
 322     ff_id3v2_finish(&mp3->id3, s->pb);
 323     mp3_write_xing(s);
 324
 325     while ((pktl = mp3->queue)) {
 326         if (write && (ret = mp3_write_packet_internal(s, &pktl->pkt)) < 0)
 327             write = 0;
 328         av_free_packet(&pktl->pkt);
 329         mp3->queue = pktl->next;
 330         av_freep(&pktl);
 331     }
 332     mp3->queue_end = NULL;
 333     return ret;
 334 }
 335
 336 static int mp2_write_trailer(struct AVFormatContext *s)
 337 {
 338     uint8_t buf[ID3v1_TAG_SIZE];
 339     MP3Context *mp3 = s->priv_data;
 340
 341     if (mp3 && mp3->pics_to_write) {
 342         av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
 343                "attached pictures.\n");
 344         mp3_queue_flush(s);
 345     }
 346
 347     /* write the id3v1 tag */
 348     if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
 349         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
 350     }
 351
 352     /* write number of frames */
 353     if (mp3 && mp3->frames_offset) {
 354         avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
 355         avio_wb32(s->pb, s->streams[mp3->audio_stream_idx]->nb_frames);
 356         avio_seek(s->pb, 0, SEEK_END);
 357     }
 358
 359     avio_flush(s->pb);
 360
 361     return 0;
 362 }
 363
 364 #if CONFIG_MP2_MUXER
 365 AVOutputFormat ff_mp2_muxer = {
 366     .name              = "mp2",
 367     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
 368     .mime_type         = "audio/x-mpeg",
 369     .extensions        = "mp2,m2a",
 370     .audio_codec       = CODEC_ID_MP2,
 371     .video_codec       = CODEC_ID_NONE,
 372     .write_packet      = ff_raw_write_packet,
 373     .write_trailer     = mp2_write_trailer,
 374     .flags             = AVFMT_NOTIMESTAMPS,
 375 };
 376 #endif
 377
 378 #if CONFIG_MP3_MUXER
 379
 380 static const AVOption options[] = {
 381     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
 382       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
 383     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
 384       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
 385     { NULL },
 386 };
 387
 388 static const AVClass mp3_muxer_class = {
 389     .class_name     = "MP3 muxer",
 390     .item_name      = av_default_item_name,
 391     .option         = options,
 392     .version        = LIBAVUTIL_VERSION_INT,
 393 };
 394
 395 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
 396 {
 397     MP3Context *mp3 = s->priv_data;
 398
 399     if (pkt->stream_index == mp3->audio_stream_idx) {
 400         if (mp3->pics_to_write) {
 401             /* buffer audio packets until we get all the pictures */
 402             AVPacketList *pktl = av_mallocz(sizeof(*pktl));
 403             if (!pktl)
 404                 return AVERROR(ENOMEM);
 405
 406             pktl->pkt     = *pkt;
 407             pkt->destruct = NULL;
 408
 409             if (mp3->queue_end)
 410                 mp3->queue_end->next = pktl;
 411             else
 412                 mp3->queue = pktl;
 413             mp3->queue_end = pktl;
 414         } else
 415             return mp3_write_packet_internal(s, pkt);
 416     } else {
 417         int ret;
 418
 419         /* warn only once for each stream */
 420         if (s->streams[pkt->stream_index]->nb_frames == 1) {
 421             av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
 422                    " ignoring.\n", pkt->stream_index);
 423         }
 424         if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
 425             return 0;
 426
 427         if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
 428             return ret;
 429         mp3->pics_to_write--;
 430
 431         /* flush the buffered audio packets */
 432         if (!mp3->pics_to_write &&
 433             (ret = mp3_queue_flush(s)) < 0)
 434             return ret;
 435     }
 436
 437     return 0;
 438 }
 439
 440 /**
 441  * Write an ID3v2 header at beginning of stream
 442  */
 443
 444 static int mp3_write_header(struct AVFormatContext *s)
 445 {
 446     MP3Context  *mp3 = s->priv_data;
 447     int ret, i;
 448
 449     /* check the streams -- we want exactly one audio and arbitrary number of
 450      * video (attached pictures) */
 451     mp3->audio_stream_idx = -1;
 452     for (i = 0; i < s->nb_streams; i++) {
 453         AVStream *st = s->streams[i];
 454         if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 455             if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != CODEC_ID_MP3) {
 456                 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
 457                        "audio stream is required.\n");
 458                 return AVERROR(EINVAL);
 459             }
 460             mp3->audio_stream_idx = i;
 461         } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
 462             av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
 463             return AVERROR(EINVAL);
 464         }
 465     }
 466     if (mp3->audio_stream_idx < 0) {
 467         av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
 468         return AVERROR(EINVAL);
 469     }
 470     mp3->pics_to_write = s->nb_streams - 1;
 471
 472     ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
 473     ret = ff_id3v2_write_metadata(s, &mp3->id3);
 474     if (ret < 0)
 475         return ret;
 476
 477     if (!mp3->pics_to_write) {
 478         ff_id3v2_finish(&mp3->id3, s->pb);
 479         mp3_write_xing(s);
 480     }
 481
 482     return 0;
 483 }
 484
 485 static int mp3_write_trailer(AVFormatContext *s)
 486 {
 487     MP3Context  *mp3 = s->priv_data;
 488     int ret=mp2_write_trailer(s);
 489
 490     if (ret < 0)
 491         return ret;
 492
 493     if (mp3->frames_offset)
 494         mp3_fix_xing(s);
 495
 496     return 0;
 497 }
 498
 499 AVOutputFormat ff_mp3_muxer = {
 500     .name              = "mp3",
 501     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
 502     .mime_type         = "audio/x-mpeg",
 503     .extensions        = "mp3",
 504     .priv_data_size    = sizeof(MP3Context),
 505     .audio_codec       = CODEC_ID_MP3,
 506     .video_codec       = CODEC_ID_PNG,
 507     .write_header      = mp3_write_header,
 508     .write_packet      = mp3_write_packet,
 509     .write_trailer     = mp3_write_trailer,
 510     .flags             = AVFMT_NOTIMESTAMPS,
 511     .priv_class        = &mp3_muxer_class,
 512 };
 513 #endif