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 */
25 #ifndef __GST_QUERY_H__
26 #define __GST_QUERY_H__
28 #include <glib.h>
30 #include <gst/gstiterator.h>
31 #include <gst/gstminiobject.h>
32 #include <gst/gststructure.h>
33 #include <gst/gstformat.h>
35 G_BEGIN_DECLS
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
48 * @GST_QUERY_FORMATS: query supported formats for convert
49 *
50 * Standard predefined Query types
51 */
52 typedef enum {
53 GST_QUERY_NONE = 0,
54 GST_QUERY_POSITION,
55 GST_QUERY_DURATION,
56 GST_QUERY_LATENCY,
57 GST_QUERY_JITTER, /* not in draft-query, necessary? */
58 GST_QUERY_RATE,
59 GST_QUERY_SEEKING,
60 GST_QUERY_SEGMENT,
61 GST_QUERY_CONVERT,
62 GST_QUERY_FORMATS
63 } GstQueryType;
65 /**
66 * GST_QUERY_TYPE_RATE_DEN:
67 *
68 * Rates are relative to this value
69 */
70 #define GST_QUERY_TYPE_RATE_DEN G_GINT64_CONSTANT (1000000)
72 typedef struct _GstQueryTypeDefinition GstQueryTypeDefinition;
73 typedef struct _GstQuery GstQuery;
74 typedef struct _GstQueryClass GstQueryClass;
76 /**
77 * GstQueryTypeDefinition:
78 * @value: the unique id of the Query type
79 * @nick: a short nick
80 * @description: a longer description of the query type
81 *
82 * A Query Type definition
83 */
84 struct _GstQueryTypeDefinition
85 {
86 GstQueryType value;
87 gchar *nick;
88 gchar *description;
89 };
91 #define GST_TYPE_QUERY (gst_query_get_type())
92 #define GST_IS_QUERY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_QUERY))
93 #define GST_IS_QUERY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_QUERY))
94 #define GST_QUERY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_QUERY, GstQueryClass))
95 #define GST_QUERY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_QUERY, GstQuery))
96 #define GST_QUERY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_QUERY, GstQueryClass))
98 #define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
100 struct _GstQuery
101 {
102 GstMiniObject mini_object;
104 /*< public > */
105 GstQueryType type;
107 GstStructure *structure;
109 /*< private > */
110 gpointer _gst_reserved[GST_PADDING];
111 };
113 struct _GstQueryClass {
114 GstMiniObjectClass mini_object_class;
116 /*< private > */
117 gpointer _gst_reserved[GST_PADDING];
118 };
120 void _gst_query_initialize (void);
121 GType gst_query_get_type (void);
123 /* register a new query */
124 GstQueryType gst_query_type_register (const gchar *nick,
125 const gchar *description);
126 GstQueryType gst_query_type_get_by_nick (const gchar *nick);
128 /* check if a query is in an array of querys */
129 gboolean gst_query_types_contains (const GstQueryType *types,
130 GstQueryType type);
132 /* query for query details */
134 G_CONST_RETURN GstQueryTypeDefinition*
135 gst_query_type_get_details (GstQueryType type);
136 GstIterator* gst_query_type_iterate_definitions (void);
138 /* refcounting */
139 #define gst_query_ref(msg) GST_QUERY (gst_mini_object_ref (GST_MINI_OBJECT (msg)))
140 #define gst_query_unref(msg) gst_mini_object_unref (GST_MINI_OBJECT (msg))
141 /* copy query */
142 #define gst_query_copy(msg) GST_QUERY (gst_mini_object_copy (GST_MINI_OBJECT (msg)))
143 #define gst_query_make_writable(msg) GST_QUERY (gst_mini_object_make_writable (GST_MINI_OBJECT (msg)))
145 /* position query */
146 GstQuery* gst_query_new_position (GstFormat format);
147 void gst_query_set_position (GstQuery *query, GstFormat format, gint64 cur);
148 void gst_query_parse_position (GstQuery *query, GstFormat *format, gint64 *cur);
150 /* duration query */
151 GstQuery* gst_query_new_duration (GstFormat format);
152 void gst_query_set_duration (GstQuery *query, GstFormat format, gint64 duration);
153 void gst_query_parse_duration (GstQuery *query, GstFormat *format, gint64 *duration);
155 /* convert query */
156 GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format);
157 void gst_query_set_convert (GstQuery *query, GstFormat src_format, gint64 src_value,
158 GstFormat dest_format, gint64 dest_value);
159 void gst_query_parse_convert (GstQuery *query, GstFormat *src_format, gint64 *src_value,
160 GstFormat *dest_format, gint64 *dest_value);
161 /* segment query */
162 GstQuery* gst_query_new_segment (GstFormat format);
163 void gst_query_set_segment (GstQuery *query, gdouble rate, GstFormat format,
164 gint64 start_value, gint64 stop_value);
165 void gst_query_parse_segment (GstQuery *query, gdouble *rate, GstFormat *format,
166 gint64 *start_value, gint64 *stop_value);
169 /* application specific query */
170 GstQuery * gst_query_new_application (GstQueryType type,
171 GstStructure *structure);
174 GstStructure * gst_query_get_structure (GstQuery *query);
176 /* moved from old gstqueryutils.h */
177 void gst_query_set_seeking (GstQuery *query, GstFormat format,
178 gboolean seekable,
179 gint64 segment_start,
180 gint64 segment_end);
181 void gst_query_set_formats (GstQuery *query, gint n_formats, ...);
183 G_END_DECLS
185 #endif /* __GST_QUERY_H__ */