1 /* libmpdclient
2    (c) 2003-2019 The Music Player Daemon Project
3    This project's homepage is: http://www.musicpd.org
4 
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8 
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11 
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15 
16    - Neither the name of the Music Player Daemon nor the names of its
17    contributors may be used to endorse or promote products derived from
18    this software without specific prior written permission.
19 
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
33 #ifndef LIBMPDCLIENT_TAG_H
34 #define LIBMPDCLIENT_TAG_H
35 
36 /**
37  * @since libmpdclient 2.10 added support for #MPD_TAG_MUSICBRAINZ_RELEASETRACKID.
38  * @since libmpdclient 2.11 added support for #MPD_TAG_ARTIST_SORT and #MPD_TAG_ALBUM_ARTIST_SORT
39  * @since libmpdclient 2.17 added support for #MPD_TAG_LABEL,
40  *                                            #MPD_TAG_MUSICBRAINZ_WORKID,
41  *                                            #MPD_TAG_GROUPING,
42  *                                            #MPD_TAG_WORK,
43  *                                            #MPD_TAG_CONDUCTOR.
44  */
45 enum mpd_tag_type
46 {
47 	/**
48 	 * Special value returned by mpd_tag_name_parse() when an
49 	 * unknown name was passed.
50 	 */
51 	MPD_TAG_UNKNOWN = -1,
52 
53 	MPD_TAG_ARTIST,
54 	MPD_TAG_ALBUM,
55 	MPD_TAG_ALBUM_ARTIST,
56 	MPD_TAG_TITLE,
57 	MPD_TAG_TRACK,
58 	MPD_TAG_NAME,
59 	MPD_TAG_GENRE,
60 	MPD_TAG_DATE,
61 	MPD_TAG_COMPOSER,
62 	MPD_TAG_PERFORMER,
63 	MPD_TAG_COMMENT,
64 	MPD_TAG_DISC,
65 
66 	MPD_TAG_MUSICBRAINZ_ARTISTID,
67 	MPD_TAG_MUSICBRAINZ_ALBUMID,
68 	MPD_TAG_MUSICBRAINZ_ALBUMARTISTID,
69 	MPD_TAG_MUSICBRAINZ_TRACKID,
70 	MPD_TAG_MUSICBRAINZ_RELEASETRACKID,
71 
72 	MPD_TAG_ORIGINAL_DATE,
73 
74 	MPD_TAG_ARTIST_SORT,
75 	MPD_TAG_ALBUM_ARTIST_SORT,
76 
77 	MPD_TAG_ALBUM_SORT,
78 	MPD_TAG_LABEL,
79 	MPD_TAG_MUSICBRAINZ_WORKID,
80 
81 	MPD_TAG_GROUPING,
82 	MPD_TAG_WORK,
83 	MPD_TAG_CONDUCTOR,
84 
85 	MPD_TAG_COMPOSER_SORT,
86 	MPD_TAG_ENSEMBLE,
87 	MPD_TAG_MOVEMENT,
88 	MPD_TAG_MOVEMENTNUMBER,
89 	MPD_TAG_LOCATION,
90 
91 	/* IMPORTANT: the ordering of tag types above must be
92 	   retained, or else the libmpdclient ABI breaks */
93 
94 	MPD_TAG_COUNT
95 };
96 
97 #ifdef __cplusplus
98 extern "C" {
99 #endif
100 
101 /**
102  * Looks up the name of the specified tag.
103  *
104  * @return the name, or NULL if the tag type is not valid
105  */
106 const char *
107 mpd_tag_name(enum mpd_tag_type type);
108 
109 /**
110  * Parses a tag name, and returns its #mpd_tag_type value.
111  *
112  * @return a #mpd_tag_type value, or MPD_TAG_UNKNOWN if the name was
113  * not recognized
114  */
115 enum mpd_tag_type
116 mpd_tag_name_parse(const char *name);
117 
118 /**
119  * Same as mpd_tag_name_parse(), but ignores case.
120  *
121  * @return a #mpd_tag_type value, or MPD_TAG_UNKNOWN if the name was
122  * not recognized
123  */
124 enum mpd_tag_type
125 mpd_tag_name_iparse(const char *name);
126 
127 #ifdef __cplusplus
128 }
129 #endif
130 
131 #endif
132