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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 #include <gst/rtsp/gstrtspurl.h>
23 #include "rtsp-media.h"
24 #include "rtsp-permissions.h"
25 #include "rtsp-address-pool.h"
27 #ifndef __GST_RTSP_MEDIA_FACTORY_H__
28 #define __GST_RTSP_MEDIA_FACTORY_H__
32 /* types for the media factory */
33 #define GST_TYPE_RTSP_MEDIA_FACTORY (gst_rtsp_media_factory_get_type ())
34 #define GST_IS_RTSP_MEDIA_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA_FACTORY))
35 #define GST_IS_RTSP_MEDIA_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA_FACTORY))
36 #define GST_RTSP_MEDIA_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
37 #define GST_RTSP_MEDIA_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactory))
38 #define GST_RTSP_MEDIA_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
39 #define GST_RTSP_MEDIA_FACTORY_CAST(obj) ((GstRTSPMediaFactory*)(obj))
40 #define GST_RTSP_MEDIA_FACTORY_CLASS_CAST(klass) ((GstRTSPMediaFactoryClass*)(klass))
42 typedef struct _GstRTSPMediaFactory GstRTSPMediaFactory;
43 typedef struct _GstRTSPMediaFactoryClass GstRTSPMediaFactoryClass;
44 typedef struct _GstRTSPMediaFactoryPrivate GstRTSPMediaFactoryPrivate;
47 * GstRTSPMediaFactory:
49 * The definition and logic for constructing the pipeline for a media. The media
50 * can contain multiple streams like audio and video.
52 struct _GstRTSPMediaFactory {
56 GstRTSPMediaFactoryPrivate *priv;
57 gpointer _gst_reserved[GST_PADDING];
61 * GstRTSPMediaFactoryClass:
62 * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
63 * The default implementation of this function will use the complete URL
64 * including the query parameters to return a key.
65 * @create_element: Construct and return a #GstElement that is a #GstBin containing
66 * the elements to use for streaming the media. The bin should contain
67 * payloaders pay\%d for each stream. The default implementation of this
68 * function returns the bin created from the launch parameter.
69 * @construct: the vmethod that will be called when the factory has to create the
70 * #GstRTSPMedia for @url. The default implementation of this
71 * function calls create_element to retrieve an element and then looks for
72 * pay\%d to create the streams.
73 * @create_pipeline: create a new pipeline or re-use an existing one and
74 * add the #GstRTSPMedia's element created by @construct to the pipeline.
75 * @configure: configure the media created with @construct. The default
76 * implementation will configure the 'shared' property of the media.
77 * @media_constructed: signal emitted when a media was constructed
78 * @media_configure: signal emitted when a media should be configured
80 * The #GstRTSPMediaFactory class structure.
82 struct _GstRTSPMediaFactoryClass {
83 GObjectClass parent_class;
85 gchar * (*gen_key) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
87 GstElement * (*create_element) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
88 GstRTSPMedia * (*construct) (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
89 GstElement * (*create_pipeline) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
90 void (*configure) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
93 void (*media_constructed) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
94 void (*media_configure) (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
97 gpointer _gst_reserved[GST_PADDING_LARGE];
101 GType gst_rtsp_media_factory_get_type (void);
103 /* creating the factory */
106 GstRTSPMediaFactory * gst_rtsp_media_factory_new (void);
108 /* configuring the factory */
111 void gst_rtsp_media_factory_set_launch (GstRTSPMediaFactory *factory,
112 const gchar *launch);
115 gchar * gst_rtsp_media_factory_get_launch (GstRTSPMediaFactory *factory);
118 void gst_rtsp_media_factory_set_permissions (GstRTSPMediaFactory *factory,
119 GstRTSPPermissions *permissions);
122 GstRTSPPermissions * gst_rtsp_media_factory_get_permissions (GstRTSPMediaFactory *factory);
125 void gst_rtsp_media_factory_add_role (GstRTSPMediaFactory *factory,
127 const gchar *fieldname, ...);
130 void gst_rtsp_media_factory_add_role_from_structure (GstRTSPMediaFactory * factory,
131 GstStructure *structure);
133 void gst_rtsp_media_factory_set_shared (GstRTSPMediaFactory *factory,
137 gboolean gst_rtsp_media_factory_is_shared (GstRTSPMediaFactory *factory);
140 void gst_rtsp_media_factory_set_stop_on_disconnect (GstRTSPMediaFactory *factory,
141 gboolean stop_on_disconnect);
144 gboolean gst_rtsp_media_factory_is_stop_on_disonnect (GstRTSPMediaFactory *factory);
147 void gst_rtsp_media_factory_set_suspend_mode (GstRTSPMediaFactory *factory,
148 GstRTSPSuspendMode mode);
151 GstRTSPSuspendMode gst_rtsp_media_factory_get_suspend_mode (GstRTSPMediaFactory *factory);
154 void gst_rtsp_media_factory_set_eos_shutdown (GstRTSPMediaFactory *factory,
155 gboolean eos_shutdown);
158 gboolean gst_rtsp_media_factory_is_eos_shutdown (GstRTSPMediaFactory *factory);
161 void gst_rtsp_media_factory_set_profiles (GstRTSPMediaFactory *factory,
162 GstRTSPProfile profiles);
165 GstRTSPProfile gst_rtsp_media_factory_get_profiles (GstRTSPMediaFactory *factory);
168 void gst_rtsp_media_factory_set_protocols (GstRTSPMediaFactory *factory,
169 GstRTSPLowerTrans protocols);
172 GstRTSPLowerTrans gst_rtsp_media_factory_get_protocols (GstRTSPMediaFactory *factory);
175 void gst_rtsp_media_factory_set_address_pool (GstRTSPMediaFactory * factory,
176 GstRTSPAddressPool * pool);
179 GstRTSPAddressPool * gst_rtsp_media_factory_get_address_pool (GstRTSPMediaFactory * factory);
182 void gst_rtsp_media_factory_set_multicast_iface (GstRTSPMediaFactory *factory, const gchar *multicast_iface);
185 gchar * gst_rtsp_media_factory_get_multicast_iface (GstRTSPMediaFactory *factory);
188 void gst_rtsp_media_factory_set_buffer_size (GstRTSPMediaFactory * factory,
192 guint gst_rtsp_media_factory_get_buffer_size (GstRTSPMediaFactory * factory);
195 void gst_rtsp_media_factory_set_retransmission_time (GstRTSPMediaFactory * factory,
199 GstClockTime gst_rtsp_media_factory_get_retransmission_time (GstRTSPMediaFactory * factory);
202 void gst_rtsp_media_factory_set_latency (GstRTSPMediaFactory * factory,
206 guint gst_rtsp_media_factory_get_latency (GstRTSPMediaFactory * factory);
209 void gst_rtsp_media_factory_set_transport_mode (GstRTSPMediaFactory *factory,
210 GstRTSPTransportMode mode);
213 GstRTSPTransportMode gst_rtsp_media_factory_get_transport_mode (GstRTSPMediaFactory *factory);
216 void gst_rtsp_media_factory_set_media_gtype (GstRTSPMediaFactory * factory,
220 GType gst_rtsp_media_factory_get_media_gtype (GstRTSPMediaFactory * factory);
223 void gst_rtsp_media_factory_set_clock (GstRTSPMediaFactory *factory,
227 GstClock * gst_rtsp_media_factory_get_clock (GstRTSPMediaFactory *factory);
230 void gst_rtsp_media_factory_set_publish_clock_mode (GstRTSPMediaFactory * factory, GstRTSPPublishClockMode mode);
233 GstRTSPPublishClockMode gst_rtsp_media_factory_get_publish_clock_mode (GstRTSPMediaFactory * factory);
235 /* creating the media from the factory and a url */
238 GstRTSPMedia * gst_rtsp_media_factory_construct (GstRTSPMediaFactory *factory,
239 const GstRTSPUrl *url);
242 GstElement * gst_rtsp_media_factory_create_element (GstRTSPMediaFactory *factory,
243 const GstRTSPUrl *url);
245 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
246 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPMediaFactory, gst_object_unref)
251 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */