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.
20 #include "rtsp-media-factory.h"
22 #define DEFAULT_LAUNCH NULL
23 #define DEFAULT_SHARED FALSE
24 #define DEFAULT_EOS_SHUTDOWN FALSE
35 GST_DEBUG_CATEGORY (rtsp_media_debug);
36 #define GST_CAT_DEFAULT rtsp_media_debug
38 static void gst_rtsp_media_factory_get_property (GObject * object, guint propid,
39 GValue * value, GParamSpec * pspec);
40 static void gst_rtsp_media_factory_set_property (GObject * object, guint propid,
41 const GValue * value, GParamSpec * pspec);
42 static void gst_rtsp_media_factory_finalize (GObject * obj);
44 static gchar *default_gen_key (GstRTSPMediaFactory * factory,
45 const GstRTSPUrl * url);
46 static GstElement *default_get_element (GstRTSPMediaFactory * factory,
47 const GstRTSPUrl * url);
48 static GstRTSPMedia *default_construct (GstRTSPMediaFactory * factory,
49 const GstRTSPUrl * url);
50 static void default_configure (GstRTSPMediaFactory * factory,
51 GstRTSPMedia * media);
52 static GstElement *default_create_pipeline (GstRTSPMediaFactory * factory,
53 GstRTSPMedia * media);
55 G_DEFINE_TYPE (GstRTSPMediaFactory, gst_rtsp_media_factory, G_TYPE_OBJECT);
58 gst_rtsp_media_factory_class_init (GstRTSPMediaFactoryClass * klass)
60 GObjectClass *gobject_class;
62 gobject_class = G_OBJECT_CLASS (klass);
64 gobject_class->get_property = gst_rtsp_media_factory_get_property;
65 gobject_class->set_property = gst_rtsp_media_factory_set_property;
66 gobject_class->finalize = gst_rtsp_media_factory_finalize;
69 * GstRTSPMediaFactory::launch
71 * The gst_parse_launch() line to use for constructing the pipeline in the
72 * default prepare vmethod.
74 * The pipeline description should return a GstBin as the toplevel element
75 * which can be accomplished by enclosing the dscription with brackets '('
78 * The description should return a pipeline with payloaders named pay0, pay1,
79 * etc.. Each of the payloaders will result in a stream.
81 * Support for dynamic payloaders can be accomplished by adding payloaders
82 * named dynpay0, dynpay1, etc..
84 g_object_class_install_property (gobject_class, PROP_LAUNCH,
85 g_param_spec_string ("launch", "Launch",
86 "A launch description of the pipeline", DEFAULT_LAUNCH,
87 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
89 g_object_class_install_property (gobject_class, PROP_SHARED,
90 g_param_spec_boolean ("shared", "Shared",
91 "If media from this factory is shared", DEFAULT_SHARED,
92 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
94 g_object_class_install_property (gobject_class, PROP_EOS_SHUTDOWN,
95 g_param_spec_boolean ("eos-shutdown", "EOS Shutdown",
96 "Send EOS down the pipeline before shutting down",
97 DEFAULT_EOS_SHUTDOWN, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
99 klass->gen_key = default_gen_key;
100 klass->get_element = default_get_element;
101 klass->construct = default_construct;
102 klass->configure = default_configure;
103 klass->create_pipeline = default_create_pipeline;
105 GST_DEBUG_CATEGORY_INIT (rtsp_media_debug, "rtspmedia", 0, "GstRTSPMedia");
109 gst_rtsp_media_factory_init (GstRTSPMediaFactory * factory)
111 factory->launch = g_strdup (DEFAULT_LAUNCH);
112 factory->shared = DEFAULT_SHARED;
113 factory->eos_shutdown = DEFAULT_EOS_SHUTDOWN;
115 factory->lock = g_mutex_new ();
116 factory->medias_lock = g_mutex_new ();
117 factory->medias = g_hash_table_new_full (g_str_hash, g_str_equal,
118 g_free, g_object_unref);
122 gst_rtsp_media_factory_finalize (GObject * obj)
124 GstRTSPMediaFactory *factory = GST_RTSP_MEDIA_FACTORY (obj);
126 g_hash_table_unref (factory->medias);
127 g_mutex_free (factory->medias_lock);
128 g_free (factory->launch);
129 g_mutex_free (factory->lock);
131 g_object_unref (factory->auth);
133 G_OBJECT_CLASS (gst_rtsp_media_factory_parent_class)->finalize (obj);
137 gst_rtsp_media_factory_get_property (GObject * object, guint propid,
138 GValue * value, GParamSpec * pspec)
140 GstRTSPMediaFactory *factory = GST_RTSP_MEDIA_FACTORY (object);
144 g_value_take_string (value, gst_rtsp_media_factory_get_launch (factory));
147 g_value_set_boolean (value, gst_rtsp_media_factory_is_shared (factory));
149 case PROP_EOS_SHUTDOWN:
150 g_value_set_boolean (value,
151 gst_rtsp_media_factory_is_eos_shutdown (factory));
154 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
159 gst_rtsp_media_factory_set_property (GObject * object, guint propid,
160 const GValue * value, GParamSpec * pspec)
162 GstRTSPMediaFactory *factory = GST_RTSP_MEDIA_FACTORY (object);
166 gst_rtsp_media_factory_set_launch (factory, g_value_get_string (value));
169 gst_rtsp_media_factory_set_shared (factory, g_value_get_boolean (value));
171 case PROP_EOS_SHUTDOWN:
172 gst_rtsp_media_factory_set_eos_shutdown (factory,
173 g_value_get_boolean (value));
176 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, propid, pspec);
181 * gst_rtsp_media_factory_new:
183 * Create a new #GstRTSPMediaFactory instance.
185 * Returns: a new #GstRTSPMediaFactory object.
187 GstRTSPMediaFactory *
188 gst_rtsp_media_factory_new (void)
190 GstRTSPMediaFactory *result;
192 result = g_object_new (GST_TYPE_RTSP_MEDIA_FACTORY, NULL);
198 * gst_rtsp_media_factory_set_launch:
199 * @factory: a #GstRTSPMediaFactory
200 * @launch: the launch description
203 * The gst_parse_launch() line to use for constructing the pipeline in the
204 * default prepare vmethod.
206 * The pipeline description should return a GstBin as the toplevel element
207 * which can be accomplished by enclosing the dscription with brackets '('
210 * The description should return a pipeline with payloaders named pay0, pay1,
211 * etc.. Each of the payloaders will result in a stream.
214 gst_rtsp_media_factory_set_launch (GstRTSPMediaFactory * factory,
215 const gchar * launch)
217 g_return_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory));
218 g_return_if_fail (launch != NULL);
220 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
221 g_free (factory->launch);
222 factory->launch = g_strdup (launch);
223 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
227 * gst_rtsp_media_factory_get_launch:
228 * @factory: a #GstRTSPMediaFactory
230 * Get the gst_parse_launch() pipeline description that will be used in the
231 * default prepare vmethod.
233 * Returns: the configured launch description. g_free() after usage.
236 gst_rtsp_media_factory_get_launch (GstRTSPMediaFactory * factory)
240 g_return_val_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory), NULL);
242 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
243 result = g_strdup (factory->launch);
244 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
250 * gst_rtsp_media_factory_set_shared:
251 * @factory: a #GstRTSPMediaFactory
252 * @shared: the new value
254 * Configure if media created from this factory can be shared between clients.
257 gst_rtsp_media_factory_set_shared (GstRTSPMediaFactory * factory,
260 g_return_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory));
262 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
263 factory->shared = shared;
264 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
268 * gst_rtsp_media_factory_is_shared:
269 * @factory: a #GstRTSPMediaFactory
271 * Get if media created from this factory can be shared between clients.
273 * Returns: %TRUE if the media will be shared between clients.
276 gst_rtsp_media_factory_is_shared (GstRTSPMediaFactory * factory)
280 g_return_val_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory), FALSE);
282 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
283 result = factory->shared;
284 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
290 * gst_rtsp_media_factory_set_eos_shutdown:
291 * @factory: a #GstRTSPMediaFactory
292 * @eos_shutdown: the new value
294 * Configure if media created from this factory will have an EOS sent to the
295 * pipeline before shutdown.
298 gst_rtsp_media_factory_set_eos_shutdown (GstRTSPMediaFactory * factory,
299 gboolean eos_shutdown)
301 g_return_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory));
303 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
304 factory->eos_shutdown = eos_shutdown;
305 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
309 * gst_rtsp_media_factory_is_eos_shutdown:
310 * @factory: a #GstRTSPMediaFactory
312 * Get if media created from this factory will have an EOS event sent to the
313 * pipeline before shutdown.
315 * Returns: %TRUE if the media will receive EOS before shutdown.
318 gst_rtsp_media_factory_is_eos_shutdown (GstRTSPMediaFactory * factory)
322 g_return_val_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory), FALSE);
324 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
325 result = factory->eos_shutdown;
326 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
332 * gst_rtsp_media_factory_set_auth:
333 * @factory: a #GstRTSPMediaFactory
334 * @auth: a #GstRTSPAuth
336 * configure @auth to be used as the authentication manager of @factory.
339 gst_rtsp_media_factory_set_auth (GstRTSPMediaFactory * factory,
344 g_return_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory));
351 factory->auth = auth;
353 g_object_unref (old);
359 * gst_rtsp_media_factory_get_auth:
360 * @factory: a #GstRTSPMediaFactory
362 * Get the #GstRTSPAuth used as the authentication manager of @factory.
364 * Returns: the #GstRTSPAuth of @factory. g_object_unref() after
368 gst_rtsp_factory_get_auth (GstRTSPMediaFactory * factory)
372 g_return_val_if_fail (GST_IS_RTSP_MEDIA_FACTORY (factory), NULL);
374 if ((result = factory->auth))
375 g_object_ref (result);
382 compare_media (gpointer key, GstRTSPMedia * media1, GstRTSPMedia * media2)
384 return (media1 == media2);
388 media_unprepared (GstRTSPMedia * media, GstRTSPMediaFactory * factory)
390 g_mutex_lock (factory->medias_lock);
391 g_hash_table_foreach_remove (factory->medias, (GHRFunc) compare_media, media);
392 g_mutex_unlock (factory->medias_lock);
396 * gst_rtsp_media_factory_construct:
397 * @factory: a #GstRTSPMediaFactory
400 * Prepare the media object and create its streams. Implementations
401 * should create the needed gstreamer elements and add them to the result
402 * object. No state changes should be performed on them yet.
404 * One or more GstRTSPMediaStream objects should be added to the result with
405 * the srcpad member set to a source pad that produces buffer of type
408 * Returns: a new #GstRTSPMedia if the media could be prepared.
411 gst_rtsp_media_factory_construct (GstRTSPMediaFactory * factory,
412 const GstRTSPUrl * url)
416 GstRTSPMediaFactoryClass *klass;
418 klass = GST_RTSP_MEDIA_FACTORY_GET_CLASS (factory);
420 /* convert the url to a key for the hashtable. NULL return or a NULL function
421 * will not cache anything for this factory. */
423 key = klass->gen_key (factory, url);
427 g_mutex_lock (factory->medias_lock);
429 /* we have a key, see if we find a cached media */
430 media = g_hash_table_lookup (factory->medias, key);
432 g_object_ref (media);
437 /* nothing cached found, try to create one */
438 if (klass->construct)
439 media = klass->construct (factory, url);
444 /* configure the media */
445 if (klass->configure)
446 klass->configure (factory, media);
448 /* check if we can cache this media */
449 if (gst_rtsp_media_is_shared (media)) {
450 /* insert in the hashtable, takes ownership of the key */
451 g_object_ref (media);
452 g_hash_table_insert (factory->medias, key, media);
455 if (!gst_rtsp_media_is_reusable (media)) {
456 /* when not reusable, connect to the unprepare signal to remove the item
457 * from our cache when it gets unprepared */
458 g_signal_connect (media, "unprepared", (GCallback) media_unprepared,
463 g_mutex_unlock (factory->medias_lock);
468 GST_INFO ("constructed media %p for url %s", media, url->abspath);
474 default_gen_key (GstRTSPMediaFactory * factory, const GstRTSPUrl * url)
477 const gchar *pre_query;
480 pre_query = url->query ? "?" : "";
481 query = url->query ? url->query : "";
484 g_strdup_printf ("%u%s%s%s", url->port, url->abspath, pre_query, query);
490 default_get_element (GstRTSPMediaFactory * factory, const GstRTSPUrl * url)
493 GError *error = NULL;
495 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
496 /* we need a parse syntax */
497 if (factory->launch == NULL)
500 /* parse the user provided launch line */
501 element = gst_parse_launch (factory->launch, &error);
505 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
508 /* a recoverable error was encountered */
509 GST_WARNING ("recoverable parsing error: %s", error->message);
510 g_error_free (error);
517 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
518 g_critical ("no launch line specified");
523 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
524 g_critical ("could not parse launch syntax (%s): %s", factory->launch,
525 (error ? error->message : "unknown reason"));
527 g_error_free (error);
532 /* try to find all the payloader elements, they should be named 'pay%d'. for
533 * each of the payloaders we will create a stream and collect the source pad. */
535 gst_rtsp_media_factory_collect_streams (GstRTSPMediaFactory * factory,
536 const GstRTSPUrl * url, GstRTSPMedia * media)
538 GstElement *element, *elem;
541 GstRTSPMediaStream *stream;
544 element = media->element;
547 for (i = 0; have_elem; i++) {
552 name = g_strdup_printf ("pay%d", i);
553 if ((elem = gst_bin_get_by_name (GST_BIN (element), name))) {
554 /* create the stream */
555 stream = g_new0 (GstRTSPMediaStream, 1);
556 stream->payloader = elem;
558 GST_INFO ("found stream %d with payloader %p", i, elem);
560 pad = gst_element_get_static_pad (elem, "src");
562 /* ghost the pad of the payloader to the element */
563 stream->srcpad = gst_ghost_pad_new (name, pad);
564 gst_pad_set_active (stream->srcpad, TRUE);
565 gst_element_add_pad (media->element, stream->srcpad);
566 gst_object_unref (elem);
569 g_array_append_val (media->streams, stream);
574 name = g_strdup_printf ("dynpay%d", i);
575 if ((elem = gst_bin_get_by_name (GST_BIN (element), name))) {
576 /* a stream that will dynamically create pads to provide RTP packets */
578 GST_INFO ("found dynamic element %d, %p", i, elem);
580 media->dynamic = g_list_prepend (media->dynamic, elem);
588 static GstRTSPMedia *
589 default_construct (GstRTSPMediaFactory * factory, const GstRTSPUrl * url)
593 GstRTSPMediaFactoryClass *klass;
595 klass = GST_RTSP_MEDIA_FACTORY_GET_CLASS (factory);
597 if (!klass->create_pipeline)
600 if (klass->get_element)
601 element = klass->get_element (factory, url);
607 /* create a new empty media */
608 media = gst_rtsp_media_new ();
609 media->element = element;
611 media->pipeline = klass->create_pipeline (factory, media);
612 if (media->pipeline == NULL)
615 gst_rtsp_media_factory_collect_streams (factory, url, media);
622 g_critical ("no create_pipeline function");
627 g_critical ("could not create element");
632 g_critical ("can't create pipeline");
633 g_object_unref (media);
639 default_create_pipeline (GstRTSPMediaFactory * factory, GstRTSPMedia * media)
641 GstElement *pipeline;
643 if (media->element == NULL)
646 pipeline = gst_pipeline_new ("media-pipeline");
647 gst_bin_add (GST_BIN_CAST (pipeline), media->element);
654 g_critical ("no element");
660 default_configure (GstRTSPMediaFactory * factory, GstRTSPMedia * media)
662 gboolean shared, eos_shutdown;
664 /* configure the sharedness */
665 GST_RTSP_MEDIA_FACTORY_LOCK (factory);
666 shared = factory->shared;
667 eos_shutdown = factory->eos_shutdown;
668 GST_RTSP_MEDIA_FACTORY_UNLOCK (factory);
670 gst_rtsp_media_set_shared (media, shared);
671 gst_rtsp_media_set_eos_shutdown (media, eos_shutdown);