gsturi.h 5.25 KB
Newer Older
1 2 3 4
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
5
 * gsturi.h: Header for uri to element mappings
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_URI_H__
#define __GST_URI_H__

#include <glib.h>
#include <gst/gstelement.h>
#include <gst/gstpluginfeature.h>

31 32
G_BEGIN_DECLS

Edward Hervey's avatar
Edward Hervey committed
33 34 35 36 37 38 39 40 41
/**
 * GstURIType:
 * @GST_URI_UNKNOWN	: The URI direction is unknown
 * @GST_URI_SINK	: The URI is a consumer.
 * @GST_URI_SRC		: The URI is a producer.
 *
 * The different types of URI direction.
 */

42
typedef enum {
Benjamin Otte's avatar
Benjamin Otte committed
43 44 45
  GST_URI_UNKNOWN,
  GST_URI_SINK,
  GST_URI_SRC
46
} GstURIType;
Benjamin Otte's avatar
Benjamin Otte committed
47

Edward Hervey's avatar
Edward Hervey committed
48 49 50 51 52 53
/**
 * GST_URI_TYPE_IS_VALID:
 * @type: A #GstURIType
 *
 * Tests if the type direction is valid.
 */
Benjamin Otte's avatar
Benjamin Otte committed
54 55
#define GST_URI_TYPE_IS_VALID(type) ((type) == GST_URI_SRC || (type) == GST_URI_SINK)

Wim Taymans's avatar
Wim Taymans committed
56
/* uri handler functions */
57
#define GST_TYPE_URI_HANDLER		(gst_uri_handler_get_type ())
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
58 59 60
#define GST_URI_HANDLER(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_URI_HANDLER, GstURIHandler))
#define GST_IS_URI_HANDLER(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_URI_HANDLER))
#define GST_URI_HANDLER_GET_INTERFACE(obj)	(G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_URI_HANDLER, GstURIHandlerInterface))
61

Wim Taymans's avatar
Wim Taymans committed
62 63 64 65 66
/**
 * GstURIHandler:
 *
 * Opaque #GstURIHandler structure.
 */
67
typedef struct _GstURIHandler GstURIHandler;
Benjamin Otte's avatar
Benjamin Otte committed
68
typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
69

Edward Hervey's avatar
Edward Hervey committed
70 71
/**
 * GstURIHandlerInterface:
Wim Taymans's avatar
Wim Taymans committed
72
 * @parent: The parent interface type
73
 * @get_type: Method to tell whether the element handles source or sink URI.
Edward Hervey's avatar
Edward Hervey committed
74 75 76
 * @get_protocols: Method to return the list of protocols handled by the element.
 * @get_uri: Method to return the URI currently handled by the element.
 * @set_uri: Method to set a new URI.
77
 * @get_type_full: Variant of get_type which takes a GType argument. This is 
78 79 80 81 82 83 84
 *   for use by bindings that need to pass context when creating a URI Handler.
 *   If implemented, get_type will be used in preference to get_type_full.
 *   Since: 0.10.15.
 * @get_protocols_full: Variant of get_protocols which takes a GType argument.
 *   This is for use by bindings that need to pass context when creating a URI
 *   Handler. If implemented, get_protocols will be used in preference to
 *   get_protocols_full. Since: 0.10.15.
Edward Hervey's avatar
Edward Hervey committed
85
 *
Stefan Kost's avatar
Stefan Kost committed
86
 * Any #GstElement using this interface should implement these methods.
Edward Hervey's avatar
Edward Hervey committed
87
 */
88 89
struct _GstURIHandlerInterface {
  GTypeInterface	parent;
90

Edward Hervey's avatar
Edward Hervey committed
91
  /*< private >*/
Benjamin Otte's avatar
Benjamin Otte committed
92
  /* signals */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
93 94
  void		(* new_uri)			(GstURIHandler * handler,
						 const gchar *   uri);
Benjamin Otte's avatar
Benjamin Otte committed
95
  /* idea for the future ?
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
96 97 98
  gboolean	(* require_password)		(GstURIHandler * handler,
						 gchar **	 username,
						 gchar **	 password);
Benjamin Otte's avatar
Benjamin Otte committed
99
   */
100

Benjamin Otte's avatar
Benjamin Otte committed
101 102
  /* vtable */

Edward Hervey's avatar
Edward Hervey committed
103
  /*< public >*/
Benjamin Otte's avatar
Benjamin Otte committed
104
  /* querying capabilities */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
105 106
  GstURIType		(* get_type)		(void);
  gchar **		(* get_protocols)	(void);
107

Benjamin Otte's avatar
Benjamin Otte committed
108
  /* using the interface */
109
  const gchar *		(* get_uri)		(GstURIHandler * handler);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
110 111 112
  gboolean		(* set_uri)		(GstURIHandler * handler,
						 const gchar *	 uri);

113 114 115
  GstURIType		(* get_type_full)	(GType type);
  gchar **		(* get_protocols_full)	(GType type);

Edward Hervey's avatar
Edward Hervey committed
116
  /*< private >*/
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
117 118
  /* we might want to add functions here to query features,
   * someone with gnome-vfs knowledge go ahead */
119

120
  gpointer _gst_reserved[GST_PADDING - 2];
121 122
};

Benjamin Otte's avatar
Benjamin Otte committed
123
/* general URI functions */
124

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
125
gboolean	gst_uri_protocol_is_valid	(const gchar * protocol);
126 127
gboolean	gst_uri_protocol_is_supported	(const GstURIType type,
						 const gchar *protocol);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
128
gboolean	gst_uri_is_valid		(const gchar * uri);
129
gchar *		gst_uri_get_protocol		(const gchar * uri) G_GNUC_MALLOC;
130 131
gboolean        gst_uri_has_protocol            (const gchar * uri,
                                                 const gchar * protocol);
132
gchar *		gst_uri_get_location		(const gchar * uri) G_GNUC_MALLOC;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
133
gchar *		gst_uri_construct		(const gchar * protocol,
134
						 const gchar * location) G_GNUC_MALLOC;
135

136
gchar *         gst_filename_to_uri             (const gchar * filename,
137
                                                 GError     ** error) G_GNUC_MALLOC;
138

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
139 140
GstElement *	gst_element_make_from_uri	(const GstURIType type,
						 const gchar *    uri,
141
						 const gchar *    elementname) G_GNUC_MALLOC;
142

Benjamin Otte's avatar
Benjamin Otte committed
143
/* accessing the interface */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
144 145 146
GType		gst_uri_handler_get_type	(void);

guint		gst_uri_handler_get_uri_type	(GstURIHandler * handler);
147
gchar **	gst_uri_handler_get_protocols	(GstURIHandler * handler) G_GNUC_MALLOC;
148
const gchar *	gst_uri_handler_get_uri		(GstURIHandler * handler);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
149 150 151 152
gboolean	gst_uri_handler_set_uri		(GstURIHandler * handler,
						 const gchar *	 uri);
void		gst_uri_handler_new_uri		(GstURIHandler * handler,
						 const gchar *	 uri);
153

154
G_END_DECLS
155

Benjamin Otte's avatar
Benjamin Otte committed
156
#endif /* __GST_URI_H__ */