2 * Copyright (C) <2007> Wim Taymans <wim@fluendo.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 * @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, gpointer user_data);
86 * @sess: an #RTPSession
87 * @src: the #RTPSource
88 * @buffer: the RTCP buffer ready for sending
89 * @user_data: user data specified when registering
91 * This callback will be called when @sess has and SR @buffer ready for doing
92 * synchronisation between streams.
94 * Returns: a #GstFlowReturn.
96 typedef GstFlowReturn (*RTPSessionSyncRTCP) (RTPSession *sess, RTPSource *src, 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 * RTPSessionCallbacks:
123 * @RTPSessionProcessRTP: callback to process RTP packets
124 * @RTPSessionSendRTP: callback for sending RTP packets
125 * @RTPSessionSendRTCP: callback for sending RTCP packets
126 * @RTPSessionSyncRTCP: callback for handling SR packets
127 * @RTPSessionReconsider: callback for reconsidering the timeout
129 * These callbacks can be installed on the session manager to get notification
130 * when RTP and RTCP packets are ready for further processing. These callbacks
131 * are not implemented with signals for performance reasons.
134 RTPSessionProcessRTP process_rtp;
135 RTPSessionSendRTP send_rtp;
136 RTPSessionSendRTCP send_rtcp;
137 RTPSessionSyncRTCP sync_rtcp;
138 RTPSessionClockRate clock_rate;
139 RTPSessionReconsider reconsider;
140 } RTPSessionCallbacks;
144 * @lock: lock to protect the session
145 * @source: the source of this session
146 * @ssrcs: Hashtable of sources indexed by SSRC
147 * @cnames: Hashtable of sources indexed by CNAME
148 * @num_sources: the number of sources
149 * @activecount: the number of active sources
150 * @callbacks: callbacks
151 * @user_data: user data passed in callbacks
153 * The RTP session manager object
165 /* info for creating reports */
174 /* for sender/receiver counting */
178 GHashTable *ssrcs[32];
182 GstClockTime next_rtcp_check_time;
183 GstClockTime last_rtcp_send_time;
189 RTPSessionCallbacks callbacks;
192 RTPSessionStats stats;
194 /* for mapping clock time to NTP time */
195 GstClockTime base_time;
200 * @on_new_ssrc: emited when a new source is found
201 * @on_bye_ssrc: emited when a source is gone
205 struct _RTPSessionClass {
206 GObjectClass parent_class;
209 void (*on_new_ssrc) (RTPSession *sess, RTPSource *source);
210 void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
211 void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
212 void (*on_ssrc_active) (RTPSession *sess, RTPSource *source);
213 void (*on_bye_ssrc) (RTPSession *sess, RTPSource *source);
214 void (*on_bye_timeout) (RTPSession *sess, RTPSource *source);
215 void (*on_timeout) (RTPSession *sess, RTPSource *source);
218 GType rtp_session_get_type (void);
220 /* create and configure */
221 RTPSession* rtp_session_new (void);
222 void rtp_session_set_callbacks (RTPSession *sess,
223 RTPSessionCallbacks *callbacks,
225 void rtp_session_set_bandwidth (RTPSession *sess, gdouble bandwidth);
226 gdouble rtp_session_get_bandwidth (RTPSession *sess);
227 void rtp_session_set_rtcp_fraction (RTPSession *sess, gdouble fraction);
228 gdouble rtp_session_get_rtcp_fraction (RTPSession *sess);
230 void rtp_session_set_cname (RTPSession *sess, const gchar *cname);
231 gchar* rtp_session_get_cname (RTPSession *sess);
232 void rtp_session_set_name (RTPSession *sess, const gchar *name);
233 gchar* rtp_session_get_name (RTPSession *sess);
234 void rtp_session_set_email (RTPSession *sess, const gchar *email);
235 gchar* rtp_session_get_email (RTPSession *sess);
236 void rtp_session_set_phone (RTPSession *sess, const gchar *phone);
237 gchar* rtp_session_get_phone (RTPSession *sess);
238 void rtp_session_set_location (RTPSession *sess, const gchar *location);
239 gchar* rtp_session_get_location (RTPSession *sess);
240 void rtp_session_set_tool (RTPSession *sess, const gchar *tool);
241 gchar* rtp_session_get_tool (RTPSession *sess);
242 void rtp_session_set_note (RTPSession *sess, const gchar *note);
243 gchar* rtp_session_get_note (RTPSession *sess);
245 /* handling sources */
246 gboolean rtp_session_add_source (RTPSession *sess, RTPSource *src);
247 guint rtp_session_get_num_sources (RTPSession *sess);
248 guint rtp_session_get_num_active_sources (RTPSession *sess);
249 RTPSource* rtp_session_get_source_by_ssrc (RTPSession *sess, guint32 ssrc);
250 RTPSource* rtp_session_get_source_by_cname (RTPSession *sess, const gchar *cname);
251 RTPSource* rtp_session_create_source (RTPSession *sess);
253 /* processing packets from receivers */
254 GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer, guint64 ntpnstime);
255 GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer);
257 /* processing packets for sending */
258 GstFlowReturn rtp_session_send_rtp (RTPSession *sess, GstBuffer *buffer, guint64 ntptime);
260 /* stopping the session */
261 GstFlowReturn rtp_session_send_bye (RTPSession *sess, const gchar *reason);
263 /* get interval for next RTCP interval */
264 GstClockTime rtp_session_next_timeout (RTPSession *sess, GstClockTime time);
265 GstFlowReturn rtp_session_on_timeout (RTPSession *sess, GstClockTime time, guint64 ntpnstime);
267 #endif /* __RTP_SESSION_H__ */