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 /**
  38  * GstQueryType:
  39  * @GST_QUERY_NONE: invalid query type
  40  * @GST_QUERY_POSITION: current position in stream
  41  * @GST_QUERY_DURATION: total duration of the stream
  42  * @GST_QUERY_LATENCY: latency of stream
  43  * @GST_QUERY_JITTER: current jitter of stream
  44  * @GST_QUERY_RATE: current rate of the stream
  45  * @GST_QUERY_SEEKING: seeking capabilities
  46  * @GST_QUERY_SEGMENT: segment start/stop positions
  47  * @GST_QUERY_CONVERT: convert values between formats
  48  * @GST_QUERY_FORMATS: query supported formats for convert
  49  *
  50  * Standard predefined Query types
  51  */
  52 /* NOTE: don't forget to update the table in gstquery.c when changing
  53  * this enum */
  54 typedef enum {
  55   GST_QUERY_NONE = 0,
  56   GST_QUERY_POSITION,
  57   GST_QUERY_DURATION,
  58   GST_QUERY_LATENCY,
  59   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
  60   GST_QUERY_RATE,
  61   GST_QUERY_SEEKING,
  62   GST_QUERY_SEGMENT,
  63   GST_QUERY_CONVERT,
  64   GST_QUERY_FORMATS
  65 } GstQueryType;
  66
  67 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  68 typedef struct _GstQuery GstQuery;
  69 typedef struct _GstQueryClass GstQueryClass;
  70
  71 /**
  72  * GstQueryTypeDefinition:
  73  * @value: the unique id of the Query type
  74  * @nick: a short nick
  75  * @description: a longer description of the query type
  76  * @quark: the quark for the nick
  77  *
  78  * A Query Type definition
  79  */
  80 struct _GstQueryTypeDefinition
  81 {
  82   GstQueryType   value;
  83   gchar         *nick;
  84   gchar         *description;
  85   GQuark         quark;
  86 };
  87
  88 #define GST_TYPE_QUERY                          (gst_query_get_type())
  89 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
  90 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
  91 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
  92 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
  93 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
  94
  95 /**
  96  * GST_QUERY_TYPE:
  97  * @query: the query to query
  98  *
  99  * Get the #GstQueryType of the query.
 100  */
 101 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
 102
 103 /**
 104  * GST_QUERY_TYPE_NAME:
 105  * @query: the query to query
 106  *
 107  * Get a constant string representation of the #GstQueryType of the query.
 108  *
 109  * Since: 0.10.4
 110  */
 111 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
 112
 113
 114 /**
 115  * GstQuery:
 116  * @mini_object: The parent #GstMiniObject type
 117  * @type: the #GstQueryType
 118  * @structure: the #GstStructure containing the query details.
 119  *
 120  * The #GstQuery structure.
 121  */
 122 struct _GstQuery
 123 {
 124   GstMiniObject mini_object;
 125
 126   /*< public > *//* with COW */
 127   GstQueryType type;
 128
 129   GstStructure *structure;
 130
 131   /*< private > */
 132   gpointer _gst_reserved;
 133 };
 134
 135 struct _GstQueryClass {
 136   GstMiniObjectClass mini_object_class;
 137
 138   /*< private > */
 139   gpointer _gst_reserved[GST_PADDING];
 140 };
 141
 142 void            _gst_query_initialize          (void);
 143
 144 const gchar*    gst_query_type_get_name        (GstQueryType query);
 145 GQuark          gst_query_type_to_quark        (GstQueryType query);
 146
 147 GType           gst_query_get_type             (void);
 148
 149 /* register a new query */
 150 GstQueryType    gst_query_type_register        (const gchar *nick,
 151                                                 const gchar *description);
 152 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 153
 154 /* check if a query is in an array of querys */
 155 gboolean        gst_query_types_contains       (const GstQueryType *types,
 156                                                 GstQueryType type);
 157
 158 /* query for query details */
 159
 160 G_CONST_RETURN GstQueryTypeDefinition*
 161                 gst_query_type_get_details         (GstQueryType type);
 162 GstIterator*    gst_query_type_iterate_definitions (void);
 163
 164 /* refcounting */
 165 /**
 166  * gst_query_ref:
 167  * @q: a #GstQuery to increase the refcount of.
 168  *
 169  * Increases the refcount of the given query by one.
 170  */
 171 #define         gst_query_ref(q)                GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (q)))
 172 /**
 173  * gst_query_unref:
 174  * @q: a #GstQuery to decrease the refcount of.
 175  *
 176  * Decreases the refcount of the query. If the refcount reaches 0, the query
 177  * will be freed.
 178  */
 179 #define         gst_query_unref(q)              gst_mini_object_unref (GST_MINI_OBJECT (q))
 180
 181 /* copy query */
 182 /**
 183  * gst_query_copy:
 184  * @q: a #GstQuery to copy.
 185  *
 186  * Copies the given query using the copy function of the parent #GstData
 187  * structure.
 188  */
 189 #define         gst_query_copy(q)               GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (q)))
 190 /**
 191  * gst_query_make_writable:
 192  * @q: a #GstQuery to make writable
 193  *
 194  * Makes a writable query from the given query.
 195  */
 196 #define         gst_query_make_writable(q)      GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
 197
 198 /* position query */
 199 GstQuery*       gst_query_new_position          (GstFormat format);
 200 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
 201 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 202
 203 /* duration query */
 204 GstQuery*       gst_query_new_duration          (GstFormat format);
 205 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
 206 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
 207
 208 /* latency query */
 209 GstQuery*       gst_query_new_latency           (void);
 210 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
 211                                                  GstClockTime max_latency);
 212 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
 213                                                  GstClockTime *max_latency);
 214
 215 /* convert query */
 216 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
 217 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 218                                                  GstFormat dest_format, gint64 dest_value);
 219 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 220                                                  GstFormat *dest_format, gint64 *dest_value);
 221 /* segment query */
 222 GstQuery*       gst_query_new_segment           (GstFormat format);
 223 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
 224                                                  gint64 start_value, gint64 stop_value);
 225 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
 226                                                  gint64 *start_value, gint64 *stop_value);
 227
 228 /* application specific query */
 229 GstQuery *      gst_query_new_application       (GstQueryType type,
 230                                                  GstStructure *structure);
 231 GstStructure *  gst_query_get_structure         (GstQuery *query);
 232
 233 /* seeking query */
 234 GstQuery*       gst_query_new_seeking           (GstFormat format);
 235 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
 236                                                  gboolean seekable,
 237                                                  gint64 segment_start,
 238                                                  gint64 segment_end);
 239 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
 240                                                  gboolean *seekable,
 241                                                  gint64 *segment_start,
 242                                                  gint64 *segment_end);
 243 /* formats query */
 244 GstQuery*       gst_query_new_formats           (void);
 245 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 246 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, GstFormat *formats);
 247 void            gst_query_parse_formats_length  (GstQuery *query, guint *n_formats);
 248 void            gst_query_parse_formats_nth     (GstQuery *query, guint nth, GstFormat *format);
 249
 250 G_END_DECLS
 251
 252 #endif /* __GST_QUERY_H__ */
 253