LCOV - code coverage report
Current view: top level - libavformat - id3v2enc.c (source / functions) Hit Total Coverage
Test: coverage.info Lines: 67 220 30.5 %
Date: 2018-05-20 11:54:08 Functions: 8 14 57.1 %

          Line data    Source code
       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 <string.h>
      23             : 
      24             : #include "libavutil/avstring.h"
      25             : #include "libavutil/dict.h"
      26             : #include "libavutil/intreadwrite.h"
      27             : #include "avformat.h"
      28             : #include "avio.h"
      29             : #include "avio_internal.h"
      30             : #include "id3v2.h"
      31             : 
      32           2 : static void id3v2_put_size(AVIOContext *pb, int size)
      33             : {
      34           2 :     avio_w8(pb, size >> 21 & 0x7f);
      35           2 :     avio_w8(pb, size >> 14 & 0x7f);
      36           2 :     avio_w8(pb, size >> 7  & 0x7f);
      37           2 :     avio_w8(pb, size       & 0x7f);
      38           2 : }
      39             : 
      40           0 : static int string_is_ascii(const uint8_t *str)
      41             : {
      42           0 :     while (*str && *str < 128) str++;
      43           0 :     return !*str;
      44             : }
      45             : 
      46           1 : static void id3v2_encode_string(AVIOContext *pb, const uint8_t *str,
      47             :                                enum ID3v2Encoding enc)
      48             : {
      49             :     int (*put)(AVIOContext*, const char*);
      50             : 
      51           1 :     if (enc == ID3v2_ENCODING_UTF16BOM) {
      52           0 :         avio_wl16(pb, 0xFEFF);      /* BOM */
      53           0 :         put = avio_put_str16le;
      54             :     } else
      55           1 :         put = avio_put_str;
      56             : 
      57           1 :     put(pb, str);
      58           1 : }
      59             : 
      60             : /**
      61             :  * Write a text frame with one (normal frames) or two (TXXX frames) strings
      62             :  * according to encoding (only UTF-8 or UTF-16+BOM supported).
      63             :  * @return number of bytes written or a negative error code.
      64             :  */
      65           1 : static int id3v2_put_ttag(ID3v2EncContext *id3, AVIOContext *avioc, const char *str1, const char *str2,
      66             :                           uint32_t tag, enum ID3v2Encoding enc)
      67             : {
      68             :     int len;
      69             :     uint8_t *pb;
      70             :     AVIOContext *dyn_buf;
      71           1 :     if (avio_open_dyn_buf(&dyn_buf) < 0)
      72           0 :         return AVERROR(ENOMEM);
      73             : 
      74             :     /* check if the strings are ASCII-only and use UTF16 only if
      75             :      * they're not */
      76           1 :     if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
      77           0 :         (!str2 || string_is_ascii(str2)))
      78           0 :         enc = ID3v2_ENCODING_ISO8859;
      79             : 
      80           1 :     avio_w8(dyn_buf, enc);
      81           1 :     id3v2_encode_string(dyn_buf, str1, enc);
      82           1 :     if (str2)
      83           0 :         id3v2_encode_string(dyn_buf, str2, enc);
      84           1 :     len = avio_close_dyn_buf(dyn_buf, &pb);
      85             : 
      86           1 :     avio_wb32(avioc, tag);
      87             :     /* ID3v2.3 frame size is not sync-safe */
      88           1 :     if (id3->version == 3)
      89           0 :         avio_wb32(avioc, len);
      90             :     else
      91           1 :         id3v2_put_size(avioc, len);
      92           1 :     avio_wb16(avioc, 0);
      93           1 :     avio_write(avioc, pb, len);
      94             : 
      95           1 :     av_freep(&pb);
      96           1 :     return len + ID3v2_HEADER_SIZE;
      97             : }
      98             : 
      99             : /**
     100             :  * Write a priv frame with owner and data. 'key' is the owner prepended with
     101             :  * ID3v2_PRIV_METADATA_PREFIX. 'data' is provided as a string. Any \xXX
     102             :  * (where 'X' is a valid hex digit) will be unescaped to the byte value.
     103             :  */
     104           0 : static int id3v2_put_priv(ID3v2EncContext *id3, AVIOContext *avioc, const char *key, const char *data)
     105             : {
     106             :     int len;
     107             :     uint8_t *pb;
     108             :     AVIOContext *dyn_buf;
     109             : 
     110           0 :     if (!av_strstart(key, ID3v2_PRIV_METADATA_PREFIX, &key)) {
     111           0 :         return 0;
     112             :     }
     113             : 
     114           0 :     if (avio_open_dyn_buf(&dyn_buf) < 0)
     115           0 :         return AVERROR(ENOMEM);
     116             : 
     117             :     // owner + null byte.
     118           0 :     avio_write(dyn_buf, key, strlen(key) + 1);
     119             : 
     120           0 :     while (*data) {
     121           0 :         if (av_strstart(data, "\\x", &data)) {
     122           0 :             if (data[0] && data[1] && av_isxdigit(data[0]) && av_isxdigit(data[1])) {
     123           0 :                 char digits[] = {data[0], data[1], 0};
     124           0 :                 avio_w8(dyn_buf, strtol(digits, NULL, 16));
     125           0 :                 data += 2;
     126             :             } else {
     127           0 :                 ffio_free_dyn_buf(&dyn_buf);
     128           0 :                 av_log(avioc, AV_LOG_ERROR, "Invalid escape '\\x%.2s' in metadata tag '"
     129             :                        ID3v2_PRIV_METADATA_PREFIX "%s'.\n", data, key);
     130           0 :                 return AVERROR(EINVAL);
     131             :             }
     132             :         } else {
     133           0 :             avio_write(dyn_buf, data++, 1);
     134             :         }
     135             :     }
     136             : 
     137           0 :     len = avio_close_dyn_buf(dyn_buf, &pb);
     138             : 
     139           0 :     avio_wb32(avioc, MKBETAG('P', 'R', 'I', 'V'));
     140           0 :     if (id3->version == 3)
     141           0 :         avio_wb32(avioc, len);
     142             :     else
     143           0 :         id3v2_put_size(avioc, len);
     144           0 :     avio_wb16(avioc, 0);
     145           0 :     avio_write(avioc, pb, len);
     146             : 
     147           0 :     av_free(pb);
     148             : 
     149           0 :     return len + ID3v2_HEADER_SIZE;
     150             : }
     151             : 
     152           1 : static int id3v2_check_write_tag(ID3v2EncContext *id3, AVIOContext *pb, AVDictionaryEntry *t,
     153             :                                  const char table[][4], enum ID3v2Encoding enc)
     154             : {
     155             :     uint32_t tag;
     156             :     int i;
     157             : 
     158           1 :     if (t->key[0] != 'T' || strlen(t->key) != 4)
     159           0 :         return -1;
     160           1 :     tag = AV_RB32(t->key);
     161          11 :     for (i = 0; *table[i]; i++)
     162          11 :         if (tag == AV_RB32(table[i]))
     163           1 :             return id3v2_put_ttag(id3, pb, t->value, NULL, tag, enc);
     164           0 :     return -1;
     165             : }
     166             : 
     167           0 : static void id3v2_3_metadata_split_date(AVDictionary **pm)
     168             : {
     169           0 :     AVDictionaryEntry *mtag = NULL;
     170           0 :     AVDictionary *dst = NULL;
     171             :     const char *key, *value;
     172           0 :     char year[5] = {0}, day_month[5] = {0};
     173             :     int i;
     174             : 
     175           0 :     while ((mtag = av_dict_get(*pm, "", mtag, AV_DICT_IGNORE_SUFFIX))) {
     176           0 :         key = mtag->key;
     177           0 :         if (!av_strcasecmp(key, "date")) {
     178             :             /* split date tag using "YYYY-MM-DD" format into year and month/day segments */
     179           0 :             value = mtag->value;
     180           0 :             i = 0;
     181           0 :             while (value[i] >= '0' && value[i] <= '9') i++;
     182           0 :             if (value[i] == '\0' || value[i] == '-') {
     183           0 :                 av_strlcpy(year, value, sizeof(year));
     184           0 :                 av_dict_set(&dst, "TYER", year, 0);
     185             : 
     186           0 :                 if (value[i] == '-' &&
     187           0 :                     value[i+1] >= '0' && value[i+1] <= '1' &&
     188           0 :                     value[i+2] >= '0' && value[i+2] <= '9' &&
     189           0 :                     value[i+3] == '-' &&
     190           0 :                     value[i+4] >= '0' && value[i+4] <= '3' &&
     191           0 :                     value[i+5] >= '0' && value[i+5] <= '9' &&
     192           0 :                     (value[i+6] == '\0' || value[i+6] == ' ')) {
     193           0 :                     snprintf(day_month, sizeof(day_month), "%.2s%.2s", value + i + 4, value + i + 1);
     194           0 :                     av_dict_set(&dst, "TDAT", day_month, 0);
     195             :                 }
     196             :             } else
     197           0 :                 av_dict_set(&dst, key, value, 0);
     198             :         } else
     199           0 :             av_dict_set(&dst, key, mtag->value, 0);
     200             :     }
     201           0 :     av_dict_free(pm);
     202           0 :     *pm = dst;
     203           0 : }
     204             : 
     205           1 : void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
     206             :                     const char *magic)
     207             : {
     208           1 :     id3->version = id3v2_version;
     209             : 
     210           1 :     avio_wb32(pb, MKBETAG(magic[0], magic[1], magic[2], id3v2_version));
     211           1 :     avio_w8(pb, 0);
     212           1 :     avio_w8(pb, 0); /* flags */
     213             : 
     214             :     /* reserve space for size */
     215           1 :     id3->size_pos = avio_tell(pb);
     216           1 :     avio_wb32(pb, 0);
     217           1 : }
     218             : 
     219           1 : static int write_metadata(AVIOContext *pb, AVDictionary **metadata,
     220             :                           ID3v2EncContext *id3, int enc)
     221             : {
     222           1 :     AVDictionaryEntry *t = NULL;
     223             :     int ret;
     224             : 
     225           1 :     ff_metadata_conv(metadata, ff_id3v2_34_metadata_conv, NULL);
     226           1 :     if (id3->version == 3)
     227           0 :         id3v2_3_metadata_split_date(metadata);
     228           1 :     else if (id3->version == 4)
     229           1 :         ff_metadata_conv(metadata, ff_id3v2_4_metadata_conv, NULL);
     230             : 
     231           3 :     while ((t = av_dict_get(*metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
     232           1 :         if ((ret = id3v2_check_write_tag(id3, pb, t, ff_id3v2_tags, enc)) > 0) {
     233           1 :             id3->len += ret;
     234           1 :             continue;
     235             :         }
     236           0 :         if ((ret = id3v2_check_write_tag(id3, pb, t, id3->version == 3 ?
     237             :                                          ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
     238           0 :             id3->len += ret;
     239           0 :             continue;
     240             :         }
     241             : 
     242           0 :         if ((ret = id3v2_put_priv(id3, pb, t->key, t->value)) > 0) {
     243           0 :             id3->len += ret;
     244           0 :             continue;
     245           0 :         } else if (ret < 0) {
     246           0 :             return ret;
     247             :         }
     248             : 
     249             :         /* unknown tag, write as TXXX frame */
     250           0 :         if ((ret = id3v2_put_ttag(id3, pb, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
     251           0 :             return ret;
     252           0 :         id3->len += ret;
     253             :     }
     254             : 
     255           1 :     return 0;
     256             : }
     257             : 
     258           0 : static int write_chapter(AVFormatContext *s, ID3v2EncContext *id3, int id, int enc)
     259             : {
     260             :     const AVRational time_base = {1, 1000};
     261           0 :     AVChapter *ch = s->chapters[id];
     262           0 :     uint8_t *dyn_buf = NULL;
     263           0 :     AVIOContext *dyn_bc = NULL;
     264             :     char name[123];
     265             :     int len, start, end, ret;
     266             : 
     267           0 :     if ((ret = avio_open_dyn_buf(&dyn_bc)) < 0)
     268           0 :         goto fail;
     269             : 
     270           0 :     start = av_rescale_q(ch->start, ch->time_base, time_base);
     271           0 :     end   = av_rescale_q(ch->end,   ch->time_base, time_base);
     272             : 
     273           0 :     snprintf(name, 122, "ch%d", id);
     274           0 :     id3->len += avio_put_str(dyn_bc, name);
     275           0 :     avio_wb32(dyn_bc, start);
     276           0 :     avio_wb32(dyn_bc, end);
     277           0 :     avio_wb32(dyn_bc, 0xFFFFFFFFu);
     278           0 :     avio_wb32(dyn_bc, 0xFFFFFFFFu);
     279             : 
     280           0 :     if ((ret = write_metadata(dyn_bc, &ch->metadata, id3, enc)) < 0)
     281           0 :         goto fail;
     282             : 
     283           0 :     len = avio_close_dyn_buf(dyn_bc, &dyn_buf);
     284           0 :     id3->len += 16 + ID3v2_HEADER_SIZE;
     285             : 
     286           0 :     avio_wb32(s->pb, MKBETAG('C', 'H', 'A', 'P'));
     287           0 :     avio_wb32(s->pb, len);
     288           0 :     avio_wb16(s->pb, 0);
     289           0 :     avio_write(s->pb, dyn_buf, len);
     290             : 
     291           0 : fail:
     292           0 :     if (dyn_bc && !dyn_buf)
     293           0 :         avio_close_dyn_buf(dyn_bc, &dyn_buf);
     294           0 :     av_freep(&dyn_buf);
     295             : 
     296           0 :     return ret;
     297             : }
     298             : 
     299           1 : int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3)
     300             : {
     301           1 :     int enc = id3->version == 3 ? ID3v2_ENCODING_UTF16BOM :
     302             :                                   ID3v2_ENCODING_UTF8;
     303             :     int i, ret;
     304             : 
     305           1 :     ff_standardize_creation_time(s);
     306           1 :     if ((ret = write_metadata(s->pb, &s->metadata, id3, enc)) < 0)
     307           0 :         return ret;
     308             : 
     309           1 :     for (i = 0; i < s->nb_chapters; i++) {
     310           0 :         if ((ret = write_chapter(s, id3, i, enc)) < 0)
     311           0 :             return ret;
     312             :     }
     313             : 
     314           1 :     return 0;
     315             : }
     316             : 
     317           0 : int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt)
     318             : {
     319           0 :     AVStream *st = s->streams[pkt->stream_index];
     320             :     AVDictionaryEntry *e;
     321             : 
     322             :     AVIOContext *dyn_buf;
     323             :     uint8_t     *buf;
     324           0 :     const CodecMime *mime = ff_id3v2_mime_tags;
     325           0 :     const char  *mimetype = NULL, *desc = "";
     326           0 :     int enc = id3->version == 3 ? ID3v2_ENCODING_UTF16BOM :
     327             :                                   ID3v2_ENCODING_UTF8;
     328           0 :     int i, len, type = 0;
     329             : 
     330             :     /* get the mimetype*/
     331           0 :     while (mime->id != AV_CODEC_ID_NONE) {
     332           0 :         if (mime->id == st->codecpar->codec_id) {
     333           0 :             mimetype = mime->str;
     334           0 :             break;
     335             :         }
     336           0 :         mime++;
     337             :     }
     338           0 :     if (!mimetype) {
     339           0 :         av_log(s, AV_LOG_ERROR, "No mimetype is known for stream %d, cannot "
     340             :                "write an attached picture.\n", st->index);
     341           0 :         return AVERROR(EINVAL);
     342             :     }
     343             : 
     344             :     /* get the picture type */
     345           0 :     e = av_dict_get(st->metadata, "comment", NULL, 0);
     346           0 :     for (i = 0; e && i < FF_ARRAY_ELEMS(ff_id3v2_picture_types); i++) {
     347           0 :         if (!av_strcasecmp(e->value, ff_id3v2_picture_types[i])) {
     348           0 :             type = i;
     349           0 :             break;
     350             :         }
     351             :     }
     352             : 
     353             :     /* get the description */
     354           0 :     if ((e = av_dict_get(st->metadata, "title", NULL, 0)))
     355           0 :         desc = e->value;
     356             : 
     357             :     /* use UTF16 only for non-ASCII strings */
     358           0 :     if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(desc))
     359           0 :         enc = ID3v2_ENCODING_ISO8859;
     360             : 
     361             :     /* start writing */
     362           0 :     if (avio_open_dyn_buf(&dyn_buf) < 0)
     363           0 :         return AVERROR(ENOMEM);
     364             : 
     365           0 :     avio_w8(dyn_buf, enc);
     366           0 :     avio_put_str(dyn_buf, mimetype);
     367           0 :     avio_w8(dyn_buf, type);
     368           0 :     id3v2_encode_string(dyn_buf, desc, enc);
     369           0 :     avio_write(dyn_buf, pkt->data, pkt->size);
     370           0 :     len = avio_close_dyn_buf(dyn_buf, &buf);
     371             : 
     372           0 :     avio_wb32(s->pb, MKBETAG('A', 'P', 'I', 'C'));
     373           0 :     if (id3->version == 3)
     374           0 :         avio_wb32(s->pb, len);
     375             :     else
     376           0 :         id3v2_put_size(s->pb, len);
     377           0 :     avio_wb16(s->pb, 0);
     378           0 :     avio_write(s->pb, buf, len);
     379           0 :     av_freep(&buf);
     380             : 
     381           0 :     id3->len += len + ID3v2_HEADER_SIZE;
     382             : 
     383           0 :     return 0;
     384             : }
     385             : 
     386           1 : void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb,
     387             :                      int padding_bytes)
     388             : {
     389             :     int64_t cur_pos;
     390             : 
     391           1 :     if (padding_bytes < 0)
     392           1 :         padding_bytes = 10;
     393             : 
     394             :     /* The ID3v2.3 specification states that 28 bits are used to represent the
     395             :      * size of the whole tag.  Therefore the current size of the tag needs to be
     396             :      * subtracted from the upper limit of 2^28-1 to clip the value correctly. */
     397             :     /* The minimum of 10 is an arbitrary amount of padding at the end of the tag
     398             :      * to fix cover art display with some software such as iTunes, Traktor,
     399             :      * Serato, Torq. */
     400           1 :     padding_bytes = av_clip(padding_bytes, 10, 268435455 - id3->len);
     401           1 :     ffio_fill(pb, 0, padding_bytes);
     402           1 :     id3->len += padding_bytes;
     403             : 
     404           1 :     cur_pos = avio_tell(pb);
     405           1 :     avio_seek(pb, id3->size_pos, SEEK_SET);
     406           1 :     id3v2_put_size(pb, id3->len);
     407           1 :     avio_seek(pb, cur_pos, SEEK_SET);
     408           1 : }
     409             : 
     410           0 : int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version,
     411             :                           const char *magic)
     412             : {
     413           0 :     ID3v2EncContext id3 = { 0 };
     414             :     int ret;
     415             : 
     416           0 :     ff_id3v2_start(&id3, s->pb, id3v2_version, magic);
     417           0 :     if ((ret = ff_id3v2_write_metadata(s, &id3)) < 0)
     418           0 :         return ret;
     419           0 :     ff_id3v2_finish(&id3, s->pb, s->metadata_header_padding);
     420             : 
     421           0 :     return 0;
     422             : }

Generated by: LCOV version 1.13