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 GQuark gst_uri_error_quark (void);
  34
  35 /**
  36  * GST_URI_ERROR:
  37  *
  38  * Get access to the error quark of the uri subsystem.
  39  */
  40 #define GST_URI_ERROR gst_uri_error_quark ()
  41
  42 /**
  43  * GstURIError:
  44  * @GST_URI_ERROR_BAD_PROTOCOL: The protocol is not supported
  45  * @GST_URI_ERROR_BAD_URI: There was a problem with the URI
  46  * @GST_URI_ERROR_BAD_STATE: Could not set or change the URI because the
  47  *     URI handler was in a state where that is not possible or not permitted
  48  * @GST_URI_ERROR_BAD_REFERENCE: There was a problem with the entity that
  49  *     the URI references
  50  *
  51  * Different URI-related errors that can occur.
  52  */
  53 typedef enum
  54 {
  55   GST_URI_ERROR_BAD_PROTOCOL,
  56   GST_URI_ERROR_BAD_URI,
  57   GST_URI_ERROR_BAD_STATE,
  58   GST_URI_ERROR_BAD_REFERENCE
  59 } GstURIError;
  60
  61 /**
  62  * GstURIType:
  63  * @GST_URI_UNKNOWN     : The URI direction is unknown
  64  * @GST_URI_SINK        : The URI is a consumer.
  65  * @GST_URI_SRC         : The URI is a producer.
  66  *
  67  * The different types of URI direction.
  68  */
  69
  70 typedef enum {
  71   GST_URI_UNKNOWN,
  72   GST_URI_SINK,
  73   GST_URI_SRC
  74 } GstURIType;
  75
  76 /**
  77  * GST_URI_TYPE_IS_VALID:
  78  * @type: A #GstURIType
  79  *
  80  * Tests if the type direction is valid.
  81  */
  82 #define GST_URI_TYPE_IS_VALID(type) ((type) == GST_URI_SRC || (type) == GST_URI_SINK)
  83
  84 /* uri handler functions */
  85 #define GST_TYPE_URI_HANDLER            (gst_uri_handler_get_type ())
  86 #define GST_URI_HANDLER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_URI_HANDLER, GstURIHandler))
  87 #define GST_IS_URI_HANDLER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_URI_HANDLER))
  88 #define GST_URI_HANDLER_GET_INTERFACE(obj)      (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_URI_HANDLER, GstURIHandlerInterface))
  89
  90 /**
  91  * GstURIHandler:
  92  *
  93  * Opaque #GstURIHandler structure.
  94  */
  95 typedef struct _GstURIHandler GstURIHandler;
  96 typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
  97
  98 /**
  99  * GstURIHandlerInterface:
 100  * @parent: The parent interface type
 101  * @get_type: Method to tell whether the element handles source or sink URI.
 102  * @get_protocols: Method to return the list of protocols handled by the element.
 103  * @get_uri: Method to return the URI currently handled by the element.
 104  * @set_uri: Method to set a new URI.
 105  *
 106  * Any #GstElement using this interface should implement these methods.
 107  */
 108 struct _GstURIHandlerInterface {
 109   GTypeInterface        parent;
 110
 111   /* vtable */
 112   /*< public >*/
 113   /* querying capabilities */
 114   GstURIType            (* get_type)            (GType type);
 115   gchar **              (* get_protocols)       (GType type);
 116
 117   /* using the interface */
 118   gchar *               (* get_uri)             (GstURIHandler * handler);
 119   gboolean              (* set_uri)             (GstURIHandler * handler,
 120                                                  const gchar   * uri,
 121                                                  GError       ** error);
 122 };
 123
 124 /* general URI functions */
 125
 126 gboolean        gst_uri_protocol_is_valid       (const gchar * protocol);
 127 gboolean        gst_uri_protocol_is_supported   (const GstURIType type,
 128                                                  const gchar *protocol);
 129 gboolean        gst_uri_is_valid                (const gchar * uri);
 130 gchar *         gst_uri_get_protocol            (const gchar * uri);
 131 gboolean        gst_uri_has_protocol            (const gchar * uri,
 132                                                  const gchar * protocol);
 133 gchar *         gst_uri_get_location            (const gchar * uri);
 134 gchar *         gst_uri_construct               (const gchar * protocol,
 135                                                  const gchar * location);
 136
 137 gchar *         gst_filename_to_uri             (const gchar * filename,
 138                                                  GError     ** error);
 139
 140 GstElement *    gst_element_make_from_uri       (const GstURIType type,
 141                                                  const gchar *    uri,
 142                                                  const gchar *    elementname);
 143
 144 /* accessing the interface */
 145 GType           gst_uri_handler_get_type        (void);
 146
 147 guint           gst_uri_handler_get_uri_type    (GstURIHandler * handler);
 148 gchar **        gst_uri_handler_get_protocols   (GstURIHandler * handler);
 149 gchar *         gst_uri_handler_get_uri         (GstURIHandler * handler);
 150 gboolean        gst_uri_handler_set_uri         (GstURIHandler * handler,
 151                                                  const gchar   * uri,
 152                                                  GError       ** error);
 153
 154 G_END_DECLS
 155
 156 #endif /* __GST_URI_H__ */