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 /**
  68  * GST_QUERY_TYPE_RATE_DEN:
  69  *
  70  * Rates are relative to this value
  71  */
  72 #define GST_QUERY_TYPE_RATE_DEN          G_GINT64_CONSTANT (1000000)
  73
  74 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
  75 typedef struct _GstQuery GstQuery;
  76 typedef struct _GstQueryClass GstQueryClass;
  77
  78 /**
  79  * GstQueryTypeDefinition:
  80  * @value: the unique id of the Query type
  81  * @nick: a short nick
  82  * @description: a longer description of the query type
  83  * @quark: the quark for the nick
  84  *
  85  * A Query Type definition
  86  */
  87 struct _GstQueryTypeDefinition
  88 {
  89   GstQueryType   value;
  90   gchar         *nick;
  91   gchar         *description;
  92   GQuark         quark;
  93 };
  94
  95 #define GST_TYPE_QUERY                          (gst_query_get_type())
  96 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
  97 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
  98 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
  99 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
 100 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
 101
 102 #define GST_QUERY_TYPE(query)  (((GstQuery*)(query))->type)
 103
 104 /**
 105  * GstQuery:
 106  * @mini_object: The parent #GstMiniObject type
 107  * @type: the #GstQueryType
 108  * @structure: the #GstStructure containing the query details.
 109  *
 110  * The #GstQuery structure.
 111  */
 112 struct _GstQuery
 113 {
 114   GstMiniObject mini_object;
 115
 116   /*< public > *//* with COW */
 117   GstQueryType type;
 118
 119   GstStructure *structure;
 120
 121   /*< private > */
 122   gpointer _gst_reserved[GST_PADDING];
 123 };
 124
 125 struct _GstQueryClass {
 126   GstMiniObjectClass mini_object_class;
 127
 128   /*< private > */
 129   gpointer _gst_reserved[GST_PADDING];
 130 };
 131
 132 void            _gst_query_initialize          (void);
 133
 134 const gchar*    gst_query_type_get_name        (GstQueryType query);
 135 GQuark          gst_query_type_to_quark        (GstQueryType query);
 136
 137 GType           gst_query_get_type             (void);
 138
 139 /* register a new query */
 140 GstQueryType    gst_query_type_register        (const gchar *nick,
 141                                                 const gchar *description);
 142 GstQueryType    gst_query_type_get_by_nick     (const gchar *nick);
 143
 144 /* check if a query is in an array of querys */
 145 gboolean        gst_query_types_contains       (const GstQueryType *types,
 146                                                 GstQueryType type);
 147
 148 /* query for query details */
 149
 150 G_CONST_RETURN GstQueryTypeDefinition*
 151                 gst_query_type_get_details         (GstQueryType type);
 152 GstIterator*    gst_query_type_iterate_definitions (void);
 153
 154 /* refcounting */
 155 /**
 156  * gst_query_ref:
 157  * @q: a #GstQuery to increase the refcount of.
 158  *
 159  * Increases the refcount of the given query by one.
 160  */
 161 #define         gst_query_ref(q)                GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (q)))
 162 /**
 163  * gst_query_unref:
 164  * @q: a #GstQuery to decrease the refcount of.
 165  *
 166  * Decreases the refcount of the query. If the refcount reaches 0, the query
 167  * will be freed.
 168  */
 169 #define         gst_query_unref(q)              gst_mini_object_unref (GST_MINI_OBJECT (q))
 170
 171 /* copy query */
 172 /**
 173  * gst_query_copy:
 174  * @q: a #GstQuery to copy.
 175  *
 176  * Copies the given query using the copy function of the parent #GstData
 177  * structure.
 178  */
 179 #define         gst_query_copy(q)               GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (q)))
 180 /**
 181  * gst_query_make_writable:
 182  * @q: a #GstQuery to make writable
 183  *
 184  * Makes a writable query from the given query.
 185  */
 186 #define         gst_query_make_writable(q)      GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
 187
 188 /* position query */
 189 GstQuery*       gst_query_new_position          (GstFormat format);
 190 void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
 191 void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 192
 193 /* duration query */
 194 GstQuery*       gst_query_new_duration          (GstFormat format);
 195 void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
 196 void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
 197
 198 /* convert query */
 199 GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
 200 void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
 201                                                  GstFormat dest_format, gint64 dest_value);
 202 void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
 203                                                  GstFormat *dest_format, gint64 *dest_value);
 204 /* segment query */
 205 GstQuery*       gst_query_new_segment           (GstFormat format);
 206 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
 207                                                  gint64 start_value, gint64 stop_value);
 208 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
 209                                                  gint64 *start_value, gint64 *stop_value);
 210
 211
 212 /* application specific query */
 213 GstQuery *      gst_query_new_application       (GstQueryType type,
 214                                                  GstStructure *structure);
 215
 216
 217 GstStructure *  gst_query_get_structure         (GstQuery *query);
 218
 219 /* moved from old gstqueryutils.h */
 220 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
 221                                                  gboolean seekable,
 222                                                  gint64 segment_start,
 223                                                  gint64 segment_end);
 224 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 225
 226 G_END_DECLS
 227
 228 #endif /* __GST_QUERY_H__ */
 229