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);
85 * RTPSessionClockRate:
86 * @sess: an #RTPSession
87 * @payload: the payload
88 * @user_data: user data specified when registering
90 * This callback will be called when @sess needs the clock-rate of @payload.
92 * Returns: the clock-rate of @pt.
94 typedef gint (*RTPSessionClockRate) (RTPSession *sess, guint8 payload, gpointer user_data);
98 * @sess: an #RTPSession
99 * @user_data: user data specified when registering
101 * This callback will be called when @sess needs the current time in
104 * Returns: a #GstClockTime with the current time in nanoseconds.
106 typedef GstClockTime (*RTPSessionGetTime) (RTPSession *sess, gpointer user_data);
109 * RTPSessionCallbacks:
110 * @RTPSessionProcessRTP: callback to process RTP packets
111 * @RTPSessionSendRTP: callback for sending RTP packets
112 * @RTPSessionSendRTCP: callback for sending RTCP packets
113 * @RTPSessionGetTime: callback for returning the current time
115 * These callbacks can be installed on the session manager to get notification
116 * when RTP and RTCP packets are ready for further processing. These callbacks
117 * are not implemented with signals for performance reasons.
120 RTPSessionProcessRTP process_rtp;
121 RTPSessionSendRTP send_rtp;
122 RTPSessionSendRTCP send_rtcp;
123 RTPSessionClockRate clock_rate;
124 RTPSessionGetTime get_time;
125 } RTPSessionCallbacks;
129 * @lock: lock to protect the session
130 * @source: the source of this session
131 * @ssrcs: Hashtable of sources indexed by SSRC
132 * @cnames: Hashtable of sources indexed by CNAME
133 * @num_sources: the number of sources
134 * @activecount: the number of active sources
135 * @callbacks: callbacks
136 * @user_data: user data passed in callbacks
138 * The RTP session manager object
150 /* info for creating reports */
159 /* for sender/receiver counting */
163 GHashTable *ssrcs[32];
167 RTPSessionCallbacks callbacks;
170 RTPSessionStats stats;
175 * @on_new_ssrc: emited when a new source is found
176 * @on_bye_ssrc: emited when a source is gone
180 struct _RTPSessionClass {
181 GObjectClass parent_class;
184 void (*on_new_ssrc) (RTPSession *sess, RTPSource *source);
185 void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
186 void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
187 void (*on_bye_ssrc) (RTPSession *sess, RTPSource *source);
190 GType rtp_session_get_type (void);
192 /* create and configure */
193 RTPSession* rtp_session_new (void);
194 void rtp_session_set_callbacks (RTPSession *sess,
195 RTPSessionCallbacks *callbacks,
197 void rtp_session_set_bandwidth (RTPSession *sess, gdouble bandwidth);
198 gdouble rtp_session_get_bandwidth (RTPSession *sess);
199 void rtp_session_set_rtcp_fraction (RTPSession *sess, gdouble fraction);
200 gdouble rtp_session_get_rtcp_fraction (RTPSession *sess);
202 void rtp_session_set_cname (RTPSession *sess, const gchar *cname);
203 gchar* rtp_session_get_cname (RTPSession *sess);
204 void rtp_session_set_name (RTPSession *sess, const gchar *name);
205 gchar* rtp_session_get_name (RTPSession *sess);
206 void rtp_session_set_email (RTPSession *sess, const gchar *email);
207 gchar* rtp_session_get_email (RTPSession *sess);
208 void rtp_session_set_phone (RTPSession *sess, const gchar *phone);
209 gchar* rtp_session_get_phone (RTPSession *sess);
210 void rtp_session_set_location (RTPSession *sess, const gchar *location);
211 gchar* rtp_session_get_location (RTPSession *sess);
212 void rtp_session_set_tool (RTPSession *sess, const gchar *tool);
213 gchar* rtp_session_get_tool (RTPSession *sess);
214 void rtp_session_set_note (RTPSession *sess, const gchar *note);
215 gchar* rtp_session_get_note (RTPSession *sess);
217 /* handling sources */
218 gboolean rtp_session_add_source (RTPSession *sess, RTPSource *src);
219 guint rtp_session_get_num_sources (RTPSession *sess);
220 guint rtp_session_get_num_active_sources (RTPSession *sess);
221 RTPSource* rtp_session_get_source_by_ssrc (RTPSession *sess, guint32 ssrc);
222 RTPSource* rtp_session_get_source_by_cname (RTPSession *sess, const gchar *cname);
223 RTPSource* rtp_session_create_source (RTPSession *sess);
225 /* processing packets from receivers */
226 GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer);
227 GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer);
229 /* processing packets for sending */
230 GstFlowReturn rtp_session_send_rtp (RTPSession *sess, GstBuffer *buffer);
232 /* get interval for next RTCP interval */
233 gdouble rtp_session_get_reporting_interval (RTPSession *sess);
234 GstFlowReturn rtp_session_perform_reporting (RTPSession *sess);
236 #endif /* __RTP_SESSION_H__ */