| /* |
| * 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> |
| #include "avformat.h" |
| #include "metadata.h" |
| |
| #define ID3v2_HEADER_SIZE 10 |
| |
| /** |
| * Default magic bytes for ID3v2 header: "ID3" |
| */ |
| #define ID3v2_DEFAULT_MAGIC "ID3" |
| |
| #define ID3v2_FLAG_DATALEN 0x0001 |
| #define ID3v2_FLAG_UNSYNCH 0x0002 |
| #define ID3v2_FLAG_ENCRYPTION 0x0004 |
| #define ID3v2_FLAG_COMPRESSION 0x0008 |
| |
| enum ID3v2Encoding { |
| ID3v2_ENCODING_ISO8859 = 0, |
| ID3v2_ENCODING_UTF16BOM = 1, |
| ID3v2_ENCODING_UTF16BE = 2, |
| ID3v2_ENCODING_UTF8 = 3, |
| }; |
| |
| 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; |
| |
| /** |
| * Detect ID3v2 Header. |
| * @param buf must be ID3v2_HEADER_SIZE byte long |
| * @param magic magic bytes to identify the header. |
| * If in doubt, use ID3v2_DEFAULT_MAGIC. |
| */ |
| int ff_id3v2_match(const uint8_t *buf, const char *magic); |
| |
| /** |
| * Get the length of an ID3v2 tag. |
| * @param buf must be ID3v2_HEADER_SIZE bytes long and point to the start of an |
| * already detected ID3v2 tag |
| */ |
| int ff_id3v2_tag_len(const uint8_t *buf); |
| |
| /** |
| * Read an ID3v2 tag (text tags only) |
| */ |
| void ff_id3v2_read(AVFormatContext *s, const char *magic); |
| |
| /** |
| * Read an ID3v2 tag, including supported extra metadata (currently only GEOB) |
| * @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 |
| */ |
| void ff_id3v2_read_all(AVFormatContext *s, const char *magic, ID3v2ExtraMeta **extra_meta); |
| |
| /** |
| * Write an ID3v2 tag. |
| * @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. |
| */ |
| int ff_id3v2_write(struct AVFormatContext *s, int id3v2_version, const char *magic); |
| |
| /** |
| * 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); |
| |
| extern const AVMetadataConv ff_id3v2_34_metadata_conv[]; |
| extern const AVMetadataConv ff_id3v2_4_metadata_conv[]; |
| |
| /** |
| * 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 |
| */ |
| extern const char ff_id3v2_tags[][4]; |
| |
| /** |
| * 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]; |
| |
| #endif /* AVFORMAT_ID3V2_H */ |