2 * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
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.
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.
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.
21 #include <gst/rtsp/gstrtspurl.h>
23 #include "rtsp-media.h"
24 #include "rtsp-auth.h"
26 #ifndef __GST_RTSP_MEDIA_FACTORY_H__
27 #define __GST_RTSP_MEDIA_FACTORY_H__
31 /* types for the media factory */
32 #define GST_TYPE_RTSP_MEDIA_FACTORY (gst_rtsp_media_factory_get_type ())
33 #define GST_IS_RTSP_MEDIA_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA_FACTORY))
34 #define GST_IS_RTSP_MEDIA_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA_FACTORY))
35 #define GST_RTSP_MEDIA_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
36 #define GST_RTSP_MEDIA_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactory))
37 #define GST_RTSP_MEDIA_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
38 #define GST_RTSP_MEDIA_FACTORY_CAST(obj) ((GstRTSPMediaFactory*)(obj))
39 #define GST_RTSP_MEDIA_FACTORY_CLASS_CAST(klass) ((GstRTSPMediaFactoryClass*)(klass))
41 typedef struct _GstRTSPMediaFactory GstRTSPMediaFactory;
42 typedef struct _GstRTSPMediaFactoryClass GstRTSPMediaFactoryClass;
44 #define GST_RTSP_MEDIA_FACTORY_GET_LOCK(f) (GST_RTSP_MEDIA_FACTORY_CAST(f)->lock)
45 #define GST_RTSP_MEDIA_FACTORY_LOCK(f) (g_mutex_lock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
46 #define GST_RTSP_MEDIA_FACTORY_UNLOCK(f) (g_mutex_unlock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
49 * GstRTSPMediaFactory:
50 * @lock: mutex protecting the datastructure.
51 * @launch: the launch description
52 * @shared: if media from this factory can be shared between clients
53 * @media_lock: mutex protecting the medias.
54 * @media: hashtable of shared media
56 * The definition and logic for constructing the pipeline for a media. The media
57 * can contain multiple streams like audio and video.
59 struct _GstRTSPMediaFactory {
65 gboolean eos_shutdown;
68 gchar *multicast_group;
75 * GstRTSPMediaFactoryClass:
76 * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
77 * The default implementation of this function will use the complete URL
78 * including the query parameters to return a key.
79 * @get_element: Construct and return a #GstElement that is a #GstBin containing
80 * the elements to use for streaming the media. The bin should contain
81 * payloaders pay%d for each stream. The default implementation of this
82 * function returns the bin created from the launch parameter.
83 * @construct: the vmethod that will be called when the factory has to create the
84 * #GstRTSPMedia for @url. The default implementation of this
85 * function calls get_element to retrieve an element and then looks for
86 * pay%d to create the streams.
87 * @configure: configure the media created with @construct. The default
88 * implementation will configure the 'shared' property of the media.
89 * @create_pipeline: create a new pipeline or re-use an existing one and
90 * add the #GstRTSPMedia's element created by @construct to the pipeline.
92 * The #GstRTSPMediaFactory class structure.
94 struct _GstRTSPMediaFactoryClass {
95 GObjectClass parent_class;
97 gchar * (*gen_key) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
99 GstElement * (*get_element) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
100 GstRTSPMedia * (*construct) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
101 void (*configure) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
102 GstElement * (*create_pipeline) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
105 void (*media_constructed) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
106 void (*media_configure) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
109 GType gst_rtsp_media_factory_get_type (void);
111 /* creating the factory */
112 GstRTSPMediaFactory * gst_rtsp_media_factory_new (void);
114 /* configuring the factory */
115 void gst_rtsp_media_factory_set_launch (GstRTSPMediaFactory *factory,
116 const gchar *launch);
117 gchar * gst_rtsp_media_factory_get_launch (GstRTSPMediaFactory *factory);
119 void gst_rtsp_media_factory_set_shared (GstRTSPMediaFactory *factory,
121 gboolean gst_rtsp_media_factory_is_shared (GstRTSPMediaFactory *factory);
123 void gst_rtsp_media_factory_set_eos_shutdown (GstRTSPMediaFactory *factory,
124 gboolean eos_shutdown);
125 gboolean gst_rtsp_media_factory_is_eos_shutdown (GstRTSPMediaFactory *factory);
127 void gst_rtsp_media_factory_set_auth (GstRTSPMediaFactory *factory, GstRTSPAuth *auth);
128 GstRTSPAuth * gst_rtsp_media_factory_get_auth (GstRTSPMediaFactory *factory);
130 void gst_rtsp_media_factory_set_buffer_size (GstRTSPMediaFactory * factory, guint size);
131 guint gst_rtsp_media_factory_get_buffer_size (GstRTSPMediaFactory * factory);
133 void gst_rtsp_media_factory_set_multicast_group (GstRTSPMediaFactory * factory, const gchar *mc);
134 gchar * gst_rtsp_media_factory_get_multicast_group (GstRTSPMediaFactory * factory);
136 /* creating the media from the factory and a url */
137 GstRTSPMedia * gst_rtsp_media_factory_construct (GstRTSPMediaFactory *factory,
138 const GstRTSPUrl *url);
140 void gst_rtsp_media_factory_collect_streams (GstRTSPMediaFactory *factory,
141 const GstRTSPUrl *url,
142 GstRTSPMedia *media);
146 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */