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 "libavcodec/packet_internal.h"
  32 #include "libavutil/intreadwrite.h"
  33 #include "libavutil/opt.h"
  34 #include "libavutil/dict.h"
  35 #include "libavutil/avassert.h"
  36 #include "libavutil/crc.h"
  37 #include "libavutil/mathematics.h"
  38 #include "libavutil/replaygain.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 // refer to: http://id3.org/ID3v1
  50 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
  51 {
  52     AVDictionaryEntry *tag;
  53     int i, count = 0;
  54
  55     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
  56     buf[0] = 'T';
  57     buf[1] = 'A';
  58     buf[2] = 'G';
  59     /* we knowingly overspecify each tag length by one byte to compensate for the mandatory null byte added by av_strlcpy */
  60     count += id3v1_set_string(s, "TIT2",    buf +  3, 30 + 1);       //title
  61     count += id3v1_set_string(s, "TPE1",    buf + 33, 30 + 1);       //author|artist
  62     count += id3v1_set_string(s, "TALB",    buf + 63, 30 + 1);       //album
  63     if ((tag = av_dict_get(s->metadata, "TYER", NULL, 0))) {         //year
  64         av_strlcpy(buf + 93, tag->value, 4 + 1);
  65         count++;
  66     } else if ((tag = av_dict_get(s->metadata, "TDRC", NULL, 0))) {
  67         av_strlcpy(buf + 93, tag->value, 4 + 1);
  68         count++;
  69     } else if ((tag = av_dict_get(s->metadata, "TDAT", NULL, 0))) {
  70         av_strlcpy(buf + 93, tag->value, 4 + 1);
  71         count++;
  72     }
  73
  74     count += id3v1_set_string(s, "comment", buf + 97, 30 + 1);
  75     if ((tag = av_dict_get(s->metadata, "TRCK", NULL, 0))) { //track
  76         buf[125] = 0;
  77         buf[126] = atoi(tag->value);
  78         count++;
  79     }
  80     buf[127] = 0xFF; /* default to unknown genre */
  81     if ((tag = av_dict_get(s->metadata, "TCON", NULL, 0))) { //genre
  82         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
  83             if (!av_strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
  84                 buf[127] = i;
  85                 count++;
  86                 break;
  87             }
  88         }
  89     }
  90     return count;
  91 }
  92
  93 #define XING_NUM_BAGS 400
  94 #define XING_TOC_SIZE 100
  95 // size of the XING/LAME data, starting from the Xing tag
  96 #define XING_SIZE 156
  97
  98 typedef struct MP3Context {
  99     const AVClass *class;
 100     ID3v2EncContext id3;
 101     int id3v2_version;
 102     int write_id3v1;
 103     int write_xing;
 104
 105     /* xing header */
 106     // a buffer containing the whole XING/LAME frame
 107     uint8_t *xing_frame;
 108     int      xing_frame_size;
 109
 110     AVCRC    audio_crc;     // CRC of the audio data
 111     uint32_t audio_size;    // total size of the audio data
 112
 113     // offset of the XING/LAME frame in the file
 114     int64_t  xing_frame_offset;
 115     // offset of the XING/INFO tag in the frame
 116     int xing_offset;
 117
 118     int32_t frames;
 119     int32_t size;
 120     uint32_t want;
 121     uint32_t seen;
 122     uint32_t pos;
 123     uint64_t bag[XING_NUM_BAGS];
 124     int initial_bitrate;
 125     int has_variable_bitrate;
 126     int delay;
 127     int padding;
 128
 129     /* index of the audio stream */
 130     int audio_stream_idx;
 131     /* number of attached pictures we still need to write */
 132     int pics_to_write;
 133
 134     /* audio packets are queued here until we get all the attached pictures */
 135     PacketList *queue, *queue_end;
 136 } MP3Context;
 137
 138 static const uint8_t xing_offtbl[2][2] = {{32, 17}, {17, 9}};
 139
 140 /*
 141  * Write an empty XING header and initialize respective data.
 142  */
 143 static int mp3_write_xing(AVFormatContext *s)
 144 {
 145     MP3Context       *mp3 = s->priv_data;
 146     AVCodecParameters *par = s->streams[mp3->audio_stream_idx]->codecpar;
 147     AVDictionaryEntry *enc = av_dict_get(s->streams[mp3->audio_stream_idx]->metadata, "encoder", NULL, 0);
 148     AVIOContext *dyn_ctx;
 149     int32_t        header;
 150     MPADecodeHeader  mpah;
 151     int srate_idx, i, channels;
 152     int bitrate_idx;
 153     int best_bitrate_idx = -1;
 154     int best_bitrate_error = INT_MAX;
 155     int ret;
 156     int ver = 0;
 157     int bytes_needed;
 158
 159     if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL) || !mp3->write_xing)
 160         return 0;
 161
 162     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++) {
 163         const uint16_t base_freq = avpriv_mpa_freq_tab[i];
 164
 165         if      (par->sample_rate == base_freq)     ver = 0x3; // MPEG 1
 166         else if (par->sample_rate == base_freq / 2) ver = 0x2; // MPEG 2
 167         else if (par->sample_rate == base_freq / 4) ver = 0x0; // MPEG 2.5
 168         else continue;
 169
 170         srate_idx = i;
 171         break;
 172     }
 173     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
 174         av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
 175         return -1;
 176     }
 177
 178     switch (par->channels) {
 179     case 1:  channels = MPA_MONO;                                          break;
 180     case 2:  channels = MPA_STEREO;                                        break;
 181     default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, "
 182                     "not writing Xing header.\n");
 183              return -1;
 184     }
 185
 186     /* dummy MPEG audio header */
 187     header  =  0xffU                                 << 24; // sync
 188     header |= (0x7 << 5 | ver << 3 | 0x1 << 1 | 0x1) << 16; // sync/audio-version/layer 3/no crc*/
 189     header |= (srate_idx << 2) << 8;
 190     header |= channels << 6;
 191
 192     for (bitrate_idx = 1; bitrate_idx < 15; bitrate_idx++) {
 193         int bit_rate = 1000 * avpriv_mpa_bitrate_tab[ver != 3][3 - 1][bitrate_idx];
 194         int error    = FFABS(bit_rate - par->bit_rate);
 195
 196         if (error < best_bitrate_error) {
 197             best_bitrate_error = error;
 198             best_bitrate_idx   = bitrate_idx;
 199         }
 200     }
 201     av_assert0(best_bitrate_idx >= 0);
 202
 203     for (bitrate_idx = best_bitrate_idx; ; bitrate_idx++) {
 204         int32_t mask = bitrate_idx << (4 + 8);
 205         if (15 == bitrate_idx)
 206             return -1;
 207         header |= mask;
 208
 209         ret = avpriv_mpegaudio_decode_header(&mpah, header);
 210         av_assert0(ret >= 0);
 211         mp3->xing_offset = xing_offtbl[mpah.lsf == 1][mpah.nb_channels == 1] + 4;
 212         bytes_needed     = mp3->xing_offset + XING_SIZE;
 213
 214         if (bytes_needed <= mpah.frame_size)
 215             break;
 216
 217         header &= ~mask;
 218     }
 219
 220     ret = avio_open_dyn_buf(&dyn_ctx);
 221     if (ret < 0)
 222         return ret;
 223
 224     avio_wb32(dyn_ctx, header);
 225
 226     ffio_fill(dyn_ctx, 0, mp3->xing_offset - 4);
 227     ffio_wfourcc(dyn_ctx, "Xing");
 228     avio_wb32(dyn_ctx, 0x01 | 0x02 | 0x04 | 0x08);  // frames / size / TOC / vbr scale
 229
 230     mp3->size = mpah.frame_size;
 231     mp3->want=1;
 232     mp3->seen=0;
 233     mp3->pos=0;
 234
 235     avio_wb32(dyn_ctx, 0);  // frames
 236     avio_wb32(dyn_ctx, 0);  // size
 237
 238     // TOC
 239     for (i = 0; i < XING_TOC_SIZE; i++)
 240         avio_w8(dyn_ctx, (uint8_t)(255 * i / XING_TOC_SIZE));
 241
 242     // vbr quality
 243     // we write it, because some (broken) tools always expect it to be present
 244     avio_wb32(dyn_ctx, 0);
 245
 246     // encoder short version string
 247     if (enc) {
 248         uint8_t encoder_str[9] = { 0 };
 249         if (   strlen(enc->value) > sizeof(encoder_str)
 250             && !strcmp("Lavc libmp3lame", enc->value)) {
 251             memcpy(encoder_str, "Lavf lame", 9);
 252         } else
 253             memcpy(encoder_str, enc->value, FFMIN(strlen(enc->value), sizeof(encoder_str)));
 254
 255         avio_write(dyn_ctx, encoder_str, sizeof(encoder_str));
 256     } else
 257         avio_write(dyn_ctx, "Lavf\0\0\0\0\0", 9);
 258
 259     avio_w8(dyn_ctx, 0);      // tag revision 0 / unknown vbr method
 260     avio_w8(dyn_ctx, 0);      // unknown lowpass filter value
 261     ffio_fill(dyn_ctx, 0, 8); // empty replaygain fields
 262     avio_w8(dyn_ctx, 0);      // unknown encoding flags
 263     avio_w8(dyn_ctx, 0);      // unknown abr/minimal bitrate
 264     avio_wb24(dyn_ctx, 0);    // empty encoder delay/padding
 265
 266     avio_w8(dyn_ctx,   0); // misc
 267     avio_w8(dyn_ctx,   0); // mp3gain
 268     avio_wb16(dyn_ctx, 0); // preset
 269
 270     // audio length and CRCs (will be updated later)
 271     avio_wb32(dyn_ctx, 0); // music length
 272     avio_wb16(dyn_ctx, 0); // music crc
 273     avio_wb16(dyn_ctx, 0); // tag crc
 274
 275     ffio_fill(dyn_ctx, 0, mpah.frame_size - bytes_needed);
 276
 277     mp3->xing_frame_size   = avio_close_dyn_buf(dyn_ctx, &mp3->xing_frame);
 278     mp3->xing_frame_offset = avio_tell(s->pb);
 279     avio_write(s->pb, mp3->xing_frame, mp3->xing_frame_size);
 280
 281     mp3->audio_size = mp3->xing_frame_size;
 282
 283     return 0;
 284 }
 285
 286 /*
 287  * Add a frame to XING data.
 288  * Following lame's "VbrTag.c".
 289  */
 290 static void mp3_xing_add_frame(MP3Context *mp3, AVPacket *pkt)
 291 {
 292     int i;
 293
 294     mp3->frames++;
 295     mp3->seen++;
 296     mp3->size += pkt->size;
 297
 298     if (mp3->want == mp3->seen) {
 299         mp3->bag[mp3->pos] = mp3->size;
 300
 301         if (XING_NUM_BAGS == ++mp3->pos) {
 302             /* shrink table to half size by throwing away each second bag. */
 303             for (i = 1; i < XING_NUM_BAGS; i += 2)
 304                 mp3->bag[i >> 1] = mp3->bag[i];
 305
 306             /* double wanted amount per bag. */
 307             mp3->want *= 2;
 308             /* adjust current position to half of table size. */
 309             mp3->pos = XING_NUM_BAGS / 2;
 310         }
 311
 312         mp3->seen = 0;
 313     }
 314 }
 315
 316 static int mp3_write_audio_packet(AVFormatContext *s, AVPacket *pkt)
 317 {
 318     MP3Context  *mp3 = s->priv_data;
 319
 320     if (pkt->data && pkt->size >= 4) {
 321         MPADecodeHeader mpah;
 322         int ret;
 323         int av_unused base;
 324         uint32_t h;
 325
 326         h = AV_RB32(pkt->data);
 327         ret = avpriv_mpegaudio_decode_header(&mpah, h);
 328         if (ret >= 0) {
 329             if (!mp3->initial_bitrate)
 330                 mp3->initial_bitrate = mpah.bit_rate;
 331             if ((mpah.bit_rate == 0) || (mp3->initial_bitrate != mpah.bit_rate))
 332                 mp3->has_variable_bitrate = 1;
 333         } else {
 334             av_log(s, AV_LOG_WARNING, "Audio packet of size %d (starting with %08"PRIX32"...) "
 335                    "is invalid, writing it anyway.\n", pkt->size, h);
 336         }
 337
 338 #ifdef FILTER_VBR_HEADERS
 339         /* filter out XING and INFO headers. */
 340         base = 4 + xing_offtbl[mpah.lsf == 1][mpah.nb_channels == 1];
 341
 342         if (base + 4 <= pkt->size) {
 343             uint32_t v = AV_RB32(pkt->data + base);
 344
 345             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
 346                 return 0;
 347         }
 348
 349         /* filter out VBRI headers. */
 350         base = 4 + 32;
 351
 352         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
 353             return 0;
 354 #endif
 355
 356         if (mp3->xing_offset) {
 357             uint8_t *side_data = NULL;
 358             size_t side_data_size;
 359
 360             mp3_xing_add_frame(mp3, pkt);
 361             mp3->audio_size += pkt->size;
 362             mp3->audio_crc   = av_crc(av_crc_get_table(AV_CRC_16_ANSI_LE),
 363                                       mp3->audio_crc, pkt->data, pkt->size);
 364
 365             side_data = av_packet_get_side_data(pkt,
 366                                                 AV_PKT_DATA_SKIP_SAMPLES,
 367                                                 &side_data_size);
 368             if (side_data && side_data_size >= 10) {
 369                 mp3->padding = FFMAX(AV_RL32(side_data + 4) + 528 + 1, 0);
 370                 if (!mp3->delay)
 371                     mp3->delay =  FFMAX(AV_RL32(side_data) - 528 - 1, 0);
 372             } else {
 373                 mp3->padding = 0;
 374             }
 375         }
 376     }
 377
 378     return ff_raw_write_packet(s, pkt);
 379 }
 380
 381 static int mp3_queue_flush(AVFormatContext *s)
 382 {
 383     MP3Context *mp3 = s->priv_data;
 384     AVPacket pkt;
 385     int ret = 0, write = 1;
 386
 387     ff_id3v2_finish(&mp3->id3, s->pb, s->metadata_header_padding);
 388     mp3_write_xing(s);
 389
 390     while (mp3->queue) {
 391         avpriv_packet_list_get(&mp3->queue, &mp3->queue_end, &pkt);
 392         if (write && (ret = mp3_write_audio_packet(s, &pkt)) < 0)
 393             write = 0;
 394         av_packet_unref(&pkt);
 395     }
 396     return ret;
 397 }
 398
 399 static void mp3_update_xing(AVFormatContext *s)
 400 {
 401     MP3Context  *mp3 = s->priv_data;
 402     AVReplayGain *rg;
 403     uint16_t tag_crc;
 404     uint8_t *toc;
 405     size_t rg_size;
 406     int i;
 407     int64_t old_pos = avio_tell(s->pb);
 408
 409     /* replace "Xing" identification string with "Info" for CBR files. */
 410     if (!mp3->has_variable_bitrate)
 411         AV_WL32(mp3->xing_frame + mp3->xing_offset, MKTAG('I', 'n', 'f', 'o'));
 412
 413     AV_WB32(mp3->xing_frame + mp3->xing_offset + 8,  mp3->frames);
 414     AV_WB32(mp3->xing_frame + mp3->xing_offset + 12, mp3->size);
 415
 416     toc    = mp3->xing_frame + mp3->xing_offset + 16;
 417     toc[0] = 0;  // first toc entry has to be zero.
 418     for (i = 1; i < XING_TOC_SIZE; ++i) {
 419         int j = i * mp3->pos / XING_TOC_SIZE;
 420         int seek_point = 256LL * mp3->bag[j] / mp3->size;
 421         toc[i] = FFMIN(seek_point, 255);
 422     }
 423
 424     /* write replaygain */
 425     rg = (AVReplayGain*)av_stream_get_side_data(s->streams[0], AV_PKT_DATA_REPLAYGAIN,
 426                                                 &rg_size);
 427     if (rg && rg_size >= sizeof(*rg)) {
 428         uint16_t val;
 429
 430         AV_WB32(mp3->xing_frame + mp3->xing_offset + 131,
 431                 av_rescale(rg->track_peak, 1 << 23, 100000));
 432
 433         if (rg->track_gain != INT32_MIN) {
 434             val  = FFABS(rg->track_gain / 10000) & ((1 << 9) - 1);
 435             val |= (rg->track_gain < 0) << 9;
 436             val |= 1 << 13;
 437             AV_WB16(mp3->xing_frame + mp3->xing_offset + 135, val);
 438         }
 439
 440         if (rg->album_gain != INT32_MIN) {
 441             val  = FFABS(rg->album_gain / 10000) & ((1 << 9) - 1);
 442             val |= (rg->album_gain < 0) << 9;
 443             val |= 1 << 14;
 444             AV_WB16(mp3->xing_frame + mp3->xing_offset + 137, val);
 445         }
 446     }
 447
 448     /* write encoder delay/padding */
 449     if (mp3->delay >= 1 << 12) {
 450         mp3->delay = (1 << 12) - 1;
 451         av_log(s, AV_LOG_WARNING, "Too many samples of initial padding.\n");
 452     }
 453     if (mp3->padding >= 1 << 12) {
 454         mp3->padding = (1 << 12) - 1;
 455         av_log(s, AV_LOG_WARNING, "Too many samples of trailing padding.\n");
 456     }
 457     AV_WB24(mp3->xing_frame + mp3->xing_offset + 141, (mp3->delay << 12) + mp3->padding);
 458
 459     AV_WB32(mp3->xing_frame + mp3->xing_offset + XING_SIZE - 8, mp3->audio_size);
 460     AV_WB16(mp3->xing_frame + mp3->xing_offset + XING_SIZE - 4, mp3->audio_crc);
 461
 462     tag_crc = av_crc(av_crc_get_table(AV_CRC_16_ANSI_LE), 0, mp3->xing_frame, 190);
 463     AV_WB16(mp3->xing_frame + mp3->xing_offset + XING_SIZE - 2, tag_crc);
 464
 465     avio_seek(s->pb,  mp3->xing_frame_offset, SEEK_SET);
 466     avio_write(s->pb, mp3->xing_frame, mp3->xing_frame_size);
 467     avio_seek(s->pb, old_pos, SEEK_SET);
 468 }
 469
 470 static int mp3_write_trailer(struct AVFormatContext *s)
 471 {
 472     uint8_t buf[ID3v1_TAG_SIZE];
 473     MP3Context *mp3 = s->priv_data;
 474
 475     if (mp3->pics_to_write) {
 476         av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
 477                "attached pictures.\n");
 478         mp3_queue_flush(s);
 479     }
 480
 481     /* write the id3v1 tag */
 482     if (mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
 483         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
 484     }
 485
 486     if (mp3->xing_offset)
 487         mp3_update_xing(s);
 488
 489     return 0;
 490 }
 491
 492 static int query_codec(enum AVCodecID id, int std_compliance)
 493 {
 494     const CodecMime *cm= ff_id3v2_mime_tags;
 495     while(cm->id != AV_CODEC_ID_NONE) {
 496         if(id == cm->id)
 497             return MKTAG('A', 'P', 'I', 'C');
 498         cm++;
 499     }
 500     return -1;
 501 }
 502
 503 static const AVOption options[] = {
 504     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
 505       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.i64 = 4}, 0, 4, AV_OPT_FLAG_ENCODING_PARAM},
 506     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
 507       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
 508     { "write_xing",  "Write the Xing header containing file duration.",
 509       offsetof(MP3Context, write_xing),  AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
 510     { NULL },
 511 };
 512
 513 static const AVClass mp3_muxer_class = {
 514     .class_name     = "MP3 muxer",
 515     .item_name      = av_default_item_name,
 516     .option         = options,
 517     .version        = LIBAVUTIL_VERSION_INT,
 518 };
 519
 520 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
 521 {
 522     MP3Context *mp3 = s->priv_data;
 523
 524     if (pkt->stream_index == mp3->audio_stream_idx) {
 525         if (mp3->pics_to_write) {
 526             /* buffer audio packets until we get all the pictures */
 527             int ret = avpriv_packet_list_put(&mp3->queue, &mp3->queue_end, pkt, av_packet_ref, 0);
 528
 529             if (ret < 0) {
 530                 av_log(s, AV_LOG_WARNING, "Not enough memory to buffer audio. Skipping picture streams\n");
 531                 mp3->pics_to_write = 0;
 532                 mp3_queue_flush(s);
 533                 return mp3_write_audio_packet(s, pkt);
 534             }
 535         } else
 536             return mp3_write_audio_packet(s, pkt);
 537     } else {
 538         int ret;
 539
 540         /* warn only once for each stream */
 541         if (s->streams[pkt->stream_index]->nb_frames == 1) {
 542             av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
 543                    " ignoring.\n", pkt->stream_index);
 544         }
 545         if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
 546             return 0;
 547
 548         if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
 549             return ret;
 550         mp3->pics_to_write--;
 551
 552         /* flush the buffered audio packets */
 553         if (!mp3->pics_to_write &&
 554             (ret = mp3_queue_flush(s)) < 0)
 555             return ret;
 556     }
 557
 558     return 0;
 559 }
 560
 561 /**
 562  * Write an ID3v2 header at beginning of stream
 563  */
 564
 565 static int mp3_init(struct AVFormatContext *s)
 566 {
 567     MP3Context  *mp3 = s->priv_data;
 568     int i;
 569
 570     if (mp3->id3v2_version      &&
 571         mp3->id3v2_version != 3 &&
 572         mp3->id3v2_version != 4) {
 573         av_log(s, AV_LOG_ERROR, "Invalid ID3v2 version requested: %d. Only "
 574                "3, 4 or 0 (disabled) are allowed.\n", mp3->id3v2_version);
 575         return AVERROR(EINVAL);
 576     }
 577
 578     /* check the streams -- we want exactly one audio and arbitrary number of
 579      * video (attached pictures) */
 580     mp3->audio_stream_idx = -1;
 581     for (i = 0; i < s->nb_streams; i++) {
 582         AVStream *st = s->streams[i];
 583         if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
 584             if (mp3->audio_stream_idx >= 0 || st->codecpar->codec_id != AV_CODEC_ID_MP3) {
 585                 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
 586                        "audio stream is required.\n");
 587                 return AVERROR(EINVAL);
 588             }
 589             mp3->audio_stream_idx = i;
 590         } else if (st->codecpar->codec_type != AVMEDIA_TYPE_VIDEO) {
 591             av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
 592             return AVERROR(EINVAL);
 593         }
 594     }
 595     if (mp3->audio_stream_idx < 0) {
 596         av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
 597         return AVERROR(EINVAL);
 598     }
 599     mp3->pics_to_write = s->nb_streams - 1;
 600
 601     if (mp3->pics_to_write && !mp3->id3v2_version) {
 602         av_log(s, AV_LOG_ERROR, "Attached pictures were requested, but the "
 603                "ID3v2 header is disabled.\n");
 604         return AVERROR(EINVAL);
 605     }
 606
 607     return 0;
 608 }
 609
 610 static int mp3_write_header(struct AVFormatContext *s)
 611 {
 612     MP3Context  *mp3 = s->priv_data;
 613     int ret;
 614
 615     if (mp3->id3v2_version) {
 616         ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
 617         ret = ff_id3v2_write_metadata(s, &mp3->id3);
 618         if (ret < 0)
 619             return ret;
 620     }
 621
 622     if (!mp3->pics_to_write) {
 623         if (mp3->id3v2_version)
 624             ff_id3v2_finish(&mp3->id3, s->pb, s->metadata_header_padding);
 625         mp3_write_xing(s);
 626     }
 627
 628     return 0;
 629 }
 630
 631 static void mp3_deinit(struct AVFormatContext *s)
 632 {
 633     MP3Context *mp3 = s->priv_data;
 634
 635     avpriv_packet_list_free(&mp3->queue, &mp3->queue_end);
 636     av_freep(&mp3->xing_frame);
 637 }
 638
 639 const AVOutputFormat ff_mp3_muxer = {
 640     .name              = "mp3",
 641     .long_name         = NULL_IF_CONFIG_SMALL("MP3 (MPEG audio layer 3)"),
 642     .mime_type         = "audio/mpeg",
 643     .extensions        = "mp3",
 644     .priv_data_size    = sizeof(MP3Context),
 645     .audio_codec       = AV_CODEC_ID_MP3,
 646     .video_codec       = AV_CODEC_ID_PNG,
 647     .init              = mp3_init,
 648     .write_header      = mp3_write_header,
 649     .write_packet      = mp3_write_packet,
 650     .write_trailer     = mp3_write_trailer,
 651     .deinit            = mp3_deinit,
 652     .query_codec       = query_codec,
 653     .flags             = AVFMT_NOTIMESTAMPS,
 654     .priv_class        = &mp3_muxer_class,
 655 };