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

   1 /*
   2  * ID3v2 header writer
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <stdint.h>
  22 #include "libavutil/avstring.h"
  23 #include "libavutil/dict.h"
  24 #include "libavutil/intreadwrite.h"
  25 #include "avformat.h"
  26 #include "avio.h"
  27 #include "id3v2.h"
  28
  29 static void id3v2_put_size(AVFormatContext *s, int size)
  30 {
  31     avio_w8(s->pb, size >> 21 & 0x7f);
  32     avio_w8(s->pb, size >> 14 & 0x7f);
  33     avio_w8(s->pb, size >> 7  & 0x7f);
  34     avio_w8(s->pb, size       & 0x7f);
  35 }
  36
  37 static int string_is_ascii(const uint8_t *str)
  38 {
  39     while (*str && *str < 128) str++;
  40     return !*str;
  41 }
  42
  43 /**
  44  * Write a text frame with one (normal frames) or two (TXXX frames) strings
  45  * according to encoding (only UTF-8 or UTF-16+BOM supported).
  46  * @return number of bytes written or a negative error code.
  47  */
  48 static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2,
  49                           uint32_t tag, enum ID3v2Encoding enc)
  50 {
  51     int len;
  52     uint8_t *pb;
  53     int (*put)(AVIOContext*, const char*);
  54     AVIOContext *dyn_buf;
  55     if (avio_open_dyn_buf(&dyn_buf) < 0)
  56         return AVERROR(ENOMEM);
  57
  58     /* check if the strings are ASCII-only and use UTF16 only if
  59      * they're not */
  60     if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
  61         (!str2 || string_is_ascii(str2)))
  62         enc = ID3v2_ENCODING_ISO8859;
  63
  64     avio_w8(dyn_buf, enc);
  65     if (enc == ID3v2_ENCODING_UTF16BOM) {
  66         avio_wl16(dyn_buf, 0xFEFF);      /* BOM */
  67         put = avio_put_str16le;
  68     } else
  69         put = avio_put_str;
  70
  71     put(dyn_buf, str1);
  72     if (str2)
  73         put(dyn_buf, str2);
  74     len = avio_close_dyn_buf(dyn_buf, &pb);
  75
  76     avio_wb32(s->pb, tag);
  77     id3v2_put_size(s, len);
  78     avio_wb16(s->pb, 0);
  79     avio_write(s->pb, pb, len);
  80
  81     av_freep(&pb);
  82     return len + ID3v2_HEADER_SIZE;
  83 }
  84
  85 static int id3v2_check_write_tag(AVFormatContext *s, AVDictionaryEntry *t, const char table[][4],
  86                                  enum ID3v2Encoding enc)
  87 {
  88     uint32_t tag;
  89     int i;
  90
  91     if (t->key[0] != 'T' || strlen(t->key) != 4)
  92         return -1;
  93     tag = AV_RB32(t->key);
  94     for (i = 0; *table[i]; i++)
  95         if (tag == AV_RB32(table[i]))
  96             return id3v2_put_ttag(s, t->value, NULL, tag, enc);
  97     return -1;
  98 }
  99
 100 static void id3v2_3_metadata_split_date(AVDictionary **pm)
 101 {
 102     AVDictionaryEntry *mtag = NULL;
 103     AVDictionary *dst = NULL;
 104     const char *key, *value;
 105     char year[5] = {0}, day_month[5] = {0};
 106     int i;
 107
 108     while ((mtag = av_dict_get(*pm, "", mtag, AV_DICT_IGNORE_SUFFIX))) {
 109         key = mtag->key;
 110         if (!av_strcasecmp(key, "date")) {
 111             /* split date tag using "YYYY-MM-DD" format into year and month/day segments */
 112             value = mtag->value;
 113             i = 0;
 114             while (value[i] >= '0' && value[i] <= '9') i++;
 115             if (value[i] == '\0' || value[i] == '-') {
 116                 av_strlcpy(year, value, sizeof(year));
 117                 av_dict_set(&dst, "TYER", year, 0);
 118
 119                 if (value[i] == '-' &&
 120                     value[i+1] >= '0' && value[i+1] <= '1' &&
 121                     value[i+2] >= '0' && value[i+2] <= '9' &&
 122                     value[i+3] == '-' &&
 123                     value[i+4] >= '0' && value[i+4] <= '3' &&
 124                     value[i+5] >= '0' && value[i+5] <= '9' &&
 125                     (value[i+6] == '\0' || value[i+6] == ' ')) {
 126                     snprintf(day_month, sizeof(day_month), "%.2s%.2s", value + i + 4, value + i + 1);
 127                     av_dict_set(&dst, "TDAT", day_month, 0);
 128                 }
 129             } else
 130                 av_dict_set(&dst, key, value, 0);
 131         } else
 132             av_dict_set(&dst, key, mtag->value, 0);
 133     }
 134     av_dict_free(pm);
 135     *pm = dst;
 136 }
 137
 138 int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version,
 139                    const char *magic)
 140 {
 141     int64_t size_pos, cur_pos;
 142     AVDictionaryEntry *t = NULL;
 143
 144     int totlen = 0, enc = id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
 145                                                ID3v2_ENCODING_UTF8;
 146
 147
 148     avio_wb32(s->pb, MKBETAG(magic[0], magic[1], magic[2], id3v2_version));
 149     avio_w8(s->pb, 0);
 150     avio_w8(s->pb, 0); /* flags */
 151
 152     /* reserve space for size */
 153     size_pos = avio_tell(s->pb);
 154     avio_wb32(s->pb, 0);
 155
 156     ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
 157     if (id3v2_version == 3)
 158         id3v2_3_metadata_split_date(&s->metadata);
 159     else if (id3v2_version == 4)
 160         ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
 161
 162     while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
 163         int ret;
 164
 165         if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
 166             totlen += ret;
 167             continue;
 168         }
 169         if ((ret = id3v2_check_write_tag(s, t, id3v2_version == 3 ?
 170                                                ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
 171             totlen += ret;
 172             continue;
 173         }
 174
 175         /* unknown tag, write as TXXX frame */
 176         if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
 177             return ret;
 178         totlen += ret;
 179     }
 180
 181     cur_pos = avio_tell(s->pb);
 182     avio_seek(s->pb, size_pos, SEEK_SET);
 183     id3v2_put_size(s, totlen);
 184     avio_seek(s->pb, cur_pos, SEEK_SET);
 185     return 0;
 186 }