gst/gstquery.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstquery.h: GstQuery API declaration
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 #ifndef __GST_QUERY_H__
  26 #define __GST_QUERY_H__
  27
  28 #include <glib.h>
  29
  30 #include <gst/gstiterator.h>
  31 #include <gst/gstdata.h>
  32 #include <gst/gststructure.h>
  33
  34 G_BEGIN_DECLS
  35
  36 typedef enum {
  37   GST_QUERY_NONE = 0,
  38   GST_QUERY_TOTAL, /* deprecated, use POSITION */
  39   GST_QUERY_POSITION,
  40   GST_QUERY_LATENCY,
  41   GST_QUERY_JITTER, /* not in draft-query, necessary? */
  42   GST_QUERY_START, /* deprecated, use SEEKING */
  43   GST_QUERY_SEGMENT_END, /* deprecated, use SEEKING */
  44   GST_QUERY_RATE, /* not in draft-query, necessary? */
  45   GST_QUERY_SEEKING,
  46   GST_QUERY_CONVERT,
  47   GST_QUERY_FORMATS
  48 } GstQueryType;
  49
  50 /* rate is relative to 1000000  */
  51 #define GST_QUERY_TYPE_RATE_DEN          G_GINT64_CONSTANT (1000000)
  52
  53 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  54 typedef struct _GstQuery GstQuery;
  55
  56 struct _GstQueryTypeDefinition
  57 {
  58   GstQueryType   value;
  59   gchar         *nick;
  60   gchar         *description;
  61 };
  62
  63 #ifdef G_HAVE_ISO_VARARGS
  64 #define GST_QUERY_TYPE_FUNCTION(type, functionname, ...)        \
  65 static const GstQueryType*                              \
  66 functionname (type object)                              \
  67 {                                                       \
  68   static const GstQueryType types[] = {                 \
  69     __VA_ARGS__,                                        \
  70     0                                                   \
  71   };                                                    \
  72   return types;                                         \
  73 }
  74 #elif defined(G_HAVE_GNUC_VARARGS)
  75 #define GST_QUERY_TYPE_FUNCTION(type, functionname, a...)       \
  76 static const GstQueryType*                              \
  77 functionname (type object)                              \
  78 {                                                       \
  79   static const GstQueryType types[] = {                 \
  80     a,                                                  \
  81     0                                                   \
  82   };                                                    \
  83   return types;                                         \
  84 }
  85 #endif
  86
  87 GST_EXPORT GType _gst_query_type;
  88
  89 #define GST_TYPE_QUERY  (_gst_query_type)
  90 #define GST_QUERY(query)        ((GstQuery*)(query))
  91 #define GST_IS_QUERY(query)     (GST_DATA_TYPE(query) == GST_TYPE_QUERY)
  92 #define GST_QUERY_TYPE(query)   (((GstQuery*)(query))->type)
  93
  94 struct _GstQuery
  95 {
  96   GstData data;
  97
  98   /*< public > */
  99   GstQueryType type;
 100
 101   GstStructure *structure;
 102
 103   /*< private > */
 104   gpointer _gst_reserved[GST_PADDING];
 105 };
 106
 107 void            _gst_query_initialize          (void);
 108 GType           gst_query_get_type             (void);
 109
 110 /* register a new query */
 111 GstQueryType    gst_query_type_register        (const gchar *nick,
 112                                                 const gchar *description);
 113 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 114
 115 /* check if a query is in an array of querys */
 116 gboolean        gst_query_types_contains       (const GstQueryType *types,
 117                                                 GstQueryType type);
 118
 119 /* query for query details */
 120 G_CONST_RETURN GstQueryTypeDefinition*
 121                 gst_query_type_get_details         (GstQueryType type);
 122 GstIterator*    gst_query_type_iterate_definitions (void);
 123
 124 /* refcounting */
 125 #define         gst_query_ref(msg)              GST_QUERY (gst_data_ref (GST_DATA (msg)))
 126 #define         gst_query_ref_by_count(msg,c)   GST_QUERY (gst_data_ref_by_count (GST_DATA (msg), (c)))
 127 #define         gst_query_unref(msg)            gst_data_unref (GST_DATA (msg))
 128 /* copy query */
 129 #define         gst_query_copy(msg)             GST_QUERY (gst_data_copy (GST_DATA (msg)))
 130 #define         gst_query_copy_on_write(msg)    GST_QUERY (gst_data_copy_on_write (GST_DATA (msg)))
 131
 132 GstQuery *      gst_query_new_application       (GstQueryType type,
 133                                                  GstStructure *structure);
 134
 135 GstStructure *  gst_query_get_structure         (GstQuery *query);
 136
 137 /* hmm */
 138 #define GST_QUERY_POSITION_GET_FORMAT(q) \
 139     (gst_structure_get_int ((q)->structure, "format"))
 140
 141 G_END_DECLS
 142
 143 #endif /* __GST_QUERY_H__ */
 144