2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttag.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.
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,
41 #define GST_TAG_MODE_IS_VALID(mode) (((mode) > GST_TAG_MERGE_UNDEFINED) && ((mode) < GST_TAG_MERGE_COUNT))
44 GST_TAG_FLAG_UNDEFINED,
50 #define GST_TAG_FLAG_IS_VALID(flag) (((flag) > GST_TAG_FLAG_UNDEFINED) && ((flag) < GST_TAG_FLAG_COUNT))
52 typedef GstStructure GstTagList;
53 #define GST_TAG_LIST(x) ((GstTagList *) (x))
54 #define GST_IS_TAG_LIST(x) (gst_is_tag_list (GST_TAG_LIST (x)))
55 #define GST_TYPE_TAG_LIST (gst_tag_list_get_type ())
57 typedef void (* GstTagForeachFunc) (const GstTagList *list, const gchar *tag, gpointer user_data);
58 typedef void (* GstTagMergeFunc) (GValue *dest, const GValue *src);
60 /* initialize tagging system */
61 void _gst_tag_initialize (void);
62 GType gst_tag_list_get_type (void);
64 void gst_tag_register (const gchar * name,
69 GstTagMergeFunc func);
70 /* some default merging functions */
71 void gst_tag_merge_use_first (GValue * dest,
73 void gst_tag_merge_strings_with_comma (GValue * dest,
76 /* basic tag support */
77 gboolean gst_tag_exists (const gchar * tag);
78 GType gst_tag_get_type (const gchar * tag);
79 G_CONST_RETURN gchar *
80 gst_tag_get_nick (const gchar * tag);
81 G_CONST_RETURN gchar *
82 gst_tag_get_description (const gchar * tag);
83 GstTagFlag gst_tag_get_flag (const gchar * tag);
84 gboolean gst_tag_is_fixed (const gchar * tag);
87 GstTagList * gst_tag_list_new (void);
88 gboolean gst_is_tag_list (gconstpointer p);
89 GstTagList * gst_tag_list_copy (const GstTagList * list);
90 void gst_tag_list_insert (GstTagList * into,
91 const GstTagList * from,
92 GstTagMergeMode mode);
93 GstTagList * gst_tag_list_merge (const GstTagList * list1,
94 const GstTagList * list2,
95 GstTagMergeMode mode);
96 void gst_tag_list_free (GstTagList * list);
97 guint gst_tag_list_get_tag_size (const GstTagList * list,
99 void gst_tag_list_add (GstTagList * list,
100 GstTagMergeMode mode,
103 void gst_tag_list_add_values (GstTagList * list,
104 GstTagMergeMode mode,
107 void gst_tag_list_add_valist (GstTagList * list,
108 GstTagMergeMode mode,
111 void gst_tag_list_add_valist_values (GstTagList * list,
112 GstTagMergeMode mode,
115 void gst_tag_list_remove_tag (GstTagList * list,
117 void gst_tag_list_foreach (GstTagList * list,
118 GstTagForeachFunc func,
121 G_CONST_RETURN GValue *
122 gst_tag_list_get_value_index (const GstTagList * list,
125 gboolean gst_tag_list_copy_value (GValue * dest,
126 const GstTagList * list,
129 /* simplifications (FIXME: do we want them?) */
130 gboolean gst_tag_list_get_char (const GstTagList * list,
133 gboolean gst_tag_list_get_char_index (const GstTagList * list,
137 gboolean gst_tag_list_get_uchar (const GstTagList * list,
140 gboolean gst_tag_list_get_uchar_index (const GstTagList * list,
144 gboolean gst_tag_list_get_boolean (const GstTagList * list,
147 gboolean gst_tag_list_get_boolean_index (const GstTagList * list,
151 gboolean gst_tag_list_get_int (const GstTagList * list,
154 gboolean gst_tag_list_get_int_index (const GstTagList * list,
158 gboolean gst_tag_list_get_uint (const GstTagList * list,
161 gboolean gst_tag_list_get_uint_index (const GstTagList * list,
165 gboolean gst_tag_list_get_long (const GstTagList * list,
168 gboolean gst_tag_list_get_long_index (const GstTagList * list,
172 gboolean gst_tag_list_get_ulong (const GstTagList * list,
175 gboolean gst_tag_list_get_ulong_index (const GstTagList * list,
179 gboolean gst_tag_list_get_int64 (const GstTagList * list,
182 gboolean gst_tag_list_get_int64_index (const GstTagList * list,
186 gboolean gst_tag_list_get_uint64 (const GstTagList * list,
189 gboolean gst_tag_list_get_uint64_index (const GstTagList * list,
193 gboolean gst_tag_list_get_float (const GstTagList * list,
196 gboolean gst_tag_list_get_float_index (const GstTagList * list,
200 gboolean gst_tag_list_get_double (const GstTagList * list,
203 gboolean gst_tag_list_get_double_index (const GstTagList * list,
207 gboolean gst_tag_list_get_string (const GstTagList * list,
210 gboolean gst_tag_list_get_string_index (const GstTagList * list,
214 gboolean gst_tag_list_get_pointer (const GstTagList * list,
217 gboolean gst_tag_list_get_pointer_index (const GstTagList * list,
222 /* GStreamer core tags (need to be discussed) */
226 * commonly used title
228 #define GST_TAG_TITLE "title"
232 * person(s) responsible for the recording
234 #define GST_TAG_ARTIST "artist"
238 * album containing this data
240 #define GST_TAG_ALBUM "album"
244 * date the data was created (in Julian calendar days)
246 #define GST_TAG_DATE "date"
250 * genre this data belongs to
252 #define GST_TAG_GENRE "genre"
256 * free text commenting the data
258 #define GST_TAG_COMMENT "comment"
260 * GST_TAG_TRACK_NUMBER:
262 * track number inside a collection
264 #define GST_TAG_TRACK_NUMBER "track-number"
266 * GST_TAG_TRACK_COUNT:
268 * count of tracks inside collection this track belongs to
270 #define GST_TAG_TRACK_COUNT "track-count"
272 * GST_TAG_ALBUM_VOLUME_NUMBER:
274 * disc number inside a collection
276 #define GST_TAG_ALBUM_VOLUME_NUMBER "album-disc-number"
278 * GST_TAG_ALBUM_VOLUME_COUNT:
280 * count of discs inside collection this disc belongs to
282 #define GST_TAG_ALBUM_VOLUME_COUNT "album-disc-count"
286 * original location of file as a URI
288 #define GST_TAG_LOCATION "location"
290 * GST_TAG_DESCRIPTION:
292 * short text describing the content of the data
294 #define GST_TAG_DESCRIPTION "description"
298 * version of this data
300 #define GST_TAG_VERSION "version"
304 * International Standard Recording Code - see http://www.ifpi.org/isrc/
306 #define GST_TAG_ISRC "isrc"
308 * GST_TAG_ORGANIZATION:
312 #define GST_TAG_ORGANIZATION "organization"
316 * copyright notice of the data
318 #define GST_TAG_COPYRIGHT "copyright"
322 * contact information
324 #define GST_TAG_CONTACT "contact"
330 #define GST_TAG_LICENSE "license"
334 * person(s) performing
336 #define GST_TAG_PERFORMER "performer"
340 * length in GStreamer time units (nanoseconds)
342 #define GST_TAG_DURATION "duration"
346 * codec the data is stored in
348 #define GST_TAG_CODEC "codec"
350 * GST_TAG_VIDEO_CODEC:
352 * codec the video data is stored in
354 #define GST_TAG_VIDEO_CODEC "video-codec"
356 * GST_TAG_AUDIO_CODEC:
358 * codec the audio data is stored in
360 #define GST_TAG_AUDIO_CODEC "audio-codec"
364 * exact or average bitrate in bits/s
366 #define GST_TAG_BITRATE "bitrate"
368 * GST_TAG_NOMINAL_BITRATE:
370 * nominal bitrate in bits/s
372 #define GST_TAG_NOMINAL_BITRATE "nominal-bitrate"
374 * GST_TAG_MINIMUM_BITRATE:
376 * minimum bitrate in bits/s
378 #define GST_TAG_MINIMUM_BITRATE "minimum-bitrate"
380 * GST_TAG_MAXIMUM_BITRATE:
382 * maximum bitrate in bits/s
384 #define GST_TAG_MAXIMUM_BITRATE "maximum-bitrate"
388 * serial number of track
390 #define GST_TAG_SERIAL "serial"
394 * encoder used to encode this stream
396 #define GST_TAG_ENCODER "encoder"
398 * GST_TAG_ENCODER_VERSION:
400 * version of the encoder used to encode this stream
402 #define GST_TAG_ENCODER_VERSION "encoder-version"
404 * GST_TAG_TRACK_GAIN:
408 #define GST_TAG_TRACK_GAIN "replaygain-track-gain"
410 * GST_TAG_TRACK_PEAK:
414 #define GST_TAG_TRACK_PEAK "replaygain-track-peak"
416 * GST_TAG_ALBUM_GAIN:
420 #define GST_TAG_ALBUM_GAIN "replaygain-album-gain"
422 * GST_TAG_ALBUM_PEAK:
426 #define GST_TAG_ALBUM_PEAK "replaygain-album-peak"
428 * GST_TAG_LANGUAGE_CODE:
430 * Language code (ISO-639-1)
432 #define GST_TAG_LANGUAGE_CODE "language-code"
436 #endif /* __GST_EVENT_H__ */