2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttaginterface.c: interface for tag setting on elements
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.
27 #include "gsttaginterface.h"
28 #include <gobject/gvaluecollector.h>
31 GST_DEBUG_CATEGORY_STATIC (gst_tag_interface_debug);
32 #define GST_CAT_DEFAULT tag_tag_interface_debug
34 static GQuark gst_tag_key;
42 gst_tag_setter_get_type (void)
44 static GType tag_setter_type = 0;
46 if (! tag_setter_type) {
47 static const GTypeInfo tag_setter_info = {
48 sizeof (GstTagSetterIFace), /* class_size */
50 NULL, /* base_finalize */
52 NULL, /* class_finalize */
53 NULL, /* class_data */
59 GST_DEBUG_CATEGORY_INIT (gst_tag_interface_debug, "GstTagInterface", 0, "interfaces for tagging");
61 tag_setter_type = g_type_register_static (G_TYPE_INTERFACE, "GstTagSetter",
64 g_type_interface_add_prerequisite (tag_setter_type, GST_TYPE_ELEMENT);
66 gst_tag_key = g_quark_from_static_string ("GST_TAG_SETTER");
69 return tag_setter_type;
72 gst_tag_data_free (gpointer p)
74 GstTagData *data = (GstTagData *) p;
77 gst_tag_list_free (data->list);
82 gst_tag_setter_get_data (GstTagSetter *setter)
86 data = g_object_get_qdata (G_OBJECT (setter), gst_tag_key);
88 data = g_new (GstTagData, 1);
90 data->mode = GST_TAG_MERGE_KEEP;
91 g_object_set_qdata_full (G_OBJECT (setter), gst_tag_key, data, gst_tag_data_free);
97 * gst_tag_setter_merge:
98 * @setter: a #GstTagSetter
99 * @list: a tag list to merge from
100 * @mode: the mode to merge with
102 * Merges the given list into the setter's list using the given mode.
105 gst_tag_setter_merge (GstTagSetter *setter, const GstTagList *list, GstTagMergeMode mode)
109 g_return_if_fail (GST_IS_TAG_SETTER (setter));
110 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
112 data = gst_tag_setter_get_data (setter);
114 data->list = gst_tag_list_copy (list);
116 gst_tag_list_merge (data->list, list, mode);
120 * gst_tag_setter_add:
121 * @setter: a #GstTagSetter
122 * @mode: the mode to use
124 * @...: more tag / value pairs to set
126 * Adds the given tag / value pairs on the setter using the given merge mode.
127 * The list must be terminated with GST_TAG_INVALID.
130 gst_tag_setter_add (GstTagSetter *setter, GstTagMergeMode mode, const gchar *tag, ...)
134 g_return_if_fail (GST_IS_TAG_SETTER (setter));
135 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
137 va_start (args, tag);
138 gst_tag_setter_add_valist (setter, mode, tag, args);
142 * gst_tag_setter_add_values:
143 * @setter: a #GstTagSetter
144 * @mode: the mode to use
146 * @...: more tag / GValue pairs to set
148 * Adds the given tag / GValue pairs on the setter using the given merge mode.
149 * The list must be terminated with GST_TAG_INVALID.
152 gst_tag_setter_add_values (GstTagSetter *setter, GstTagMergeMode mode, const gchar *tag, ...)
156 g_return_if_fail (GST_IS_TAG_SETTER (setter));
157 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
159 va_start (args, tag);
160 gst_tag_setter_add_valist_values (setter, mode, tag, args);
164 * gst_tag_setter_add_valist:
165 * @setter: a #GstTagSetter
166 * @mode: the mode to use
168 * @var_args: tag / value pairs to set
170 * Adds the given tag / value pairs on the setter using the given merge mode.
171 * The list must be terminated with GST_TAG_INVALID.
174 gst_tag_setter_add_valist (GstTagSetter *setter, GstTagMergeMode mode, const gchar *tag, va_list var_args)
178 g_return_if_fail (GST_IS_TAG_SETTER (setter));
179 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
181 data = gst_tag_setter_get_data (setter);
183 data->list = gst_tag_list_new ();
185 gst_tag_list_add_valist (data->list, mode, tag, var_args);
188 * gst_tag_setter_add_valist_values:
189 * @setter: a #GstTagSetter
190 * @mode: the mode to use
192 * @var_args: tag / GValue pairs to set
194 * Adds the given tag / GValue pairs on the setter using the given merge mode.
195 * The list must be terminated with GST_TAG_INVALID.
198 gst_tag_setter_add_valist_values (GstTagSetter *setter, GstTagMergeMode mode, const gchar *tag, va_list var_args)
202 g_return_if_fail (GST_IS_TAG_SETTER (setter));
203 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
205 data = gst_tag_setter_get_data (setter);
207 data->list = gst_tag_list_new ();
209 gst_tag_list_add_valist_values (data->list, mode, tag, var_args);
212 * gst_tag_setter_get_list:
213 * @setter: a #GstTagSetter
215 * Retrieves a copy of the current list of tags the setter uses.
216 * You need to gst_tag_list_free() the list after use.
218 * Returns: a current snapshot of the taglist used in the setter
219 * or NULL if none is used.
222 gst_tag_setter_get_list (GstTagSetter *setter)
224 g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL);
226 return gst_tag_setter_get_data (setter)->list;
229 * gst_tag_setter_set_merge_mode:
230 * @setter: a #GstTagSetter
231 * @overwrite: The mode with which tags are added
233 * Sets the given merge mode that is used for adding tags from events to tags
234 * specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
235 * the tags by this interface and discards tags from events.
238 gst_tag_setter_set_merge_mode (GstTagSetter *setter, GstTagMergeMode mode)
240 g_return_if_fail (GST_IS_TAG_SETTER (setter));
241 g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
243 gst_tag_setter_get_data (setter)->mode = mode;
246 * gst_tag_setter_get_merge_mode:
247 * @setter: a #GstTagSetter
249 * Queries the mode by which tags inside the setter are overwritten by tags
252 * Returns: the merge mode used inside the element.
255 gst_tag_setter_get_merge_mode (GstTagSetter *setter)
257 g_return_val_if_fail (GST_IS_TAG_SETTER (setter), FALSE);
259 return gst_tag_setter_get_data (setter)->mode;