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.
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 _GstRTSPMediaStream GstRTSPMediaStream;
40 typedef struct _GstRTSPMedia GstRTSPMedia;
41 typedef struct _GstRTSPMediaClass GstRTSPMediaClass;
42 typedef struct _GstRTSPMediaTrans GstRTSPMediaTrans;
44 typedef gboolean (*GstRTSPSendFunc) (GstBuffer *buffer, guint8 channel, gpointer user_data);
45 typedef void (*GstRTSPKeepAliveFunc) (gpointer user_data);
49 * @idx: a stream index
50 * @send_rtp: callback for sending RTP messages
51 * @send_rtcp: callback for sending RTCP messages
52 * @user_data: user data passed in the callbacks
53 * @notify: free function for the user_data.
54 * @keep_alive: keep alive callback
55 * @ka_user_data: data passed to @keep_alive
56 * @ka_notify: called when @ka_user_data is freed
57 * @active: if we are actively sending
58 * @timeout: if we timed out
59 * @transport: a transport description
60 * @rtpsource: the receiver rtp source object
62 * A Transport description for stream @idx
64 struct _GstRTSPMediaTrans {
67 GstRTSPSendFunc send_rtp;
68 GstRTSPSendFunc send_rtcp;
70 GDestroyNotify notify;
72 GstRTSPKeepAliveFunc keep_alive;
73 gpointer ka_user_data;
74 GDestroyNotify ka_notify;
78 GstRTSPTransport *transport;
86 * @srcpad: the srcpad of the stream
87 * @payloader: the payloader of the format
88 * @prepared: if the stream is prepared for streaming
89 * @server_port: the server udp ports
90 * @recv_rtp_sink: sinkpad for RTP buffers
91 * @recv_rtcp_sink: sinkpad for RTCP buffers
92 * @recv_rtp_src: srcpad for RTP buffers
93 * @recv_rtcp_src: srcpad for RTCP buffers
94 * @udpsrc: the udp source elements for RTP/RTCP
95 * @udpsink: the udp sink elements for RTP/RTCP
96 * @appsrc: the app source elements for RTP/RTCP
97 * @appsink: the app sink elements for RTP/RTCP
98 * @server_port: the server ports for this stream
99 * @caps_sig: the signal id for detecting caps
100 * @caps: the caps of the stream
101 * @tranports: the current transports being streamed
103 * The definition of a media stream. The streams are identified by @id.
105 struct _GstRTSPMediaStream {
107 GstElement *payloader;
110 /* pads on the rtpbin */
111 GstPad *recv_rtcp_sink;
112 GstPad *recv_rtp_sink;
113 GstPad *send_rtp_sink;
114 GstPad *send_rtp_src;
115 GstPad *send_rtcp_src;
117 /* the RTPSession object */
120 /* sinks used for sending and receiving RTP and RTCP, they share
122 GstElement *udpsrc[2];
123 GstElement *udpsink[2];
124 /* for TCP transport */
125 GstElement *appsrc[2];
126 GstElement *appsink[2];
129 GstElement *selector[2];
131 /* server ports for sending/receiving */
132 GstRTSPRange server_port;
134 /* the caps of the stream */
138 /* transports we stream to */
144 * @shared: if this media can be shared between clients
145 * @reusable: if this media can be reused after an unprepare
146 * @element: the data providing element
147 * @streams: the different streams provided by @element
148 * @prepared: if the media is prepared for streaming
149 * @pipeline: the toplevel pipeline
150 * @source: the bus watch for pipeline messages.
151 * @id: the id of the watch
152 * @is_live: if the pipeline is live
153 * @buffering: if the pipeline is buffering
154 * @target_state: the desired target state of the pipeline
155 * @rtpbin: the rtpbin
156 * @range: the range of the media being streamed
158 * A class that contains the GStreamer element along with a list of
159 * #GstRTSPediaStream objects that can produce data.
161 * This object is usually created from a #GstRTSPMediaFactory.
163 struct _GstRTSPMedia {
176 /* the pipeline for the media */
177 GstElement *pipeline;
178 GstElement *fakesink;
184 GstState target_state;
186 /* RTP session manager */
189 /* the range of media */
190 GstRTSPTimeRange range;
195 * @context: the main context for dispatching messages
196 * @loop: the mainloop for message.
197 * @thread: the thread dispatching messages.
198 * @handle_message: handle a message
199 * @unprepare: the default implementation sets the pipeline's state
202 * The RTSP media class
204 struct _GstRTSPMediaClass {
205 GObjectClass parent_class;
207 /* thread for the mainloop */
208 GMainContext *context;
213 gboolean (*handle_message) (GstRTSPMedia *media, GstMessage *message);
214 gboolean (*unprepare) (GstRTSPMedia *media);
217 gboolean (*unprepared) (GstRTSPMedia *media);
220 GType gst_rtsp_media_get_type (void);
222 /* creating the media */
223 GstRTSPMedia * gst_rtsp_media_new (void);
225 void gst_rtsp_media_set_shared (GstRTSPMedia *media, gboolean shared);
226 gboolean gst_rtsp_media_is_shared (GstRTSPMedia *media);
228 void gst_rtsp_media_set_reusable (GstRTSPMedia *media, gboolean reusable);
229 gboolean gst_rtsp_media_is_reusable (GstRTSPMedia *media);
231 /* prepare the media for playback */
232 gboolean gst_rtsp_media_prepare (GstRTSPMedia *media);
233 gboolean gst_rtsp_media_is_prepared (GstRTSPMedia *media);
234 gboolean gst_rtsp_media_unprepare (GstRTSPMedia *media);
236 /* dealing with the media */
237 guint gst_rtsp_media_n_streams (GstRTSPMedia *media);
238 GstRTSPMediaStream * gst_rtsp_media_get_stream (GstRTSPMedia *media, guint idx);
240 gboolean gst_rtsp_media_seek (GstRTSPMedia *media, GstRTSPTimeRange *range);
242 GstFlowReturn gst_rtsp_media_stream_rtp (GstRTSPMediaStream *stream, GstBuffer *buffer);
243 GstFlowReturn gst_rtsp_media_stream_rtcp (GstRTSPMediaStream *stream, GstBuffer *buffer);
245 gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state, GArray *trans);
249 #endif /* __GST_RTSP_MEDIA_H__ */