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