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  *                    2011 Wim Taymans <wim.taymans@gmail.com>
   6  *
   7  * gstquery.h: GstQuery API declaration
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25
  26 #ifndef __GST_QUERY_H__
  27 #define __GST_QUERY_H__
  28
  29 #include <glib.h>
  30
  31 #include <gst/gstiterator.h>
  32 #include <gst/gstminiobject.h>
  33 #include <gst/gststructure.h>
  34 #include <gst/gstformat.h>
  35 #include <gst/gstpad.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /**
  40  * GstQueryType:
  41  * @GST_QUERY_NONE: invalid query type
  42  * @GST_QUERY_POSITION: current position in stream
  43  * @GST_QUERY_DURATION: total duration of the stream
  44  * @GST_QUERY_LATENCY: latency of stream
  45  * @GST_QUERY_JITTER: current jitter of stream
  46  * @GST_QUERY_RATE: current rate of the stream
  47  * @GST_QUERY_SEEKING: seeking capabilities
  48  * @GST_QUERY_SEGMENT: segment start/stop positions
  49  * @GST_QUERY_CONVERT: convert values between formats
  50  * @GST_QUERY_FORMATS: query supported formats for convert
  51  * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
  52  * 0.10.20.
  53  * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
  54  * 0.10.22.
  55  * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
  56  * @GST_QUERY_ALLOCATION: the buffer allocation properties
  57  * @GST_QUERY_SCHEDULING: the scheduling properties
  58  * @GST_QUERY_ACCEPT_CAPS: the accept caps query
  59  *
  60  * Standard predefined Query types
  61  */
  62 /* NOTE: don't forget to update the table in gstquery.c when changing
  63  * this enum */
  64 typedef enum {
  65   GST_QUERY_NONE = 0,
  66   GST_QUERY_POSITION,
  67   GST_QUERY_DURATION,
  68   GST_QUERY_LATENCY,
  69   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
  70   GST_QUERY_RATE,
  71   GST_QUERY_SEEKING,
  72   GST_QUERY_SEGMENT,
  73   GST_QUERY_CONVERT,
  74   GST_QUERY_FORMATS,
  75   GST_QUERY_BUFFERING,
  76   GST_QUERY_CUSTOM,
  77   GST_QUERY_URI,
  78   GST_QUERY_ALLOCATION,
  79   GST_QUERY_SCHEDULING,
  80   GST_QUERY_ACCEPT_CAPS,
  81   GST_QUERY_LAST
  82 } GstQueryType;
  83
  84 /**
  85  * GstBufferingMode:
  86  * @GST_BUFFERING_STREAM: a small amount of data is buffered
  87  * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
  88  * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
  89  * @GST_BUFFERING_LIVE: the stream is a live stream
  90  *
  91  * The different types of buffering methods.
  92  */
  93 typedef enum {
  94   GST_BUFFERING_STREAM,
  95   GST_BUFFERING_DOWNLOAD,
  96   GST_BUFFERING_TIMESHIFT,
  97   GST_BUFFERING_LIVE
  98 } GstBufferingMode;
  99
 100 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
 101 typedef struct _GstQuery GstQuery;
 102
 103 /**
 104  * GstQueryTypeDefinition:
 105  * @value: the unique id of the Query type
 106  * @nick: a short nick
 107  * @description: a longer description of the query type
 108  * @quark: the quark for the nick
 109  *
 110  * A Query Type definition
 111  */
 112 struct _GstQueryTypeDefinition
 113 {
 114   GstQueryType   value;
 115   const gchar   *nick;
 116   const gchar   *description;
 117   GQuark         quark;
 118 };
 119
 120 #define GST_TYPE_QUERY                         (gst_query_get_type())
 121 #define GST_IS_QUERY(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
 122 #define GST_QUERY_CAST(obj)                    ((GstQuery*)(obj))
 123 #define GST_QUERY(obj)                         (GST_QUERY_CAST(obj))
 124
 125
 126 /**
 127  * GST_QUERY_TYPE:
 128  * @query: the query to query
 129  *
 130  * Get the #GstQueryType of the query.
 131  */
 132 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
 133
 134 /**
 135  * GST_QUERY_TYPE_NAME:
 136  * @query: the query to query
 137  *
 138  * Get a constant string representation of the #GstQueryType of the query.
 139  *
 140  * Since: 0.10.4
 141  */
 142 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
 143
 144
 145 /**
 146  * GstQuery:
 147  * @mini_object: The parent #GstMiniObject type
 148  * @type: the #GstQueryType
 149  *
 150  * The #GstQuery structure.
 151  */
 152 struct _GstQuery
 153 {
 154   GstMiniObject mini_object;
 155
 156   /*< public > *//* with COW */
 157   GstQueryType type;
 158 };
 159
 160 const gchar*    gst_query_type_get_name        (GstQueryType query);
 161 GQuark          gst_query_type_to_quark        (GstQueryType query);
 162
 163 GType           gst_query_get_type             (void);
 164
 165 /* register a new query */
 166 GstQueryType    gst_query_type_register        (const gchar *nick,
 167                                                 const gchar *description);
 168 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 169
 170 /* check if a query is in an array of querys */
 171 gboolean        gst_query_types_contains       (const GstQueryType *types,
 172                                                 GstQueryType type);
 173
 174 /* query for query details */
 175
 176 const GstQueryTypeDefinition*
 177                 gst_query_type_get_details         (GstQueryType type);
 178 GstIterator*    gst_query_type_iterate_definitions (void);
 179
 180 /* refcounting */
 181 /**
 182  * gst_query_ref:
 183  * @q: a #GstQuery to increase the refcount of.
 184  *
 185  * Increases the refcount of the given query by one.
 186  *
 187  * Returns: @q
 188  */
 189 #ifdef _FOOL_GTK_DOC_
 190 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
 191 #endif
 192
 193 static inline GstQuery *
 194 gst_query_ref (GstQuery * q)
 195 {
 196   return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
 197 }
 198
 199 /**
 200  * gst_query_unref:
 201  * @q: a #GstQuery to decrease the refcount of.
 202  *
 203  * Decreases the refcount of the query. If the refcount reaches 0, the query
 204  * will be freed.
 205  */
 206 #ifdef _FOOL_GTK_DOC_
 207 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
 208 #endif
 209
 210 static inline void
 211 gst_query_unref (GstQuery * q)
 212 {
 213   gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
 214 }
 215
 216 /* copy query */
 217 /**
 218  * gst_query_copy:
 219  * @q: a #GstQuery to copy.
 220  *
 221  * Copies the given query using the copy function of the parent #GstStructure.
 222  *
 223  * Free-function: gst_query_unref
 224  *
 225  * Returns: (transfer full): a new copy of @q.
 226  */
 227 #ifdef _FOOL_GTK_DOC_
 228 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
 229 #endif
 230
 231 static inline GstQuery *
 232 gst_query_copy (const GstQuery * q)
 233 {
 234   return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
 235 }
 236
 237 /**
 238  * gst_query_is_writable:
 239  * @q: a #GstQuery
 240  *
 241  * Tests if you can safely write data into a query's structure.
 242  */
 243 #define         gst_query_is_writable(q)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
 244 /**
 245  * gst_query_make_writable:
 246  * @q: (transfer full): a #GstQuery to make writable
 247  *
 248  * Makes a writable query from the given query.
 249  *
 250  * Returns: (transfer full): a new writable query (possibly same as @q)
 251  */
 252 #define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
 253 /**
 254  * gst_query_replace:
 255  * @old_query: (inout) (transfer full): pointer to a pointer to a #GstQuery
 256  *     to be replaced.
 257  * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
 258  *     replace the query pointed to by @old_query.
 259  *
 260  * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
 261  * modification is done atomically (so this is useful for ensuring thread safety
 262  * in some cases), and the reference counts are updated appropriately (the old
 263  * query is unreffed, the new one is reffed).
 264  *
 265  * Either @new_query or the #GstQuery pointed to by @old_query may be NULL.
 266  */
 267 #define         gst_query_replace(old_query,new_query) \
 268     gst_mini_object_replace ((GstMiniObject **)(old_query), GST_MINI_OBJECT_CAST (new_query))
 269
 270
 271 /* application specific query */
 272 GstQuery *      gst_query_new_custom            (GstQueryType type, GstStructure *structure);
 273 const GstStructure *
 274                 gst_query_get_structure         (GstQuery *query);
 275 GstStructure *  gst_query_writable_structure    (GstQuery *query);
 276
 277 /* position query */
 278 GstQuery*       gst_query_new_position          (GstFormat format);
 279 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
 280 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 281
 282 /* duration query */
 283 GstQuery*       gst_query_new_duration          (GstFormat format);
 284 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
 285 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
 286
 287 /* latency query */
 288 GstQuery*       gst_query_new_latency           (void);
 289 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
 290                                                  GstClockTime max_latency);
 291 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
 292                                                  GstClockTime *max_latency);
 293
 294 /* convert query */
 295 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
 296 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 297                                                  GstFormat dest_format, gint64 dest_value);
 298 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 299                                                  GstFormat *dest_format, gint64 *dest_value);
 300 /* segment query */
 301 GstQuery*       gst_query_new_segment           (GstFormat format);
 302 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
 303                                                  gint64 start_value, gint64 stop_value);
 304 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
 305                                                  gint64 *start_value, gint64 *stop_value);
 306
 307 /* seeking query */
 308 GstQuery*       gst_query_new_seeking           (GstFormat format);
 309 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
 310                                                  gboolean seekable,
 311                                                  gint64 segment_start,
 312                                                  gint64 segment_end);
 313 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
 314                                                  gboolean *seekable,
 315                                                  gint64 *segment_start,
 316                                                  gint64 *segment_end);
 317 /* formats query */
 318 GstQuery*       gst_query_new_formats           (void);
 319 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 320 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, const GstFormat *formats);
 321 void            gst_query_parse_n_formats       (GstQuery *query, guint *n_formats);
 322 void            gst_query_parse_nth_format      (GstQuery *query, guint nth, GstFormat *format);
 323
 324 /* buffering query */
 325 GstQuery*       gst_query_new_buffering           (GstFormat format);
 326 void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
 327 void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
 328
 329 void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
 330                                                    gint avg_in, gint avg_out,
 331                                                    gint64 buffering_left);
 332 void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
 333                                                    gint *avg_in, gint *avg_out,
 334                                                    gint64 *buffering_left);
 335
 336 void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
 337                                                    gint64 start, gint64 stop,
 338                                                    gint64 estimated_total);
 339 void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
 340                                                    gint64 *start, gint64 *stop,
 341                                                    gint64 *estimated_total);
 342
 343 gboolean        gst_query_add_buffering_range       (GstQuery *query,
 344                                                      gint64 start, gint64 stop);
 345 guint           gst_query_get_n_buffering_ranges    (GstQuery *query);
 346 gboolean        gst_query_parse_nth_buffering_range (GstQuery *query,
 347                                                      guint index, gint64 *start,
 348                                                      gint64 *stop);
 349
 350 /* URI query */
 351 GstQuery *      gst_query_new_uri                 (void);
 352 void            gst_query_parse_uri               (GstQuery *query, gchar **uri);
 353 void            gst_query_set_uri                 (GstQuery *query, const gchar *uri);
 354
 355 /* allocation query */
 356 GstQuery *      gst_query_new_allocation          (GstCaps *caps, gboolean need_pool);
 357 void            gst_query_parse_allocation        (GstQuery *query, GstCaps **caps, gboolean *need_pool);
 358
 359 void            gst_query_set_allocation_params   (GstQuery *query, guint size, guint min_buffers,
 360                                                    guint max_buffers, guint prefix, guint alignment,
 361                                                    GstBufferPool *pool);
 362 void            gst_query_parse_allocation_params (GstQuery *query, guint *size, guint *min_buffers,
 363                                                    guint *max_buffers, guint *prefix, guint *alignment,
 364                                                    GstBufferPool **pool);
 365
 366 void            gst_query_add_allocation_meta       (GstQuery *query, const gchar *api);
 367 guint           gst_query_get_n_allocation_metas    (GstQuery *query);
 368 const gchar *   gst_query_parse_nth_allocation_meta (GstQuery *query, guint index);
 369 gboolean        gst_query_has_allocation_meta       (GstQuery *query, const gchar *api);
 370
 371 void            gst_query_add_allocation_memory       (GstQuery *query, const gchar *alloc);
 372 guint           gst_query_get_n_allocation_memories   (GstQuery *query);
 373 const gchar *   gst_query_parse_nth_allocation_memory (GstQuery *query, guint index);
 374
 375 /* scheduling query */
 376 GstQuery *      gst_query_new_scheduling          (void);
 377
 378 void            gst_query_set_scheduling          (GstQuery *query, gboolean pull_mode,
 379                                                    gboolean random_access, gboolean sequential,
 380                                                    gint minsize, gint maxsize, gint align);
 381 void            gst_query_parse_scheduling        (GstQuery *query, gboolean *pull_mode,
 382                                                    gboolean *random_access, gboolean *sequential,
 383                                                    gint *minsize, gint *maxsize, gint *align);
 384 /* accept-caps query */
 385 GstQuery *      gst_query_new_accept_caps          (GstCaps *caps);
 386 void            gst_query_parse_accept_caps        (GstQuery *query, GstCaps **caps);
 387 void            gst_query_set_accept_caps_result   (GstQuery *query, gboolean result);
 388 void            gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
 389
 390 G_END_DECLS
 391
 392 #endif /* __GST_QUERY_H__ */
 393