gst/gsturi.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gsturi.h: Header for uri to element mappings
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_URI_H__
  25 #define __GST_URI_H__
  26
  27 #include <glib.h>
  28 #include <gst/gstelement.h>
  29 #include <gst/gstpluginfeature.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * GstURIType:
  35  * @GST_URI_UNKNOWN     : The URI direction is unknown
  36  * @GST_URI_SINK        : The URI is a consumer.
  37  * @GST_URI_SRC         : The URI is a producer.
  38  *
  39  * The different types of URI direction.
  40  */
  41
  42 typedef enum {
  43   GST_URI_UNKNOWN,
  44   GST_URI_SINK,
  45   GST_URI_SRC
  46 } GstURIType;
  47
  48 /**
  49  * GST_URI_TYPE_IS_VALID:
  50  * @type: A #GstURIType
  51  *
  52  * Tests if the type direction is valid.
  53  */
  54 #define GST_URI_TYPE_IS_VALID(type) ((type) == GST_URI_SRC || (type) == GST_URI_SINK)
  55
  56 /* uri handler functions */
  57 #define GST_TYPE_URI_HANDLER            (gst_uri_handler_get_type ())
  58 #define GST_URI_HANDLER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_URI_HANDLER, GstURIHandler))
  59 #define GST_IS_URI_HANDLER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_URI_HANDLER))
  60 #define GST_URI_HANDLER_GET_INTERFACE(obj)      (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_URI_HANDLER, GstURIHandlerInterface))
  61
  62 /**
  63  * GstURIHandler:
  64  *
  65  * Opaque #GstURIHandler structure.
  66  */
  67 typedef struct _GstURIHandler GstURIHandler;
  68 typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
  69
  70 /**
  71  * GstURIHandlerInterface:
  72  * @parent: The parent interface type
  73  * @get_type: Method to tell whether the element handles source or sink URI.
  74  * @get_protocols: Method to return the list of protocols handled by the element.
  75  * @get_uri: Method to return the URI currently handled by the element.
  76  * @set_uri: Method to set a new URI.
  77  *
  78  * Any #GstElement using this interface should implement these methods.
  79  */
  80 struct _GstURIHandlerInterface {
  81   GTypeInterface        parent;
  82
  83   /*< private >*/
  84   /* signals */
  85   void          (* new_uri)                     (GstURIHandler * handler,
  86                                                  const gchar *   uri);
  87   /* idea for the future ?
  88   gboolean      (* require_password)            (GstURIHandler * handler,
  89                                                  gchar **        username,
  90                                                  gchar **        password);
  91    */
  92
  93   /* vtable */
  94
  95   /*< public >*/
  96   /* querying capabilities */
  97   GstURIType            (* get_type)            (GType type);
  98   gchar **              (* get_protocols)       (GType type);
  99
 100   /* using the interface */
 101   const gchar *         (* get_uri)             (GstURIHandler * handler);
 102   gboolean              (* set_uri)             (GstURIHandler * handler,
 103                                                  const gchar *   uri);
 104
 105   /*< private >*/
 106   /* we might want to add functions here to query features,
 107    * someone with gnome-vfs knowledge go ahead */
 108
 109   gpointer _gst_reserved[GST_PADDING];
 110 };
 111
 112 /* general URI functions */
 113
 114 gboolean        gst_uri_protocol_is_valid       (const gchar * protocol);
 115 gboolean        gst_uri_protocol_is_supported   (const GstURIType type,
 116                                                  const gchar *protocol);
 117 gboolean        gst_uri_is_valid                (const gchar * uri);
 118 gchar *         gst_uri_get_protocol            (const gchar * uri);
 119 gboolean        gst_uri_has_protocol            (const gchar * uri,
 120                                                  const gchar * protocol);
 121 gchar *         gst_uri_get_location            (const gchar * uri);
 122 gchar *         gst_uri_construct               (const gchar * protocol,
 123                                                  const gchar * location);
 124
 125 gchar *         gst_filename_to_uri             (const gchar * filename,
 126                                                  GError     ** error);
 127
 128 GstElement *    gst_element_make_from_uri       (const GstURIType type,
 129                                                  const gchar *    uri,
 130                                                  const gchar *    elementname);
 131
 132 /* accessing the interface */
 133 GType           gst_uri_handler_get_type        (void);
 134
 135 guint           gst_uri_handler_get_uri_type    (GstURIHandler * handler);
 136 gchar **        gst_uri_handler_get_protocols   (GstURIHandler * handler);
 137 const gchar *   gst_uri_handler_get_uri         (GstURIHandler * handler);
 138 gboolean        gst_uri_handler_set_uri         (GstURIHandler * handler,
 139                                                  const gchar *   uri);
 140 void            gst_uri_handler_new_uri         (GstURIHandler * handler,
 141                                                  const gchar *   uri);
 142
 143 G_END_DECLS
 144
 145 #endif /* __GST_URI_H__ */