2 * Copyright (C) <2007> Wim Taymans <wim.taymans@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.
20 #ifndef __RTP_SESSION_H__
21 #define __RTP_SESSION_H__
24 #include <gst/netbuffer/gstnetbuffer.h>
26 #include "rtpsource.h"
28 typedef struct _RTPSession RTPSession;
29 typedef struct _RTPSessionClass RTPSessionClass;
31 #define RTP_TYPE_SESSION (rtp_session_get_type())
32 #define RTP_SESSION(sess) (G_TYPE_CHECK_INSTANCE_CAST((sess),RTP_TYPE_SESSION,RTPSession))
33 #define RTP_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),RTP_TYPE_SESSION,RTPSessionClass))
34 #define RTP_IS_SESSION(sess) (G_TYPE_CHECK_INSTANCE_TYPE((sess),RTP_TYPE_SESSION))
35 #define RTP_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_SESSION))
36 #define RTP_SESSION_CAST(sess) ((RTPSession *)(sess))
38 #define RTP_SESSION_LOCK(sess) (g_mutex_lock ((sess)->lock))
39 #define RTP_SESSION_UNLOCK(sess) (g_mutex_unlock ((sess)->lock))
42 * RTPSessionProcessRTP:
43 * @sess: an #RTPSession
44 * @src: the #RTPSource
45 * @buffer: the RTP buffer ready for processing
46 * @user_data: user data specified when registering
48 * This callback will be called when @sess has @buffer ready for further
49 * processing. Processing the buffer typically includes decoding and displaying
52 * Returns: a #GstFlowReturn.
54 typedef GstFlowReturn (*RTPSessionProcessRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
58 * @sess: an #RTPSession
59 * @src: the #RTPSource
60 * @buffer: the RTP buffer ready for sending
61 * @user_data: user data specified when registering
63 * This callback will be called when @sess has @buffer ready for sending to
64 * all listening participants in this session.
66 * Returns: a #GstFlowReturn.
68 typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
72 * @sess: an #RTPSession
73 * @src: the #RTPSource
74 * @buffer: the RTCP buffer ready for sending
75 * @eos: if an EOS event should be pushed
76 * @user_data: user data specified when registering
78 * This callback will be called when @sess has @buffer ready for sending to
79 * all listening participants in this session.
81 * Returns: a #GstFlowReturn.
83 typedef GstFlowReturn (*RTPSessionSendRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer,
84 gboolean eos, gpointer user_data);
88 * @sess: an #RTPSession
89 * @src: the #RTPSource
90 * @buffer: the RTCP buffer ready for synchronisation
91 * @user_data: user data specified when registering
93 * This callback will be called when @sess has an SR @buffer ready for doing
94 * synchronisation between streams.
96 * Returns: a #GstFlowReturn.
98 typedef GstFlowReturn (*RTPSessionSyncRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
101 * RTPSessionClockRate:
102 * @sess: an #RTPSession
103 * @payload: the payload
104 * @user_data: user data specified when registering
106 * This callback will be called when @sess needs the clock-rate of @payload.
108 * Returns: the clock-rate of @pt.
110 typedef gint (*RTPSessionClockRate) (RTPSession *sess, guint8 payload, gpointer user_data);
113 * RTPSessionReconsider:
114 * @sess: an #RTPSession
115 * @user_data: user data specified when registering
117 * This callback will be called when @sess needs to cancel the current timeout.
118 * The currently running timeout should be canceled and a new reporting interval
119 * should be requested from @sess.
121 typedef void (*RTPSessionReconsider) (RTPSession *sess, gpointer user_data);
124 * RTPSessionCallbacks:
125 * @RTPSessionProcessRTP: callback to process RTP packets
126 * @RTPSessionSendRTP: callback for sending RTP packets
127 * @RTPSessionSendRTCP: callback for sending RTCP packets
128 * @RTPSessionSyncRTCP: callback for handling SR packets
129 * @RTPSessionReconsider: callback for reconsidering the timeout
131 * These callbacks can be installed on the session manager to get notification
132 * when RTP and RTCP packets are ready for further processing. These callbacks
133 * are not implemented with signals for performance reasons.
136 RTPSessionProcessRTP process_rtp;
137 RTPSessionSendRTP send_rtp;
138 RTPSessionSyncRTCP sync_rtcp;
139 RTPSessionSendRTCP send_rtcp;
140 RTPSessionClockRate clock_rate;
141 RTPSessionReconsider reconsider;
142 } RTPSessionCallbacks;
145 * RTPConflictingAddress:
146 * @address: #GstNetAddress which conflicted
147 * @last_conflict_time: time when the last conflict was seen
149 * This structure is used to account for addresses that have conflicted to find
154 GstNetAddress address;
156 } RTPConflictingAddress;
160 * @lock: lock to protect the session
161 * @source: the source of this session
162 * @ssrcs: Hashtable of sources indexed by SSRC
163 * @cnames: Hashtable of sources indexed by CNAME
164 * @num_sources: the number of sources
165 * @activecount: the number of active sources
166 * @callbacks: callbacks
167 * @user_data: user data passed in callbacks
168 * @stats: session statistics
169 * @conflicting_addresses: GList of conflicting addresses
171 * The RTP session manager object
183 /* for sender/receiver counting */
187 GHashTable *ssrcs[32];
191 GstClockTime next_rtcp_check_time;
192 GstClockTime last_rtcp_send_time;
198 RTPSessionCallbacks callbacks;
199 gpointer process_rtp_user_data;
200 gpointer send_rtp_user_data;
201 gpointer send_rtcp_user_data;
202 gpointer sync_rtcp_user_data;
203 gpointer clock_rate_user_data;
204 gpointer reconsider_user_data;
206 RTPSessionStats stats;
208 GList *conflicting_addresses;
209 gboolean change_ssrc;
214 * @on_new_ssrc: emited when a new source is found
215 * @on_bye_ssrc: emited when a source is gone
219 struct _RTPSessionClass {
220 GObjectClass parent_class;
223 void (*on_new_ssrc) (RTPSession *sess, RTPSource *source);
224 void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
225 void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
226 void (*on_ssrc_active) (RTPSession *sess, RTPSource *source);
227 void (*on_ssrc_sdes) (RTPSession *sess, RTPSource *source);
228 void (*on_bye_ssrc) (RTPSession *sess, RTPSource *source);
229 void (*on_bye_timeout) (RTPSession *sess, RTPSource *source);
230 void (*on_timeout) (RTPSession *sess, RTPSource *source);
233 GType rtp_session_get_type (void);
235 /* create and configure */
236 RTPSession* rtp_session_new (void);
237 void rtp_session_set_callbacks (RTPSession *sess,
238 RTPSessionCallbacks *callbacks,
240 void rtp_session_set_process_rtp_callback (RTPSession * sess,
241 RTPSessionProcessRTP callback,
243 void rtp_session_set_send_rtp_callback (RTPSession * sess,
244 RTPSessionSendRTP callback,
246 void rtp_session_set_send_rtcp_callback (RTPSession * sess,
247 RTPSessionSendRTCP callback,
249 void rtp_session_set_sync_rtcp_callback (RTPSession * sess,
250 RTPSessionSyncRTCP callback,
252 void rtp_session_set_clock_rate_callback (RTPSession * sess,
253 RTPSessionClockRate callback,
255 void rtp_session_set_reconsider_callback (RTPSession * sess,
256 RTPSessionReconsider callback,
258 void rtp_session_set_bandwidth (RTPSession *sess, gdouble bandwidth);
259 gdouble rtp_session_get_bandwidth (RTPSession *sess);
260 void rtp_session_set_rtcp_fraction (RTPSession *sess, gdouble fraction);
261 gdouble rtp_session_get_rtcp_fraction (RTPSession *sess);
263 gboolean rtp_session_set_sdes_string (RTPSession *sess, GstRTCPSDESType type,
265 gchar* rtp_session_get_sdes_string (RTPSession *sess, GstRTCPSDESType type);
267 /* handling sources */
268 RTPSource* rtp_session_get_internal_source (RTPSession *sess);
270 void rtp_session_set_internal_ssrc (RTPSession *sess, guint32 ssrc);
271 guint32 rtp_session_get_internal_ssrc (RTPSession *sess);
273 gboolean rtp_session_add_source (RTPSession *sess, RTPSource *src);
274 guint rtp_session_get_num_sources (RTPSession *sess);
275 guint rtp_session_get_num_active_sources (RTPSession *sess);
276 RTPSource* rtp_session_get_source_by_ssrc (RTPSession *sess, guint32 ssrc);
277 RTPSource* rtp_session_get_source_by_cname (RTPSession *sess, const gchar *cname);
278 RTPSource* rtp_session_create_source (RTPSession *sess);
280 /* processing packets from receivers */
281 GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer, GstClockTime current_time, guint64 ntpnstime);
282 GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer, GstClockTime current_time);
284 /* processing packets for sending */
285 GstFlowReturn rtp_session_send_rtp (RTPSession *sess, GstBuffer *buffer, GstClockTime current_time, guint64 ntpnstime);
287 /* stopping the session */
288 GstFlowReturn rtp_session_send_bye (RTPSession *sess, const gchar *reason, GstClockTime current_time);
290 /* get interval for next RTCP interval */
291 GstClockTime rtp_session_next_timeout (RTPSession *sess, GstClockTime current_time);
292 GstFlowReturn rtp_session_on_timeout (RTPSession *sess, GstClockTime current_time, guint64 ntpnstime);
294 #endif /* __RTP_SESSION_H__ */