Fixes for -Wwrite-strings
[platform/upstream/gstreamer.git] / gst / gstquery.h
index 672de3f..ae9b07b 100644 (file)
@@ -46,6 +46,11 @@ G_BEGIN_DECLS
  * @GST_QUERY_SEGMENT: segment start/stop positions
  * @GST_QUERY_CONVERT: convert values between formats
  * @GST_QUERY_FORMATS: query supported formats for convert
+ * @GST_QUERY_BUFFERING: query available media for efficient seeking. Since
+ * 0.10.20.
+ * @GST_QUERY_CUSTOM: a custom application or element defined query. Since
+ * 0.10.22.
+ * @GST_QUERY_URI: query the URI of the source or sink. Since 0.10.22.
  *
  * Standard predefined Query types
  */
@@ -56,20 +61,32 @@ typedef enum {
   GST_QUERY_POSITION,
   GST_QUERY_DURATION,
   GST_QUERY_LATENCY,
-  GST_QUERY_JITTER,    /* not in draft-query, necessary? */
+  GST_QUERY_JITTER,     /* not in draft-query, necessary? */
   GST_QUERY_RATE,
   GST_QUERY_SEEKING,
   GST_QUERY_SEGMENT,
   GST_QUERY_CONVERT,
-  GST_QUERY_FORMATS
+  GST_QUERY_FORMATS,
+  GST_QUERY_BUFFERING,
+  GST_QUERY_CUSTOM,
+  GST_QUERY_URI
 } GstQueryType;
 
 /**
- * GST_QUERY_TYPE_RATE_DEN:
+ * GstBufferingMode:
+ * @GST_BUFFERING_STREAM: a small amount of data is buffered
+ * @GST_BUFFERING_DOWNLOAD: the stream is being downloaded
+ * @GST_BUFFERING_TIMESHIFT: the stream is being downloaded in a ringbuffer
+ * @GST_BUFFERING_LIVE: the stream is a live stream
  *
- * Rates are relative to this value
+ * The different types of buffering methods.
  */
-#define GST_QUERY_TYPE_RATE_DEN          G_GINT64_CONSTANT (1000000)
+typedef enum {
+  GST_BUFFERING_STREAM,
+  GST_BUFFERING_DOWNLOAD,
+  GST_BUFFERING_TIMESHIFT,
+  GST_BUFFERING_LIVE
+} GstBufferingMode;
 
 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
 typedef struct _GstQuery GstQuery;
@@ -87,18 +104,20 @@ typedef struct _GstQueryClass GstQueryClass;
 struct _GstQueryTypeDefinition
 {
   GstQueryType   value;
-  gchar        *nick;
-  gchar        *description;
+  const gchar   *nick;
+  const gchar   *description;
   GQuark         quark;
 };
 
-#define GST_TYPE_QUERY                         (gst_query_get_type())
+#define GST_TYPE_QUERY                          (gst_query_get_type())
 #define GST_IS_QUERY(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
 #define GST_IS_QUERY_CLASS(klass)              (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
 #define GST_QUERY_GET_CLASS(obj)               (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
 #define GST_QUERY(obj)                         (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
+#define GST_QUERY_CAST(obj)                    ((GstQuery*)(obj)) /* only since 0.10.23 */
 #define GST_QUERY_CLASS(klass)                 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
 
+
 /**
  * GST_QUERY_TYPE:
  * @query: the query to query
@@ -135,23 +154,21 @@ struct _GstQuery
 
   GstStructure *structure;
 
-  /*< private > */
+  /*< private >*/
   gpointer _gst_reserved;
 };
 
 struct _GstQueryClass {
   GstMiniObjectClass mini_object_class;
 
-  /*< private > */
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
 
-void            _gst_query_initialize          (void);
-
 const gchar*    gst_query_type_get_name        (GstQueryType query);
 GQuark          gst_query_type_to_quark        (GstQueryType query);
 
-GType          gst_query_get_type             (void);
+GType           gst_query_get_type             (void);
 
 /* register a new query */
 GstQueryType    gst_query_type_register        (const gchar *nick,
@@ -174,8 +191,19 @@ GstIterator*    gst_query_type_iterate_definitions (void);
  * @q: a #GstQuery to increase the refcount of.
  *
  * Increases the refcount of the given query by one.
+ *
+ * Returns: @q
  */
-#define         gst_query_ref(q)               GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (q)))
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
+#endif
+
+static inline GstQuery *
+gst_query_ref (GstQuery * q)
+{
+  return GST_QUERY_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (q)));
+}
+
 /**
  * gst_query_unref:
  * @q: a #GstQuery to decrease the refcount of.
@@ -183,41 +211,66 @@ GstIterator*    gst_query_type_iterate_definitions (void);
  * Decreases the refcount of the query. If the refcount reaches 0, the query
  * will be freed.
  */
-#define         gst_query_unref(q)             gst_mini_object_unref (GST_MINI_OBJECT (q))
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC void gst_query_unref (GstQuery * q);
+#endif
+
+static inline void
+gst_query_unref (GstQuery * q)
+{
+  gst_mini_object_unref (GST_MINI_OBJECT_CAST (q));
+}
 
 /* copy query */
 /**
  * gst_query_copy:
  * @q: a #GstQuery to copy.
  *
- * Copies the given query using the copy function of the parent #GstData
- * structure.
+ * Copies the given query using the copy function of the parent #GstStructure.
+ *
+ * Returns: a new copy of @q.
  */
-#define         gst_query_copy(q)              GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (q)))
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);
+#endif
+
+static inline GstQuery *
+gst_query_copy (const GstQuery * q)
+{
+  return GST_QUERY_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CAST (q)));
+}
+
 /**
  * gst_query_make_writable:
  * @q: a #GstQuery to make writable
  *
  * Makes a writable query from the given query.
  */
-#define         gst_query_make_writable(q)     GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (q)))
+#define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
 
 /* position query */
-GstQuery*      gst_query_new_position          (GstFormat format);
-void           gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
-void           gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
+GstQuery*       gst_query_new_position          (GstFormat format);
+void            gst_query_set_position          (GstQuery *query, GstFormat format, gint64 cur);
+void            gst_query_parse_position        (GstQuery *query, GstFormat *format, gint64 *cur);
 
 /* duration query */
-GstQuery*      gst_query_new_duration          (GstFormat format);
-void           gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
-void           gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
+GstQuery*       gst_query_new_duration          (GstFormat format);
+void            gst_query_set_duration          (GstQuery *query, GstFormat format, gint64 duration);
+void            gst_query_parse_duration        (GstQuery *query, GstFormat *format, gint64 *duration);
+
+/* latency query */
+GstQuery*       gst_query_new_latency           (void);
+void            gst_query_set_latency           (GstQuery *query, gboolean live, GstClockTime min_latency,
+                                                 GstClockTime max_latency);
+void            gst_query_parse_latency         (GstQuery *query, gboolean *live, GstClockTime *min_latency,
+                                                 GstClockTime *max_latency);
 
 /* convert query */
-GstQuery*      gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
-void           gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
-                                                GstFormat dest_format, gint64 dest_value);
-void           gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
-                                                GstFormat *dest_format, gint64 *dest_value);
+GstQuery*       gst_query_new_convert           (GstFormat src_format, gint64 value, GstFormat dest_format);
+void            gst_query_set_convert           (GstQuery *query, GstFormat src_format, gint64 src_value,
+                                                 GstFormat dest_format, gint64 dest_value);
+void            gst_query_parse_convert         (GstQuery *query, GstFormat *src_format, gint64 *src_value,
+                                                 GstFormat *dest_format, gint64 *dest_value);
 /* segment query */
 GstQuery*       gst_query_new_segment           (GstFormat format);
 void            gst_query_set_segment           (GstQuery *query, gdouble rate, GstFormat format,
@@ -225,15 +278,12 @@ void            gst_query_set_segment           (GstQuery *query, gdouble rate,
 void            gst_query_parse_segment         (GstQuery *query, gdouble *rate, GstFormat *format,
                                                  gint64 *start_value, gint64 *stop_value);
 
-
 /* application specific query */
-GstQuery *     gst_query_new_application       (GstQueryType type,
+GstQuery *      gst_query_new_application       (GstQueryType type,
                                                  GstStructure *structure);
+GstStructure *  gst_query_get_structure         (GstQuery *query);
 
-
-GstStructure *  gst_query_get_structure                (GstQuery *query);
-
-/* moved from old gstqueryutils.h */
+/* seeking query */
 GstQuery*       gst_query_new_seeking           (GstFormat format);
 void            gst_query_set_seeking           (GstQuery *query, GstFormat format,
                                                  gboolean seekable,
@@ -243,13 +293,36 @@ void            gst_query_parse_seeking         (GstQuery *query, GstFormat *for
                                                  gboolean *seekable,
                                                  gint64 *segment_start,
                                                  gint64 *segment_end);
-
+/* formats query */
 GstQuery*       gst_query_new_formats           (void);
 void            gst_query_set_formats           (GstQuery *query, gint n_formats, ...);
 void            gst_query_set_formatsv          (GstQuery *query, gint n_formats, GstFormat *formats);
 void            gst_query_parse_formats_length  (GstQuery *query, guint *n_formats);
 void            gst_query_parse_formats_nth     (GstQuery *query, guint nth, GstFormat *format);
 
+/* buffering query */
+GstQuery*       gst_query_new_buffering           (GstFormat format);
+void            gst_query_set_buffering_percent   (GstQuery *query, gboolean busy, gint percent);
+void            gst_query_parse_buffering_percent (GstQuery *query, gboolean *busy, gint *percent);
+
+void            gst_query_set_buffering_stats     (GstQuery *query, GstBufferingMode mode,
+                                                   gint avg_in, gint avg_out,
+                                                   gint64 buffering_left);
+void            gst_query_parse_buffering_stats    (GstQuery *query, GstBufferingMode *mode,
+                                                   gint *avg_in, gint *avg_out,
+                                                   gint64 *buffering_left);
+
+void            gst_query_set_buffering_range     (GstQuery *query, GstFormat format,
+                                                   gint64 start, gint64 stop,
+                                                   gint64 estimated_total);
+void            gst_query_parse_buffering_range   (GstQuery *query, GstFormat *format,
+                                                   gint64 *start, gint64 *stop,
+                                                   gint64 *estimated_total);
+/* URI query */
+GstQuery *      gst_query_new_uri                 (void);
+void            gst_query_parse_uri               (GstQuery *query, gchar **uri);
+void            gst_query_set_uri                 (GstQuery *query, const gchar *uri);
+
 G_END_DECLS
 
 #endif /* __GST_QUERY_H__ */