gst/rtpmanager/rtpsession.h

   1 /* GStreamer
   2  * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #ifndef __RTP_SESSION_H__
  21 #define __RTP_SESSION_H__
  22
  23 #include <gst/gst.h>
  24
  25 #include "rtpsource.h"
  26
  27 typedef struct _RTPSession RTPSession;
  28 typedef struct _RTPSessionClass RTPSessionClass;
  29
  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))
  36
  37 #define RTP_SESSION_LOCK(sess)     (g_mutex_lock (&(sess)->lock))
  38 #define RTP_SESSION_UNLOCK(sess)   (g_mutex_unlock (&(sess)->lock))
  39
  40 /**
  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
  46  *
  47  * This callback will be called when @sess has @buffer ready for further
  48  * processing. Processing the buffer typically includes decoding and displaying
  49  * the buffer.
  50  *
  51  * Returns: a #GstFlowReturn.
  52  */
  53 typedef GstFlowReturn (*RTPSessionProcessRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);
  54
  55 /**
  56  * RTPSessionSendRTP:
  57  * @sess: an #RTPSession
  58  * @src: the #RTPSource
  59  * @buffer: the RTP buffer ready for sending
  60  * @user_data: user data specified when registering
  61  *
  62  * This callback will be called when @sess has @buffer ready for sending to
  63  * all listening participants in this session.
  64  *
  65  * Returns: a #GstFlowReturn.
  66  */
  67 typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, gpointer data, gpointer user_data);
  68
  69 /**
  70  * RTPSessionSendRTCP:
  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
  76  *
  77  * This callback will be called when @sess has @buffer ready for sending to
  78  * all listening participants in this session.
  79  *
  80  * Returns: a #GstFlowReturn.
  81  */
  82 typedef GstFlowReturn (*RTPSessionSendRTCP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer,
  83     gboolean eos, gpointer user_data);
  84
  85 /**
  86  * RTPSessionSyncRTCP:
  87  * @sess: an #RTPSession
  88  * @buffer: the RTCP buffer ready for synchronisation
  89  * @user_data: user data specified when registering
  90  *
  91  * This callback will be called when @sess has an SR @buffer ready for doing
  92  * synchronisation between streams.
  93  *
  94  * Returns: a #GstFlowReturn.
  95  */
  96 typedef GstFlowReturn (*RTPSessionSyncRTCP) (RTPSession *sess, GstBuffer *buffer, gpointer user_data);
  97
  98 /**
  99  * RTPSessionClockRate:
 100  * @sess: an #RTPSession
 101  * @payload: the payload
 102  * @user_data: user data specified when registering
 103  *
 104  * This callback will be called when @sess needs the clock-rate of @payload.
 105  *
 106  * Returns: the clock-rate of @pt.
 107  */
 108 typedef gint (*RTPSessionClockRate) (RTPSession *sess, guint8 payload, gpointer user_data);
 109
 110 /**
 111  * RTPSessionReconsider:
 112  * @sess: an #RTPSession
 113  * @user_data: user data specified when registering
 114  *
 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.
 118  */
 119 typedef void (*RTPSessionReconsider) (RTPSession *sess, gpointer user_data);
 120
 121 /**
 122  * RTPSessionRequestKeyUnit:
 123  * @sess: an #RTPSession
 124  * @all_headers: %TRUE if "all-headers" property should be set on the key unit
 125  *  request
 126  * @user_data: user data specified when registering
 127 *
 128  * Asks the encoder to produce a key unit as soon as possibly within the
 129  * bandwidth constraints
 130  */
 131 typedef void (*RTPSessionRequestKeyUnit) (RTPSession *sess,
 132     gboolean all_headers, gpointer user_data);
 133
 134 /**
 135  * RTPSessionRequestTime:
 136  * @sess: an #RTPSession
 137  * @user_data: user data specified when registering
 138  *
 139  * This callback will be called when @sess needs the current time. The time
 140  * should be returned as a #GstClockTime
 141  */
 142 typedef GstClockTime (*RTPSessionRequestTime) (RTPSession *sess,
 143     gpointer user_data);
 144
 145 /**
 146  * RTPSessionCallbacks:
 147  * @RTPSessionProcessRTP: callback to process RTP packets
 148  * @RTPSessionSendRTP: callback for sending RTP packets
 149  * @RTPSessionSendRTCP: callback for sending RTCP packets
 150  * @RTPSessionSyncRTCP: callback for handling SR packets
 151  * @RTPSessionReconsider: callback for reconsidering the timeout
 152  * @RTPSessionRequestKeyUnit: callback for requesting a new key unit
 153  *
 154  * These callbacks can be installed on the session manager to get notification
 155  * when RTP and RTCP packets are ready for further processing. These callbacks
 156  * are not implemented with signals for performance reasons.
 157  */
 158 typedef struct {
 159   RTPSessionProcessRTP  process_rtp;
 160   RTPSessionSendRTP     send_rtp;
 161   RTPSessionSyncRTCP    sync_rtcp;
 162   RTPSessionSendRTCP    send_rtcp;
 163   RTPSessionClockRate   clock_rate;
 164   RTPSessionReconsider  reconsider;
 165   RTPSessionRequestKeyUnit request_key_unit;
 166   RTPSessionRequestTime request_time;
 167 } RTPSessionCallbacks;
 168
 169 /**
 170  * RTPSession:
 171  * @lock: lock to protect the session
 172  * @source: the source of this session
 173  * @ssrcs: Hashtable of sources indexed by SSRC
 174  * @num_sources: the number of sources
 175  * @activecount: the number of active sources
 176  * @callbacks: callbacks
 177  * @user_data: user data passed in callbacks
 178  * @stats: session statistics
 179  *
 180  * The RTP session manager object
 181  */
 182 struct _RTPSession {
 183   GObject       object;
 184
 185   GMutex        lock;
 186
 187   guint         header_len;
 188   guint         mtu;
 189
 190   GstStructure *sdes;
 191
 192   guint         probation;
 193
 194   /* bandwidths */
 195   gboolean     recalc_bandwidth;
 196   guint        bandwidth;
 197   gdouble      rtcp_bandwidth;
 198   guint        rtcp_rr_bandwidth;
 199   guint        rtcp_rs_bandwidth;
 200
 201   guint32       suggested_ssrc;
 202
 203   /* for sender/receiver counting */
 204   guint32       key;
 205   guint32       mask_idx;
 206   guint32       mask;
 207   GHashTable   *ssrcs[32];
 208   guint         total_sources;
 209
 210   guint16       generation;
 211   GstClockTime  next_rtcp_check_time;
 212   GstClockTime  last_rtcp_send_time;
 213   GstClockTime  start_time;
 214   gboolean      first_rtcp;
 215   gboolean      allow_early;
 216
 217   GstClockTime  next_early_rtcp_time;
 218
 219   gboolean      scheduled_bye;
 220
 221   RTPSessionCallbacks   callbacks;
 222   gpointer              process_rtp_user_data;
 223   gpointer              send_rtp_user_data;
 224   gpointer              send_rtcp_user_data;
 225   gpointer              sync_rtcp_user_data;
 226   gpointer              clock_rate_user_data;
 227   gpointer              reconsider_user_data;
 228   gpointer              request_key_unit_user_data;
 229   gpointer              request_time_user_data;
 230
 231   RTPSessionStats stats;
 232
 233   gboolean      favor_new;
 234   GstClockTime  rtcp_feedback_retention_window;
 235   guint         rtcp_immediate_feedback_threshold;
 236
 237   GstClockTime last_keyframe_request;
 238   gboolean     last_keyframe_all_headers;
 239 };
 240
 241 /**
 242  * RTPSessionClass:
 243  * @on_new_ssrc: emited when a new source is found
 244  * @on_bye_ssrc: emited when a source is gone
 245  *
 246  * The session class.
 247  */
 248 struct _RTPSessionClass {
 249   GObjectClass   parent_class;
 250
 251   /* action signals */
 252   RTPSource* (*get_source_by_ssrc) (RTPSession *sess, guint32 ssrc);
 253
 254   /* signals */
 255   void (*on_new_ssrc)       (RTPSession *sess, RTPSource *source);
 256   void (*on_ssrc_collision) (RTPSession *sess, RTPSource *source);
 257   void (*on_ssrc_validated) (RTPSession *sess, RTPSource *source);
 258   void (*on_ssrc_active)    (RTPSession *sess, RTPSource *source);
 259   void (*on_ssrc_sdes)      (RTPSession *sess, RTPSource *source);
 260   void (*on_bye_ssrc)       (RTPSession *sess, RTPSource *source);
 261   void (*on_bye_timeout)    (RTPSession *sess, RTPSource *source);
 262   void (*on_timeout)        (RTPSession *sess, RTPSource *source);
 263   void (*on_sender_timeout) (RTPSession *sess, RTPSource *source);
 264   gboolean (*on_sending_rtcp) (RTPSession *sess, GstBuffer *buffer,
 265       gboolean early);
 266   void (*on_feedback_rtcp)  (RTPSession *sess, guint type, guint fbtype,
 267       guint sender_ssrc, guint media_ssrc, GstBuffer *fci);
 268   void (*send_rtcp)         (RTPSession *sess, GstClockTime max_delay);
 269 };
 270
 271 GType rtp_session_get_type (void);
 272
 273 /* create and configure */
 274 RTPSession*     rtp_session_new           (void);
 275 void            rtp_session_set_callbacks          (RTPSession *sess,
 276                                                     RTPSessionCallbacks *callbacks,
 277                                                     gpointer user_data);
 278 void            rtp_session_set_process_rtp_callback   (RTPSession * sess,
 279                                                     RTPSessionProcessRTP callback,
 280                                                     gpointer user_data);
 281 void            rtp_session_set_send_rtp_callback  (RTPSession * sess,
 282                                                     RTPSessionSendRTP callback,
 283                                                     gpointer user_data);
 284 void            rtp_session_set_send_rtcp_callback   (RTPSession * sess,
 285                                                     RTPSessionSendRTCP callback,
 286                                                     gpointer user_data);
 287 void            rtp_session_set_sync_rtcp_callback   (RTPSession * sess,
 288                                                     RTPSessionSyncRTCP callback,
 289                                                     gpointer user_data);
 290 void            rtp_session_set_clock_rate_callback   (RTPSession * sess,
 291                                                     RTPSessionClockRate callback,
 292                                                     gpointer user_data);
 293 void            rtp_session_set_reconsider_callback (RTPSession * sess,
 294                                                     RTPSessionReconsider callback,
 295                                                     gpointer user_data);
 296 void            rtp_session_set_request_time_callback (RTPSession * sess,
 297                                                     RTPSessionRequestTime callback,
 298                                                     gpointer user_data);
 299
 300 void            rtp_session_set_bandwidth          (RTPSession *sess, gdouble bandwidth);
 301 gdouble         rtp_session_get_bandwidth          (RTPSession *sess);
 302 void            rtp_session_set_rtcp_fraction      (RTPSession *sess, gdouble fraction);
 303 gdouble         rtp_session_get_rtcp_fraction      (RTPSession *sess);
 304
 305 GstStructure *  rtp_session_get_sdes_struct        (RTPSession *sess);
 306 void            rtp_session_set_sdes_struct        (RTPSession *sess, const GstStructure *sdes);
 307
 308 /* handling sources */
 309 guint32         rtp_session_suggest_ssrc           (RTPSession *sess);
 310
 311 gboolean        rtp_session_add_source             (RTPSession *sess, RTPSource *src);
 312 guint           rtp_session_get_num_sources        (RTPSession *sess);
 313 guint           rtp_session_get_num_active_sources (RTPSession *sess);
 314 RTPSource*      rtp_session_get_source_by_ssrc     (RTPSession *sess, guint32 ssrc);
 315 RTPSource*      rtp_session_create_source          (RTPSession *sess);
 316
 317 /* processing packets from receivers */
 318 GstFlowReturn   rtp_session_process_rtp            (RTPSession *sess, GstBuffer *buffer,
 319                                                     GstClockTime current_time,
 320                                                     GstClockTime running_time);
 321 GstFlowReturn   rtp_session_process_rtcp           (RTPSession *sess, GstBuffer *buffer,
 322                                                     GstClockTime current_time,
 323                                                     guint64 ntpnstime);
 324
 325 /* processing packets for sending */
 326 void            rtp_session_update_send_caps       (RTPSession *sess, GstCaps *caps);
 327 GstFlowReturn   rtp_session_send_rtp               (RTPSession *sess, gpointer data, gboolean is_list,
 328                                                     GstClockTime current_time, GstClockTime running_time);
 329
 330 /* scheduling bye */
 331 void            rtp_session_mark_all_bye           (RTPSession *sess, const gchar *reason);
 332 GstFlowReturn   rtp_session_schedule_bye           (RTPSession *sess, GstClockTime current_time);
 333
 334 /* get interval for next RTCP interval */
 335 GstClockTime    rtp_session_next_timeout           (RTPSession *sess, GstClockTime current_time);
 336 GstFlowReturn   rtp_session_on_timeout             (RTPSession *sess, GstClockTime current_time,
 337                                                     guint64 ntpnstime, GstClockTime running_time);
 338
 339 /* request the transmittion of an early RTCP packet */
 340 void            rtp_session_request_early_rtcp     (RTPSession * sess, GstClockTime current_time,
 341                                                     GstClockTime max_delay);
 342
 343 /* Notify session of a request for a new key unit */
 344 gboolean        rtp_session_request_key_unit       (RTPSession * sess,
 345                                                     guint32 ssrc,
 346                                                     gboolean fir,
 347                                                     gint count);
 348 gboolean        rtp_session_request_nack           (RTPSession * sess,
 349                                                     guint32 ssrc,
 350                                                     guint16 seqnum,
 351                                                     GstClockTime max_delay);
 352
 353
 354 #endif /* __RTP_SESSION_H__ */