id3v2enc: fix writing frame sizes for ID3v2.3
[ffmpeg.git] / libavformat / id3v2enc.c
1 /*
2  * ID3v2 header writer
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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
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(AVIOContext *pb, int size)
30 {
31     avio_w8(pb, size >> 21 & 0x7f);
32     avio_w8(pb, size >> 14 & 0x7f);
33     avio_w8(pb, size >> 7  & 0x7f);
34     avio_w8(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(ID3v2EncContext *id3, AVIOContext *avioc, 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(avioc, tag);
77     /* ID3v2.3 frame size is not synchsafe */
78     if (id3->version == 3)
79         avio_wb32(avioc, len);
80     else
81         id3v2_put_size(avioc, len);
82     avio_wb16(avioc, 0);
83     avio_write(avioc, pb, len);
84
85     av_freep(&pb);
86     return len + ID3v2_HEADER_SIZE;
87 }
88
89 static int id3v2_check_write_tag(ID3v2EncContext *id3, AVIOContext *pb, AVDictionaryEntry *t,
90                                  const char table[][4], enum ID3v2Encoding enc)
91 {
92     uint32_t tag;
93     int i;
94
95     if (t->key[0] != 'T' || strlen(t->key) != 4)
96         return -1;
97     tag = AV_RB32(t->key);
98     for (i = 0; *table[i]; i++)
99         if (tag == AV_RB32(table[i]))
100             return id3v2_put_ttag(id3, pb, t->value, NULL, tag, enc);
101     return -1;
102 }
103
104 void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
105                     const char *magic)
106 {
107     id3->version = id3v2_version;
108
109     avio_wb32(pb, MKBETAG(magic[0], magic[1], magic[2], id3v2_version));
110     avio_w8(pb, 0);
111     avio_w8(pb, 0); /* flags */
112
113     /* reserve space for size */
114     id3->size_pos = avio_tell(pb);
115     avio_wb32(pb, 0);
116 }
117
118 int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3)
119 {
120     AVDictionaryEntry *t = NULL;
121     int enc = id3->version == 3 ? ID3v2_ENCODING_UTF16BOM :
122                                   ID3v2_ENCODING_UTF8;
123
124     ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
125     if (id3->version == 4)
126         ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
127
128     while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
129         int ret;
130
131         if ((ret = id3v2_check_write_tag(id3, s->pb, t, ff_id3v2_tags, enc)) > 0) {
132             id3->len += ret;
133             continue;
134         }
135         if ((ret = id3v2_check_write_tag(id3, s->pb, t, id3->version == 3 ?
136                                                ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
137             id3->len += ret;
138             continue;
139         }
140
141         /* unknown tag, write as TXXX frame */
142         if ((ret = id3v2_put_ttag(id3, s->pb, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
143             return ret;
144         id3->len += ret;
145     }
146
147     return 0;
148 }
149
150 void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb)
151 {
152     int64_t cur_pos = avio_tell(pb);
153     avio_seek(pb, id3->size_pos, SEEK_SET);
154     id3v2_put_size(pb, id3->len);
155     avio_seek(pb, cur_pos, SEEK_SET);
156 }
157
158 int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version,
159                           const char *magic)
160 {
161     ID3v2EncContext id3 = { 0 };
162     int ret;
163
164     ff_id3v2_start(&id3, s->pb, id3v2_version, magic);
165     if ((ret = ff_id3v2_write_metadata(s, &id3)) < 0)
166         return ret;
167     ff_id3v2_finish(&id3, s->pb);
168
169     return 0;
170 }