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/rtsp.h>
24 #ifndef __GST_RTSP_STREAM_H__
25 #define __GST_RTSP_STREAM_H__
27 #include "rtsp-server-prelude.h"
31 /* types for the media stream */
32 #define GST_TYPE_RTSP_STREAM (gst_rtsp_stream_get_type ())
33 #define GST_IS_RTSP_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_STREAM))
34 #define GST_IS_RTSP_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_STREAM))
35 #define GST_RTSP_STREAM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
36 #define GST_RTSP_STREAM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStream))
37 #define GST_RTSP_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
38 #define GST_RTSP_STREAM_CAST(obj) ((GstRTSPStream*)(obj))
39 #define GST_RTSP_STREAM_CLASS_CAST(klass) ((GstRTSPStreamClass*)(klass))
41 typedef struct _GstRTSPStream GstRTSPStream;
42 typedef struct _GstRTSPStreamClass GstRTSPStreamClass;
43 typedef struct _GstRTSPStreamPrivate GstRTSPStreamPrivate;
45 #include "rtsp-stream-transport.h"
46 #include "rtsp-address-pool.h"
47 #include "rtsp-session.h"
48 #include "rtsp-media.h"
53 * The definition of a media stream.
55 struct _GstRTSPStream {
59 GstRTSPStreamPrivate *priv;
60 gpointer _gst_reserved[GST_PADDING];
63 struct _GstRTSPStreamClass {
64 GObjectClass parent_class;
67 gpointer _gst_reserved[GST_PADDING];
71 GType gst_rtsp_stream_get_type (void);
74 GstRTSPStream * gst_rtsp_stream_new (guint idx, GstElement *payloader,
78 guint gst_rtsp_stream_get_index (GstRTSPStream *stream);
81 guint gst_rtsp_stream_get_pt (GstRTSPStream *stream);
84 GstPad * gst_rtsp_stream_get_srcpad (GstRTSPStream *stream);
87 GstPad * gst_rtsp_stream_get_sinkpad (GstRTSPStream *stream);
90 void gst_rtsp_stream_set_control (GstRTSPStream *stream, const gchar *control);
93 gchar * gst_rtsp_stream_get_control (GstRTSPStream *stream);
96 gboolean gst_rtsp_stream_has_control (GstRTSPStream *stream, const gchar *control);
99 void gst_rtsp_stream_set_mtu (GstRTSPStream *stream, guint mtu);
102 guint gst_rtsp_stream_get_mtu (GstRTSPStream *stream);
105 void gst_rtsp_stream_set_dscp_qos (GstRTSPStream *stream, gint dscp_qos);
108 gint gst_rtsp_stream_get_dscp_qos (GstRTSPStream *stream);
111 gboolean gst_rtsp_stream_is_transport_supported (GstRTSPStream *stream,
112 GstRTSPTransport *transport);
115 void gst_rtsp_stream_set_profiles (GstRTSPStream *stream, GstRTSPProfile profiles);
118 GstRTSPProfile gst_rtsp_stream_get_profiles (GstRTSPStream *stream);
121 void gst_rtsp_stream_set_protocols (GstRTSPStream *stream, GstRTSPLowerTrans protocols);
124 GstRTSPLowerTrans gst_rtsp_stream_get_protocols (GstRTSPStream *stream);
127 void gst_rtsp_stream_set_address_pool (GstRTSPStream *stream, GstRTSPAddressPool *pool);
131 gst_rtsp_stream_get_address_pool (GstRTSPStream *stream);
134 void gst_rtsp_stream_set_multicast_iface (GstRTSPStream *stream, const gchar * multicast_iface);
137 gchar * gst_rtsp_stream_get_multicast_iface (GstRTSPStream *stream);
140 GstRTSPAddress * gst_rtsp_stream_reserve_address (GstRTSPStream *stream,
141 const gchar * address,
147 gboolean gst_rtsp_stream_join_bin (GstRTSPStream *stream,
148 GstBin *bin, GstElement *rtpbin,
152 gboolean gst_rtsp_stream_leave_bin (GstRTSPStream *stream,
153 GstBin *bin, GstElement *rtpbin);
156 GstBin * gst_rtsp_stream_get_joined_bin (GstRTSPStream *stream);
159 gboolean gst_rtsp_stream_set_blocked (GstRTSPStream * stream,
163 gboolean gst_rtsp_stream_is_blocking (GstRTSPStream * stream);
167 gboolean gst_rtsp_stream_unblock_linked (GstRTSPStream * stream);
170 void gst_rtsp_stream_set_client_side (GstRTSPStream *stream, gboolean client_side);
173 gboolean gst_rtsp_stream_is_client_side (GstRTSPStream *stream);
176 void gst_rtsp_stream_get_server_port (GstRTSPStream *stream,
177 GstRTSPRange *server_port,
178 GSocketFamily family);
181 GstRTSPAddress * gst_rtsp_stream_get_multicast_address (GstRTSPStream *stream,
182 GSocketFamily family);
186 GObject * gst_rtsp_stream_get_rtpsession (GstRTSPStream *stream);
189 GstElement * gst_rtsp_stream_get_srtp_encoder (GstRTSPStream *stream);
192 void gst_rtsp_stream_get_ssrc (GstRTSPStream *stream,
196 gboolean gst_rtsp_stream_get_rtpinfo (GstRTSPStream *stream,
197 guint *rtptime, guint *seq,
199 GstClockTime *running_time);
202 GstCaps * gst_rtsp_stream_get_caps (GstRTSPStream *stream);
205 GstFlowReturn gst_rtsp_stream_recv_rtp (GstRTSPStream *stream,
209 GstFlowReturn gst_rtsp_stream_recv_rtcp (GstRTSPStream *stream,
213 gboolean gst_rtsp_stream_add_transport (GstRTSPStream *stream,
214 GstRTSPStreamTransport *trans);
217 gboolean gst_rtsp_stream_remove_transport (GstRTSPStream *stream,
218 GstRTSPStreamTransport *trans);
221 GSocket * gst_rtsp_stream_get_rtp_socket (GstRTSPStream *stream,
222 GSocketFamily family);
225 GSocket * gst_rtsp_stream_get_rtcp_socket (GstRTSPStream *stream,
226 GSocketFamily family);
229 GSocket * gst_rtsp_stream_get_rtp_multicast_socket (GstRTSPStream *stream,
230 GSocketFamily family);
233 GSocket * gst_rtsp_stream_get_rtcp_multicast_socket (GstRTSPStream *stream,
234 GSocketFamily family);
237 gboolean gst_rtsp_stream_update_crypto (GstRTSPStream * stream,
238 guint ssrc, GstCaps * crypto);
241 gboolean gst_rtsp_stream_query_position (GstRTSPStream * stream,
245 gboolean gst_rtsp_stream_query_stop (GstRTSPStream * stream,
249 gboolean gst_rtsp_stream_seekable (GstRTSPStream *stream);
252 void gst_rtsp_stream_set_seqnum_offset (GstRTSPStream *stream, guint16 seqnum);
255 guint16 gst_rtsp_stream_get_current_seqnum (GstRTSPStream *stream);
258 void gst_rtsp_stream_set_retransmission_time (GstRTSPStream *stream, GstClockTime time);
261 GstClockTime gst_rtsp_stream_get_retransmission_time (GstRTSPStream *stream);
264 guint gst_rtsp_stream_get_retransmission_pt (GstRTSPStream * stream);
267 void gst_rtsp_stream_set_retransmission_pt (GstRTSPStream * stream,
271 void gst_rtsp_stream_set_buffer_size (GstRTSPStream *stream, guint size);
274 guint gst_rtsp_stream_get_buffer_size (GstRTSPStream *stream);
277 void gst_rtsp_stream_set_pt_map (GstRTSPStream * stream, guint pt, GstCaps * caps);
280 GstElement * gst_rtsp_stream_request_aux_sender (GstRTSPStream * stream, guint sessid);
283 GstElement * gst_rtsp_stream_request_aux_receiver (GstRTSPStream * stream, guint sessid);
286 gboolean gst_rtsp_stream_allocate_udp_sockets (GstRTSPStream * stream, GSocketFamily family,
287 GstRTSPTransport *transport, gboolean use_client_settings);
290 void gst_rtsp_stream_set_publish_clock_mode (GstRTSPStream * stream, GstRTSPPublishClockMode mode);
293 GstRTSPPublishClockMode gst_rtsp_stream_get_publish_clock_mode (GstRTSPStream * stream);
296 gboolean gst_rtsp_stream_set_max_mcast_ttl (GstRTSPStream *stream, guint ttl);
299 guint gst_rtsp_stream_get_max_mcast_ttl (GstRTSPStream *stream);
302 gboolean gst_rtsp_stream_complete_stream (GstRTSPStream * stream, const GstRTSPTransport * transport);
305 gboolean gst_rtsp_stream_is_complete (GstRTSPStream * stream);
308 gboolean gst_rtsp_stream_is_sender (GstRTSPStream * stream);
311 gboolean gst_rtsp_stream_is_receiver (GstRTSPStream * stream);
314 gboolean gst_rtsp_stream_handle_keymgmt (GstRTSPStream *stream, const gchar *keymgmt);
316 /* ULP Forward Error Correction (RFC 5109) */
318 gboolean gst_rtsp_stream_get_ulpfec_enabled (GstRTSPStream *stream);
321 void gst_rtsp_stream_set_ulpfec_pt (GstRTSPStream *stream, guint pt);
324 guint gst_rtsp_stream_get_ulpfec_pt (GstRTSPStream *stream);
327 GstElement * gst_rtsp_stream_request_ulpfec_decoder (GstRTSPStream *stream, GstElement *rtpbin, guint sessid);
330 GstElement * gst_rtsp_stream_request_ulpfec_encoder (GstRTSPStream *stream, guint sessid);
333 void gst_rtsp_stream_set_ulpfec_percentage (GstRTSPStream *stream, guint percentage);
336 guint gst_rtsp_stream_get_ulpfec_percentage (GstRTSPStream *stream);
339 * GstRTSPStreamTransportFilterFunc:
340 * @stream: a #GstRTSPStream object
341 * @trans: a #GstRTSPStreamTransport in @stream
342 * @user_data: user data that has been given to gst_rtsp_stream_transport_filter()
344 * This function will be called by the gst_rtsp_stream_transport_filter(). An
345 * implementation should return a value of #GstRTSPFilterResult.
347 * When this function returns #GST_RTSP_FILTER_REMOVE, @trans will be removed
350 * A return value of #GST_RTSP_FILTER_KEEP will leave @trans untouched in
353 * A value of #GST_RTSP_FILTER_REF will add @trans to the result #GList of
354 * gst_rtsp_stream_transport_filter().
356 * Returns: a #GstRTSPFilterResult.
358 typedef GstRTSPFilterResult (*GstRTSPStreamTransportFilterFunc) (GstRTSPStream *stream,
359 GstRTSPStreamTransport *trans,
363 GList * gst_rtsp_stream_transport_filter (GstRTSPStream *stream,
364 GstRTSPStreamTransportFilterFunc func,
367 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
368 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPStream, gst_object_unref)
373 #endif /* __GST_RTSP_STREAM_H__ */