Mercurial > hg > sv-dependency-builds

annotate win32-mingw/include/id3tag.h @ 169:223a55898ab9 tip default

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 9fe94270bdf5
children
rev   line source
cannam@91 1 /*
cannam@91 2 * libid3tag - ID3 tag manipulation library
cannam@91 3 * Copyright (C) 2000-2004 Underbit Technologies, Inc.
cannam@91 4 *
cannam@91 5 * This program is free software; you can redistribute it and/or modify
cannam@91 6 * it under the terms of the GNU General Public License as published by
cannam@91 7 * the Free Software Foundation; either version 2 of the License, or
cannam@91 8 * (at your option) any later version.
cannam@91 9 *
cannam@91 10 * This program is distributed in the hope that it will be useful,
cannam@91 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@91 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
cannam@91 13 * GNU General Public License for more details.
cannam@91 14 *
cannam@91 15 * You should have received a copy of the GNU General Public License
cannam@91 16 * along with this program; if not, write to the Free Software
cannam@91 17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
cannam@91 18 *
cannam@91 19 * If you would like to negotiate alternate licensing terms, you may do
cannam@91 20 * so by contacting: Underbit Technologies, Inc. <info@underbit.com>
cannam@91 21 *
cannam@91 22 * $Id: id3tag.h,v 1.17 2004/01/23 23:22:46 rob Exp $
cannam@91 23 */
cannam@91 24
cannam@91 25 # ifndef LIBID3TAG_ID3TAG_H
cannam@91 26 # define LIBID3TAG_ID3TAG_H
cannam@91 27
cannam@91 28 # ifdef __cplusplus
cannam@91 29 extern "C" {
cannam@91 30 # endif
cannam@91 31
cannam@91 32 # define ID3_TAG_VERSION 0x0400
cannam@91 33 # define ID3_TAG_VERSION_MAJOR(x) (((x) >> 8) & 0xff)
cannam@91 34 # define ID3_TAG_VERSION_MINOR(x) (((x) >> 0) & 0xff)
cannam@91 35
cannam@91 36 typedef unsigned char id3_byte_t;
cannam@91 37 typedef unsigned long id3_length_t;
cannam@91 38
cannam@91 39 typedef unsigned long id3_ucs4_t;
cannam@91 40
cannam@91 41 typedef unsigned char id3_latin1_t;
cannam@91 42 typedef unsigned short id3_utf16_t;
cannam@91 43 typedef signed char id3_utf8_t;
cannam@91 44
cannam@91 45 struct id3_tag {
cannam@91 46 unsigned int refcount;
cannam@91 47 unsigned int version;
cannam@91 48 int flags;
cannam@91 49 int extendedflags;
cannam@91 50 int restrictions;
cannam@91 51 int options;
cannam@91 52 unsigned int nframes;
cannam@91 53 struct id3_frame **frames;
cannam@91 54 id3_length_t paddedsize;
cannam@91 55 };
cannam@91 56
cannam@91 57 # define ID3_TAG_QUERYSIZE 10
cannam@91 58
cannam@91 59 /* ID3v1 field frames */
cannam@91 60
cannam@91 61 # define ID3_FRAME_TITLE "TIT2"
cannam@91 62 # define ID3_FRAME_ARTIST "TPE1"
cannam@91 63 # define ID3_FRAME_ALBUM "TALB"
cannam@91 64 # define ID3_FRAME_TRACK "TRCK"
cannam@91 65 # define ID3_FRAME_YEAR "TDRC"
cannam@91 66 # define ID3_FRAME_GENRE "TCON"
cannam@91 67 # define ID3_FRAME_COMMENT "COMM"
cannam@91 68
cannam@91 69 /* special frames */
cannam@91 70
cannam@91 71 # define ID3_FRAME_OBSOLETE "ZOBS" /* with apologies to the French */
cannam@91 72
cannam@91 73 /* tag flags */
cannam@91 74
cannam@91 75 enum {
cannam@91 76 ID3_TAG_FLAG_UNSYNCHRONISATION = 0x80,
cannam@91 77 ID3_TAG_FLAG_EXTENDEDHEADER = 0x40,
cannam@91 78 ID3_TAG_FLAG_EXPERIMENTALINDICATOR = 0x20,
cannam@91 79 ID3_TAG_FLAG_FOOTERPRESENT = 0x10,
cannam@91 80
cannam@91 81 ID3_TAG_FLAG_KNOWNFLAGS = 0xf0
cannam@91 82 };
cannam@91 83
cannam@91 84 /* tag extended flags */
cannam@91 85
cannam@91 86 enum {
cannam@91 87 ID3_TAG_EXTENDEDFLAG_TAGISANUPDATE = 0x40,
cannam@91 88 ID3_TAG_EXTENDEDFLAG_CRCDATAPRESENT = 0x20,
cannam@91 89 ID3_TAG_EXTENDEDFLAG_TAGRESTRICTIONS = 0x10,
cannam@91 90
cannam@91 91 ID3_TAG_EXTENDEDFLAG_KNOWNFLAGS = 0x70
cannam@91 92 };
cannam@91 93
cannam@91 94 /* tag restrictions */
cannam@91 95
cannam@91 96 enum {
cannam@91 97 ID3_TAG_RESTRICTION_TAGSIZE_MASK = 0xc0,
cannam@91 98 ID3_TAG_RESTRICTION_TAGSIZE_128_FRAMES_1_MB = 0x00,
cannam@91 99 ID3_TAG_RESTRICTION_TAGSIZE_64_FRAMES_128_KB = 0x40,
cannam@91 100 ID3_TAG_RESTRICTION_TAGSIZE_32_FRAMES_40_KB = 0x80,
cannam@91 101 ID3_TAG_RESTRICTION_TAGSIZE_32_FRAMES_4_KB = 0xc0
cannam@91 102 };
cannam@91 103
cannam@91 104 enum {
cannam@91 105 ID3_TAG_RESTRICTION_TEXTENCODING_MASK = 0x20,
cannam@91 106 ID3_TAG_RESTRICTION_TEXTENCODING_NONE = 0x00,
cannam@91 107 ID3_TAG_RESTRICTION_TEXTENCODING_LATIN1_UTF8 = 0x20
cannam@91 108 };
cannam@91 109
cannam@91 110 enum {
cannam@91 111 ID3_TAG_RESTRICTION_TEXTSIZE_MASK = 0x18,
cannam@91 112 ID3_TAG_RESTRICTION_TEXTSIZE_NONE = 0x00,
cannam@91 113 ID3_TAG_RESTRICTION_TEXTSIZE_1024_CHARS = 0x08,
cannam@91 114 ID3_TAG_RESTRICTION_TEXTSIZE_128_CHARS = 0x10,
cannam@91 115 ID3_TAG_RESTRICTION_TEXTSIZE_30_CHARS = 0x18
cannam@91 116 };
cannam@91 117
cannam@91 118 enum {
cannam@91 119 ID3_TAG_RESTRICTION_IMAGEENCODING_MASK = 0x04,
cannam@91 120 ID3_TAG_RESTRICTION_IMAGEENCODING_NONE = 0x00,
cannam@91 121 ID3_TAG_RESTRICTION_IMAGEENCODING_PNG_JPEG = 0x04
cannam@91 122 };
cannam@91 123
cannam@91 124 enum {
cannam@91 125 ID3_TAG_RESTRICTION_IMAGESIZE_MASK = 0x03,
cannam@91 126 ID3_TAG_RESTRICTION_IMAGESIZE_NONE = 0x00,
cannam@91 127 ID3_TAG_RESTRICTION_IMAGESIZE_256_256 = 0x01,
cannam@91 128 ID3_TAG_RESTRICTION_IMAGESIZE_64_64 = 0x02,
cannam@91 129 ID3_TAG_RESTRICTION_IMAGESIZE_64_64_EXACT = 0x03
cannam@91 130 };
cannam@91 131
cannam@91 132 /* library options */
cannam@91 133
cannam@91 134 enum {
cannam@91 135 ID3_TAG_OPTION_UNSYNCHRONISATION = 0x0001, /* use unsynchronisation */
cannam@91 136 ID3_TAG_OPTION_COMPRESSION = 0x0002, /* use compression */
cannam@91 137 ID3_TAG_OPTION_CRC = 0x0004, /* use CRC */
cannam@91 138
cannam@91 139 ID3_TAG_OPTION_APPENDEDTAG = 0x0010, /* tag will be appended */
cannam@91 140 ID3_TAG_OPTION_FILEALTERED = 0x0020, /* audio data was altered */
cannam@91 141
cannam@91 142 ID3_TAG_OPTION_ID3V1 = 0x0100 /* render ID3v1/ID3v1.1 tag */
cannam@91 143 };
cannam@91 144
cannam@91 145 struct id3_frame {
cannam@91 146 char id[5];
cannam@91 147 char const *description;
cannam@91 148 unsigned int refcount;
cannam@91 149 int flags;
cannam@91 150 int group_id;
cannam@91 151 int encryption_method;
cannam@91 152 id3_byte_t *encoded;
cannam@91 153 id3_length_t encoded_length;
cannam@91 154 id3_length_t decoded_length;
cannam@91 155 unsigned int nfields;
cannam@91 156 union id3_field *fields;
cannam@91 157 };
cannam@91 158
cannam@91 159 enum {
cannam@91 160 /* frame status flags */
cannam@91 161 ID3_FRAME_FLAG_TAGALTERPRESERVATION = 0x4000,
cannam@91 162 ID3_FRAME_FLAG_FILEALTERPRESERVATION = 0x2000,
cannam@91 163 ID3_FRAME_FLAG_READONLY = 0x1000,
cannam@91 164
cannam@91 165 ID3_FRAME_FLAG_STATUSFLAGS = 0xff00,
cannam@91 166
cannam@91 167 /* frame format flags */
cannam@91 168 ID3_FRAME_FLAG_GROUPINGIDENTITY = 0x0040,
cannam@91 169 ID3_FRAME_FLAG_COMPRESSION = 0x0008,
cannam@91 170 ID3_FRAME_FLAG_ENCRYPTION = 0x0004,
cannam@91 171 ID3_FRAME_FLAG_UNSYNCHRONISATION = 0x0002,
cannam@91 172 ID3_FRAME_FLAG_DATALENGTHINDICATOR = 0x0001,
cannam@91 173
cannam@91 174 ID3_FRAME_FLAG_FORMATFLAGS = 0x00ff,
cannam@91 175
cannam@91 176 ID3_FRAME_FLAG_KNOWNFLAGS = 0x704f
cannam@91 177 };
cannam@91 178
cannam@91 179 enum id3_field_type {
cannam@91 180 ID3_FIELD_TYPE_TEXTENCODING,
cannam@91 181 ID3_FIELD_TYPE_LATIN1,
cannam@91 182 ID3_FIELD_TYPE_LATIN1FULL,
cannam@91 183 ID3_FIELD_TYPE_LATIN1LIST,
cannam@91 184 ID3_FIELD_TYPE_STRING,
cannam@91 185 ID3_FIELD_TYPE_STRINGFULL,
cannam@91 186 ID3_FIELD_TYPE_STRINGLIST,
cannam@91 187 ID3_FIELD_TYPE_LANGUAGE,
cannam@91 188 ID3_FIELD_TYPE_FRAMEID,
cannam@91 189 ID3_FIELD_TYPE_DATE,
cannam@91 190 ID3_FIELD_TYPE_INT8,
cannam@91 191 ID3_FIELD_TYPE_INT16,
cannam@91 192 ID3_FIELD_TYPE_INT24,
cannam@91 193 ID3_FIELD_TYPE_INT32,
cannam@91 194 ID3_FIELD_TYPE_INT32PLUS,
cannam@91 195 ID3_FIELD_TYPE_BINARYDATA
cannam@91 196 };
cannam@91 197
cannam@91 198 enum id3_field_textencoding {
cannam@91 199 ID3_FIELD_TEXTENCODING_ISO_8859_1 = 0x00,
cannam@91 200 ID3_FIELD_TEXTENCODING_UTF_16 = 0x01,
cannam@91 201 ID3_FIELD_TEXTENCODING_UTF_16BE = 0x02,
cannam@91 202 ID3_FIELD_TEXTENCODING_UTF_8 = 0x03
cannam@91 203 };
cannam@91 204
cannam@91 205 union id3_field {
cannam@91 206 enum id3_field_type type;
cannam@91 207 struct {
cannam@91 208 enum id3_field_type type;
cannam@91 209 signed long value;
cannam@91 210 } number;
cannam@91 211 struct {
cannam@91 212 enum id3_field_type type;
cannam@91 213 id3_latin1_t *ptr;
cannam@91 214 } latin1;
cannam@91 215 struct {
cannam@91 216 enum id3_field_type type;
cannam@91 217 unsigned int nstrings;
cannam@91 218 id3_latin1_t **strings;
cannam@91 219 } latin1list;
cannam@91 220 struct {
cannam@91 221 enum id3_field_type type;
cannam@91 222 id3_ucs4_t *ptr;
cannam@91 223 } string;
cannam@91 224 struct {
cannam@91 225 enum id3_field_type type;
cannam@91 226 unsigned int nstrings;
cannam@91 227 id3_ucs4_t **strings;
cannam@91 228 } stringlist;
cannam@91 229 struct {
cannam@91 230 enum id3_field_type type;
cannam@91 231 char value[9];
cannam@91 232 } immediate;
cannam@91 233 struct {
cannam@91 234 enum id3_field_type type;
cannam@91 235 id3_byte_t *data;
cannam@91 236 id3_length_t length;
cannam@91 237 } binary;
cannam@91 238 };
cannam@91 239
cannam@91 240 /* file interface */
cannam@91 241
cannam@91 242 enum id3_file_mode {
cannam@91 243 ID3_FILE_MODE_READONLY = 0,
cannam@91 244 ID3_FILE_MODE_READWRITE
cannam@91 245 };
cannam@91 246
cannam@91 247 struct id3_file *id3_file_open(char const *, enum id3_file_mode);
cannam@91 248 struct id3_file *id3_file_fdopen(int, enum id3_file_mode);
cannam@91 249 int id3_file_close(struct id3_file *);
cannam@91 250
cannam@91 251 struct id3_tag *id3_file_tag(struct id3_file const *);
cannam@91 252
cannam@91 253 int id3_file_update(struct id3_file *);
cannam@91 254
cannam@91 255 /* tag interface */
cannam@91 256
cannam@91 257 struct id3_tag *id3_tag_new(void);
cannam@91 258 void id3_tag_delete(struct id3_tag *);
cannam@91 259
cannam@91 260 unsigned int id3_tag_version(struct id3_tag const *);
cannam@91 261
cannam@91 262 int id3_tag_options(struct id3_tag *, int, int);
cannam@91 263 void id3_tag_setlength(struct id3_tag *, id3_length_t);
cannam@91 264
cannam@91 265 void id3_tag_clearframes(struct id3_tag *);
cannam@91 266
cannam@91 267 int id3_tag_attachframe(struct id3_tag *, struct id3_frame *);
cannam@91 268 int id3_tag_detachframe(struct id3_tag *, struct id3_frame *);
cannam@91 269
cannam@91 270 struct id3_frame *id3_tag_findframe(struct id3_tag const *,
cannam@91 271 char const *, unsigned int);
cannam@91 272
cannam@91 273 signed long id3_tag_query(id3_byte_t const *, id3_length_t);
cannam@91 274
cannam@91 275 struct id3_tag *id3_tag_parse(id3_byte_t const *, id3_length_t);
cannam@91 276 id3_length_t id3_tag_render(struct id3_tag const *, id3_byte_t *);
cannam@91 277
cannam@91 278 /* frame interface */
cannam@91 279
cannam@91 280 struct id3_frame *id3_frame_new(char const *);
cannam@91 281 void id3_frame_delete(struct id3_frame *);
cannam@91 282
cannam@91 283 union id3_field *id3_frame_field(struct id3_frame const *, unsigned int);
cannam@91 284
cannam@91 285 /* field interface */
cannam@91 286
cannam@91 287 enum id3_field_type id3_field_type(union id3_field const *);
cannam@91 288
cannam@91 289 int id3_field_setint(union id3_field *, signed long);
cannam@91 290 int id3_field_settextencoding(union id3_field *, enum id3_field_textencoding);
cannam@91 291 int id3_field_setstrings(union id3_field *, unsigned int, id3_ucs4_t **);
cannam@91 292 int id3_field_addstring(union id3_field *, id3_ucs4_t const *);
cannam@91 293 int id3_field_setlanguage(union id3_field *, char const *);
cannam@91 294 int id3_field_setlatin1(union id3_field *, id3_latin1_t const *);
cannam@91 295 int id3_field_setfulllatin1(union id3_field *, id3_latin1_t const *);
cannam@91 296 int id3_field_setstring(union id3_field *, id3_ucs4_t const *);
cannam@91 297 int id3_field_setfullstring(union id3_field *, id3_ucs4_t const *);
cannam@91 298 int id3_field_setframeid(union id3_field *, char const *);
cannam@91 299 int id3_field_setbinarydata(union id3_field *,
cannam@91 300 id3_byte_t const *, id3_length_t);
cannam@91 301
cannam@91 302 signed long id3_field_getint(union id3_field const *);
cannam@91 303 enum id3_field_textencoding id3_field_gettextencoding(union id3_field const *);
cannam@91 304 id3_latin1_t const *id3_field_getlatin1(union id3_field const *);
cannam@91 305 id3_latin1_t const *id3_field_getfulllatin1(union id3_field const *);
cannam@91 306 id3_ucs4_t const *id3_field_getstring(union id3_field const *);
cannam@91 307 id3_ucs4_t const *id3_field_getfullstring(union id3_field const *);
cannam@91 308 unsigned int id3_field_getnstrings(union id3_field const *);
cannam@91 309 id3_ucs4_t const *id3_field_getstrings(union id3_field const *,
cannam@91 310 unsigned int);
cannam@91 311 char const *id3_field_getframeid(union id3_field const *);
cannam@91 312 id3_byte_t const *id3_field_getbinarydata(union id3_field const *,
cannam@91 313 id3_length_t *);
cannam@91 314
cannam@91 315 /* genre interface */
cannam@91 316
cannam@91 317 id3_ucs4_t const *id3_genre_index(unsigned int);
cannam@91 318 id3_ucs4_t const *id3_genre_name(id3_ucs4_t const *);
cannam@91 319 int id3_genre_number(id3_ucs4_t const *);
cannam@91 320
cannam@91 321 /* ucs4 interface */
cannam@91 322
cannam@91 323 id3_latin1_t *id3_ucs4_latin1duplicate(id3_ucs4_t const *);
cannam@91 324 id3_utf16_t *id3_ucs4_utf16duplicate(id3_ucs4_t const *);
cannam@91 325 id3_utf8_t *id3_ucs4_utf8duplicate(id3_ucs4_t const *);
cannam@91 326
cannam@91 327 void id3_ucs4_putnumber(id3_ucs4_t *, unsigned long);
cannam@91 328 unsigned long id3_ucs4_getnumber(id3_ucs4_t const *);
cannam@91 329
cannam@91 330 /* latin1/utf16/utf8 interfaces */
cannam@91 331
cannam@91 332 id3_ucs4_t *id3_latin1_ucs4duplicate(id3_latin1_t const *);
cannam@91 333 id3_ucs4_t *id3_utf16_ucs4duplicate(id3_utf16_t const *);
cannam@91 334 id3_ucs4_t *id3_utf8_ucs4duplicate(id3_utf8_t const *);
cannam@91 335
cannam@91 336 /* version interface */
cannam@91 337
cannam@91 338 # define ID3_VERSION_MAJOR 0
cannam@91 339 # define ID3_VERSION_MINOR 15
cannam@91 340 # define ID3_VERSION_PATCH 1
cannam@91 341 # define ID3_VERSION_EXTRA " (beta)"
cannam@91 342
cannam@91 343 # define ID3_VERSION_STRINGIZE(str) #str
cannam@91 344 # define ID3_VERSION_STRING(num) ID3_VERSION_STRINGIZE(num)
cannam@91 345
cannam@91 346 # define ID3_VERSION ID3_VERSION_STRING(ID3_VERSION_MAJOR) "." \
cannam@91 347 ID3_VERSION_STRING(ID3_VERSION_MINOR) "." \
cannam@91 348 ID3_VERSION_STRING(ID3_VERSION_PATCH) \
cannam@91 349 ID3_VERSION_EXTRA
cannam@91 350
cannam@91 351 # define ID3_PUBLISHYEAR "2000-2004"
cannam@91 352 # define ID3_AUTHOR "Underbit Technologies, Inc."
cannam@91 353 # define ID3_EMAIL "info@underbit.com"
cannam@91 354
cannam@91 355 extern char const id3_version[];
cannam@91 356 extern char const id3_copyright[];
cannam@91 357 extern char const id3_author[];
cannam@91 358 extern char const id3_build[];
cannam@91 359
cannam@91 360 # ifdef __cplusplus
cannam@91 361 }
cannam@91 362 # endif
cannam@91 363
cannam@91 364 # endif