id3v2.h 4.65 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * ID3v2 header parser
 * Copyright (c) 2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef AVFORMAT_ID3V2_H
#define AVFORMAT_ID3V2_H

#include <stdint.h>
26
#include "avformat.h"
27
#include "internal.h"
28
#include "metadata.h"
29 30 31

#define ID3v2_HEADER_SIZE 10

32 33 34 35 36
/**
 * Default magic bytes for ID3v2 header: "ID3"
 */
#define ID3v2_DEFAULT_MAGIC "ID3"

37 38 39 40 41
#define ID3v2_FLAG_DATALEN     0x0001
#define ID3v2_FLAG_UNSYNCH     0x0002
#define ID3v2_FLAG_ENCRYPTION  0x0004
#define ID3v2_FLAG_COMPRESSION 0x0008

42 43 44 45 46 47 48
enum ID3v2Encoding {
    ID3v2_ENCODING_ISO8859  = 0,
    ID3v2_ENCODING_UTF16BOM = 1,
    ID3v2_ENCODING_UTF16BE  = 2,
    ID3v2_ENCODING_UTF8     = 3,
};

49 50 51 52 53 54
typedef struct ID3v2EncContext {
    int      version;       ///< ID3v2 minor version, either 3 or 4
    int64_t size_pos;       ///< offset of the tag total size
    int          len;       ///< size of the tag written so far
} ID3v2EncContext;

55 56 57 58 59 60 61 62 63 64 65 66 67 68
typedef struct ID3v2ExtraMeta {
    const char *tag;
    void *data;
    struct ID3v2ExtraMeta *next;
} ID3v2ExtraMeta;

typedef struct ID3v2ExtraMetaGEOB {
    uint32_t datasize;
    uint8_t *mime_type;
    uint8_t *file_name;
    uint8_t *description;
    uint8_t *data;
} ID3v2ExtraMetaGEOB;

69 70 71 72 73 74 75 76
typedef struct ID3v2ExtraMetaAPIC {
    uint8_t     *data;
    int          len;
    const char  *type;
    uint8_t     *description;
    enum CodecID id;
} ID3v2ExtraMetaAPIC;

77
/**
78
 * Detect ID3v2 Header.
79
 * @param buf   must be ID3v2_HEADER_SIZE byte long
80
 * @param magic magic bytes to identify the header.
81
 * If in doubt, use ID3v2_DEFAULT_MAGIC.
82
 */
83
int ff_id3v2_match(const uint8_t *buf, const char *magic);
84

85
/**
86
 * Get the length of an ID3v2 tag.
87
 * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an
88 89 90 91
 * already detected ID3v2 tag
 */
int ff_id3v2_tag_len(const uint8_t *buf);

92
/**
93
 * Read an ID3v2 tag, including supported extra metadata
94 95
 * @param extra_meta If not NULL, extra metadata is parsed into a list of
 * ID3v2ExtraMeta structs and *extra_meta points to the head of the list
96
 */
97
void ff_id3v2_read(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta);
98

99
/**
100 101 102 103 104 105 106 107 108 109
 * Initialize an ID3v2 tag.
 */
void ff_id3v2_start(ID3v2EncContext *id3, AVIOContext *pb, int id3v2_version,
                    const char *magic);

/**
 * Convert and write all global metadata from s into an ID3v2 tag.
 */
int ff_id3v2_write_metadata(AVFormatContext *s, ID3v2EncContext *id3);

110 111 112 113 114
/**
 * Write an attached picture from pkt into an ID3v2 tag.
 */
int ff_id3v2_write_apic(AVFormatContext *s, ID3v2EncContext *id3, AVPacket *pkt);

115 116
/**
 * Finalize an opened ID3v2 tag.
117
 */
118
void ff_id3v2_finish(ID3v2EncContext *id3, AVIOContext *pb);
119

120
/**
121
 * Write an ID3v2 tag containing all global metadata from s.
122 123 124 125
 * @param id3v2_version Subversion of ID3v2; supported values are 3 and 4
 * @param magic magic bytes to identify the header
 * If in doubt, use ID3v2_DEFAULT_MAGIC.
 */
126
int ff_id3v2_write_simple(struct AVFormatContext *s, int id3v2_version, const char *magic);
127

128 129 130 131 132 133
/**
 * Free memory allocated parsing special (non-text) metadata.
 * @param extra_meta Pointer to a pointer to the head of a ID3v2ExtraMeta list, *extra_meta is set to NULL.
 */
void ff_id3v2_free_extra_meta(ID3v2ExtraMeta **extra_meta);

134 135 136 137 138 139
/**
 * Create a stream for each APIC (attached picture) extracted from the
 * ID3v2 header.
 */
int ff_id3v2_parse_apic(AVFormatContext *s, ID3v2ExtraMeta **extra_meta);

140 141
extern const AVMetadataConv ff_id3v2_34_metadata_conv[];
extern const AVMetadataConv ff_id3v2_4_metadata_conv[];
142

143
/**
144
 * A list of text information frames allowed in both ID3 v2.3 and v2.4
145
 * http://www.id3.org/id3v2.4.0-frames
146
 * http://www.id3.org/id3v2.4.0-changes
147
 */
148
extern const char ff_id3v2_tags[][4];
149

150 151 152 153 154 155 156 157 158 159
/**
 * ID3v2.4-only text information frames.
 */
extern const char ff_id3v2_4_tags[][4];

/**
 * ID3v2.3-only text information frames.
 */
extern const char ff_id3v2_3_tags[][4];

160 161 162 163
extern const CodecMime ff_id3v2_mime_tags[];

extern const char *ff_id3v2_picture_types[21];

164
#endif /* AVFORMAT_ID3V2_H */