2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttaglist.h: Header for tag support
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_TAGLIST_H__
24 #define __GST_TAGLIST_H__
26 #include <gst/gststructure.h>
31 GST_TAG_MERGE_UNDEFINED,
32 GST_TAG_MERGE_REPLACE_ALL,
33 GST_TAG_MERGE_REPLACE,
35 GST_TAG_MERGE_PREPEND,
37 GST_TAG_MERGE_KEEP_ALL,
42 #define GST_TAG_MODE_IS_VALID(mode) (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))
45 GST_TAG_FLAG_UNDEFINED,
52 #define GST_TAG_FLAG_IS_VALID(flag) (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))
54 typedef GstStructure GstTagList;
55 #define GST_TAG_LIST(x) ((GstTagList *) (x))
56 #define GST_IS_TAG_LIST(x) (gst_is_tag_list (GST_TAG_LIST (x)))
57 #define GST_TYPE_TAG_LIST (gst_tag_list_get_type ())
61 * @list: the #GstTagList
62 * @tag: a name of a tag in @list
63 * @user_data: user data
65 * A function that will be called in gst_tag_list_foreach(). The function may
66 * not modify the tag list.
68 * Returns: TRUE if the foreach operation should continue, FALSE if
69 * the foreach operation should stop with FALSE.
71 typedef gboolean (*GstTagForeachFunc) (const GstTagList *list,
75 typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
77 /* initialize tagging system */
78 void _gst_tag_initialize (void);
79 GType gst_tag_list_get_type (void);
81 void gst_tag_register (const gchar * name,
86 GstTagMergeFunc func);
87 /* some default merging functions */
88 void gst_tag_merge_use_first (GValue * dest,
90 void gst_tag_merge_strings_with_comma (GValue * dest,
93 /* basic tag support */
94 gboolean gst_tag_exists (const gchar * tag);
95 GType gst_tag_get_type (const gchar * tag);
96 G_CONST_RETURN gchar *
97 gst_tag_get_nick (const gchar * tag);
98 G_CONST_RETURN gchar *
99 gst_tag_get_description (const gchar * tag);
100 GstTagFlag gst_tag_get_flag (const gchar * tag);
101 gboolean gst_tag_is_fixed (const gchar * tag);
104 GstTagList * gst_tag_list_new (void);
105 gboolean gst_is_tag_list (gconstpointer p);
106 GstTagList * gst_tag_list_copy (const GstTagList * list);
107 void gst_tag_list_insert (GstTagList * into,
108 const GstTagList * from,
109 GstTagMergeMode mode);
110 GstTagList * gst_tag_list_merge (const GstTagList * list1,
111 const GstTagList * list2,
112 GstTagMergeMode mode);
113 void gst_tag_list_free (GstTagList * list);
114 guint gst_tag_list_get_tag_size (const GstTagList * list,
116 void gst_tag_list_add (GstTagList * list,
117 GstTagMergeMode mode,
120 void gst_tag_list_add_values (GstTagList * list,
121 GstTagMergeMode mode,
124 void gst_tag_list_add_valist (GstTagList * list,
125 GstTagMergeMode mode,
128 void gst_tag_list_add_valist_values (GstTagList * list,
129 GstTagMergeMode mode,
132 void gst_tag_list_remove_tag (GstTagList * list,
134 void gst_tag_list_foreach (const GstTagList * list,
135 GstTagForeachFunc func,
138 G_CONST_RETURN GValue *
139 gst_tag_list_get_value_index (const GstTagList * list,
142 gboolean gst_tag_list_copy_value (GValue * dest,
143 const GstTagList * list,
146 /* simplifications (FIXME: do we want them?) */
147 gboolean gst_tag_list_get_char (const GstTagList * list,
150 gboolean gst_tag_list_get_char_index (const GstTagList * list,
154 gboolean gst_tag_list_get_uchar (const GstTagList * list,
157 gboolean gst_tag_list_get_uchar_index (const GstTagList * list,
161 gboolean gst_tag_list_get_boolean (const GstTagList * list,
164 gboolean gst_tag_list_get_boolean_index (const GstTagList * list,
168 gboolean gst_tag_list_get_int (const GstTagList * list,
171 gboolean gst_tag_list_get_int_index (const GstTagList * list,
175 gboolean gst_tag_list_get_uint (const GstTagList * list,
178 gboolean gst_tag_list_get_uint_index (const GstTagList * list,
182 gboolean gst_tag_list_get_long (const GstTagList * list,
185 gboolean gst_tag_list_get_long_index (const GstTagList * list,
189 gboolean gst_tag_list_get_ulong (const GstTagList * list,
192 gboolean gst_tag_list_get_ulong_index (const GstTagList * list,
196 gboolean gst_tag_list_get_int64 (const GstTagList * list,
199 gboolean gst_tag_list_get_int64_index (const GstTagList * list,
203 gboolean gst_tag_list_get_uint64 (const GstTagList * list,
206 gboolean gst_tag_list_get_uint64_index (const GstTagList * list,
210 gboolean gst_tag_list_get_float (const GstTagList * list,
213 gboolean gst_tag_list_get_float_index (const GstTagList * list,
217 gboolean gst_tag_list_get_double (const GstTagList * list,
220 gboolean gst_tag_list_get_double_index (const GstTagList * list,
224 gboolean gst_tag_list_get_string (const GstTagList * list,
227 gboolean gst_tag_list_get_string_index (const GstTagList * list,
231 gboolean gst_tag_list_get_pointer (const GstTagList * list,
234 gboolean gst_tag_list_get_pointer_index (const GstTagList * list,
238 gboolean gst_tag_list_get_date (const GstTagList * list,
241 gboolean gst_tag_list_get_date_index (const GstTagList * list,
246 /* GStreamer core tags (need to be discussed) */
250 * commonly used title
252 #define GST_TAG_TITLE "title"
256 * person(s) responsible for the recording
258 #define GST_TAG_ARTIST "artist"
262 * album containing this data
264 #define GST_TAG_ALBUM "album"
268 * date the data was created (#GDate structure)
270 #define GST_TAG_DATE "date"
274 * genre this data belongs to
276 #define GST_TAG_GENRE "genre"
280 * free text commenting the data
282 #define GST_TAG_COMMENT "comment"
284 * GST_TAG_TRACK_NUMBER:
286 * track number inside a collection
288 #define GST_TAG_TRACK_NUMBER "track-number"
290 * GST_TAG_TRACK_COUNT:
292 * count of tracks inside collection this track belongs to
294 #define GST_TAG_TRACK_COUNT "track-count"
296 * GST_TAG_ALBUM_VOLUME_NUMBER:
298 * disc number inside a collection
300 #define GST_TAG_ALBUM_VOLUME_NUMBER "album-disc-number"
302 * GST_TAG_ALBUM_VOLUME_COUNT:
304 * count of discs inside collection this disc belongs to
306 #define GST_TAG_ALBUM_VOLUME_COUNT "album-disc-count"
310 * original location of file as a URI
312 #define GST_TAG_LOCATION "location"
314 * GST_TAG_DESCRIPTION:
316 * short text describing the content of the data
318 #define GST_TAG_DESCRIPTION "description"
322 * version of this data
324 #define GST_TAG_VERSION "version"
328 * International Standard Recording Code - see http://www.ifpi.org/isrc/
330 #define GST_TAG_ISRC "isrc"
332 * GST_TAG_ORGANIZATION:
336 #define GST_TAG_ORGANIZATION "organization"
340 * copyright notice of the data
342 #define GST_TAG_COPYRIGHT "copyright"
346 * contact information
348 #define GST_TAG_CONTACT "contact"
354 #define GST_TAG_LICENSE "license"
358 * person(s) performing
360 #define GST_TAG_PERFORMER "performer"
364 * length in GStreamer time units (nanoseconds)
366 #define GST_TAG_DURATION "duration"
370 * codec the data is stored in
372 #define GST_TAG_CODEC "codec"
374 * GST_TAG_VIDEO_CODEC:
376 * codec the video data is stored in
378 #define GST_TAG_VIDEO_CODEC "video-codec"
380 * GST_TAG_AUDIO_CODEC:
382 * codec the audio data is stored in
384 #define GST_TAG_AUDIO_CODEC "audio-codec"
388 * exact or average bitrate in bits/s
390 #define GST_TAG_BITRATE "bitrate"
392 * GST_TAG_NOMINAL_BITRATE:
394 * nominal bitrate in bits/s
396 #define GST_TAG_NOMINAL_BITRATE "nominal-bitrate"
398 * GST_TAG_MINIMUM_BITRATE:
400 * minimum bitrate in bits/s
402 #define GST_TAG_MINIMUM_BITRATE "minimum-bitrate"
404 * GST_TAG_MAXIMUM_BITRATE:
406 * maximum bitrate in bits/s
408 #define GST_TAG_MAXIMUM_BITRATE "maximum-bitrate"
412 * serial number of track
414 #define GST_TAG_SERIAL "serial"
418 * encoder used to encode this stream
420 #define GST_TAG_ENCODER "encoder"
422 * GST_TAG_ENCODER_VERSION:
424 * version of the encoder used to encode this stream
426 #define GST_TAG_ENCODER_VERSION "encoder-version"
428 * GST_TAG_TRACK_GAIN:
432 #define GST_TAG_TRACK_GAIN "replaygain-track-gain"
434 * GST_TAG_TRACK_PEAK:
438 #define GST_TAG_TRACK_PEAK "replaygain-track-peak"
440 * GST_TAG_ALBUM_GAIN:
444 #define GST_TAG_ALBUM_GAIN "replaygain-album-gain"
446 * GST_TAG_ALBUM_PEAK:
450 #define GST_TAG_ALBUM_PEAK "replaygain-album-peak"
452 * GST_TAG_LANGUAGE_CODE:
454 * Language code (ISO-639-1)
456 #define GST_TAG_LANGUAGE_CODE "language-code"
460 #endif /* __GST_TAGLIST_H__ */