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