5aa6bab385d954d04cc234bc7966417b237a9d4d
[flac.git] / src / plugin_common / canonical_tag.h
1 /* plugin_common - Routines common to several plugins\r
2  * Copyright (C) 2002,2003,2004  Josh Coalson\r
3  *\r
4  * This program is free software; you can redistribute it and/or\r
5  * modify it under the terms of the GNU General Public License\r
6  * as published by the Free Software Foundation; either version 2\r
7  * of the License, or (at your option) any later version.\r
8  *\r
9  * This program is distributed in the hope that it will be useful,\r
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
12  * GNU General Public License for more details.\r
13  *\r
14  * You should have received a copy of the GNU General Public License\r
15  * along with this program; if not, write to the Free Software\r
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
17  */\r
18 \r
19 #ifndef FLAC__PLUGIN_COMMON__CANONICAL_TAG_H\r
20 #define FLAC__PLUGIN_COMMON__CANONICAL_TAG_H\r
21 \r
22 #include "id3v1.h"\r
23 #include "id3v2.h"\r
24 \r
25 /* TODO: splay tree? */\r
26 typedef struct tagFLAC__tag_entry FLAC__tag_entry;\r
27 struct tagFLAC__tag_entry\r
28 {\r
29         FLAC__tag_entry *next, *prev;\r
30         /* TODO: name in ascii? */\r
31         wchar_t *name;\r
32         wchar_t *value;\r
33 };\r
34 \r
35 typedef struct {\r
36         FLAC__tag_entry *head, *tail;\r
37         unsigned count;\r
38 } FLAC_Plugin__CanonicalTag;\r
39 \r
40 \r
41 typedef FLAC__tag_entry *FLAC__tag_iterator;\r
42 \r
43 FLAC_Plugin__CanonicalTag *FLAC_plugin__canonical_tag_new();\r
44 void FLAC_plugin__canonical_tag_init(FLAC_Plugin__CanonicalTag *);\r
45 void FLAC_plugin__canonical_tag_clear(FLAC_Plugin__CanonicalTag *);\r
46 void FLAC_plugin__canonical_tag_delete(FLAC_Plugin__CanonicalTag *);\r
47 \r
48 /* note that multiple fields with the same name are allowed.\r
49  * set - adds field if it's not present yet, or replaces\r
50  * existing field if it's present.\r
51  */\r
52 void FLAC_plugin__canonical_set(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name, const wchar_t *value);\r
53 void FLAC_plugin__canonical_set_ansi(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name, const char *value);\r
54 /* set_new - only adds field if it's not present yet. */\r
55 void FLAC_plugin__canonical_set_new(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name, const wchar_t *value);\r
56 /* add - adds field if it's not present yet, or merges value with existing\r
57  * field, if it's present. (sep - separator string to use when merging;\r
58  * if sep==NULL no merging occurs - always adds new field)\r
59  */\r
60 void FLAC_plugin__canonical_add(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name, const wchar_t *value, const wchar_t *sep);\r
61 void FLAC_plugin__canonical_add_utf8(FLAC_Plugin__CanonicalTag *tag, const char *name, const char *value, unsigned namelen, unsigned vallen, const char *sep); /* 'namelen'/'vallen' may be (unsigned)(-1) if 'name'/'value' is NUL-terminated */\r
62 \r
63 /* gets value of the first field with the given name (NULL if field not found) */\r
64 const wchar_t *FLAC_plugin__canonical_get(const FLAC_Plugin__CanonicalTag *tag, const wchar_t *name);\r
65 /* removes first field with the given name.\r
66  * (returns 'true' if deleted, 'false' if not found)\r
67  */\r
68 FLAC__bool FLAC_plugin__canonical_remove(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name);\r
69 /* removes all fields with the given name. */\r
70 void FLAC_plugin__canonical_remove_all(FLAC_Plugin__CanonicalTag *tag, const wchar_t *name);\r
71 \r
72 /* enumeration */\r
73 unsigned FLAC_plugin__canonical_get_count(FLAC_Plugin__CanonicalTag *tag);\r
74 FLAC__tag_iterator FLAC_plugin__canonical_first(FLAC_Plugin__CanonicalTag *tag);\r
75 FLAC__tag_iterator FLAC_plugin__canonical_next(FLAC__tag_iterator it);\r
76 wchar_t *FLAC_plugin__canonical_get_name(FLAC__tag_iterator it);\r
77 wchar_t *FLAC_plugin__canonical_get_value(FLAC__tag_iterator it);\r
78 \r
79 /* returns a new string containing the current entry in UTF-8 in "NAME=VALUE" form */\r
80 char *FLAC_plugin__canonical_get_formatted(FLAC__tag_iterator it);\r
81 \r
82 void FLAC_plugin__canonical_tag_merge(FLAC_Plugin__CanonicalTag *dest, const FLAC_Plugin__CanonicalTag *src);\r
83 void FLAC_plugin__canonical_tag_convert_from_id3v1(FLAC_Plugin__CanonicalTag *, const FLAC_Plugin__Id3v1_Tag *);\r
84 void FLAC_plugin__canonical_tag_convert_from_id3v2(FLAC_Plugin__CanonicalTag *, const FLAC_Plugin__Id3v2_Tag *);\r
85 \r
86 void FLAC_plugin__canonical_tag_add_id3v1(const char *filename, FLAC_Plugin__CanonicalTag *tag);\r
87 void FLAC_plugin__canonical_tag_add_id3v2(const char *filename, FLAC_Plugin__CanonicalTag *tag);\r
88 \r
89 /* Returns a merged tag based on any Vorbis comments, id3v2 tag, and id3v1.\r
90  * In case of overlaps the preceding precedence applies.\r
91  *\r
92  * sep - separator to use when merging fields with same name (in VorbisComment).\r
93  * should be in UTF-8. if sep==NULL, no merging occurs, so multiple fields\r
94  * with the same name can exist.\r
95  */\r
96 void FLAC_plugin__canonical_tag_get_combined(const char *filename, FLAC_Plugin__CanonicalTag *tag, const char *sep);\r
97 \r
98 /* helpers */\r
99 wchar_t *FLAC_plugin__convert_ansi_to_wide(const char *src);\r
100 wchar_t *FLAC_plugin__convert_utf8_to_ucs2(const char *src, unsigned length); /* 'length' may be (unsigned)(-1) if 'src' is NUL-terminated */\r
101 char    *FLAC_plugin__convert_ucs2_to_utf8(const wchar_t *src);\r
102 \r
103 #endif\r