Small cleanups
[platform/upstream/gstreamer.git] / 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 /* uri handler functions */
34 #define GST_TYPE_URI_HANDLER            (gst_uri_handler_get_type ())
35 #define GST_URI_HANDLER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_URI_HANDLER, GstURIHandler))
36 #define GST_IS_URI_HANDLER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_URI_HANDLER))
37 #define GST_URI_HANDLER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_URI_HANDLER, GstURIHandlerClass))
38 #define GST_IS_URI_HANDLER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_URI_HANDLER))
39 #define GST_URI_HANDLER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_URI_HANDLER, GstURIHandlerClass))
40
41 typedef struct _GstURIHandler GstURIHandler;
42 typedef struct _GstURIHandlerClass GstURIHandlerClass;
43
44 struct _GstURIHandler {
45   GstPluginFeature feature;
46
47   /* --- public ---- */
48   gchar *uri;              /* The uri that is described */
49   gchar *longdesc;         /* description of the uri */
50   gchar *element;          /* The element that can handle this uri */
51   gchar *property;         /* The property on the element to set the uri */
52 };
53
54 struct _GstURIHandlerClass {
55   GstPluginFeatureClass parent;
56 };
57
58 GType                   gst_uri_handler_get_type        (void);
59
60 GstURIHandler*          gst_uri_handler_new             (const gchar *name, 
61                                                          const gchar *uri, const gchar *longdesc, 
62                                                          const gchar *element, gchar *property);
63 void                    gst_uri_handler_destroy         (GstURIHandler *handler);
64
65 GstURIHandler*          gst_uri_handler_find            (const gchar *name);
66 GstURIHandler*          gst_uri_handler_find_by_uri     (const gchar *uri);
67
68 GstElement*             gst_uri_handler_create          (GstURIHandler *handler, const gchar *name);
69 GstElement*             gst_uri_handler_make_by_uri     (const gchar *uri, const gchar *name);
70
71 G_END_DECLS
72
73 #endif /* __GST_URI_H */