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  * @GST_QUERY_CAPS: the caps query
  60  *
  61  * Standard predefined Query types
  62  */
  63 /* NOTE: don't forget to update the table in gstquery.c when changing
  64  * this enum */
  65 typedef enum {
  66   GST_QUERY_NONE = 0,
  67   GST_QUERY_POSITION,
  68   GST_QUERY_DURATION,
  69   GST_QUERY_LATENCY,
  70   GST_QUERY_JITTER,     /* not in draft-query, necessary? */
  71   GST_QUERY_RATE,
  72   GST_QUERY_SEEKING,
  73   GST_QUERY_SEGMENT,
  74   GST_QUERY_CONVERT,
  75   GST_QUERY_FORMATS,
  76   GST_QUERY_BUFFERING,
  77   GST_QUERY_CUSTOM,
  78   GST_QUERY_URI,
  79   GST_QUERY_ALLOCATION,
  80   GST_QUERY_SCHEDULING,
  81   GST_QUERY_ACCEPT_CAPS,
  82   GST_QUERY_CAPS
  83 } GstQueryType;
  84
  85 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  86 typedef struct _GstQuery GstQuery;
  87
  88 /**
  89  * GstQueryTypeDefinition:
  90  * @value: the unique id of the Query type
  91  * @nick: a short nick
  92  * @description: a longer description of the query type
  93  * @quark: the quark for the nick
  94  *
  95  * A Query Type definition
  96  */
  97 struct _GstQueryTypeDefinition
  98 {
  99   GstQueryType   value;
 100   const gchar   *nick;
 101   const gchar   *description;
 102   GQuark         quark;
 103 };
 104
 105 #define GST_TYPE_QUERY                         (gst_query_get_type())
 106 #define GST_IS_QUERY(obj)                      (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_QUERY))
 107 #define GST_QUERY_CAST(obj)                    ((GstQuery*)(obj))
 108 #define GST_QUERY(obj)                         (GST_QUERY_CAST(obj))
 109
 110
 111 /**
 112  * GST_QUERY_TYPE:
 113  * @query: the query to query
 114  *
 115  * Get the #GstQueryType of the query.
 116  */
 117 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
 118
 119 /**
 120  * GST_QUERY_TYPE_NAME:
 121  * @query: the query to query
 122  *
 123  * Get a constant string representation of the #GstQueryType of the query.
 124  *
 125  * Since: 0.10.4
 126  */
 127 #define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
 128
 129
 130 /**
 131  * GstQuery:
 132  * @mini_object: The parent #GstMiniObject type
 133  * @type: the #GstQueryType
 134  *
 135  * The #GstQuery structure.
 136  */
 137 struct _GstQuery
 138 {
 139   GstMiniObject mini_object;
 140
 141   /*< public > *//* with COW */
 142   GstQueryType type;
 143 };
 144
 145 const gchar*    gst_query_type_get_name        (GstQueryType query);
 146 GQuark          gst_query_type_to_quark        (GstQueryType query);
 147
 148 GType           gst_query_get_type             (void);
 149
 150 /* register a new query */
 151 GstQueryType    gst_query_type_register        (const gchar *nick,
 152                                                 const gchar *description);
 153 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 154
 155 /* check if a query is in an array of querys */
 156 gboolean        gst_query_types_contains       (const GstQueryType *types,
 157                                                 GstQueryType type);
 158
 159 /* query for query details */
 160
 161 const GstQueryTypeDefinition*
 162                 gst_query_type_get_details         (GstQueryType type);
 163 GstIterator*    gst_query_type_iterate_definitions (void) G_GNUC_MALLOC;
 164
 165 /* refcounting */
 166 /**
 167  * gst_query_ref:
 168  * @q: a #GstQuery to increase the refcount of.
 169  *
 170  * Increases the refcount of the given query by one.
 171  *
 172  * Returns: @q
 173  */
 174 #ifdef _FOOL_GTK_DOC_
 175 G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
 176 #endif
 177
 178 static inline GstQuery *
 179 gst_query_ref (GstQuery * q)
 180 {
 181   return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
 182 }
 183
 184 /**
 185  * gst_query_unref:
 186  * @q: a #GstQuery to decrease the refcount of.
 187  *
 188  * Decreases the refcount of the query. If the refcount reaches 0, the query
 189  * will be freed.
 190  */
 191 #ifdef _FOOL_GTK_DOC_
 192 G_INLINE_FUNC void gst_query_unref (GstQuery * q);
 193 #endif
 194
 195 static inline void
 196 gst_query_unref (GstQuery * q)
 197 {
 198   gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
 199 }
 200
 201 /* copy query */
 202 /**
 203  * gst_query_copy:
 204  * @q: a #GstQuery to copy.
 205  *
 206  * Copies the given query using the copy function of the parent #GstStructure.
 207  *
 208  * Free-function: gst_query_unref
 209  *
 210  * Returns: (transfer full): a new copy of @q.
 211  */
 212 #ifdef _FOOL_GTK_DOC_
 213 G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
 214 #endif
 215
 216 static inline GstQuery *
 217 gst_query_copy (const GstQuery * q)
 218 {
 219   return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (q)));
 220 }
 221
 222 /**
 223  * gst_query_is_writable:
 224  * @q: a #GstQuery
 225  *
 226  * Tests if you can safely write data into a query's structure.
 227  */
 228 #define         gst_query_is_writable(q)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
 229 /**
 230  * gst_query_make_writable:
 231  * @q: (transfer full): a #GstQuery to make writable
 232  *
 233  * Makes a writable query from the given query.
 234  *
 235  * Returns: (transfer full): a new writable query (possibly same as @q)
 236  */
 237 #define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
 238 /**
 239  * gst_query_replace:
 240  * @old_query: (inout) (transfer full): pointer to a pointer to a #GstQuery
 241  *     to be replaced.
 242  * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
 243  *     replace the query pointed to by @old_query.
 244  *
 245  * Modifies a pointer to a #GstQuery to point to a different #GstQuery. The
 246  * modification is done atomically (so this is useful for ensuring thread safety
 247  * in some cases), and the reference counts are updated appropriately (the old
 248  * query is unreffed, the new one is reffed).
 249  *
 250  * Either @new_query or the #GstQuery pointed to by @old_query may be NULL.
 251  *
 252  * Returns: TRUE if @new_query was different from @old_query
 253  */
 254 #ifdef _FOOL_GTK_DOC_
 255 G_INLINE_FUNC gboolean gst_query_replace (GstQuery **old_query, GstQuery *new_query);
 256 #endif
 257
 258 static inline gboolean
 259 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
 260 {
 261   return gst_mini_object_replace ((GstMiniObject **) old_query, (GstMiniObject *) new_query);
 262 }
 263
 264 /* application specific query */
 265 GstQuery *      gst_query_new_custom            (GstQueryType type, GstStructure *structure) G_GNUC_MALLOC;
 266 const GstStructure *
 267                 gst_query_get_structure         (GstQuery *query);
 268 GstStructure *  gst_query_writable_structure    (GstQuery *query);
 269
 270 /* position query */
 271 GstQuery*       gst_query_new_position          (GstFormat format) G_GNUC_MALLOC;
 272 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
 273 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 274
 275 /* duration query */
 276 GstQuery*       gst_query_new_duration          (GstFormat format) G_GNUC_MALLOC;
 277 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
 278 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
 279
 280 /* latency query */
 281 GstQuery*       gst_query_new_latency           (void) G_GNUC_MALLOC;
 282 void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
 283                                                  GstClockTime max_latency);
 284 void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
 285                                                  GstClockTime *max_latency);
 286
 287 /* convert query */
 288 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format) G_GNUC_MALLOC;
 289 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 290                                                  GstFormat dest_format, gint64 dest_value);
 291 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 292                                                  GstFormat *dest_format, gint64 *dest_value);
 293 /* segment query */
 294 GstQuery*       gst_query_new_segment           (GstFormat format) G_GNUC_MALLOC;
 295 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
 296                                                  gint64 start_value, gint64 stop_value);
 297 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
 298                                                  gint64 *start_value, gint64 *stop_value);
 299
 300 /* seeking query */
 301 GstQuery*       gst_query_new_seeking           (GstFormat format) G_GNUC_MALLOC;
 302 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
 303                                                  gboolean seekable,
 304                                                  gint64 segment_start,
 305                                                  gint64 segment_end);
 306 void            gst_query_parse_seeking         (GstQuery *query, GstFormat *format,
 307                                                  gboolean *seekable,
 308                                                  gint64 *segment_start,
 309                                                  gint64 *segment_end);
 310 /* formats query */
 311 GstQuery*       gst_query_new_formats           (void) G_GNUC_MALLOC;
 312 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 313 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, const GstFormat *formats);
 314 void            gst_query_parse_n_formats       (GstQuery *query, guint *n_formats);
 315 void            gst_query_parse_nth_format      (GstQuery *query, guint nth, GstFormat *format);
 316
 317 /* buffering query */
 318 /**
 319  * GstBufferingMode:
 320  * @GST_BUFFERING_STREAM: a small amount of data is buffered
 321  * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
 322  * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
 323  * @GST_BUFFERING_LIVE: the stream is a live stream
 324  *
 325  * The different types of buffering methods.
 326  */
 327 typedef enum {
 328   GST_BUFFERING_STREAM,
 329   GST_BUFFERING_DOWNLOAD,
 330   GST_BUFFERING_TIMESHIFT,
 331   GST_BUFFERING_LIVE
 332 } GstBufferingMode;
 333
 334 GstQuery*       gst_query_new_buffering           (GstFormat format) G_GNUC_MALLOC;
 335 void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
 336 void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
 337
 338 void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
 339                                                    gint avg_in, gint avg_out,
 340                                                    gint64 buffering_left);
 341 void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
 342                                                    gint *avg_in, gint *avg_out,
 343                                                    gint64 *buffering_left);
 344
 345 void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
 346                                                    gint64 start, gint64 stop,
 347                                                    gint64 estimated_total);
 348 void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
 349                                                    gint64 *start, gint64 *stop,
 350                                                    gint64 *estimated_total);
 351
 352 gboolean        gst_query_add_buffering_range       (GstQuery *query,
 353                                                      gint64 start, gint64 stop);
 354 guint           gst_query_get_n_buffering_ranges    (GstQuery *query);
 355 gboolean        gst_query_parse_nth_buffering_range (GstQuery *query,
 356                                                      guint index, gint64 *start,
 357                                                      gint64 *stop);
 358
 359 /* URI query */
 360 GstQuery *      gst_query_new_uri                 (void) G_GNUC_MALLOC;
 361 void            gst_query_parse_uri               (GstQuery *query, gchar **uri);
 362 void            gst_query_set_uri                 (GstQuery *query, const gchar *uri);
 363
 364 /* allocation query */
 365 GstQuery *      gst_query_new_allocation          (GstCaps *caps, gboolean need_pool) G_GNUC_MALLOC;
 366 void            gst_query_parse_allocation        (GstQuery *query, GstCaps **caps, gboolean *need_pool);
 367
 368 void            gst_query_set_allocation_params   (GstQuery *query, guint size, guint min_buffers,
 369                                                    guint max_buffers, guint prefix, guint alignment,
 370                                                    GstBufferPool *pool);
 371 void            gst_query_parse_allocation_params (GstQuery *query, guint *size, guint *min_buffers,
 372                                                    guint *max_buffers, guint *prefix, guint *alignment,
 373                                                    GstBufferPool **pool);
 374
 375 void            gst_query_add_allocation_meta       (GstQuery *query, const gchar *api);
 376 guint           gst_query_get_n_allocation_metas    (GstQuery *query);
 377 const gchar *   gst_query_parse_nth_allocation_meta (GstQuery *query, guint index);
 378 gboolean        gst_query_has_allocation_meta       (GstQuery *query, const gchar *api);
 379
 380 void            gst_query_add_allocation_memory       (GstQuery *query, const gchar *alloc);
 381 guint           gst_query_get_n_allocation_memories   (GstQuery *query);
 382 const gchar *   gst_query_parse_nth_allocation_memory (GstQuery *query, guint index);
 383
 384 /* scheduling query */
 385 /**
 386  * GstSchedulingFlags:
 387  * @GST_SCHEDULING_FLAG_SEEKABLE: if seeking is possible
 388  * @GST_SCHEDULING_FLAG_SEQUENTIAL: if sequential access is recommended
 389  *
 390  * The different scheduling flags.
 391  */
 392 typedef enum {
 393   GST_SCHEDULING_FLAG_SEEKABLE      = (1 << 0),
 394   GST_SCHEDULING_FLAG_SEQUENTIAL    = (1 << 1)
 395 } GstSchedulingFlags;
 396
 397 GstQuery *      gst_query_new_scheduling          (void) G_GNUC_MALLOC;
 398
 399 void            gst_query_set_scheduling          (GstQuery *query, GstSchedulingFlags flags,
 400                                                    gint minsize, gint maxsize, gint align);
 401 void            gst_query_parse_scheduling        (GstQuery *query, GstSchedulingFlags *flags,
 402                                                    gint *minsize, gint *maxsize, gint *align);
 403
 404 void            gst_query_add_scheduling_mode       (GstQuery *query, GstPadMode mode);
 405 guint           gst_query_get_n_scheduling_modes    (GstQuery *query);
 406 GstPadMode      gst_query_parse_nth_scheduling_mode (GstQuery *query, guint index);
 407 gboolean        gst_query_has_scheduling_mode       (GstQuery *query, GstPadMode mode);
 408
 409 /* accept-caps query */
 410 GstQuery *      gst_query_new_accept_caps          (GstCaps *caps) G_GNUC_MALLOC;
 411 void            gst_query_parse_accept_caps        (GstQuery *query, GstCaps **caps);
 412 void            gst_query_set_accept_caps_result   (GstQuery *query, gboolean result);
 413 void            gst_query_parse_accept_caps_result (GstQuery *query, gboolean *result);
 414
 415 /* caps query */
 416 GstQuery *      gst_query_new_caps                 (GstCaps *filter) G_GNUC_MALLOC;
 417 void            gst_query_parse_caps               (GstQuery *query, GstCaps **filter);
 418
 419 void            gst_query_set_caps_result          (GstQuery *query, GstCaps *caps);
 420 void            gst_query_parse_caps_result        (GstQuery *query, GstCaps **caps);
 421
 422 void            gst_query_intersect_caps_result    (GstQuery *query, GstCaps *filter,
 423                                                     GstCapsIntersectMode mode);
 424
 425 G_END_DECLS
 426
 427 #endif /* __GST_QUERY_H__ */
 428