2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2014 David Waring, British Broadcasting Corporation
5 * <david.waring@rd.bbc.co.uk>
7 * gsturi.h: Header for uri to element mappings and URI manipulation.
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.
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.
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., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
30 #include <glib-object.h>
35 GQuark gst_uri_error_quark (void);
40 * Get access to the error quark of the uri subsystem.
42 #define GST_URI_ERROR gst_uri_error_quark ()
46 * @GST_URI_ERROR_UNSUPPORTED_PROTOCOL: The protocol is not supported
47 * @GST_URI_ERROR_BAD_URI: There was a problem with the URI
48 * @GST_URI_ERROR_BAD_STATE: Could not set or change the URI because the
49 * URI handler was in a state where that is not possible or not permitted
50 * @GST_URI_ERROR_BAD_REFERENCE: There was a problem with the entity that
53 * Different URI-related errors that can occur.
57 GST_URI_ERROR_UNSUPPORTED_PROTOCOL,
58 GST_URI_ERROR_BAD_URI,
59 GST_URI_ERROR_BAD_STATE,
60 GST_URI_ERROR_BAD_REFERENCE
65 * @GST_URI_UNKNOWN: The URI direction is unknown
66 * @GST_URI_SINK: The URI is a consumer.
67 * @GST_URI_SRC: The URI is a producer.
69 * The different types of URI direction.
79 * GST_URI_TYPE_IS_VALID:
80 * @type: A #GstURIType
82 * Tests if the type direction is valid.
84 #define GST_URI_TYPE_IS_VALID(type) ((type) == GST_URI_SRC || (type) == GST_URI_SINK)
86 /* uri handler functions */
87 #define GST_TYPE_URI_HANDLER (gst_uri_handler_get_type ())
88 #define GST_URI_HANDLER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_URI_HANDLER, GstURIHandler))
89 #define GST_IS_URI_HANDLER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_URI_HANDLER))
90 #define GST_URI_HANDLER_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_URI_HANDLER, GstURIHandlerInterface))
95 * Opaque #GstURIHandler structure.
97 typedef struct _GstURIHandler GstURIHandler;
98 typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
100 #include <gst/gstelement.h>
101 #include <gst/gstconfig.h>
102 #include "gstminiobject.h"
105 * GstURIHandlerInterface:
106 * @parent: The parent interface type
107 * @get_type: Method to tell whether the element handles source or sink URI.
108 * @get_protocols: Method to return the list of protocols handled by the element.
109 * @get_uri: Method to return the URI currently handled by the element.
110 * @set_uri: Method to set a new URI.
112 * Any #GstElement using this interface should implement these methods.
114 struct _GstURIHandlerInterface {
115 GTypeInterface parent;
119 /* querying capabilities */
120 GstURIType (* get_type) (GType type);
121 const gchar * const * (* get_protocols) (GType type);
123 /* using the interface */
124 gchar * (* get_uri) (GstURIHandler * handler);
125 gboolean (* set_uri) (GstURIHandler * handler,
130 /* general URI functions */
133 gboolean gst_uri_protocol_is_valid (const gchar * protocol);
136 gboolean gst_uri_protocol_is_supported (const GstURIType type,
137 const gchar *protocol);
139 gboolean gst_uri_is_valid (const gchar * uri);
142 gchar * gst_uri_get_protocol (const gchar * uri) G_GNUC_MALLOC;
145 gboolean gst_uri_has_protocol (const gchar * uri,
146 const gchar * protocol);
148 gchar * gst_uri_get_location (const gchar * uri) G_GNUC_MALLOC;
150 #ifndef GST_DISABLE_DEPRECATED
151 GST_DEPRECATED_FOR(gst_uri_new)
152 gchar * gst_uri_construct (const gchar * protocol,
153 const gchar * location) G_GNUC_MALLOC;
157 gchar * gst_filename_to_uri (const gchar * filename,
158 GError ** error) G_GNUC_MALLOC;
160 GstElement * gst_element_make_from_uri (const GstURIType type,
162 const gchar * elementname,
163 GError ** error) G_GNUC_MALLOC;
165 /* accessing the interface */
168 GType gst_uri_handler_get_type (void);
171 GstURIType gst_uri_handler_get_uri_type (GstURIHandler * handler);
174 const gchar * const * gst_uri_handler_get_protocols (GstURIHandler * handler);
177 gchar * gst_uri_handler_get_uri (GstURIHandler * handler) G_GNUC_MALLOC;
180 gboolean gst_uri_handler_set_uri (GstURIHandler * handler,
185 * GstUri Type macros.
187 #define GST_TYPE_URI (gst_uri_get_type ())
188 #define GST_IS_URI(obj) (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_URI))
189 #define GST_URI_CAST(obj) ((GstUri *)(obj))
190 #define GST_URI_CONST_CAST(obj) ((const GstUri *)(obj))
191 #define GST_URI(obj) (GST_URI_CAST(obj))
196 * This is a private structure that holds the various parts of a parsed URI.
199 typedef struct _GstUri GstUri;
204 * Value for #GstUri<!-- -->.port to indicate no port number.
206 #define GST_URI_NO_PORT 0
208 /* used by GST_TYPE_URI */
211 GType gst_uri_get_type (void);
214 * Method definitions.
218 GstUri * gst_uri_new (const gchar * scheme,
219 const gchar * userinfo,
224 const gchar * fragment) G_GNUC_MALLOC;
226 GstUri * gst_uri_new_with_base (GstUri * base,
227 const gchar * scheme,
228 const gchar * userinfo,
233 const gchar * fragment) G_GNUC_MALLOC;
235 GstUri * gst_uri_from_string (const gchar * uri) G_GNUC_MALLOC;
238 GstUri * gst_uri_from_string_with_base (GstUri * base,
239 const gchar * uri) G_GNUC_MALLOC;
241 gboolean gst_uri_equal (const GstUri * first,
242 const GstUri * second);
244 GstUri * gst_uri_join (GstUri * base_uri,
245 GstUri * ref_uri) G_GNUC_WARN_UNUSED_RESULT;
247 gchar * gst_uri_join_strings (const gchar * base_uri,
248 const gchar * ref_uri) G_GNUC_MALLOC;
250 gboolean gst_uri_is_writable (const GstUri * uri);
253 GstUri * gst_uri_make_writable (GstUri * uri) G_GNUC_WARN_UNUSED_RESULT;
256 gchar * gst_uri_to_string (const GstUri * uri) G_GNUC_MALLOC;
259 gboolean gst_uri_is_normalized (const GstUri * uri);
262 gboolean gst_uri_normalize (GstUri * uri);
265 const gchar * gst_uri_get_scheme (const GstUri * uri);
268 gboolean gst_uri_set_scheme (GstUri * uri, const gchar * scheme);
271 const gchar * gst_uri_get_userinfo (const GstUri * uri);
274 gboolean gst_uri_set_userinfo (GstUri * uri, const gchar * userinfo);
277 const gchar * gst_uri_get_host (const GstUri * uri);
280 gboolean gst_uri_set_host (GstUri * uri, const gchar * host);
283 guint gst_uri_get_port (const GstUri * uri);
286 gboolean gst_uri_set_port (GstUri * uri, guint port);
289 gchar * gst_uri_get_path (const GstUri * uri);
292 gboolean gst_uri_set_path (GstUri * uri, const gchar * path);
295 gchar * gst_uri_get_path_string (const GstUri * uri);
298 gboolean gst_uri_set_path_string (GstUri * uri, const gchar * path);
301 GList * gst_uri_get_path_segments (const GstUri * uri);
304 gboolean gst_uri_set_path_segments (GstUri * uri, GList * path_segments);
307 gboolean gst_uri_append_path (GstUri * uri,
308 const gchar * relative_path);
310 gboolean gst_uri_append_path_segment (GstUri * uri,
311 const gchar * path_segment);
313 gchar * gst_uri_get_query_string (const GstUri * uri);
316 gboolean gst_uri_set_query_string (GstUri * uri, const gchar * query);
319 GHashTable * gst_uri_get_query_table (const GstUri * uri);
322 gboolean gst_uri_set_query_table (GstUri * uri,
323 GHashTable * query_table);
325 gboolean gst_uri_set_query_value (GstUri * uri, const gchar * query_key,
326 const gchar * query_value);
328 gboolean gst_uri_remove_query_key (GstUri * uri, const gchar * query_key);
331 gboolean gst_uri_query_has_key (const GstUri * uri,
332 const gchar * query_key);
335 const gchar * gst_uri_get_query_value (const GstUri * uri,
336 const gchar * query_key);
339 GList * gst_uri_get_query_keys (const GstUri * uri);
342 const gchar * gst_uri_get_fragment (const GstUri * uri);
345 gboolean gst_uri_set_fragment (GstUri * uri, const gchar * fragment);
348 GHashTable * gst_uri_get_media_fragment_table (const GstUri * uri);
352 * @uri: This #GstUri object.
354 * Create a new #GstUri object with the same data as this #GstUri object.
355 * If @uri is %NULL then returns %NULL.
357 * Returns: (transfer full): A new #GstUri object which is a copy of this
360 static inline GstUri *
361 gst_uri_copy (const GstUri * uri)
363 return GST_URI_CAST (gst_mini_object_copy (GST_MINI_OBJECT_CONST_CAST (uri)));
368 * @uri: (transfer none): This #GstUri object.
370 * Add a reference to this #GstUri object. See gst_mini_object_ref() for further
373 * Returns: This object with the reference count incremented.
375 static inline GstUri *
376 gst_uri_ref (GstUri * uri)
378 return GST_URI_CAST (gst_mini_object_ref (GST_MINI_OBJECT_CAST (uri)));
383 * @uri: (transfer full): This #GstUri object.
385 * Decrement the reference count to this #GstUri object.
387 * If the reference count drops to 0 then finalize this object.
389 * See gst_mini_object_unref() for further info.
392 gst_uri_unref (GstUri * uri)
394 gst_mini_object_unref (GST_MINI_OBJECT_CAST (uri));
397 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
398 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstUri, gst_uri_unref)
403 #endif /* __GST_URI_H__ */