/* GStreamer
- * Copyright (C) <2007> Wim Taymans <wim@fluendo.com>
+ * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#ifndef __RTP_SESSION_H__
#define __RTP_SESSION_H__
#include <gst/gst.h>
-#include <gst/netbuffer/gstnetbuffer.h>
#include "rtpsource.h"
#define RTP_IS_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_SESSION))
#define RTP_SESSION_CAST(sess) ((RTPSession *)(sess))
-#define RTP_SESSION_LOCK(sess) (g_mutex_lock ((sess)->lock))
-#define RTP_SESSION_UNLOCK(sess) (g_mutex_unlock ((sess)->lock))
+#define RTP_SESSION_LOCK(sess) (g_mutex_lock (&(sess)->lock))
+#define RTP_SESSION_UNLOCK(sess) (g_mutex_unlock (&(sess)->lock))
/**
* RTPSessionProcessRTP:
*
* Returns: a #GstFlowReturn.
*/
-typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
+typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, gpointer data, gpointer user_data);
/**
* RTPSessionSendRTCP:
* @sess: an #RTPSession
* @src: the #RTPSource
* @buffer: the RTCP buffer ready for sending
+ * @eos: if an EOS event should be pushed
* @user_data: user data specified when registering
*
* This callback will be called when @sess has @buffer ready for sending to
*
* Returns: a #GstFlowReturn.
*/
-typedef GstFlowReturn (*RTPSessionSendRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
+typedef GstFlowReturn (*RTPSessionSendRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer,
+ gboolean eos, gpointer user_data);
+
+/**
+ * RTPSessionSyncRTCP:
+ * @sess: an #RTPSession
+ * @src: the #RTPSource
+ * @buffer: the RTCP buffer ready for synchronisation
+ * @user_data: user data specified when registering
+ *
+ * This callback will be called when @sess has an SR @buffer ready for doing
+ * synchronisation between streams.
+ *
+ * Returns: a #GstFlowReturn.
+ */
+typedef GstFlowReturn (*RTPSessionSyncRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
/**
* RTPSessionClockRate:
typedef gint (*RTPSessionClockRate) (RTPSession *sess, guint8 payload, gpointer user_data);
/**
- * RTPSessionGetTime:
+ * RTPSessionReconsider:
* @sess: an #RTPSession
* @user_data: user data specified when registering
*
- * This callback will be called when @sess needs the current time in
- * nanoseconds.
+ * This callback will be called when @sess needs to cancel the current timeout.
+ * The currently running timeout should be canceled and a new reporting interval
+ * should be requested from @sess.
+ */
+typedef void (*RTPSessionReconsider) (RTPSession *sess, gpointer user_data);
+
+/**
+ * RTPSessionRequestKeyUnit:
+ * @sess: an #RTPSession
+ * @all_headers: %TRUE if "all-headers" property should be set on the key unit
+ * request
+ * @user_data: user data specified when registering
+*
+ * Asks the encoder to produce a key unit as soon as possibly within the
+ * bandwidth constraints
+ */
+typedef void (*RTPSessionRequestKeyUnit) (RTPSession *sess,
+ gboolean all_headers, gpointer user_data);
+
+/**
+ * RTPSessionRequestTime:
+ * @sess: an #RTPSession
+ * @user_data: user data specified when registering
*
- * Returns: a #GstClockTime with the current time in nanoseconds.
+ * This callback will be called when @sess needs the current time. The time
+ * should be returned as a #GstClockTime
*/
-typedef GstClockTime (*RTPSessionGetTime) (RTPSession *sess, gpointer user_data);
+typedef GstClockTime (*RTPSessionRequestTime) (RTPSession *sess,
+ gpointer user_data);
/**
* RTPSessionCallbacks:
* @RTPSessionProcessRTP: callback to process RTP packets
* @RTPSessionSendRTP: callback for sending RTP packets
* @RTPSessionSendRTCP: callback for sending RTCP packets
- * @RTPSessionGetTime: callback for returning the current time
+ * @RTPSessionSyncRTCP: callback for handling SR packets
+ * @RTPSessionReconsider: callback for reconsidering the timeout
+ * @RTPSessionRequestKeyUnit: callback for requesting a new key unit
*
* These callbacks can be installed on the session manager to get notification
* when RTP and RTCP packets are ready for further processing. These callbacks
typedef struct {
RTPSessionProcessRTP process_rtp;
RTPSessionSendRTP send_rtp;
+ RTPSessionSyncRTCP sync_rtcp;
RTPSessionSendRTCP send_rtcp;
RTPSessionClockRate clock_rate;
- RTPSessionGetTime get_time;
+ RTPSessionReconsider reconsider;
+ RTPSessionRequestKeyUnit request_key_unit;
+ RTPSessionRequestTime request_time;
} RTPSessionCallbacks;
/**
* @activecount: the number of active sources
* @callbacks: callbacks
* @user_data: user data passed in callbacks
+ * @stats: session statistics
*
* The RTP session manager object
*/
struct _RTPSession {
GObject object;
- GMutex *lock;
+ GMutex lock;
guint header_len;
guint mtu;
- RTPSource *source;
+ guint probation;
+
+ /* bandwidths */
+ gboolean recalc_bandwidth;
+ guint bandwidth;
+ gdouble rtcp_bandwidth;
+ guint rtcp_rr_bandwidth;
+ guint rtcp_rs_bandwidth;
- /* info for creating reports */
- gchar *cname;
- gchar *name;
- gchar *email;
- gchar *phone;
- gchar *location;
- gchar *tool;
- gchar *note;
+ RTPSource *source;
/* for sender/receiver counting */
guint32 key;
GHashTable *cnames;
guint total_sources;
- RTPSessionCallbacks callbacks;
- gpointer user_data;
+ GstClockTime next_rtcp_check_time;
+ GstClockTime last_rtcp_send_time;
+ GstClockTime start_time;
+ gboolean first_rtcp;
+ gboolean allow_early;
+
+ GstClockTime next_early_rtcp_time;
+
+ gchar *bye_reason;
+ gboolean sent_bye;
+
+ RTPSessionCallbacks callbacks;
+ gpointer process_rtp_user_data;
+ gpointer send_rtp_user_data;
+ gpointer send_rtcp_user_data;
+ gpointer sync_rtcp_user_data;
+ gpointer clock_rate_user_data;
+ gpointer reconsider_user_data;
+ gpointer request_key_unit_user_data;
+ gpointer request_time_user_data;
RTPSessionStats stats;
+
+ gboolean change_ssrc;
+ gboolean favor_new;
+ GstClockTime rtcp_feedback_retention_window;
+ guint rtcp_immediate_feedback_threshold;
+
+ GstClockTime last_keyframe_request;
+ gboolean last_keyframe_all_headers;
};
/**
struct _RTPSessionClass {
GObjectClass parent_class;
+ /* action signals */
+ RTPSource* (*get_source_by_ssrc) (RTPSession *sess, guint32 ssrc);
+
/* signals */
void (*on_new_ssrc) (RTPSession *sess, RTPSource *source);
void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
+ void (*on_ssrc_active) (RTPSession *sess, RTPSource *source);
+ void (*on_ssrc_sdes) (RTPSession *sess, RTPSource *source);
void (*on_bye_ssrc) (RTPSession *sess, RTPSource *source);
+ void (*on_bye_timeout) (RTPSession *sess, RTPSource *source);
+ void (*on_timeout) (RTPSession *sess, RTPSource *source);
+ void (*on_sender_timeout) (RTPSession *sess, RTPSource *source);
+ gboolean (*on_sending_rtcp) (RTPSession *sess, GstBuffer *buffer,
+ gboolean early);
+ void (*on_feedback_rtcp) (RTPSession *sess, guint type, guint fbtype,
+ guint sender_ssrc, guint media_ssrc, GstBuffer *fci);
+ void (*send_rtcp) (RTPSession *sess, GstClockTimeDiff max_delay);
};
GType rtp_session_get_type (void);
/* create and configure */
RTPSession* rtp_session_new (void);
-void rtp_session_set_callbacks (RTPSession *sess,
+void rtp_session_set_callbacks (RTPSession *sess,
RTPSessionCallbacks *callbacks,
gpointer user_data);
+void rtp_session_set_process_rtp_callback (RTPSession * sess,
+ RTPSessionProcessRTP callback,
+ gpointer user_data);
+void rtp_session_set_send_rtp_callback (RTPSession * sess,
+ RTPSessionSendRTP callback,
+ gpointer user_data);
+void rtp_session_set_send_rtcp_callback (RTPSession * sess,
+ RTPSessionSendRTCP callback,
+ gpointer user_data);
+void rtp_session_set_sync_rtcp_callback (RTPSession * sess,
+ RTPSessionSyncRTCP callback,
+ gpointer user_data);
+void rtp_session_set_clock_rate_callback (RTPSession * sess,
+ RTPSessionClockRate callback,
+ gpointer user_data);
+void rtp_session_set_reconsider_callback (RTPSession * sess,
+ RTPSessionReconsider callback,
+ gpointer user_data);
+void rtp_session_set_request_time_callback (RTPSession * sess,
+ RTPSessionRequestTime callback,
+ gpointer user_data);
+
void rtp_session_set_bandwidth (RTPSession *sess, gdouble bandwidth);
gdouble rtp_session_get_bandwidth (RTPSession *sess);
void rtp_session_set_rtcp_fraction (RTPSession *sess, gdouble fraction);
gdouble rtp_session_get_rtcp_fraction (RTPSession *sess);
-void rtp_session_set_cname (RTPSession *sess, const gchar *cname);
-gchar* rtp_session_get_cname (RTPSession *sess);
-void rtp_session_set_name (RTPSession *sess, const gchar *name);
-gchar* rtp_session_get_name (RTPSession *sess);
-void rtp_session_set_email (RTPSession *sess, const gchar *email);
-gchar* rtp_session_get_email (RTPSession *sess);
-void rtp_session_set_phone (RTPSession *sess, const gchar *phone);
-gchar* rtp_session_get_phone (RTPSession *sess);
-void rtp_session_set_location (RTPSession *sess, const gchar *location);
-gchar* rtp_session_get_location (RTPSession *sess);
-void rtp_session_set_tool (RTPSession *sess, const gchar *tool);
-gchar* rtp_session_get_tool (RTPSession *sess);
-void rtp_session_set_note (RTPSession *sess, const gchar *note);
-gchar* rtp_session_get_note (RTPSession *sess);
+gboolean rtp_session_set_sdes_string (RTPSession *sess, GstRTCPSDESType type,
+ const gchar *cname);
+gchar* rtp_session_get_sdes_string (RTPSession *sess, GstRTCPSDESType type);
+
+GstStructure * rtp_session_get_sdes_struct (RTPSession *sess);
+void rtp_session_set_sdes_struct (RTPSession *sess, const GstStructure *sdes);
/* handling sources */
+RTPSource* rtp_session_get_internal_source (RTPSession *sess);
+
+void rtp_session_set_internal_ssrc (RTPSession *sess, guint32 ssrc);
+guint32 rtp_session_get_internal_ssrc (RTPSession *sess);
+
gboolean rtp_session_add_source (RTPSession *sess, RTPSource *src);
-gint rtp_session_get_num_sources (RTPSession *sess);
-gint rtp_session_get_num_active_sources (RTPSession *sess);
+guint rtp_session_get_num_sources (RTPSession *sess);
+guint rtp_session_get_num_active_sources (RTPSession *sess);
RTPSource* rtp_session_get_source_by_ssrc (RTPSession *sess, guint32 ssrc);
RTPSource* rtp_session_get_source_by_cname (RTPSession *sess, const gchar *cname);
RTPSource* rtp_session_create_source (RTPSession *sess);
/* processing packets from receivers */
-GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer);
-GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer);
+GstFlowReturn rtp_session_process_rtp (RTPSession *sess, GstBuffer *buffer,
+ GstClockTime current_time,
+ GstClockTime running_time);
+GstFlowReturn rtp_session_process_rtcp (RTPSession *sess, GstBuffer *buffer,
+ GstClockTime current_time,
+ guint64 ntpnstime);
/* processing packets for sending */
-GstFlowReturn rtp_session_send_rtp (RTPSession *sess, GstBuffer *buffer);
+void rtp_session_update_send_caps (RTPSession *sess, GstCaps *caps);
+GstFlowReturn rtp_session_send_rtp (RTPSession *sess, gpointer data, gboolean is_list,
+ GstClockTime current_time, GstClockTime running_time);
+
+/* stopping the session */
+GstFlowReturn rtp_session_schedule_bye (RTPSession *sess, const gchar *reason,
+ GstClockTime current_time);
/* get interval for next RTCP interval */
-gdouble rtp_session_get_reporting_interval (RTPSession *sess);
-GstFlowReturn rtp_session_perform_reporting (RTPSession *sess);
+GstClockTime rtp_session_next_timeout (RTPSession *sess, GstClockTime current_time);
+GstFlowReturn rtp_session_on_timeout (RTPSession *sess, GstClockTime current_time,
+ guint64 ntpnstime, GstClockTime running_time);
+
+/* request the transmittion of an early RTCP packet */
+void rtp_session_request_early_rtcp (RTPSession * sess, GstClockTime current_time,
+ GstClockTimeDiff max_delay);
+
+/* Notify session of a request for a new key unit */
+gboolean rtp_session_request_key_unit (RTPSession * sess,
+ guint32 ssrc,
+ GstClockTime now,
+ gboolean fir,
+ gint count);
#endif /* __RTP_SESSION_H__ */
projects / platform / upstream / gstreamer.git / blobdiff