gst/gsttaginterface.c

   1 /* GStreamer
   2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   3  *
   4  * gsttaginterface.c: interface for tag setting on elements
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include "gsttaginterface.h"
  28 #include <gobject/gvaluecollector.h>
  29 #include <string.h>
  30
  31 GST_DEBUG_CATEGORY_STATIC (gst_tag_interface_debug);
  32 #define GST_CAT_DEFAULT tag_tag_interface_debug
  33
  34 static GQuark gst_tag_key;
  35
  36 typedef struct
  37 {
  38   GstTagMergeMode mode;
  39   GstTagList *list;
  40 } GstTagData;
  41
  42 GType
  43 gst_tag_setter_get_type (void)
  44 {
  45   static GType tag_setter_type = 0;
  46
  47   if (!tag_setter_type) {
  48     static const GTypeInfo tag_setter_info = {
  49       sizeof (GstTagSetterIFace),       /* class_size */
  50       NULL,                     /* base_init */
  51       NULL,                     /* base_finalize */
  52       NULL,
  53       NULL,                     /* class_finalize */
  54       NULL,                     /* class_data */
  55       0,
  56       0,
  57       NULL
  58     };
  59
  60     GST_DEBUG_CATEGORY_INIT (gst_tag_interface_debug, "GstTagInterface", 0,
  61         "interfaces for tagging");
  62
  63     tag_setter_type = g_type_register_static (G_TYPE_INTERFACE, "GstTagSetter",
  64         &tag_setter_info, 0);
  65
  66     g_type_interface_add_prerequisite (tag_setter_type, GST_TYPE_ELEMENT);
  67
  68     gst_tag_key = g_quark_from_static_string ("GST_TAG_SETTER");
  69   }
  70
  71   return tag_setter_type;
  72 }
  73 static void
  74 gst_tag_data_free (gpointer p)
  75 {
  76   GstTagData *data = (GstTagData *) p;
  77
  78   if (data->list)
  79     gst_tag_list_free (data->list);
  80
  81   g_free (data);
  82 }
  83 static GstTagData *
  84 gst_tag_setter_get_data (GstTagSetter * setter)
  85 {
  86   GstTagData *data;
  87
  88   data = g_object_get_qdata (G_OBJECT (setter), gst_tag_key);
  89   if (!data) {
  90     data = g_new (GstTagData, 1);
  91     data->list = NULL;
  92     data->mode = GST_TAG_MERGE_KEEP;
  93     g_object_set_qdata_full (G_OBJECT (setter), gst_tag_key, data,
  94         gst_tag_data_free);
  95   }
  96
  97   return data;
  98 }
  99
 100 /**
 101  * gst_tag_setter_merge:
 102  * @setter: a #GstTagSetter
 103  * @list: a tag list to merge from
 104  * @mode: the mode to merge with
 105  *
 106  * Merges the given list into the setter's list using the given mode.
 107  */
 108 void
 109 gst_tag_setter_merge (GstTagSetter * setter, const GstTagList * list,
 110     GstTagMergeMode mode)
 111 {
 112   GstTagData *data;
 113
 114   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 115   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 116
 117   data = gst_tag_setter_get_data (setter);
 118   if (!data->list) {
 119     data->list = gst_tag_list_copy (list);
 120   } else {
 121     gst_tag_list_merge (data->list, list, mode);
 122   }
 123 }
 124
 125 /**
 126  * gst_tag_setter_add:
 127  * @setter: a #GstTagSetter
 128  * @mode: the mode to use
 129  * @tag: tag to set
 130  * @...: more tag / value pairs to set
 131  *
 132  * Adds the given tag / value pairs on the setter using the given merge mode.
 133  * The list must be terminated with GST_TAG_INVALID.
 134  */
 135 void
 136 gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode,
 137     const gchar * tag, ...)
 138 {
 139   va_list args;
 140
 141   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 142   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 143
 144   va_start (args, tag);
 145   gst_tag_setter_add_valist (setter, mode, tag, args);
 146   va_end (args);
 147 }
 148
 149 /**
 150  * gst_tag_setter_add_values:
 151  * @setter: a #GstTagSetter
 152  * @mode: the mode to use
 153  * @tag: tag to set
 154  * @...: more tag / GValue pairs to set
 155  *
 156  * Adds the given tag / GValue pairs on the setter using the given merge mode.
 157  * The list must be terminated with GST_TAG_INVALID.
 158  */
 159 void
 160 gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode,
 161     const gchar * tag, ...)
 162 {
 163   va_list args;
 164
 165   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 166   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 167
 168   va_start (args, tag);
 169   gst_tag_setter_add_valist_values (setter, mode, tag, args);
 170   va_end (args);
 171 }
 172
 173 /**
 174  * gst_tag_setter_add_valist:
 175  * @setter: a #GstTagSetter
 176  * @mode: the mode to use
 177  * @tag: tag to set
 178  * @var_args: tag / value pairs to set
 179  *
 180  * Adds the given tag / value pairs on the setter using the given merge mode.
 181  * The list must be terminated with GST_TAG_INVALID.
 182  */
 183 void
 184 gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode,
 185     const gchar * tag, va_list var_args)
 186 {
 187   GstTagData *data;
 188
 189   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 190   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 191
 192   data = gst_tag_setter_get_data (setter);
 193   if (!data->list)
 194     data->list = gst_tag_list_new ();
 195
 196   gst_tag_list_add_valist (data->list, mode, tag, var_args);
 197 }
 198
 199 /**
 200  * gst_tag_setter_add_valist_values:
 201  * @setter: a #GstTagSetter
 202  * @mode: the mode to use
 203  * @tag: tag to set
 204  * @var_args: tag / GValue pairs to set
 205  *
 206  * Adds the given tag / GValue pairs on the setter using the given merge mode.
 207  * The list must be terminated with GST_TAG_INVALID.
 208  */
 209 void
 210 gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode,
 211     const gchar * tag, va_list var_args)
 212 {
 213   GstTagData *data;
 214
 215   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 216   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 217
 218   data = gst_tag_setter_get_data (setter);
 219   if (!data->list)
 220     data->list = gst_tag_list_new ();
 221
 222   gst_tag_list_add_valist_values (data->list, mode, tag, var_args);
 223 }
 224
 225 /**
 226  * gst_tag_setter_get_list:
 227  * @setter: a #GstTagSetter
 228  *
 229  * Retrieves a copy of the current list of tags the setter uses.
 230  * You need to gst_tag_list_free() the list after use.
 231  *
 232  * Returns: a current snapshot of the taglist used in the setter
 233  *          or NULL if none is used.
 234  */
 235 const GstTagList *
 236 gst_tag_setter_get_list (GstTagSetter * setter)
 237 {
 238   g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL);
 239
 240   return gst_tag_setter_get_data (setter)->list;
 241 }
 242
 243 /**
 244  * gst_tag_setter_set_merge_mode:
 245  * @setter: a #GstTagSetter
 246  * @mode: The mode with which tags are added
 247  *
 248  * Sets the given merge mode that is used for adding tags from events to tags
 249  * specified by this interface. The default is #GST_TAG_MERGE_KEEP, which keeps
 250  * the tags by this interface and discards tags from events.
 251  */
 252 void
 253 gst_tag_setter_set_merge_mode (GstTagSetter * setter, GstTagMergeMode mode)
 254 {
 255   g_return_if_fail (GST_IS_TAG_SETTER (setter));
 256   g_return_if_fail (GST_TAG_MODE_IS_VALID (mode));
 257
 258   gst_tag_setter_get_data (setter)->mode = mode;
 259 }
 260
 261 /**
 262  * gst_tag_setter_get_merge_mode:
 263  * @setter: a #GstTagSetter
 264  *
 265  * Queries the mode by which tags inside the setter are overwritten by tags
 266  * from events
 267  *
 268  * Returns: the merge mode used inside the element.
 269  */
 270 GstTagMergeMode
 271 gst_tag_setter_get_merge_mode (GstTagSetter * setter)
 272 {
 273   g_return_val_if_fail (GST_IS_TAG_SETTER (setter), FALSE);
 274
 275   return gst_tag_setter_get_data (setter)->mode;
 276 }