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.
20 * SECTION:rtsp-session-media
21 * @short_description: Media managed in a session
22 * @see_also: #GstRTSPMedia, #GstRTSPSession
24 * The #GstRTSPSessionMedia object manages a #GstRTSPMedia with a given path.
26 * With gst_rtsp_session_media_get_transport() and
27 * gst_rtsp_session_media_set_transport() the transports of a #GstRTSPStream of
28 * the managed #GstRTSPMedia can be retrieved and configured.
30 * Use gst_rtsp_session_media_set_state() to control the media state and
33 * Last reviewed on 2013-07-16 (1.0.0)
38 #include "rtsp-session.h"
40 #define GST_RTSP_SESSION_MEDIA_GET_PRIVATE(obj) \
41 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_RTSP_SESSION_MEDIA, GstRTSPSessionMediaPrivate))
43 struct _GstRTSPSessionMediaPrivate
46 gchar *path; /* unmutable */
47 gint path_len; /* unmutable */
48 GstRTSPMedia *media; /* unmutable */
49 GstRTSPState state; /* protected by lock */
50 guint counter; /* protected by lock */
52 GPtrArray *transports; /* protected by lock */
61 GST_DEBUG_CATEGORY_STATIC (rtsp_session_media_debug);
62 #define GST_CAT_DEFAULT rtsp_session_media_debug
64 static void gst_rtsp_session_media_finalize (GObject * obj);
66 G_DEFINE_TYPE (GstRTSPSessionMedia, gst_rtsp_session_media, G_TYPE_OBJECT);
69 gst_rtsp_session_media_class_init (GstRTSPSessionMediaClass * klass)
71 GObjectClass *gobject_class;
73 g_type_class_add_private (klass, sizeof (GstRTSPSessionMediaPrivate));
75 gobject_class = G_OBJECT_CLASS (klass);
77 gobject_class->finalize = gst_rtsp_session_media_finalize;
79 GST_DEBUG_CATEGORY_INIT (rtsp_session_media_debug, "rtspsessionmedia", 0,
80 "GstRTSPSessionMedia");
84 gst_rtsp_session_media_init (GstRTSPSessionMedia * media)
86 GstRTSPSessionMediaPrivate *priv = GST_RTSP_SESSION_MEDIA_GET_PRIVATE (media);
90 g_mutex_init (&priv->lock);
91 priv->state = GST_RTSP_STATE_INIT;
95 gst_rtsp_session_media_finalize (GObject * obj)
97 GstRTSPSessionMedia *media;
98 GstRTSPSessionMediaPrivate *priv;
100 media = GST_RTSP_SESSION_MEDIA (obj);
103 GST_INFO ("free session media %p", media);
105 gst_rtsp_session_media_set_state (media, GST_STATE_NULL);
107 g_ptr_array_unref (priv->transports);
110 g_object_unref (priv->media);
111 g_mutex_clear (&priv->lock);
113 G_OBJECT_CLASS (gst_rtsp_session_media_parent_class)->finalize (obj);
117 free_session_media (gpointer data)
120 g_object_unref (data);
124 * gst_rtsp_session_media_new:
126 * @media: the #GstRTSPMedia
128 * Create a new #GstRTSPSessionMedia that manages the streams
129 * in @media for @path. @media should be prepared.
131 * Ownership is taken of @media.
133 * Returns: a new #GstRTSPSessionMedia.
135 GstRTSPSessionMedia *
136 gst_rtsp_session_media_new (const gchar * path, GstRTSPMedia * media)
138 GstRTSPSessionMediaPrivate *priv;
139 GstRTSPSessionMedia *result;
141 GstRTSPMediaStatus status;
143 g_return_val_if_fail (path != NULL, NULL);
144 g_return_val_if_fail (GST_IS_RTSP_MEDIA (media), NULL);
145 status = gst_rtsp_media_get_status (media);
146 g_return_val_if_fail (status == GST_RTSP_MEDIA_STATUS_PREPARED || status ==
147 GST_RTSP_MEDIA_STATUS_SUSPENDED, NULL);
149 result = g_object_new (GST_TYPE_RTSP_SESSION_MEDIA, NULL);
152 priv->path = g_strdup (path);
153 priv->path_len = strlen (path);
156 /* prealloc the streams now, filled with NULL */
157 n_streams = gst_rtsp_media_n_streams (media);
158 priv->transports = g_ptr_array_new_full (n_streams, free_session_media);
159 g_ptr_array_set_size (priv->transports, n_streams);
165 * gst_rtsp_session_media_matches:
166 * @media: a #GstRTSPSessionMedia
168 * @matched: (out): the amount of matched characters of @path
170 * Check if the path of @media matches @path. It @path matches, the amount of
171 * matched characters is returned in @matched.
173 * Returns: %TRUE when @path matches the path of @media.
176 gst_rtsp_session_media_matches (GstRTSPSessionMedia * media,
177 const gchar * path, gint * matched)
179 GstRTSPSessionMediaPrivate *priv;
182 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), FALSE);
183 g_return_val_if_fail (path != NULL, FALSE);
184 g_return_val_if_fail (matched != NULL, FALSE);
189 /* path needs to be smaller than the media path */
190 if (len < priv->path_len)
193 /* if media path is larger, it there should be a / following the path */
194 if (len > priv->path_len && path[priv->path_len] != '/')
197 *matched = priv->path_len;
199 return strncmp (path, priv->path, priv->path_len) == 0;
203 * gst_rtsp_session_media_get_media:
204 * @media: a #GstRTSPSessionMedia
206 * Get the #GstRTSPMedia that was used when constructing @media
208 * Returns: (transfer none): the #GstRTSPMedia of @media. Remains valid as long
209 * as @media is valid.
212 gst_rtsp_session_media_get_media (GstRTSPSessionMedia * media)
214 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
216 return media->priv->media;
220 * gst_rtsp_session_media_get_base_time:
221 * @media: a #GstRTSPSessionMedia
223 * Get the base_time of the #GstRTSPMedia in @media
225 * Returns: the base_time of the media.
228 gst_rtsp_session_media_get_base_time (GstRTSPSessionMedia * media)
230 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), GST_CLOCK_TIME_NONE);
232 return gst_rtsp_media_get_base_time (media->priv->media);
236 * gst_rtsp_session_media_get_rtpinfo:
237 * @media: a #GstRTSPSessionMedia
239 * Retrieve the RTP-Info header string for all streams in @media
240 * with configured transports.
242 * Returns: (transfer full): The RTP-Info as a string, g_free()
246 gst_rtsp_session_media_get_rtpinfo (GstRTSPSessionMedia * media)
248 GstRTSPSessionMediaPrivate *priv;
249 GString *rtpinfo = NULL;
250 GstRTSPStreamTransport *transport;
251 GstRTSPStream *stream;
253 GstClockTime earliest = GST_CLOCK_TIME_NONE;
255 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
258 g_mutex_lock (&priv->lock);
260 if (gst_rtsp_media_get_status (priv->media) != GST_RTSP_MEDIA_STATUS_PREPARED)
263 n_streams = priv->transports->len;
265 /* first step, take lowest running-time from all streams */
266 GST_LOG_OBJECT (media, "determining start time among %d transports",
269 for (i = 0; i < n_streams; i++) {
270 GstClockTime running_time;
272 transport = g_ptr_array_index (priv->transports, i);
273 if (transport == NULL) {
274 GST_DEBUG_OBJECT (media, "ignoring unconfigured transport %d", i);
278 stream = gst_rtsp_stream_transport_get_stream (transport);
279 if (!gst_rtsp_stream_get_rtpinfo (stream, NULL, NULL, NULL, &running_time))
282 GST_LOG_OBJECT (media, "running time of %d stream: %" GST_TIME_FORMAT, i,
283 GST_TIME_ARGS (running_time));
285 if (!GST_CLOCK_TIME_IS_VALID (earliest)) {
286 earliest = running_time;
288 earliest = MIN (earliest, running_time);
292 GST_LOG_OBJECT (media, "media start time: %" GST_TIME_FORMAT,
293 GST_TIME_ARGS (earliest));
295 /* next step, scale all rtptime of all streams to lowest running-time */
296 GST_LOG_OBJECT (media, "collecting RTP info for %d transports", n_streams);
298 for (i = 0; i < n_streams; i++) {
299 gchar *stream_rtpinfo;
301 transport = g_ptr_array_index (priv->transports, i);
302 if (transport == NULL) {
303 GST_DEBUG_OBJECT (media, "ignoring unconfigured transport %d", i);
308 gst_rtsp_stream_transport_get_rtpinfo (transport, earliest);
309 if (stream_rtpinfo == NULL)
310 goto stream_rtpinfo_missing;
313 rtpinfo = g_string_new ("");
315 g_string_append (rtpinfo, ", ");
317 g_string_append (rtpinfo, stream_rtpinfo);
318 g_free (stream_rtpinfo);
321 if (rtpinfo == NULL) {
322 GST_INFO_OBJECT (media, "no transports configured, RTP info is empty");
323 rtpinfo = g_string_new ("");
326 g_mutex_unlock (&priv->lock);
328 return g_string_free (rtpinfo, FALSE);
333 g_mutex_unlock (&priv->lock);
334 GST_ERROR_OBJECT (media, "media was not prepared");
337 stream_rtpinfo_missing:
339 g_mutex_unlock (&priv->lock);
341 g_string_free (rtpinfo, TRUE);
342 GST_ERROR_OBJECT (media, "could not get stream %d rtpinfo", i);
348 * gst_rtsp_session_media_set_transport:
349 * @media: a #GstRTSPSessionMedia
350 * @stream: a #GstRTSPStream
351 * @tr: a #GstRTSPTransport
353 * Configure the transport for @stream to @tr in @media.
355 * Returns: (transfer none): the new or updated #GstRTSPStreamTransport for @stream.
357 GstRTSPStreamTransport *
358 gst_rtsp_session_media_set_transport (GstRTSPSessionMedia * media,
359 GstRTSPStream * stream, GstRTSPTransport * tr)
361 GstRTSPSessionMediaPrivate *priv;
362 GstRTSPStreamTransport *result;
365 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
366 g_return_val_if_fail (GST_IS_RTSP_STREAM (stream), NULL);
367 g_return_val_if_fail (tr != NULL, NULL);
369 idx = gst_rtsp_stream_get_index (stream);
370 g_return_val_if_fail (idx < priv->transports->len, NULL);
372 g_mutex_lock (&priv->lock);
373 result = g_ptr_array_index (priv->transports, idx);
374 if (result == NULL) {
375 result = gst_rtsp_stream_transport_new (stream, tr);
376 g_ptr_array_index (priv->transports, idx) = result;
377 g_mutex_unlock (&priv->lock);
379 gst_rtsp_stream_transport_set_transport (result, tr);
380 g_mutex_unlock (&priv->lock);
387 * gst_rtsp_session_media_get_transport:
388 * @media: a #GstRTSPSessionMedia
389 * @idx: the stream index
391 * Get a previously created #GstRTSPStreamTransport for the stream at @idx.
393 * Returns: (transfer none): a #GstRTSPStreamTransport that is valid until the
394 * session of @media is unreffed.
396 GstRTSPStreamTransport *
397 gst_rtsp_session_media_get_transport (GstRTSPSessionMedia * media, guint idx)
399 GstRTSPSessionMediaPrivate *priv;
400 GstRTSPStreamTransport *result;
402 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
404 g_return_val_if_fail (idx < priv->transports->len, NULL);
406 g_mutex_lock (&priv->lock);
407 result = g_ptr_array_index (priv->transports, idx);
408 g_mutex_unlock (&priv->lock);
414 * gst_rtsp_session_media_alloc_channels:
415 * @media: a #GstRTSPSessionMedia
416 * @range: a #GstRTSPRange
418 * Fill @range with the next available min and max channels for
419 * interleaved transport.
421 * Returns: %TRUE on success.
424 gst_rtsp_session_media_alloc_channels (GstRTSPSessionMedia * media,
425 GstRTSPRange * range)
427 GstRTSPSessionMediaPrivate *priv;
429 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), FALSE);
433 g_mutex_lock (&priv->lock);
434 range->min = priv->counter++;
435 range->max = priv->counter++;
436 g_mutex_unlock (&priv->lock);
442 * gst_rtsp_session_media_set_state:
443 * @media: a #GstRTSPSessionMedia
444 * @state: the new state
446 * Tell the media object @media to change to @state.
448 * Returns: %TRUE on success.
451 gst_rtsp_session_media_set_state (GstRTSPSessionMedia * media, GstState state)
453 GstRTSPSessionMediaPrivate *priv;
456 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), FALSE);
460 g_mutex_lock (&priv->lock);
461 ret = gst_rtsp_media_set_state (priv->media, state, priv->transports);
462 g_mutex_unlock (&priv->lock);
468 * gst_rtsp_session_media_set_rtsp_state:
469 * @media: a #GstRTSPSessionMedia
470 * @state: a #GstRTSPState
472 * Set the RTSP state of @media to @state.
475 gst_rtsp_session_media_set_rtsp_state (GstRTSPSessionMedia * media,
478 GstRTSPSessionMediaPrivate *priv;
480 g_return_if_fail (GST_IS_RTSP_SESSION_MEDIA (media));
484 g_mutex_lock (&priv->lock);
486 g_mutex_unlock (&priv->lock);
490 * gst_rtsp_session_media_get_rtsp_state:
491 * @media: a #GstRTSPSessionMedia
493 * Get the current RTSP state of @media.
495 * Returns: the current RTSP state of @media.
498 gst_rtsp_session_media_get_rtsp_state (GstRTSPSessionMedia * media)
500 GstRTSPSessionMediaPrivate *priv;
503 g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media),
504 GST_RTSP_STATE_INVALID);
508 g_mutex_lock (&priv->lock);
510 g_mutex_unlock (&priv->lock);