gst/gststructure.h

   1 /* GStreamer
   2  * Copyright (C) 2003 David A. Schleef <ds@schleef.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __GST_STRUCTURE_H__
  21 #define __GST_STRUCTURE_H__
  22
  23 #include <gst/gstconfig.h>
  24 #include <gst/gsttypes.h>
  25 #include <glib-object.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_STRUCTURE             (gst_structure_get_type ())
  30 #define GST_STRUCTURE(object)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GST_TYPE_STRUCTURE, GstStructure))
  31 #define GST_IS_STRUCTURE(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), GST_TYPE_STRUCTURE))
  32
  33 typedef struct _GstStructure GstStructure;
  34
  35 typedef gboolean (*GstStructureForeachFunc) (GQuark   field_id,
  36                                              GValue * value,
  37                                              gpointer user_data);
  38
  39 struct _GstStructure {
  40   GType type;
  41
  42   GQuark name;
  43
  44   GArray *fields;
  45
  46   gpointer _gst_reserved[GST_PADDING];
  47 };
  48
  49 GType                   gst_structure_get_type             (void) G_GNUC_CONST;
  50
  51 GstStructure *          gst_structure_empty_new            (const gchar *            name);
  52 GstStructure *          gst_structure_id_empty_new         (GQuark                   quark);
  53 GstStructure *          gst_structure_new                  (const gchar *            name,
  54                                                             const gchar *            firstfield,
  55                                                             ...);
  56 GstStructure *          gst_structure_new_valist           (const gchar *            name,
  57                                                             const gchar *            firstfield,
  58                                                             va_list                  varargs);
  59 GstStructure *          gst_structure_copy                 (const GstStructure      *structure);
  60 void                    gst_structure_free                 (GstStructure            *structure);
  61
  62 G_CONST_RETURN gchar *  gst_structure_get_name             (const GstStructure      *structure);
  63 void                    gst_structure_set_name             (GstStructure            *structure,
  64                                                             const gchar             *name);
  65
  66 void                    gst_structure_id_set_value         (GstStructure            *structure,
  67                                                             GQuark                   field,
  68                                                             const GValue            *value);
  69 void                    gst_structure_set_value            (GstStructure            *structure,
  70                                                             const gchar             *fieldname,
  71                                                             const GValue            *value);
  72 void                    gst_structure_set                  (GstStructure            *structure,
  73                                                             const gchar             *fieldname,
  74                                                             ...);
  75 void                    gst_structure_set_valist           (GstStructure            *structure,
  76                                                             const gchar             *fieldname,
  77                                                             va_list varargs);
  78 G_CONST_RETURN GValue * gst_structure_id_get_value         (const GstStructure      *structure,
  79                                                             GQuark                   field);
  80 G_CONST_RETURN GValue * gst_structure_get_value            (const GstStructure      *structure,
  81                                                             const gchar             *fieldname);
  82 void                    gst_structure_remove_field         (GstStructure            *structure,
  83                                                             const gchar             *fieldname);
  84 void                    gst_structure_remove_fields        (GstStructure            *structure,
  85                                                              const gchar            *fieldname,
  86                                                             ...);
  87 void                    gst_structure_remove_fields_valist (GstStructure             *structure,
  88                                                             const gchar             *fieldname,
  89                                                             va_list                  varargs);
  90 void                    gst_structure_remove_all_fields    (GstStructure            *structure);
  91
  92 GType                   gst_structure_get_field_type       (const GstStructure      *structure,
  93                                                             const gchar             *fieldname);
  94 gboolean                gst_structure_foreach              (GstStructure            *structure,
  95                                                             GstStructureForeachFunc  func,
  96                                                             gpointer                 user_data);
  97 gint                    gst_structure_n_fields             (const GstStructure      *structure);
  98 gboolean                gst_structure_has_field            (const GstStructure      *structure,
  99                                                             const gchar             *fieldname);
 100 gboolean                gst_structure_has_field_typed      (const GstStructure      *structure,
 101                                                             const gchar             *fieldname,
 102                                                             GType                    type);
 103
 104 /* utility functions */
 105 gboolean                gst_structure_get_boolean          (const GstStructure      *structure,
 106                                                             const gchar             *fieldname,
 107                                                             gboolean                *value);
 108 gboolean                gst_structure_get_int              (const GstStructure      *structure,
 109                                                             const gchar             *fieldname,
 110                                                             gint                    *value);
 111 gboolean                gst_structure_get_fourcc           (const GstStructure      *structure,
 112                                                             const gchar             *fieldname,
 113                                                             guint32                 *value);
 114 gboolean                gst_structure_get_double           (const GstStructure      *structure,
 115                                                             const gchar             *fieldname,
 116                                                             gdouble                 *value);
 117 G_CONST_RETURN gchar *  gst_structure_get_string           (const GstStructure      *structure,
 118                                                             const gchar             *fieldname);
 119
 120 gchar *                 gst_structure_to_string            (const GstStructure      *structure);
 121 GstStructure *          gst_structure_from_string          (const gchar             *string,
 122                                                             gchar                  **end);
 123
 124 G_END_DECLS
 125
 126 #endif
 127