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 <strings.h>
  23 #include "avformat.h"
  24 #include "id3v1.h"
  25 #include "id3v2.h"
  26 #include "rawenc.h"
  27 #include "libavutil/avstring.h"
  28 #include "libavutil/intreadwrite.h"
  29 #include "libavutil/opt.h"
  30 #include "libavcodec/mpegaudio.h"
  31 #include "libavcodec/mpegaudiodata.h"
  32 #include "libavcodec/mpegaudiodecheader.h"
  33 #include "libavformat/avio_internal.h"
  34
  35 static int id3v1_set_string(AVFormatContext *s, const char *key,
  36                             uint8_t *buf, int buf_size)
  37 {
  38     AVMetadataTag *tag;
  39     if ((tag = av_metadata_get(s->metadata, key, NULL, 0)))
  40         av_strlcpy(buf, tag->value, buf_size);
  41     return !!tag;
  42 }
  43
  44 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
  45 {
  46     AVMetadataTag *tag;
  47     int i, count = 0;
  48
  49     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
  50     buf[0] = 'T';
  51     buf[1] = 'A';
  52     buf[2] = 'G';
  53     count += id3v1_set_string(s, "TIT2",    buf +  3, 30);       //title
  54     count += id3v1_set_string(s, "TPE1",    buf + 33, 30);       //author|artist
  55     count += id3v1_set_string(s, "TALB",    buf + 63, 30);       //album
  56     count += id3v1_set_string(s, "TDRL",    buf + 93,  4);       //date
  57     count += id3v1_set_string(s, "comment", buf + 97, 30);
  58     if ((tag = av_metadata_get(s->metadata, "TRCK", NULL, 0))) { //track
  59         buf[125] = 0;
  60         buf[126] = atoi(tag->value);
  61         count++;
  62     }
  63     buf[127] = 0xFF; /* default to unknown genre */
  64     if ((tag = av_metadata_get(s->metadata, "TCON", NULL, 0))) { //genre
  65         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
  66             if (!strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
  67                 buf[127] = i;
  68                 count++;
  69                 break;
  70             }
  71         }
  72     }
  73     return count;
  74 }
  75
  76 /* simple formats */
  77
  78 static void id3v2_put_size(AVFormatContext *s, int size)
  79 {
  80     avio_w8(s->pb, size >> 21 & 0x7f);
  81     avio_w8(s->pb, size >> 14 & 0x7f);
  82     avio_w8(s->pb, size >> 7  & 0x7f);
  83     avio_w8(s->pb, size       & 0x7f);
  84 }
  85
  86 static int string_is_ascii(const uint8_t *str)
  87 {
  88     while (*str && *str < 128) str++;
  89     return !*str;
  90 }
  91
  92 /**
  93  * Write a text frame with one (normal frames) or two (TXXX frames) strings
  94  * according to encoding (only UTF-8 or UTF-16+BOM supported).
  95  * @return number of bytes written or a negative error code.
  96  */
  97 static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2,
  98                           uint32_t tag, enum ID3v2Encoding enc)
  99 {
 100     int len;
 101     uint8_t *pb;
 102     int (*put)(AVIOContext*, const char*);
 103     AVIOContext *dyn_buf;
 104     if (avio_open_dyn_buf(&dyn_buf) < 0)
 105         return AVERROR(ENOMEM);
 106
 107     /* check if the strings are ASCII-only and use UTF16 only if
 108      * they're not */
 109     if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
 110         (!str2 || string_is_ascii(str2)))
 111         enc = ID3v2_ENCODING_ISO8859;
 112
 113     avio_w8(dyn_buf, enc);
 114     if (enc == ID3v2_ENCODING_UTF16BOM) {
 115         avio_wl16(dyn_buf, 0xFEFF);      /* BOM */
 116         put = avio_put_str16le;
 117     } else
 118         put = avio_put_str;
 119
 120     put(dyn_buf, str1);
 121     if (str2)
 122         put(dyn_buf, str2);
 123     len = avio_close_dyn_buf(dyn_buf, &pb);
 124
 125     avio_wb32(s->pb, tag);
 126     id3v2_put_size(s, len);
 127     avio_wb16(s->pb, 0);
 128     avio_write(s->pb, pb, len);
 129
 130     av_freep(&pb);
 131     return len + ID3v2_HEADER_SIZE;
 132 }
 133
 134 static int mp2_write_trailer(struct AVFormatContext *s)
 135 {
 136     uint8_t buf[ID3v1_TAG_SIZE];
 137
 138     /* write the id3v1 tag */
 139     if (id3v1_create_tag(s, buf) > 0) {
 140         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
 141         avio_flush(s->pb);
 142     }
 143     return 0;
 144 }
 145
 146 #if CONFIG_MP2_MUXER
 147 AVOutputFormat ff_mp2_muxer = {
 148     "mp2",
 149     NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
 150     "audio/x-mpeg",
 151     "mp2,m2a",
 152     0,
 153     CODEC_ID_MP2,
 154     CODEC_ID_NONE,
 155     NULL,
 156     ff_raw_write_packet,
 157     mp2_write_trailer,
 158 };
 159 #endif
 160
 161 #if CONFIG_MP3_MUXER
 162 #define VBR_NUM_BAGS 400
 163 #define VBR_TOC_SIZE 100
 164 typedef struct MP3Context {
 165     const AVClass *class;
 166     int id3v2_version;
 167     int64_t frames_offset;
 168     int32_t frames;
 169     int32_t size;
 170     uint32_t want;
 171     uint32_t seen;
 172     uint32_t pos;
 173     uint64_t bag[VBR_NUM_BAGS];
 174 } MP3Context;
 175
 176 static const AVOption options[] = {
 177     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
 178       offsetof(MP3Context, id3v2_version), FF_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
 179     { NULL },
 180 };
 181
 182 static const AVClass mp3_muxer_class = {
 183     .class_name     = "MP3 muxer",
 184     .item_name      = av_default_item_name,
 185     .option         = options,
 186     .version        = LIBAVUTIL_VERSION_INT,
 187 };
 188
 189 static int id3v2_check_write_tag(AVFormatContext *s, AVMetadataTag *t, const char table[][4],
 190                                  enum ID3v2Encoding enc)
 191 {
 192     uint32_t tag;
 193     int i;
 194
 195     if (t->key[0] != 'T' || strlen(t->key) != 4)
 196         return -1;
 197     tag = AV_RB32(t->key);
 198     for (i = 0; *table[i]; i++)
 199         if (tag == AV_RB32(table[i]))
 200             return id3v2_put_ttag(s, t->value, NULL, tag, enc);
 201     return -1;
 202 }
 203
 204 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
 205
 206 /*
 207  * Write an empty XING header and initialize respective data.
 208  */
 209 static int mp3_write_xing(AVFormatContext *s)
 210 {
 211     AVCodecContext   *codec = s->streams[0]->codec;
 212     MP3Context       *mp3 = s->priv_data;
 213     int              bitrate_idx = 3;
 214     int64_t          xing_offset;
 215     int32_t          mask, header;
 216     MPADecodeHeader  c;
 217     int              srate_idx, i, channels;
 218     int              needed;
 219
 220     for (i = 0; i < FF_ARRAY_ELEMS(ff_mpa_freq_tab); i++)
 221         if (ff_mpa_freq_tab[i] == codec->sample_rate) {
 222             srate_idx = i;
 223             break;
 224         }
 225     if (i == FF_ARRAY_ELEMS(ff_mpa_freq_tab)) {
 226         av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
 227         return -1;
 228     }
 229
 230     switch (codec->channels) {
 231     case 1:  channels = MPA_MONO;                                          break;
 232     case 2:  channels = MPA_STEREO;                                        break;
 233     default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
 234     }
 235
 236     /* dummy MPEG audio header */
 237     header  =  0xff                                  << 24; // sync
 238     header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
 239     header |= (srate_idx << 2) <<  8;
 240     header |= channels << 6;
 241
 242     for (;;) {
 243         if (15 == bitrate_idx)
 244             return -1;
 245
 246         mask = (bitrate_idx << 4) <<  8;
 247         header |= mask;
 248         ff_mpegaudio_decode_header(&c, header);
 249         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 250         needed = 4              // header
 251                + xing_offset
 252                + 4              // xing tag
 253                + 4              // frames/size/toc flags
 254                + 4              // frames
 255                + 4              // size
 256                + VBR_TOC_SIZE;  // toc
 257
 258         if (needed <= c.frame_size)
 259             break;
 260
 261         header &= ~mask;
 262         ++bitrate_idx;
 263     }
 264
 265     avio_wb32(s->pb, header);
 266     ffio_fill(s->pb, 0, xing_offset);
 267     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
 268     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
 269
 270     mp3->frames_offset = avio_tell(s->pb);
 271     mp3->size = c.frame_size;
 272     mp3->want=1;
 273     mp3->seen=0;
 274     mp3->pos=0;
 275
 276     avio_wb32(s->pb, 0);  // frames
 277     avio_wb32(s->pb, 0);  // size
 278
 279     // toc
 280     for (i = 0; i < VBR_TOC_SIZE; ++i)
 281         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
 282
 283     ffio_fill(s->pb, 0, c.frame_size - needed);
 284     avio_flush(s->pb);
 285
 286     return 0;
 287 }
 288
 289 /*
 290  * Add a frame to XING data.
 291  * Following lame's "VbrTag.c".
 292  */
 293 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
 294 {
 295     MP3Context  *mp3 = s->priv_data;
 296     int i;
 297
 298     ++mp3->frames;
 299     mp3->size += pkt->size;
 300
 301     if (mp3->want == ++mp3->seen) {
 302         mp3->bag[mp3->pos] = mp3->size;
 303
 304         if (VBR_NUM_BAGS == ++mp3->pos) {
 305             /* shrink table to half size by throwing away each second bag. */
 306             for (i = 1; i < VBR_NUM_BAGS; i += 2)
 307                 mp3->bag[i >> 1] = mp3->bag[i];
 308
 309             /* double wanted amount per bag. */
 310             mp3->want <<= 1;
 311             /* adjust current position to half of table size. */
 312             mp3->pos >>= 1;
 313         }
 314
 315         mp3->seen = 0;
 316     }
 317 }
 318
 319 static void mp3_fix_xing(AVFormatContext *s)
 320 {
 321     MP3Context  *mp3 = s->priv_data;
 322     int i;
 323
 324     avio_flush(s->pb);
 325     avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
 326     avio_wb32(s->pb, mp3->frames);
 327     avio_wb32(s->pb, mp3->size);
 328
 329     avio_w8(s->pb, 0);  // first toc entry has to be zero.
 330
 331     for (i = 1; i < VBR_TOC_SIZE; ++i) {
 332         int j = i * mp3->pos / VBR_TOC_SIZE;
 333         int seek_point = 256LL * mp3->bag[j] / mp3->size;
 334         avio_w8(s->pb, FFMIN(seek_point, 255));
 335     }
 336
 337     avio_flush(s->pb);
 338     avio_seek(s->pb, 0, SEEK_END);
 339 }
 340
 341 /**
 342  * Write an ID3v2 header at beginning of stream
 343  */
 344
 345 static int mp3_write_header(struct AVFormatContext *s)
 346 {
 347     MP3Context  *mp3 = s->priv_data;
 348     AVMetadataTag *t = NULL;
 349     int totlen = 0, enc = mp3->id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
 350                                                     ID3v2_ENCODING_UTF8;
 351     int64_t size_pos, cur_pos;
 352
 353     avio_wb32(s->pb, MKBETAG('I', 'D', '3', mp3->id3v2_version));
 354     avio_w8(s->pb, 0);
 355     avio_w8(s->pb, 0); /* flags */
 356
 357     /* reserve space for size */
 358     size_pos = avio_tell(s->pb);
 359     avio_wb32(s->pb, 0);
 360
 361     ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
 362     if (mp3->id3v2_version == 4)
 363         ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
 364
 365     while ((t = av_metadata_get(s->metadata, "", t, AV_METADATA_IGNORE_SUFFIX))) {
 366         int ret;
 367
 368         if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
 369             totlen += ret;
 370             continue;
 371         }
 372         if ((ret = id3v2_check_write_tag(s, t, mp3->id3v2_version == 3 ?
 373                                                ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
 374             totlen += ret;
 375             continue;
 376         }
 377
 378         /* unknown tag, write as TXXX frame */
 379         if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
 380             return ret;
 381         totlen += ret;
 382     }
 383
 384     cur_pos = avio_tell(s->pb);
 385     avio_seek(s->pb, size_pos, SEEK_SET);
 386     id3v2_put_size(s, totlen);
 387     avio_seek(s->pb, cur_pos, SEEK_SET);
 388
 389     if (s->pb->seekable)
 390         mp3_write_xing(s);
 391
 392     return 0;
 393 }
 394
 395 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
 396 {
 397     if (! pkt || ! pkt->data || pkt->size < 4)
 398         return ff_raw_write_packet(s, pkt);
 399     else {
 400         MP3Context  *mp3 = s->priv_data;
 401 #ifdef FILTER_VBR_HEADERS
 402         MPADecodeHeader c;
 403         int base;
 404
 405         ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
 406
 407         /* filter out XING and INFO headers. */
 408         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
 409
 410         if (base + 4 <= pkt->size) {
 411             uint32_t v = AV_RB32(pkt->data + base);
 412
 413             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
 414                 return 0;
 415         }
 416
 417         /* filter out VBRI headers. */
 418         base = 4 + 32;
 419
 420         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
 421             return 0;
 422 #endif
 423
 424         if (mp3->frames_offset)
 425             mp3_xing_add_frame(s, pkt);
 426
 427         return ff_raw_write_packet(s, pkt);
 428     }
 429 }
 430
 431 static int mp3_write_trailer(AVFormatContext *s)
 432 {
 433     MP3Context  *mp3 = s->priv_data;
 434     int ret=mp2_write_trailer(s);
 435
 436     if (ret < 0)
 437         return ret;
 438
 439     if (mp3->frames_offset)
 440         mp3_fix_xing(s);
 441
 442     return 0;
 443 }
 444
 445 AVOutputFormat ff_mp3_muxer = {
 446     "mp3",
 447     NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
 448     "audio/x-mpeg",
 449     "mp3",
 450     sizeof(MP3Context),
 451     CODEC_ID_MP3,
 452     CODEC_ID_NONE,
 453     mp3_write_header,
 454     mp3_write_packet,
 455     mp3_write_trailer,
 456     AVFMT_NOTIMESTAMPS,
 457     .priv_class = &mp3_muxer_class,
 458 };
 459 #endif