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  * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
  50  * 0.10.20.
  51  * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
  52  * 0.10.22.
  53  * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
  54  *
  55  * Standard predefined Query types
  56  */
  57 /* NOTE: don't forget to update the table in gstquery.c when changing
  58  * this enum */
  59 typedef enum {
  60   GST_QUERY_NONE = 0,
  61   GST_QUERY_POSITION,
  62   GST_QUERY_DURATION,
  63   GST_QUERY_LATENCY,
  64   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
  65   GST_QUERY_RATE,
  66   GST_QUERY_SEEKING,
  67   GST_QUERY_SEGMENT,
  68   GST_QUERY_CONVERT,
  69   GST_QUERY_FORMATS,
  70   GST_QUERY_BUFFERING,
  71   GST_QUERY_CUSTOM,
  72   GST_QUERY_URI
  73 } GstQueryType;
  74
  75 /**
  76  * GstBufferingMode:
  77  * @GST_BUFFERING_STREAM: a small amount of data is buffered
  78  * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
  79  * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
  80  * @GST_BUFFERING_LIVE: the stream is a live stream
  81  *
  82  * The different types of buffering methods.
  83  */
  84 typedef enum {
  85   GST_BUFFERING_STREAM,
  86   GST_BUFFERING_DOWNLOAD,
  87   GST_BUFFERING_TIMESHIFT,
  88   GST_BUFFERING_LIVE
  89 } GstBufferingMode;
  90
  91 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  92 typedef struct _GstQuery GstQuery;
  93 typedef struct _GstQueryClass GstQueryClass;
  94
  95 /**
  96  * GstQueryTypeDefinition:
  97  * @value: the unique id of the Query type
  98  * @nick: a short nick
  99  * @description: a longer description of the query type
 100  * @quark: the quark for the nick
 101  *
 102  * A Query Type definition
 103  */
 104 struct _GstQueryTypeDefinition
 105 {
 106   GstQueryType   value;
 107   gchar         *nick;
 108   gchar         *description;
 109   GQuark         quark;
 110 };
 111
 112 #define GST_TYPE_QUERY                          (gst_query_get_type())
 113 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
 114 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
 115 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
 116 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
 117 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
 118
 119 /**
 120  * GST_QUERY_TYPE:
 121  * @query: the query to query
 122  *
 123  * Get the #GstQueryType of the query.
 124  */
 125 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
 126
 127 /**
 128  * GST_QUERY_TYPE_NAME:
 129  * @query: the query to query
 130  *
 131  * Get a constant string representation of the #GstQueryType of the query.
 132  *
 133  * Since: 0.10.4
 134  */
 135 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
 136
 137
 138 /**
 139  * GstQuery:
 140  * @mini_object: The parent #GstMiniObject type
 141  * @type: the #GstQueryType
 142  * @structure: the #GstStructure containing the query details.
 143  *
 144  * The #GstQuery structure.
 145  */
 146 struct _GstQuery
 147 {
 148   GstMiniObject mini_object;
 149
 150   /*< public > *//* with COW */
 151   GstQueryType type;
 152
 153   GstStructure *structure;
 154
 155   /*< private > */
 156   gpointer _gst_reserved;
 157 };
 158
 159 struct _GstQueryClass {
 160   GstMiniObjectClass mini_object_class;
 161
 162   /*< private > */
 163   gpointer _gst_reserved[GST_PADDING];
 164 };
 165
 166 const gchar*    gst_query_type_get_name        (GstQueryType query);
 167 GQuark          gst_query_type_to_quark        (GstQueryType query);
 168
 169 GType           gst_query_get_type             (void);
 170
 171 /* register a new query */
 172 GstQueryType    gst_query_type_register        (const gchar *nick,
 173                                                 const gchar *description);
 174 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 175
 176 /* check if a query is in an array of querys */
 177 gboolean        gst_query_types_contains       (const GstQueryType *types,
 178                                                 GstQueryType type);
 179
 180 /* query for query details */
 181
 182 G_CONST_RETURN GstQueryTypeDefinition*
 183                 gst_query_type_get_details         (GstQueryType type);
 184 GstIterator*    gst_query_type_iterate_definitions (void);
 185
 186 /* refcounting */
 187 /**
 188  * gst_query_ref:
 189  * @q: a #GstQuery to increase the refcount of.
 190  *
 191  * Increases the refcount of the given query by one.
 192  *
 193  * Returns: @q
 194  */
 195 #ifdef _FOOL_GTK_DOC_
 196 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
 197 #endif
 198
 199 static inline GstQuery *
 200 gst_query_ref (GstQuery * q)
 201 {
 202   return GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
 203 }
 204
 205 /**
 206  * gst_query_unref:
 207  * @q: a #GstQuery to decrease the refcount of.
 208  *
 209  * Decreases the refcount of the query. If the refcount reaches 0, the query
 210  * will be freed.
 211  */
 212 #ifdef _FOOL_GTK_DOC_
 213 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
 214 #endif
 215
 216 static inline void
 217 gst_query_unref (GstQuery * q)
 218 {
 219   gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
 220 }
 221
 222 /* copy query */
 223 /**
 224  * gst_query_copy:
 225  * @q: a #GstQuery to copy.
 226  *
 227  * Copies the given query using the copy function of the parent #GstData
 228  * structure.
 229  *
 230  * Returns: a new copy of @q.
 231  */
 232 #ifdef _FOOL_GTK_DOC_
 233 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
 234 #endif
 235
 236 static inline GstQuery *
 237 gst_query_copy (const GstQuery * q)
 238 {
 239   return GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT_CAST (q)));
 240 }
 241
 242 /**
 243  * gst_query_make_writable:
 244  * @q: a #GstQuery to make writable
 245  *
 246  * Makes a writable query from the given query.
 247  */
 248 #define         gst_query_make_writable(q)      GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
 249
 250 /* position query */
 251 GstQuery*       gst_query_new_position          (GstFormat format);
 252 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
 253 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 254
 255 /* duration query */
 256 GstQuery*       gst_query_new_duration          (GstFormat format);
 257 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
 258 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
 259
 260 /* latency query */
 261 GstQuery*       gst_query_new_latency           (void);
 262 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
 263                                                  GstClockTime max_latency);
 264 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
 265                                                  GstClockTime *max_latency);
 266
 267 /* convert query */
 268 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
 269 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 270                                                  GstFormat dest_format, gint64 dest_value);
 271 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 272                                                  GstFormat *dest_format, gint64 *dest_value);
 273 /* segment query */
 274 GstQuery*       gst_query_new_segment           (GstFormat format);
 275 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
 276                                                  gint64 start_value, gint64 stop_value);
 277 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
 278                                                  gint64 *start_value, gint64 *stop_value);
 279
 280 /* application specific query */
 281 GstQuery *      gst_query_new_application       (GstQueryType type,
 282                                                  GstStructure *structure);
 283 GstStructure *  gst_query_get_structure         (GstQuery *query);
 284
 285 /* seeking query */
 286 GstQuery*       gst_query_new_seeking           (GstFormat format);
 287 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
 288                                                  gboolean seekable,
 289                                                  gint64 segment_start,
 290                                                  gint64 segment_end);
 291 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
 292                                                  gboolean *seekable,
 293                                                  gint64 *segment_start,
 294                                                  gint64 *segment_end);
 295 /* formats query */
 296 GstQuery*       gst_query_new_formats           (void);
 297 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 298 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, GstFormat *formats);
 299 void            gst_query_parse_formats_length  (GstQuery *query, guint *n_formats);
 300 void            gst_query_parse_formats_nth     (GstQuery *query, guint nth, GstFormat *format);
 301
 302 /* buffering query */
 303 GstQuery*       gst_query_new_buffering           (GstFormat format);
 304 void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
 305 void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
 306
 307 void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
 308                                                    gint avg_in, gint avg_out,
 309                                                    gint64 buffering_left);
 310 void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
 311                                                    gint *avg_in, gint *avg_out,
 312                                                    gint64 *buffering_left);
 313
 314 void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
 315                                                    gint64 start, gint64 stop,
 316                                                    gint64 estimated_total);
 317 void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
 318                                                    gint64 *start, gint64 *stop,
 319                                                    gint64 *estimated_total);
 320 /* URI query */
 321 GstQuery *      gst_query_new_uri                 (void);
 322 void            gst_query_parse_uri               (GstQuery *query, gchar **uri);
 323 void            gst_query_set_uri                 (GstQuery *query, const gchar *uri);
 324
 325 G_END_DECLS
 326
 327 #endif /* __GST_QUERY_H__ */
 328