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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef __RTP_SESSION_H__
21 #define __RTP_SESSION_H__
25 #include "rtpsource.h"
27 typedef struct _RTPSession RTPSession;
28 typedef struct _RTPSessionClass RTPSessionClass;
30 #define RTP_TYPE_SESSION (rtp_session_get_type())
31 #define RTP_SESSION(sess) (G_TYPE_CHECK_INSTANCE_CAST((sess),RTP_TYPE_SESSION,RTPSession))
32 #define RTP_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),RTP_TYPE_SESSION,RTPSessionClass))
33 #define RTP_IS_SESSION(sess) (G_TYPE_CHECK_INSTANCE_TYPE((sess),RTP_TYPE_SESSION))
34 #define RTP_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_SESSION))
35 #define RTP_SESSION_CAST(sess) ((RTPSession *)(sess))
37 #define RTP_SESSION_LOCK(sess) (g_mutex_lock (&(sess)->lock))
38 #define RTP_SESSION_UNLOCK(sess) (g_mutex_unlock (&(sess)->lock))
41 * RTPSessionProcessRTP:
42 * @sess: an #RTPSession
43 * @src: the #RTPSource
44 * @buffer: the RTP buffer ready for processing
45 * @user_data: user data specified when registering
47 * This callback will be called when @sess has @buffer ready for further
48 * processing. Processing the buffer typically includes decoding and displaying
51 * Returns: a #GstFlowReturn.
53 typedef GstFlowReturn (*RTPSessionProcessRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
57 * @sess: an #RTPSession
58 * @src: the #RTPSource
59 * @buffer: the RTP buffer ready for sending
60 * @user_data: user data specified when registering
62 * This callback will be called when @sess has @buffer ready for sending to
63 * all listening participants in this session.
65 * Returns: a #GstFlowReturn.
67 typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, gpointer data, gpointer user_data);
71 * @sess: an #RTPSession
72 * @src: the #RTPSource
73 * @buffer: the RTCP buffer ready for sending
74 * @eos: if an EOS event should be pushed
75 * @user_data: user data specified when registering
77 * This callback will be called when @sess has @buffer ready for sending to
78 * all listening participants in this session.
80 * Returns: a #GstFlowReturn.
82 typedef GstFlowReturn (*RTPSessionSendRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer,
83 gboolean eos, gpointer user_data);
87 * @sess: an #RTPSession
88 * @buffer: the RTCP buffer ready for synchronisation
89 * @user_data: user data specified when registering
91 * This callback will be called when @sess has an SR @buffer ready for doing
92 * synchronisation between streams.
94 * Returns: a #GstFlowReturn.
96 typedef GstFlowReturn (*RTPSessionSyncRTCP) (RTPSession *sess, GstBuffer *buffer, gpointer user_data);
99 * RTPSessionClockRate:
100 * @sess: an #RTPSession
101 * @payload: the payload
102 * @user_data: user data specified when registering
104 * This callback will be called when @sess needs the clock-rate of @payload.
106 * Returns: the clock-rate of @pt.
108 typedef gint (*RTPSessionClockRate) (RTPSession *sess, guint8 payload, gpointer user_data);
111 * RTPSessionReconsider:
112 * @sess: an #RTPSession
113 * @user_data: user data specified when registering
115 * This callback will be called when @sess needs to cancel the current timeout.
116 * The currently running timeout should be canceled and a new reporting interval
117 * should be requested from @sess.
119 typedef void (*RTPSessionReconsider) (RTPSession *sess, gpointer user_data);
122 * RTPSessionRequestKeyUnit:
123 * @sess: an #RTPSession
124 * @all_headers: %TRUE if "all-headers" property should be set on the key unit
126 * @user_data: user data specified when registering
128 * Asks the encoder to produce a key unit as soon as possibly within the
129 * bandwidth constraints
131 typedef void (*RTPSessionRequestKeyUnit) (RTPSession *sess,
132 gboolean all_headers, gpointer user_data);
135 * RTPSessionRequestTime:
136 * @sess: an #RTPSession
137 * @user_data: user data specified when registering
139 * This callback will be called when @sess needs the current time. The time
140 * should be returned as a #GstClockTime
142 typedef GstClockTime (*RTPSessionRequestTime) (RTPSession *sess,
146 * RTPSessionNotifyNACK:
147 * @sess: an #RTPSession
148 * @seqnum: the missing seqnum
149 * @blp: other missing seqnums
150 * @user_data: user data specified when registering
152 * Notifies of NACKed frames.
154 typedef void (*RTPSessionNotifyNACK) (RTPSession *sess,
155 guint16 seqnum, guint16 blp, gpointer user_data);
158 * RTPSessionCallbacks:
159 * @RTPSessionProcessRTP: callback to process RTP packets
160 * @RTPSessionSendRTP: callback for sending RTP packets
161 * @RTPSessionSendRTCP: callback for sending RTCP packets
162 * @RTPSessionSyncRTCP: callback for handling SR packets
163 * @RTPSessionReconsider: callback for reconsidering the timeout
164 * @RTPSessionRequestKeyUnit: callback for requesting a new key unit
165 * @RTPSessionRequestTime: callback for requesting the current time
166 * @RTPSessionNotifyNACK: callback for notifying NACK
168 * These callbacks can be installed on the session manager to get notification
169 * when RTP and RTCP packets are ready for further processing. These callbacks
170 * are not implemented with signals for performance reasons.
173 RTPSessionProcessRTP process_rtp;
174 RTPSessionSendRTP send_rtp;
175 RTPSessionSyncRTCP sync_rtcp;
176 RTPSessionSendRTCP send_rtcp;
177 RTPSessionClockRate clock_rate;
178 RTPSessionReconsider reconsider;
179 RTPSessionRequestKeyUnit request_key_unit;
180 RTPSessionRequestTime request_time;
181 RTPSessionNotifyNACK notify_nack;
182 } RTPSessionCallbacks;
186 * @lock: lock to protect the session
187 * @source: the source of this session
188 * @ssrcs: Hashtable of sources indexed by SSRC
189 * @num_sources: the number of sources
190 * @activecount: the number of active sources
191 * @callbacks: callbacks
192 * @user_data: user data passed in callbacks
193 * @stats: session statistics
195 * The RTP session manager object
210 gboolean recalc_bandwidth;
212 gdouble rtcp_bandwidth;
213 guint rtcp_rr_bandwidth;
214 guint rtcp_rs_bandwidth;
216 guint32 suggested_ssrc;
218 /* for sender/receiver counting */
222 GHashTable *ssrcs[32];
226 GstClockTime next_rtcp_check_time;
227 GstClockTime last_rtcp_send_time;
228 GstClockTime start_time;
230 gboolean allow_early;
232 GstClockTime next_early_rtcp_time;
234 gboolean scheduled_bye;
236 RTPSessionCallbacks callbacks;
237 gpointer process_rtp_user_data;
238 gpointer send_rtp_user_data;
239 gpointer send_rtcp_user_data;
240 gpointer sync_rtcp_user_data;
241 gpointer clock_rate_user_data;
242 gpointer reconsider_user_data;
243 gpointer request_key_unit_user_data;
244 gpointer request_time_user_data;
245 gpointer notify_nack_user_data;
247 RTPSessionStats stats;
250 GstClockTime rtcp_feedback_retention_window;
251 guint rtcp_immediate_feedback_threshold;
253 GstClockTime last_keyframe_request;
254 gboolean last_keyframe_all_headers;
259 * @on_new_ssrc: emited when a new source is found
260 * @on_bye_ssrc: emited when a source is gone
264 struct _RTPSessionClass {
265 GObjectClass parent_class;
268 RTPSource* (*get_source_by_ssrc) (RTPSession *sess, guint32 ssrc);
271 void (*on_new_ssrc) (RTPSession *sess, RTPSource *source);
272 void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
273 void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
274 void (*on_ssrc_active) (RTPSession *sess, RTPSource *source);
275 void (*on_ssrc_sdes) (RTPSession *sess, RTPSource *source);
276 void (*on_bye_ssrc) (RTPSession *sess, RTPSource *source);
277 void (*on_bye_timeout) (RTPSession *sess, RTPSource *source);
278 void (*on_timeout) (RTPSession *sess, RTPSource *source);
279 void (*on_sender_timeout) (RTPSession *sess, RTPSource *source);
280 gboolean (*on_sending_rtcp) (RTPSession *sess, GstBuffer *buffer,
282 void (*on_feedback_rtcp) (RTPSession *sess, guint type, guint fbtype,
283 guint sender_ssrc, guint media_ssrc, GstBuffer *fci);
284 void (*send_rtcp) (RTPSession *sess, GstClockTime max_delay);
287 GType rtp_session_get_type (void);
289 /* create and configure */
290 RTPSession* rtp_session_new (void);
291 void rtp_session_set_callbacks (RTPSession *sess,
292 RTPSessionCallbacks *callbacks,
294 void rtp_session_set_process_rtp_callback (RTPSession * sess,
295 RTPSessionProcessRTP callback,
297 void rtp_session_set_send_rtp_callback (RTPSession * sess,
298 RTPSessionSendRTP callback,
300 void rtp_session_set_send_rtcp_callback (RTPSession * sess,
301 RTPSessionSendRTCP callback,
303 void rtp_session_set_sync_rtcp_callback (RTPSession * sess,
304 RTPSessionSyncRTCP callback,
306 void rtp_session_set_clock_rate_callback (RTPSession * sess,
307 RTPSessionClockRate callback,
309 void rtp_session_set_reconsider_callback (RTPSession * sess,
310 RTPSessionReconsider callback,
312 void rtp_session_set_request_time_callback (RTPSession * sess,
313 RTPSessionRequestTime callback,
316 void rtp_session_set_bandwidth (RTPSession *sess, gdouble bandwidth);
317 gdouble rtp_session_get_bandwidth (RTPSession *sess);
318 void rtp_session_set_rtcp_fraction (RTPSession *sess, gdouble fraction);
319 gdouble rtp_session_get_rtcp_fraction (RTPSession *sess);
321 GstStructure * rtp_session_get_sdes_struct (RTPSession *sess);
322 void rtp_session_set_sdes_struct (RTPSession *sess, const GstStructure *sdes);
324 /* handling sources */
325 guint32 rtp_session_suggest_ssrc (RTPSession *sess);
327 gboolean rtp_session_add_source (RTPSession *sess, RTPSource *src);
328 guint rtp_session_get_num_sources (RTPSession *sess);
329 guint rtp_session_get_num_active_sources (RTPSession *sess);
330 RTPSource* rtp_session_get_source_by_ssrc (RTPSession *sess, guint32 ssrc);
331 RTPSource* rtp_session_create_source (RTPSession *sess);
333 /* processing packets from receivers */
334 GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer,
335 GstClockTime current_time,
336 GstClockTime running_time,
338 GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer,
339 GstClockTime current_time,
342 /* processing packets for sending */
343 void rtp_session_update_send_caps (RTPSession *sess, GstCaps *caps);
344 GstFlowReturn rtp_session_send_rtp (RTPSession *sess, gpointer data, gboolean is_list,
345 GstClockTime current_time, GstClockTime running_time);
348 void rtp_session_mark_all_bye (RTPSession *sess, const gchar *reason);
349 GstFlowReturn rtp_session_schedule_bye (RTPSession *sess, GstClockTime current_time);
351 /* get interval for next RTCP interval */
352 GstClockTime rtp_session_next_timeout (RTPSession *sess, GstClockTime current_time);
353 GstFlowReturn rtp_session_on_timeout (RTPSession *sess, GstClockTime current_time,
354 guint64 ntpnstime, GstClockTime running_time);
356 /* request the transmittion of an early RTCP packet */
357 void rtp_session_request_early_rtcp (RTPSession * sess, GstClockTime current_time,
358 GstClockTime max_delay);
360 /* Notify session of a request for a new key unit */
361 gboolean rtp_session_request_key_unit (RTPSession * sess,
365 gboolean rtp_session_request_nack (RTPSession * sess,
368 GstClockTime max_delay);
371 #endif /* __RTP_SESSION_H__ */