rtsp-media-mapping: rename find_media vfunc to find_factory
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-media-mapping.h
1 /* GStreamer
2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #include <gst/gst.h>
21
22 #include <gst/rtsp/gstrtspurl.h>
23
24 #include "rtsp-media-factory.h"
25
26 #ifndef __GST_RTSP_MEDIA_MAPPING_H__
27 #define __GST_RTSP_MEDIA_MAPPING_H__
28
29 G_BEGIN_DECLS
30
31 #define GST_TYPE_RTSP_MEDIA_MAPPING              (gst_rtsp_media_mapping_get_type ())
32 #define GST_IS_RTSP_MEDIA_MAPPING(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA_MAPPING))
33 #define GST_IS_RTSP_MEDIA_MAPPING_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA_MAPPING))
34 #define GST_RTSP_MEDIA_MAPPING_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA_MAPPING, GstRTSPMediaMappingClass))
35 #define GST_RTSP_MEDIA_MAPPING(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA_MAPPING, GstRTSPMediaMapping))
36 #define GST_RTSP_MEDIA_MAPPING_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA_MAPPING, GstRTSPMediaMappingClass))
37 #define GST_RTSP_MEDIA_MAPPING_CAST(obj)         ((GstRTSPMediaMapping*)(obj))
38 #define GST_RTSP_MEDIA_MAPPING_CLASS_CAST(klass) ((GstRTSPMediaMappingClass*)(klass))
39
40 typedef struct _GstRTSPMediaMapping GstRTSPMediaMapping;
41 typedef struct _GstRTSPMediaMappingClass GstRTSPMediaMappingClass;
42
43 /**
44  * GstRTSPMediaMapping:
45  * @mappings: the mountpoint to media mappings
46  *
47  * Creates a #GstRTSPMediaFactory object for a given url.
48  */
49 struct _GstRTSPMediaMapping {
50   GObject       parent;
51
52   GHashTable   *mappings;
53 };
54
55 /**
56  * GstRTSPMediaMappingClass:
57  * @find_factory: Create or return a previously cached #GstRTSPMediaFactory object
58  *        for the given url. the default implementation will use the mappings
59  *        added with gst_rtsp_media_mapping_add_factory().
60  *
61  * The class for the media mapping object.
62  */
63 struct _GstRTSPMediaMappingClass {
64   GObjectClass  parent_class;
65
66   GstRTSPMediaFactory * (*find_factory)  (GstRTSPMediaMapping *mapping, const GstRTSPUrl *url);
67 };
68
69 GType                 gst_rtsp_media_mapping_get_type     (void);
70
71 /* creating a mapping */
72 GstRTSPMediaMapping * gst_rtsp_media_mapping_new          (void);
73
74 /* finding a media factory */
75 GstRTSPMediaFactory * gst_rtsp_media_mapping_find_factory   (GstRTSPMediaMapping *mapping, const GstRTSPUrl *url);
76
77 /* managing media to a path */
78 void                  gst_rtsp_media_mapping_add_factory    (GstRTSPMediaMapping *mapping, const gchar *path,
79                                                              GstRTSPMediaFactory *factory);
80 void                  gst_rtsp_media_mapping_remove_factory (GstRTSPMediaMapping *mapping, const gchar *path);
81
82 G_END_DECLS
83
84 #endif /* __GST_RTSP_MEDIA_MAPPING_H__ */