id3v2enc.c
Go to the documentation of this file.
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(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 
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)))
63 
64  avio_w8(dyn_buf, enc);
65  if (enc == ID3v2_ENCODING_UTF16BOM) {
66  avio_wl16(dyn_buf, 0xFEFF); /* BOM */
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 int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version,
101  const char *magic)
102 {
103  int64_t size_pos, cur_pos;
105 
106  int totlen = 0, enc = id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
108 
109 
110  avio_wb32(s->pb, MKBETAG(magic[0], magic[1], magic[2], id3v2_version));
111  avio_w8(s->pb, 0);
112  avio_w8(s->pb, 0); /* flags */
113 
114  /* reserve space for size */
115  size_pos = avio_tell(s->pb);
116  avio_wb32(s->pb, 0);
117 
119  if (id3v2_version == 4)
121 
122  while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
123  int ret;
124 
125  if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
126  totlen += ret;
127  continue;
128  }
129  if ((ret = id3v2_check_write_tag(s, t, id3v2_version == 3 ?
130  ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
131  totlen += ret;
132  continue;
133  }
134 
135  /* unknown tag, write as TXXX frame */
136  if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
137  return ret;
138  totlen += ret;
139  }
140 
141  cur_pos = avio_tell(s->pb);
142  avio_seek(s->pb, size_pos, SEEK_SET);
143  id3v2_put_size(s, totlen);
144  avio_seek(s->pb, cur_pos, SEEK_SET);
145  return 0;
146 }
void avio_wl16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:527
Bytestream IO Context.
Definition: avio.h:68
Buffered I/O operations.
int size
AV_WL32 AV_WL24 AV_WL16 AV_RB32
Definition: bytestream.h:89
int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
Return the written size and a pointer to the buffer.
Definition: aviobuf.c:1196
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:211
const char ff_id3v2_4_tags[][4]
ID3v2.4-only text information frames.
Definition: id3v2.c:78
AVDictionaryEntry * av_dict_get(AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:27
int avio_open_dyn_buf(AVIOContext **s)
Open a write only memory stream.
Definition: aviobuf.c:1184
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:147
Format I/O context.
Definition: avformat.h:863
ID3v2Encoding
Definition: id3v2.h:41
Public dictionary API.
#define ID3v2_HEADER_SIZE
Definition: id3v2.h:29
const AVMetadataConv ff_id3v2_34_metadata_conv[]
Definition: id3v2.c:29
#define put(d, s)
Definition: dsputil_align.c:50
uint32_t tag
Definition: movenc.c:670
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:492
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:190
static float t
void ff_metadata_conv(AVDictionary **pm, const AVMetadataConv *d_conv, const AVMetadataConv *s_conv)
Definition: metadata.c:55
AVDictionary * metadata
Definition: avformat.h:1085
static int id3v2_check_write_tag(AVFormatContext *s, AVDictionaryEntry *t, const char table[][4], enum ID3v2Encoding enc)
Definition: id3v2enc.c:85
const AVMetadataConv ff_id3v2_4_metadata_conv[]
Definition: id3v2.c:47
#define AVERROR(e)
Definition: error.h:43
static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2, uint32_t tag, enum ID3v2Encoding enc)
Write a text frame with one (normal frames) or two (TXXX frames) strings according to encoding (only ...
Definition: id3v2enc.c:48
static int string_is_ascii(const uint8_t *str)
Definition: id3v2enc.c:37
int avio_put_str(AVIOContext *s, const char *str)
Write a NULL-terminated string.
Definition: aviobuf.c:469
const char ff_id3v2_tags[][4]
A list of text information frames allowed in both ID3 v2.3 and v2.4 http://www.id3.org/id3v2.4.0-frames http://www.id3.org/id3v2.4.0-changes.
Definition: id3v2.c:70
NULL
Definition: eval.c:50
AVIOContext * pb
Definition: avformat.h:896
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:169
int avio_put_str16le(AVIOContext *s, const char *str)
Convert an UTF-8 string to UTF-16LE and write it.
Definition: aviobuf.c:480
int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version, const char *magic)
Write an ID3v2 tag.
Definition: id3v2enc.c:100
void avio_wb16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:533
static void id3v2_put_size(AVFormatContext *s, int size)
Definition: id3v2enc.c:29
Main libavformat public API header.
char * key
Definition: dict.h:75
#define MKBETAG(a, b, c, d)
Definition: common.h:232
const char ff_id3v2_3_tags[][4]
ID3v2.3-only text information frames.
Definition: id3v2.c:84
char * value
Definition: dict.h:76
int len
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:324
#define AV_DICT_IGNORE_SUFFIX
Definition: dict.h:62