gst/gsttagsetter.c

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