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/gstrtsprange.h>
22 #include <gst/rtsp/gstrtspurl.h>
23 #include <gst/net/gstnet.h>
25 #ifndef __GST_RTSP_MEDIA_H__
26 #define __GST_RTSP_MEDIA_H__
30 /* types for the media */
31 #define GST_TYPE_RTSP_MEDIA (gst_rtsp_media_get_type ())
32 #define GST_IS_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA))
33 #define GST_IS_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA))
34 #define GST_RTSP_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
35 #define GST_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMedia))
36 #define GST_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
37 #define GST_RTSP_MEDIA_CAST(obj) ((GstRTSPMedia*)(obj))
38 #define GST_RTSP_MEDIA_CLASS_CAST(klass) ((GstRTSPMediaClass*)(klass))
40 typedef struct _GstRTSPMedia GstRTSPMedia;
41 typedef struct _GstRTSPMediaClass GstRTSPMediaClass;
42 typedef struct _GstRTSPMediaPrivate GstRTSPMediaPrivate;
46 * @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
47 * @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
49 * @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
50 * @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
51 * @GST_RTSP_MEDIA_STATUS_SUSPENDED: media is suspended
52 * @GST_RTSP_MEDIA_STATUS_ERROR: media pipeline is in error
54 * The state of the media pipeline.
57 GST_RTSP_MEDIA_STATUS_UNPREPARED = 0,
58 GST_RTSP_MEDIA_STATUS_UNPREPARING = 1,
59 GST_RTSP_MEDIA_STATUS_PREPARING = 2,
60 GST_RTSP_MEDIA_STATUS_PREPARED = 3,
61 GST_RTSP_MEDIA_STATUS_SUSPENDED = 4,
62 GST_RTSP_MEDIA_STATUS_ERROR = 5
67 * @GST_RTSP_SUSPEND_MODE_NONE: Media is not suspended
68 * @GST_RTSP_SUSPEND_MODE_PAUSE: Media is PAUSED in suspend
69 * @GST_RTSP_SUSPEND_MODE_RESET: The media is set to NULL when suspended
71 * The suspend mode of the media pipeline. A media pipeline is suspended right
72 * after creating the SDP and when the client performs a PAUSED request.
75 GST_RTSP_SUSPEND_MODE_NONE = 0,
76 GST_RTSP_SUSPEND_MODE_PAUSE = 1,
77 GST_RTSP_SUSPEND_MODE_RESET = 2
81 * GstRTSPTransportMode:
82 * @GST_RTSP_TRANSPORT_MODE_PLAY: Transport supports PLAY mode
83 * @GST_RTSP_TRANSPORT_MODE_RECORD: Transport supports RECORD mode
85 * The supported modes of the media.
88 GST_RTSP_TRANSPORT_MODE_PLAY = 1,
89 GST_RTSP_TRANSPORT_MODE_RECORD = 2,
90 } GstRTSPTransportMode;
92 #define GST_TYPE_RTSP_TRANSPORT_MODE (gst_rtsp_transport_mode_get_type())
93 GType gst_rtsp_transport_mode_get_type (void);
95 #define GST_TYPE_RTSP_SUSPEND_MODE (gst_rtsp_suspend_mode_get_type())
96 GType gst_rtsp_suspend_mode_get_type (void);
98 #include "rtsp-stream.h"
99 #include "rtsp-thread-pool.h"
100 #include "rtsp-permissions.h"
101 #include "rtsp-address-pool.h"
102 #include "rtsp-sdp.h"
107 * A class that contains the GStreamer element along with a list of
108 * #GstRTSPStream objects that can produce data.
110 * This object is usually created from a #GstRTSPMediaFactory.
112 struct _GstRTSPMedia {
116 GstRTSPMediaPrivate *priv;
117 gpointer _gst_reserved[GST_PADDING];
122 * @handle_message: handle a message
123 * @prepare: the default implementation adds all elements and sets the
124 * pipeline's state to GST_STATE_PAUSED (or GST_STATE_PLAYING
125 * in case of NO_PREROLL elements).
126 * @unprepare: the default implementation sets the pipeline's state
127 * to GST_STATE_NULL and removes all elements.
128 * @suspend: the default implementation sets the pipeline's state to
129 * GST_STATE_NULL GST_STATE_PAUSED depending on the selected
131 * @unsuspend: the default implementation reverts the suspend operation.
132 * The pipeline will be prerolled again if it's state was
133 * set to GST_STATE_NULL in suspend.
134 * @convert_range: convert a range to the given unit
135 * @query_position: query the current position in the pipeline
136 * @query_stop: query when playback will stop
138 * The RTSP media class
140 struct _GstRTSPMediaClass {
141 GObjectClass parent_class;
144 gboolean (*handle_message) (GstRTSPMedia *media, GstMessage *message);
145 gboolean (*prepare) (GstRTSPMedia *media, GstRTSPThread *thread);
146 gboolean (*unprepare) (GstRTSPMedia *media);
147 gboolean (*suspend) (GstRTSPMedia *media);
148 gboolean (*unsuspend) (GstRTSPMedia *media);
149 gboolean (*convert_range) (GstRTSPMedia *media, GstRTSPTimeRange *range,
150 GstRTSPRangeUnit unit);
151 gboolean (*query_position) (GstRTSPMedia *media, gint64 *position);
152 gboolean (*query_stop) (GstRTSPMedia *media, gint64 *stop);
153 GstElement * (*create_rtpbin) (GstRTSPMedia *media);
154 gboolean (*setup_rtpbin) (GstRTSPMedia *media, GstElement *rtpbin);
155 gboolean (*setup_sdp) (GstRTSPMedia *media, GstSDPMessage *sdp, GstSDPInfo *info);
158 void (*new_stream) (GstRTSPMedia *media, GstRTSPStream * stream);
159 void (*removed_stream) (GstRTSPMedia *media, GstRTSPStream * stream);
161 void (*prepared) (GstRTSPMedia *media);
162 void (*unprepared) (GstRTSPMedia *media);
164 void (*target_state) (GstRTSPMedia *media, GstState state);
165 void (*new_state) (GstRTSPMedia *media, GstState state);
167 gboolean (*handle_sdp) (GstRTSPMedia *media, GstSDPMessage *sdp);
170 gpointer _gst_reserved[GST_PADDING_LARGE-1];
173 GType gst_rtsp_media_get_type (void);
175 /* creating the media */
176 GstRTSPMedia * gst_rtsp_media_new (GstElement *element);
177 GstElement * gst_rtsp_media_get_element (GstRTSPMedia *media);
179 void gst_rtsp_media_take_pipeline (GstRTSPMedia *media, GstPipeline *pipeline);
181 GstRTSPMediaStatus gst_rtsp_media_get_status (GstRTSPMedia *media);
183 void gst_rtsp_media_set_permissions (GstRTSPMedia *media,
184 GstRTSPPermissions *permissions);
185 GstRTSPPermissions * gst_rtsp_media_get_permissions (GstRTSPMedia *media);
187 void gst_rtsp_media_set_shared (GstRTSPMedia *media, gboolean shared);
188 gboolean gst_rtsp_media_is_shared (GstRTSPMedia *media);
190 void gst_rtsp_media_set_transport_mode (GstRTSPMedia *media, GstRTSPTransportMode mode);
191 GstRTSPTransportMode gst_rtsp_media_get_transport_mode (GstRTSPMedia *media);
193 void gst_rtsp_media_set_reusable (GstRTSPMedia *media, gboolean reusable);
194 gboolean gst_rtsp_media_is_reusable (GstRTSPMedia *media);
196 void gst_rtsp_media_set_profiles (GstRTSPMedia *media, GstRTSPProfile profiles);
197 GstRTSPProfile gst_rtsp_media_get_profiles (GstRTSPMedia *media);
199 void gst_rtsp_media_set_protocols (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
200 GstRTSPLowerTrans gst_rtsp_media_get_protocols (GstRTSPMedia *media);
202 void gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
203 gboolean gst_rtsp_media_is_eos_shutdown (GstRTSPMedia *media);
205 void gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
206 GstRTSPAddressPool * gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
208 void gst_rtsp_media_set_buffer_size (GstRTSPMedia *media, guint size);
209 guint gst_rtsp_media_get_buffer_size (GstRTSPMedia *media);
211 void gst_rtsp_media_set_retransmission_time (GstRTSPMedia *media, GstClockTime time);
212 GstClockTime gst_rtsp_media_get_retransmission_time (GstRTSPMedia *media);
214 void gst_rtsp_media_set_latency (GstRTSPMedia *media, guint latency);
215 guint gst_rtsp_media_get_latency (GstRTSPMedia *media);
217 void gst_rtsp_media_use_time_provider (GstRTSPMedia *media, gboolean time_provider);
218 gboolean gst_rtsp_media_is_time_provider (GstRTSPMedia *media);
219 GstNetTimeProvider * gst_rtsp_media_get_time_provider (GstRTSPMedia *media,
220 const gchar *address, guint16 port);
222 /* prepare the media for playback */
223 gboolean gst_rtsp_media_prepare (GstRTSPMedia *media, GstRTSPThread *thread);
224 gboolean gst_rtsp_media_unprepare (GstRTSPMedia *media);
226 void gst_rtsp_media_set_suspend_mode (GstRTSPMedia *media, GstRTSPSuspendMode mode);
227 GstRTSPSuspendMode gst_rtsp_media_get_suspend_mode (GstRTSPMedia *media);
229 gboolean gst_rtsp_media_suspend (GstRTSPMedia *media);
230 gboolean gst_rtsp_media_unsuspend (GstRTSPMedia *media);
232 gboolean gst_rtsp_media_setup_sdp (GstRTSPMedia * media, GstSDPMessage * sdp,
235 gboolean gst_rtsp_media_handle_sdp (GstRTSPMedia * media, GstSDPMessage * sdp);
238 /* creating streams */
239 void gst_rtsp_media_collect_streams (GstRTSPMedia *media);
240 GstRTSPStream * gst_rtsp_media_create_stream (GstRTSPMedia *media,
241 GstElement *payloader,
244 /* dealing with the media */
245 GstClock * gst_rtsp_media_get_clock (GstRTSPMedia *media);
246 GstClockTime gst_rtsp_media_get_base_time (GstRTSPMedia *media);
248 guint gst_rtsp_media_n_streams (GstRTSPMedia *media);
249 GstRTSPStream * gst_rtsp_media_get_stream (GstRTSPMedia *media, guint idx);
250 GstRTSPStream * gst_rtsp_media_find_stream (GstRTSPMedia *media, const gchar * control);
252 gboolean gst_rtsp_media_seek (GstRTSPMedia *media, GstRTSPTimeRange *range);
253 gchar * gst_rtsp_media_get_range_string (GstRTSPMedia *media,
255 GstRTSPRangeUnit unit);
257 gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state,
258 GPtrArray *transports);
259 void gst_rtsp_media_set_pipeline_state (GstRTSPMedia * media,
264 #endif /* __GST_RTSP_MEDIA_H__ */