yading@11: /*
yading@11:  * ID3v2 header writer
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: #include <stdint.h>
yading@11: #include <string.h>
yading@11: 
yading@11: #include "libavutil/avstring.h"
yading@11: #include "libavutil/dict.h"
yading@11: #include "libavutil/intreadwrite.h"
yading@11: #include "avformat.h"
yading@11: #include "avio.h"
yading@11: #include "id3v2.h"
yading@11: 
yading@11: static void id3v2_put_size(AVIOContext *pb, int size)
yading@11: {
yading@11:     avio_w8(pb, size >> 21 & 0x7f);
yading@11:     avio_w8(pb, size >> 14 & 0x7f);
yading@11:     avio_w8(pb, size >> 7  & 0x7f);
yading@11:     avio_w8(pb, size       & 0x7f);
yading@11: }
yading@11: 
yading@11: static int string_is_ascii(const uint8_t *str)
yading@11: {
yading@11:     while (*str && *str < 128) str++;
yading@11:     return !*str;
yading@11: }
yading@11: 
yading@11: static void id3v2_encode_string(AVIOContext *pb, const uint8_t *str,
yading@11:                                enum ID3v2Encoding enc)
yading@11: {
yading@11:     int (*put)(AVIOContext*, const char*);
yading@11: 
yading@11:     if (enc == ID3v2_ENCODING_UTF16BOM) {
yading@11:         avio_wl16(pb, 0xFEFF);      /* BOM */
yading@11:         put = avio_put_str16le;
yading@11:     } else
yading@11:         put = avio_put_str;
yading@11: 
yading@11:     put(pb, str);
yading@11: }
yading@11: 
yading@11: /**
yading@11:  * Write a text frame with one (normal frames) or two (TXXX frames) strings
yading@11:  * according to encoding (only UTF-8 or UTF-16+BOM supported).
yading@11:  * @return number of bytes written or a negative error code.
yading@11:  */
yading@11: static int id3v2_put_ttag(ID3v2EncContext *id3, AVIOContext *avioc, const char *str1, const char *str2,
yading@11:                           uint32_t tag, enum ID3v2Encoding enc)
yading@11: {
yading@11:     int len;
yading@11:     uint8_t *pb;
yading@11:     AVIOContext *dyn_buf;
yading@11:     if (avio_open_dyn_buf(&dyn_buf) < 0)
yading@11:         return AVERROR(ENOMEM);
yading@11: 
yading@11:     /* check if the strings are ASCII-only and use UTF16 only if
yading@11:      * they're not */
yading@11:     if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
yading@11:         (!str2 || string_is_ascii(str2)))
yading@11:         enc = ID3v2_ENCODING_ISO8859;
yading@11: 
yading@11:     avio_w8(dyn_buf, enc);
yading@11:     id3v2_encode_string(dyn_buf, str1, enc);
yading@11:     if (str2)
yading@11:         id3v2_encode_string(dyn_buf, str2, enc);
yading@11:     len = avio_close_dyn_buf(dyn_buf, &pb);
yading@11: 
yading@11:     avio_wb32(avioc, tag);
yading@11:     /* ID3v2.3 frame size is not synchsafe */
yading@11:     if (id3->version == 3)
yading@11:         avio_wb32(avioc, len);
yading@11:     else
yading@11:         id3v2_put_size(avioc, len);
yading@11:     avio_wb16(avioc, 0);
yading@11:     avio_write(avioc, pb, len);
yading@11: 
yading@11:     av_freep(&pb);
yading@11:     return len + ID3v2_HEADER_SIZE;
yading@11: }
yading@11: 
yading@11: static int id3v2_check_write_tag(ID3v2EncContext *id3, AVIOContext *pb, AVDictionaryEntry *t,
yading@11:                                  const char table[][4], enum ID3v2Encoding enc)
yading@11: {
yading@11:     uint32_t tag;
yading@11:     int i;
yading@11: 
yading@11:     if (t->key[0] != 'T' || strlen(t->key) != 4)
yading@11:         return -1;
yading@11:     tag = AV_RB32(t->key);
yading@11:     for (i = 0; *table[i]; i++)
yading@11:         if (tag == AV_RB32(table[i]))
yading@11:             return id3v2_put_ttag(id3, pb, t->value, NULL, tag, enc);
yading@11:     return -1;
yading@11: }
yading@11: 
yading@11: static void id3v2_3_metadata_split_date(AVDictionary **pm)
yading@11: {
yading@11:     AVDictionaryEntry *mtag = NULL;
yading@11:     AVDictionary *dst = NULL;
yading@11:     const char *key, *value;
yading@11:     char year[5] = {0}, day_month[5] = {0};
yading@11:     int i;
yading@11: 
yading@11:     while ((mtag = av_dict_get(*pm, "", mtag, AV_DICT_IGNORE_SUFFIX))) {
yading@11:         key = mtag->key;
yading@11:         if (!av_strcasecmp(key, "date")) {
yading@11:             /* split date tag using "YYYY-MM-DD" format into year and month/day segments */
yading@11:             value = mtag->value;
yading@11:             i = 0;
yading@11:             while (value[i] >= '0' && value[i] <= '9') i++;
yading@11:             if (value[i] == '\0' || value[i] == '-') {
yading@11:                 av_strlcpy(year, value, sizeof(year));
yading@11:                 av_dict_set(&dst, "TYER", year, 0);
yading@11: 
yading@11:                 if (value[i] == '-' &&
yading@11:                     value[i+1] >= '0' && value[i+1] <= '1' &&
yading@11:                     value[i+2] >= '0' && value[i+2] <= '9' &&
yading@11:                     value[i+3] == '-' &&
yading@11:                     value[i+4] >= '0' && value[i+4] <= '3' &&
yading@11:                     value[i+5] >= '0' && value[i+5] <= '9' &&
yading@11:                     (value[i+6] == '\0' || value[i+6] == ' ')) {
yading@11:                     snprintf(day_month, sizeof(day_month), "%.2s%.2s", value + i + 4, value + i + 1);
yading@11:                     av_dict_set(&dst, "TDAT", day_month, 0);
yading@11:                 }
yading@11:             } else
yading@11:                 av_dict_set(&dst, key, value, 0);
yading@11:         } else
yading@11:             av_dict_set(&dst, key, mtag->value, 0);
yading@11:     }
yading@11:     av_dict_free(pm);
yading@11:     *pm = dst;
yading@11: }
yading@11: 
yading@11: void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
yading@11:                     const char *magic)
yading@11: {
yading@11:     id3->version = id3v2_version;
yading@11: 
yading@11:     avio_wb32(pb, MKBETAG(magic[0], magic[1], magic[2], id3v2_version));
yading@11:     avio_w8(pb, 0);
yading@11:     avio_w8(pb, 0); /* flags */
yading@11: 
yading@11:     /* reserve space for size */
yading@11:     id3->size_pos = avio_tell(pb);
yading@11:     avio_wb32(pb, 0);
yading@11: }
yading@11: 
yading@11: int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3)
yading@11: {
yading@11:     AVDictionaryEntry *t = NULL;
yading@11:     int enc = id3->version == 3 ? ID3v2_ENCODING_UTF16BOM :
yading@11:                                   ID3v2_ENCODING_UTF8;
yading@11: 
yading@11:     ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
yading@11:     if (id3->version == 3)
yading@11:         id3v2_3_metadata_split_date(&s->metadata);
yading@11:     else if (id3->version == 4)
yading@11:         ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
yading@11: 
yading@11:     while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
yading@11:         int ret;
yading@11: 
yading@11:         if ((ret = id3v2_check_write_tag(id3, s->pb, t, ff_id3v2_tags, enc)) > 0) {
yading@11:             id3->len += ret;
yading@11:             continue;
yading@11:         }
yading@11:         if ((ret = id3v2_check_write_tag(id3, s->pb, t, id3->version == 3 ?
yading@11:                                                ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
yading@11:             id3->len += ret;
yading@11:             continue;
yading@11:         }
yading@11: 
yading@11:         /* unknown tag, write as TXXX frame */
yading@11:         if ((ret = id3v2_put_ttag(id3, s->pb, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
yading@11:             return ret;
yading@11:         id3->len += ret;
yading@11:     }
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt)
yading@11: {
yading@11:     AVStream *st = s->streams[pkt->stream_index];
yading@11:     AVDictionaryEntry *e;
yading@11: 
yading@11:     AVIOContext *dyn_buf;
yading@11:     uint8_t     *buf;
yading@11:     const CodecMime *mime = ff_id3v2_mime_tags;
yading@11:     const char  *mimetype = NULL, *desc = "";
yading@11:     int enc = id3->version == 3 ? ID3v2_ENCODING_UTF16BOM :
yading@11:                                   ID3v2_ENCODING_UTF8;
yading@11:     int i, len, type = 0;
yading@11: 
yading@11:     /* get the mimetype*/
yading@11:     while (mime->id != AV_CODEC_ID_NONE) {
yading@11:         if (mime->id == st->codec->codec_id) {
yading@11:             mimetype = mime->str;
yading@11:             break;
yading@11:         }
yading@11:         mime++;
yading@11:     }
yading@11:     if (!mimetype) {
yading@11:         av_log(s, AV_LOG_ERROR, "No mimetype is known for stream %d, cannot "
yading@11:                "write an attached picture.\n", st->index);
yading@11:         return AVERROR(EINVAL);
yading@11:     }
yading@11: 
yading@11:     /* get the picture type */
yading@11:     e = av_dict_get(st->metadata, "comment", NULL, 0);
yading@11:     for (i = 0; e && i < FF_ARRAY_ELEMS(ff_id3v2_picture_types); i++) {
yading@11:         if (strstr(ff_id3v2_picture_types[i], e->value) == ff_id3v2_picture_types[i]) {
yading@11:             type = i;
yading@11:             break;
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     /* get the description */
yading@11:     if ((e = av_dict_get(st->metadata, "title", NULL, 0)))
yading@11:         desc = e->value;
yading@11: 
yading@11:     /* start writing */
yading@11:     if (avio_open_dyn_buf(&dyn_buf) < 0)
yading@11:         return AVERROR(ENOMEM);
yading@11: 
yading@11:     avio_w8(dyn_buf, enc);
yading@11:     avio_put_str(dyn_buf, mimetype);
yading@11:     avio_w8(dyn_buf, type);
yading@11:     id3v2_encode_string(dyn_buf, desc, enc);
yading@11:     avio_write(dyn_buf, pkt->data, pkt->size);
yading@11:     len = avio_close_dyn_buf(dyn_buf, &buf);
yading@11: 
yading@11:     avio_wb32(s->pb, MKBETAG('A', 'P', 'I', 'C'));
yading@11:     if (id3->version == 3)
yading@11:         avio_wb32(s->pb, len);
yading@11:     else
yading@11:         id3v2_put_size(s->pb, len);
yading@11:     avio_wb16(s->pb, 0);
yading@11:     avio_write(s->pb, buf, len);
yading@11:     av_freep(&buf);
yading@11: 
yading@11:     id3->len += len + ID3v2_HEADER_SIZE;
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb)
yading@11: {
yading@11:     int64_t cur_pos = avio_tell(pb);
yading@11:     avio_seek(pb, id3->size_pos, SEEK_SET);
yading@11:     id3v2_put_size(pb, id3->len);
yading@11:     avio_seek(pb, cur_pos, SEEK_SET);
yading@11: }
yading@11: 
yading@11: int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version,
yading@11:                           const char *magic)
yading@11: {
yading@11:     ID3v2EncContext id3 = { 0 };
yading@11:     int ret;
yading@11: 
yading@11:     ff_id3v2_start(&id3, s->pb, id3v2_version, magic);
yading@11:     if ((ret = ff_id3v2_write_metadata(s, &id3)) < 0)
yading@11:         return ret;
yading@11:     ff_id3v2_finish(&id3, s->pb);
yading@11: 
yading@11:     return 0;
yading@11: }