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);
48 * @idx: a stream index
49 * @send_rtp: callback for sending RTP messages
50 * @send_rtcp: callback for sending RTCP messages
51 * @user_data: user data passed in the callbacks
52 * @notify: free function for the user_data.
53 * @transport: a transport description
55 * A Transport description for stream @idx
57 struct _GstRTSPMediaTrans {
60 GstRTSPSendFunc send_rtp;
61 GstRTSPSendFunc send_rtcp;
63 GDestroyNotify notify;
65 GstRTSPTransport *transport;
71 * @srcpad: the srcpad of the stream
72 * @payloader: the payloader of the format
73 * @prepared: if the stream is prepared for streaming
74 * @server_port: the server udp ports
75 * @recv_rtp_sink: sinkpad for RTP buffers
76 * @recv_rtcp_sink: sinkpad for RTCP buffers
77 * @recv_rtp_src: srcpad for RTP buffers
78 * @recv_rtcp_src: srcpad for RTCP buffers
79 * @udpsrc: the udp source elements for RTP/RTCP
80 * @udpsink: the udp sink elements for RTP/RTCP
81 * @appsrc: the app source elements for RTP/RTCP
82 * @appsink: the app sink elements for RTP/RTCP
83 * @server_port: the server ports for this stream
84 * @caps_sig: the signal id for detecting caps
85 * @caps: the caps of the stream
86 * @tranports: the current transports being streamed
88 * The definition of a media stream. The streams are identified by @id.
90 struct _GstRTSPMediaStream {
92 GstElement *payloader;
95 /* pads on the rtpbin */
96 GstPad *recv_rtcp_sink;
97 GstPad *send_rtp_sink;
99 GstPad *send_rtcp_src;
101 /* the RTPSession object */
104 /* sinks used for sending and receiving RTP and RTCP, they share
106 GstElement *udpsrc[2];
107 GstElement *udpsink[2];
108 /* for TCP transport */
109 GstElement *appsrc[2];
110 GstElement *appsink[2];
112 /* server ports for sending/receiving */
113 GstRTSPRange server_port;
115 /* the caps of the stream */
119 /* transports we stream to */
125 * @shared: if this media can be shared between clients
126 * @element: the data providing element
127 * @streams: the different streams provided by @element
128 * @prepared: if the media is prepared for streaming
129 * @pipeline: the toplevel pipeline
130 * @source: the bus watch for pipeline messages.
131 * @id: the id of the watch
132 * @is_live: if the pipeline is live
133 * @buffering: if the pipeline is buffering
134 * @target_state: the desired target state of the pipeline
135 * @rtpbin: the rtpbin
136 * @range: the range of the media being streamed
138 * A class that contains the GStreamer element along with a list of
139 * #GstRTSPediaStream objects that can produce data.
141 * This object is usually created from a #GstRTSPMediaFactory.
143 struct _GstRTSPMedia {
152 /* the pipeline for the media */
153 GstElement *pipeline;
159 GstState target_state;
161 /* RTP session manager */
164 /* the range of media */
165 GstRTSPTimeRange range;
170 * @context: the main context for dispatching messages
171 * @loop: the mainloop for message.
172 * @thread: the thread dispatching messages.
173 * @handle_message: handle a message
175 * The RTSP media class
177 struct _GstRTSPMediaClass {
178 GObjectClass parent_class;
180 /* thread for the mainloop */
181 GMainContext *context;
185 gboolean (*handle_message) (GstRTSPMedia *media, GstMessage *message);
188 GType gst_rtsp_media_get_type (void);
190 /* creating the media */
191 GstRTSPMedia * gst_rtsp_media_new (void);
193 void gst_rtsp_media_set_shared (GstRTSPMedia *media, gboolean shared);
194 gboolean gst_rtsp_media_is_shared (GstRTSPMedia *media);
196 /* prepare the media for playback */
197 gboolean gst_rtsp_media_prepare (GstRTSPMedia *media);
199 /* dealing with the media */
200 guint gst_rtsp_media_n_streams (GstRTSPMedia *media);
201 GstRTSPMediaStream * gst_rtsp_media_get_stream (GstRTSPMedia *media, guint idx);
203 GstFlowReturn gst_rtsp_media_stream_rtp (GstRTSPMediaStream *stream, GstBuffer *buffer);
204 GstFlowReturn gst_rtsp_media_stream_rtcp (GstRTSPMediaStream *stream, GstBuffer *buffer);
206 gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state, GArray *trans);
210 #endif /* __GST_RTSP_MEDIA_H__ */