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>
24 #ifndef __GST_RTSP_MEDIA_H__
25 #define __GST_RTSP_MEDIA_H__
29 /* types for the media */
30 #define GST_TYPE_RTSP_MEDIA (gst_rtsp_media_get_type ())
31 #define GST_IS_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA))
32 #define GST_IS_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA))
33 #define GST_RTSP_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
34 #define GST_RTSP_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMedia))
35 #define GST_RTSP_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
36 #define GST_RTSP_MEDIA_CAST(obj) ((GstRTSPMedia*)(obj))
37 #define GST_RTSP_MEDIA_CLASS_CAST(klass) ((GstRTSPMediaClass*)(klass))
39 typedef struct _GstRTSPMedia GstRTSPMedia;
40 typedef struct _GstRTSPMediaClass GstRTSPMediaClass;
42 #include "rtsp-stream.h"
43 #include "rtsp-auth.h"
47 * @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
48 * @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
50 * @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
51 * @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
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_ERROR = 4
66 * @parent: parent GObject
67 * @lock: for protecting the object
68 * @cond: for signaling the object
69 * @shared: if this media can be shared between clients
70 * @reusable: if this media can be reused after an unprepare
71 * @protocols: the allowed lower transport for this stream
72 * @reused: if this media has been reused
73 * @is_ipv6: if this media is using ipv6
74 * @eos_shutdown: if EOS should be sent on shutdown
75 * @buffer_size: The UDP buffer size
76 * @auth: the authentication service in use
77 * @multicast_group: the multicast group to use
78 * @mtu: the MTU of the payloaders
79 * @element: the data providing element
80 * @streams: the different #GstRTSPStream provided by @element
81 * @dynamic: list of dynamic elements managed by @element
82 * @status: the status of the media pipeline
83 * @n_active: the number of active connections
84 * @adding: when elements are added to the pipeline
85 * @pipeline: the toplevel pipeline
86 * @fakesink: for making state changes async
87 * @source: the bus watch for pipeline messages.
88 * @id: the id of the watch
89 * @is_live: if the pipeline is live
90 * @seekable: if the pipeline can perform a seek
91 * @buffering: if the pipeline is buffering
92 * @target_state: the desired target state of the pipeline
94 * @range: the range of the media being streamed
96 * A class that contains the GStreamer element along with a list of
97 * #GstRTSPStream objects that can produce data.
99 * This object is usually created from a #GstRTSPMediaFactory.
101 struct _GstRTSPMedia {
109 GstRTSPLowerTrans protocols;
112 gboolean eos_shutdown;
115 gchar *multicast_group;
119 GRecMutex state_lock;
122 GstRTSPMediaStatus status;
126 /* the pipeline for the media */
127 GstElement *pipeline;
128 GstElement *fakesink;
135 GstState target_state;
137 /* RTP session manager */
140 /* the range of media */
141 GstRTSPTimeRange range;
146 * @context: the main context for dispatching messages
147 * @loop: the mainloop for message.
148 * @thread: the thread dispatching messages.
149 * @handle_message: handle a message
150 * @unprepare: the default implementation sets the pipeline's state
151 * to GST_STATE_NULL and removes all elements.
153 * The RTSP media class
155 struct _GstRTSPMediaClass {
156 GObjectClass parent_class;
158 /* thread for the mainloop */
159 GMainContext *context;
164 gboolean (*handle_message) (GstRTSPMedia *media, GstMessage *message);
165 gboolean (*unprepare) (GstRTSPMedia *media);
168 gboolean (*prepared) (GstRTSPMedia *media);
169 gboolean (*unprepared) (GstRTSPMedia *media);
171 gboolean (*new_state) (GstRTSPMedia *media, GstState state);
174 GType gst_rtsp_media_get_type (void);
176 /* creating the media */
177 GstRTSPMedia * gst_rtsp_media_new (void);
179 void gst_rtsp_media_set_shared (GstRTSPMedia *media, gboolean shared);
180 gboolean gst_rtsp_media_is_shared (GstRTSPMedia *media);
182 void gst_rtsp_media_set_reusable (GstRTSPMedia *media, gboolean reusable);
183 gboolean gst_rtsp_media_is_reusable (GstRTSPMedia *media);
185 void gst_rtsp_media_set_protocols (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
186 GstRTSPLowerTrans gst_rtsp_media_get_protocols (GstRTSPMedia *media);
188 void gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
189 gboolean gst_rtsp_media_is_eos_shutdown (GstRTSPMedia *media);
191 void gst_rtsp_media_set_auth (GstRTSPMedia *media, GstRTSPAuth *auth);
192 GstRTSPAuth * gst_rtsp_media_get_auth (GstRTSPMedia *media);
194 void gst_rtsp_media_set_buffer_size (GstRTSPMedia *media, guint size);
195 guint gst_rtsp_media_get_buffer_size (GstRTSPMedia *media);
197 void gst_rtsp_media_set_multicast_group (GstRTSPMedia *media, const gchar * mc);
198 gchar * gst_rtsp_media_get_multicast_group (GstRTSPMedia *media);
200 void gst_rtsp_media_set_mtu (GstRTSPMedia *media, guint mtu);
201 guint gst_rtsp_media_get_mtu (GstRTSPMedia *media);
204 /* prepare the media for playback */
205 gboolean gst_rtsp_media_prepare (GstRTSPMedia *media);
206 gboolean gst_rtsp_media_unprepare (GstRTSPMedia *media);
208 /* creating streams */
209 void gst_rtsp_media_collect_streams (GstRTSPMedia *media);
210 GstRTSPStream * gst_rtsp_media_create_stream (GstRTSPMedia *media,
211 GstElement *payloader,
214 /* dealing with the media */
215 guint gst_rtsp_media_n_streams (GstRTSPMedia *media);
216 GstRTSPStream * gst_rtsp_media_get_stream (GstRTSPMedia *media, guint idx);
218 gboolean gst_rtsp_media_seek (GstRTSPMedia *media, GstRTSPTimeRange *range);
219 gchar * gst_rtsp_media_get_range_string (GstRTSPMedia *media, gboolean play);
221 gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state,
222 GPtrArray *transports);
226 #endif /* __GST_RTSP_MEDIA_H__ */