09fffeb93dac118f07d85c8cdbf87b8e2b1bf3b8
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-stream.h
1 /* GStreamer
2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #include <gst/gst.h>
21 #include <gst/rtsp/gstrtsprange.h>
22 #include <gst/rtsp/gstrtspurl.h>
23 #include <gio/gio.h>
24
25 #ifndef __GST_RTSP_STREAM_H__
26 #define __GST_RTSP_STREAM_H__
27
28 G_BEGIN_DECLS
29
30 /* types for the media stream */
31 #define GST_TYPE_RTSP_STREAM              (gst_rtsp_stream_get_type ())
32 #define GST_IS_RTSP_STREAM(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_STREAM))
33 #define GST_IS_RTSP_STREAM_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_STREAM))
34 #define GST_RTSP_STREAM_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
35 #define GST_RTSP_STREAM(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStream))
36 #define GST_RTSP_STREAM_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
37 #define GST_RTSP_STREAM_CAST(obj)         ((GstRTSPStream*)(obj))
38 #define GST_RTSP_STREAM_CLASS_CAST(klass) ((GstRTSPStreamClass*)(klass))
39
40 typedef struct _GstRTSPStream GstRTSPStream;
41 typedef struct _GstRTSPStreamClass GstRTSPStreamClass;
42 typedef struct _GstRTSPStreamPrivate GstRTSPStreamPrivate;
43
44 #include "rtsp-stream-transport.h"
45 #include "rtsp-address-pool.h"
46
47 /**
48  * GstRTSPStream:
49  *
50  * The definition of a media stream.
51  */
52 struct _GstRTSPStream {
53   GObject       parent;
54
55   /*< private >*/
56   GstRTSPStreamPrivate *priv;
57 };
58
59 struct _GstRTSPStreamClass {
60   GObjectClass parent_class;
61 };
62
63 GType             gst_rtsp_stream_get_type         (void);
64
65 GstRTSPStream *   gst_rtsp_stream_new              (guint idx, GstElement *payloader,
66                                                     GstPad *srcpad);
67 guint             gst_rtsp_stream_get_index        (GstRTSPStream *stream);
68 GstPad *          gst_rtsp_stream_get_srcpad       (GstRTSPStream *stream);
69
70 void              gst_rtsp_stream_set_control      (GstRTSPStream *stream, const gchar *control);
71 gchar *           gst_rtsp_stream_get_control      (GstRTSPStream *stream);
72 gboolean          gst_rtsp_stream_has_control      (GstRTSPStream *stream, const gchar *control);
73
74 void              gst_rtsp_stream_set_mtu          (GstRTSPStream *stream, guint mtu);
75 guint             gst_rtsp_stream_get_mtu          (GstRTSPStream *stream);
76
77 void              gst_rtsp_stream_set_dscp_qos     (GstRTSPStream *stream, gint dscp_qos);
78 gint              gst_rtsp_stream_get_dscp_qos     (GstRTSPStream *stream);
79
80 void              gst_rtsp_stream_set_protocols    (GstRTSPStream *stream, GstRTSPLowerTrans protocols);
81 GstRTSPLowerTrans gst_rtsp_stream_get_protocols    (GstRTSPStream *stream);
82
83 void              gst_rtsp_stream_set_address_pool (GstRTSPStream *stream, GstRTSPAddressPool *pool);
84 GstRTSPAddressPool *
85                   gst_rtsp_stream_get_address_pool (GstRTSPStream *stream);
86
87 GstRTSPAddress *  gst_rtsp_stream_reserve_address  (GstRTSPStream *stream,
88                                                     const gchar * address,
89                                                     guint port,
90                                                     guint n_ports,
91                                                     guint ttl);
92
93 gboolean          gst_rtsp_stream_join_bin         (GstRTSPStream *stream,
94                                                     GstBin *bin, GstElement *rtpbin,
95                                                     GstState state);
96 gboolean          gst_rtsp_stream_leave_bin        (GstRTSPStream *stream,
97                                                     GstBin *bin, GstElement *rtpbin);
98
99 void              gst_rtsp_stream_get_server_port  (GstRTSPStream *stream,
100                                                     GstRTSPRange *server_port,
101                                                     GSocketFamily family);
102 GstRTSPAddress *  gst_rtsp_stream_get_multicast_address (GstRTSPStream *stream,
103                                                          GSocketFamily family);
104
105
106 GObject *         gst_rtsp_stream_get_rtpsession   (GstRTSPStream *stream);
107
108 void              gst_rtsp_stream_get_ssrc         (GstRTSPStream *stream,
109                                                     guint *ssrc);
110
111 gboolean          gst_rtsp_stream_get_rtpinfo      (GstRTSPStream *stream,
112                                                     guint *rtptime, guint *seq);
113 GstCaps *         gst_rtsp_stream_get_caps         (GstRTSPStream *stream);
114
115 GstFlowReturn     gst_rtsp_stream_recv_rtp         (GstRTSPStream *stream,
116                                                     GstBuffer *buffer);
117 GstFlowReturn     gst_rtsp_stream_recv_rtcp        (GstRTSPStream *stream,
118                                                     GstBuffer *buffer);
119
120 gboolean          gst_rtsp_stream_add_transport    (GstRTSPStream *stream,
121                                                     GstRTSPStreamTransport *trans);
122 gboolean          gst_rtsp_stream_remove_transport (GstRTSPStream *stream,
123                                                     GstRTSPStreamTransport *trans);
124
125 GSocket *         gst_rtsp_stream_get_rtp_socket   (GstRTSPStream *stream,
126                                                     GSocketFamily family);
127 GSocket *         gst_rtsp_stream_get_rtcp_socket  (GstRTSPStream *stream,
128                                                     GSocketFamily family);
129
130 G_END_DECLS
131
132 #endif /* __GST_RTSP_STREAM_H__ */