rtsp-server: added annotations to indicate type of ownership transfer of return values
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-session-media.c
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 #include <string.h>
20
21 #include "rtsp-session.h"
22
23 #undef DEBUG
24
25 #define DEFAULT_TIMEOUT 60
26
27 enum
28 {
29   PROP_0,
30   PROP_LAST
31 };
32
33 GST_DEBUG_CATEGORY_STATIC (rtsp_session_media_debug);
34 #define GST_CAT_DEFAULT rtsp_session_media_debug
35
36 static void gst_rtsp_session_media_finalize (GObject * obj);
37
38 G_DEFINE_TYPE (GstRTSPSessionMedia, gst_rtsp_session_media, G_TYPE_OBJECT);
39
40 static void
41 gst_rtsp_session_media_class_init (GstRTSPSessionMediaClass * klass)
42 {
43   GObjectClass *gobject_class;
44
45   gobject_class = G_OBJECT_CLASS (klass);
46
47   gobject_class->finalize = gst_rtsp_session_media_finalize;
48
49   GST_DEBUG_CATEGORY_INIT (rtsp_session_media_debug, "rtspsessionmedia", 0,
50       "GstRTSPSessionMedia");
51 }
52
53 static void
54 gst_rtsp_session_media_init (GstRTSPSessionMedia * media)
55 {
56   media->state = GST_RTSP_STATE_INIT;
57 }
58
59 static void
60 gst_rtsp_session_media_finalize (GObject * obj)
61 {
62   GstRTSPSessionMedia *media;
63
64   media = GST_RTSP_SESSION_MEDIA (obj);
65
66   GST_INFO ("free session media %p", media);
67
68   gst_rtsp_session_media_set_state (media, GST_STATE_NULL);
69
70   g_ptr_array_unref (media->transports);
71
72   gst_rtsp_url_free (media->url);
73   g_object_unref (media->media);
74
75   G_OBJECT_CLASS (gst_rtsp_session_media_parent_class)->finalize (obj);
76 }
77
78 static void
79 free_session_media (gpointer data)
80 {
81   if (data)
82     g_object_unref (data);
83 }
84
85 /**
86  * gst_rtsp_session_media_new:
87  * @url: the #GstRTSPUrl
88  * @media: the #GstRTSPMedia
89  *
90  * Create a new #GstRTPSessionMedia that manages the streams
91  * in @media for @url. @media should be prepared.
92  *
93  * Ownership is taken of @media.
94  *
95  * Returns: a new #GstRTSPSessionMedia.
96  */
97 GstRTSPSessionMedia *
98 gst_rtsp_session_media_new (const GstRTSPUrl * url, GstRTSPMedia * media)
99 {
100   GstRTSPSessionMedia *result;
101   guint n_streams;
102
103   g_return_val_if_fail (url != NULL, NULL);
104   g_return_val_if_fail (GST_IS_RTSP_MEDIA (media), NULL);
105   g_return_val_if_fail (media->status == GST_RTSP_MEDIA_STATUS_PREPARED, NULL);
106
107   result = g_object_new (GST_TYPE_RTSP_SESSION_MEDIA, NULL);
108   result->url = gst_rtsp_url_copy ((GstRTSPUrl *) url);
109   result->media = media;
110
111   /* prealloc the streams now, filled with NULL */
112   n_streams = gst_rtsp_media_n_streams (media);
113   result->transports = g_ptr_array_new_full (n_streams, free_session_media);
114   g_ptr_array_set_size (result->transports, n_streams);
115
116   return result;
117 }
118
119 /**
120  * gst_rtsp_session_media_set_transport:
121  * @media: a #GstRTSPSessionMedia
122  * @stream: a #GstRTSPStream
123  * @tr: a #GstRTSPTransport
124  *
125  * Configure the transport for @stream to @tr in @media.
126  *
127  * Returns: (transfer none): the new or updated #GstRTSPStreamTransport for @stream.
128  */
129 GstRTSPStreamTransport *
130 gst_rtsp_session_media_set_transport (GstRTSPSessionMedia * media,
131     GstRTSPStream * stream, GstRTSPTransport * tr)
132 {
133   GstRTSPStreamTransport *result;
134
135   g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
136   g_return_val_if_fail (GST_IS_RTSP_STREAM (stream), NULL);
137   g_return_val_if_fail (stream->idx < media->transports->len, NULL);
138
139   result = g_ptr_array_index (media->transports, stream->idx);
140   if (result == NULL) {
141     result = gst_rtsp_stream_transport_new (stream, tr);
142     g_ptr_array_index (media->transports, stream->idx) = result;
143   } else {
144     gst_rtsp_stream_transport_set_transport (result, tr);
145   }
146   return result;
147 }
148
149 /**
150  * gst_rtsp_session_media_get_transport:
151  * @media: a #GstRTSPSessionMedia
152  * @idx: the stream index
153  *
154  * Get a previously created #GstRTSPStreamTransport for the stream at @idx.
155  *
156  * Returns: (transfer none): a #GstRTSPStreamTransport that is valid until the
157  * session of @media is unreffed.
158  */
159 GstRTSPStreamTransport *
160 gst_rtsp_session_media_get_transport (GstRTSPSessionMedia * media, guint idx)
161 {
162   GstRTSPStreamTransport *result;
163
164   g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), NULL);
165   g_return_val_if_fail (idx < media->transports->len, NULL);
166
167   result = g_ptr_array_index (media->transports, idx);
168
169   return result;
170 }
171
172 /**
173  * gst_rtsp_session_media_alloc_channels:
174  * @media: a #GstRTSPSessionMedia
175  * @range: a #GstRTSPRange
176  *
177  * Fill @range with the next available min and max channels for
178  * interleaved transport.
179  *
180  * Returns: %TRUE on success.
181  */
182 gboolean
183 gst_rtsp_session_media_alloc_channels (GstRTSPSessionMedia * media,
184     GstRTSPRange * range)
185 {
186   g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), FALSE);
187
188   range->min = media->counter++;
189   range->max = media->counter++;
190
191   return TRUE;
192 }
193
194 /**
195  * gst_rtsp_session_media_set_state:
196  * @media: a #GstRTSPSessionMedia
197  * @state: the new state
198  *
199  * Tell the media object @media to change to @state.
200  *
201  * Returns: %TRUE on success.
202  */
203 gboolean
204 gst_rtsp_session_media_set_state (GstRTSPSessionMedia * media, GstState state)
205 {
206   gboolean ret;
207
208   g_return_val_if_fail (GST_IS_RTSP_SESSION_MEDIA (media), FALSE);
209
210   ret = gst_rtsp_media_set_state (media->media, state, media->transports);
211
212   return ret;
213 }