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/gstminiobject.h>
  32 #include <gst/gststructure.h>
  33 #include <gst/gstformat.h>
  34
  35 G_BEGIN_DECLS
  36
  37 typedef enum {
  38   GST_QUERY_NONE = 0,
  39   GST_QUERY_POSITION,   /* get current/end position */
  40   GST_QUERY_LATENCY,    /* get current latency */
  41   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
  42   GST_QUERY_RATE,       /* get current playback rate */
  43   GST_QUERY_SEEKING,    /* get seeking start/stop positions */
  44   GST_QUERY_CONVERT,    /* convert values */
  45   GST_QUERY_FORMATS     /* query supported formats for convert */
  46 } GstQueryType;
  47
  48 /* rate is relative to 1000000  */
  49 #define GST_QUERY_TYPE_RATE_DEN          G_GINT64_CONSTANT (1000000)
  50
  51 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  52 typedef struct _GstQuery GstQuery;
  53 typedef struct _GstQueryClass GstQueryClass;
  54
  55 struct _GstQueryTypeDefinition
  56 {
  57   GstQueryType   value;
  58   gchar         *nick;
  59   gchar         *description;
  60 };
  61
  62 #ifdef G_HAVE_ISO_VARARGS
  63 #define GST_QUERY_TYPE_FUNCTION(type, functionname, ...)        \
  64 static const GstQueryType*                              \
  65 functionname (type object)                              \
  66 {                                                       \
  67   static const GstQueryType types[] = {                 \
  68     __VA_ARGS__,                                        \
  69     0                                                   \
  70   };                                                    \
  71   return types;                                         \
  72 }
  73 #elif defined(G_HAVE_GNUC_VARARGS)
  74 #define GST_QUERY_TYPE_FUNCTION(type, functionname, a...)       \
  75 static const GstQueryType*                              \
  76 functionname (type object)                              \
  77 {                                                       \
  78   static const GstQueryType types[] = {                 \
  79     a,                                                  \
  80     0                                                   \
  81   };                                                    \
  82   return types;                                         \
  83 }
  84 #endif
  85
  86 #define GST_TYPE_QUERY                          (gst_query_get_type())
  87 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
  88 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
  89 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
  90 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
  91 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
  92
  93 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
  94
  95 struct _GstQuery
  96 {
  97   GstMiniObject mini_object;
  98
  99   /*< public > */
 100   GstQueryType type;
 101
 102   GstStructure *structure;
 103
 104   /*< private > */
 105   gpointer _gst_reserved[GST_PADDING];
 106 };
 107
 108 struct _GstQueryClass {
 109   GstMiniObjectClass mini_object_class;
 110
 111   /*< private > */
 112   gpointer _gst_reserved[GST_PADDING];
 113 };
 114
 115 void            _gst_query_initialize          (void);
 116 GType           gst_query_get_type             (void);
 117
 118 /* register a new query */
 119 GstQueryType    gst_query_type_register        (const gchar *nick,
 120                                                 const gchar *description);
 121 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 122
 123 /* check if a query is in an array of querys */
 124 gboolean        gst_query_types_contains       (const GstQueryType *types,
 125                                                 GstQueryType type);
 126
 127 /* query for query details */
 128 G_CONST_RETURN GstQueryTypeDefinition*
 129                 gst_query_type_get_details         (GstQueryType type);
 130 GstIterator*    gst_query_type_iterate_definitions (void);
 131
 132 /* refcounting */
 133 #define         gst_query_ref(msg)              GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (msg)))
 134 #define         gst_query_unref(msg)            gst_mini_object_unref (GST_MINI_OBJECT (msg))
 135 /* copy query */
 136 #define         gst_query_copy(msg)             GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (msg)))
 137 #define         gst_query_make_writable(msg)    GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (msg)))
 138
 139 /* position query */
 140 GstQuery*       gst_query_new_position          (GstFormat format);
 141 void            gst_query_set_position          (GstQuery *query, GstFormat format,
 142                                                  gint64 cur, gint64 end);
 143 void            gst_query_parse_position        (GstQuery *query, GstFormat *format,
 144                                                  gint64 *cur, gint64 *end);
 145 /* convert query */
 146 GstQuery*       gst_query_new_convert           (GstFormat src_fmt, gint64 value, GstFormat dest_fmt);
 147 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 148                                                  GstFormat dest_format, gint64 dest_value);
 149 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 150                                                  GstFormat *dest_format, gint64 *dest_value);
 151
 152 /* application specific query */
 153 GstQuery *      gst_query_new_application       (GstQueryType type,
 154                                                  GstStructure *structure);
 155
 156
 157 GstStructure *  gst_query_get_structure         (GstQuery *query);
 158
 159 G_END_DECLS
 160
 161 #endif /* __GST_QUERY_H__ */
 162