rtpsession.h 15.3 KB
Newer Older
1
/* GStreamer
2
 * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
3
4
5
6
7
8
9
10
11
12
13
14
15
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
16
17
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 */

#ifndef __RTP_SESSION_H__
#define __RTP_SESSION_H__

#include <gst/gst.h>

#include "rtpsource.h"

typedef struct _RTPSession RTPSession;
typedef struct _RTPSessionClass RTPSessionClass;

#define RTP_TYPE_SESSION             (rtp_session_get_type())
#define RTP_SESSION(sess)            (G_TYPE_CHECK_INSTANCE_CAST((sess),RTP_TYPE_SESSION,RTPSession))
#define RTP_SESSION_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),RTP_TYPE_SESSION,RTPSessionClass))
#define RTP_IS_SESSION(sess)         (G_TYPE_CHECK_INSTANCE_TYPE((sess),RTP_TYPE_SESSION))
#define RTP_IS_SESSION_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_SESSION))
#define RTP_SESSION_CAST(sess)       ((RTPSession *)(sess))

Wim Taymans's avatar
Wim Taymans committed
37
38
#define RTP_SESSION_LOCK(sess)     (g_mutex_lock (&(sess)->lock))
#define RTP_SESSION_UNLOCK(sess)   (g_mutex_unlock (&(sess)->lock))
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

/**
 * RTPSessionProcessRTP:
 * @sess: an #RTPSession
 * @src: the #RTPSource
 * @buffer: the RTP buffer ready for processing
 * @user_data: user data specified when registering
 *
 * This callback will be called when @sess has @buffer ready for further
 * processing. Processing the buffer typically includes decoding and displaying
 * the buffer.
 *
 * Returns: a #GstFlowReturn.
 */
typedef GstFlowReturn (*RTPSessionProcessRTP) (RTPSession *sess, RTPSource *src, GstBuffer *buffer, gpointer user_data);

/**
 * RTPSessionSendRTP:
 * @sess: an #RTPSession
 * @src: the #RTPSource
 * @buffer: the RTP buffer ready for sending
 * @user_data: user data specified when registering
 *
 * This callback will be called when @sess has @buffer ready for sending to
 * all listening participants in this session.
 *
 * Returns: a #GstFlowReturn.
 */
67
typedef GstFlowReturn (*RTPSessionSendRTP) (RTPSession *sess, RTPSource *src, gpointer data, gpointer user_data);
68
69
70
71
72
73

/**
 * RTPSessionSendRTCP:
 * @sess: an #RTPSession
 * @src: the #RTPSource
 * @buffer: the RTCP buffer ready for sending
74
 * @eos: if an EOS event should be pushed
75
76
77
78
79
80
81
 * @user_data: user data specified when registering
 *
 * This callback will be called when @sess has @buffer ready for sending to
 * all listening participants in this session.
 *
 * Returns: a #GstFlowReturn.
 */
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
90
 * @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.
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
103
 * @user_data: user data specified when registering
 *
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
112
113
114
/**
 * RTPSessionReconsider:
 * @sess: an #RTPSession
 * @user_data: user data specified when registering
 *
115
 * This callback will be called when @sess needs to cancel the current timeout.
116
117
118
119
120
 * 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);

121
122
123
124
125
126
/**
 * 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
127
 *
128
129
130
131
132
133
 * 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);

134
135
136
137
138
139
140
141
142
143
144
/**
 * RTPSessionRequestTime:
 * @sess: an #RTPSession
 * @user_data: user data specified when registering
 *
 * This callback will be called when @sess needs the current time. The time
 * should be returned as a #GstClockTime
 */
typedef GstClockTime (*RTPSessionRequestTime) (RTPSession *sess,
    gpointer user_data);

145
146
147
148
149
/**
 * RTPSessionNotifyNACK:
 * @sess: an #RTPSession
 * @seqnum: the missing seqnum
 * @blp: other missing seqnums
150
 * @ssrc: SSRC of requested stream
151
152
153
154
155
 * @user_data: user data specified when registering
 *
 * Notifies of NACKed frames.
 */
typedef void (*RTPSessionNotifyNACK) (RTPSession *sess,
156
    guint16 seqnum, guint16 blp, guint32 ssrc, gpointer user_data);
157

158
159
160
161
162
163
164
165
166
167
/**
 * RTPSessionReconfigure:
 * @sess: an #RTPSession
 * @user_data: user data specified when registering
 *
 * This callback will be called when @sess wants to reconfigure the
 * negotiated parameters.
 */
typedef void (*RTPSessionReconfigure) (RTPSession *sess, gpointer user_data);

168
169
170
171
172
/**
 * RTPSessionCallbacks:
 * @RTPSessionProcessRTP: callback to process RTP packets
 * @RTPSessionSendRTP: callback for sending RTP packets
 * @RTPSessionSendRTCP: callback for sending RTCP packets
173
 * @RTPSessionSyncRTCP: callback for handling SR packets
174
 * @RTPSessionReconsider: callback for reconsidering the timeout
175
 * @RTPSessionRequestKeyUnit: callback for requesting a new key unit
176
177
 * @RTPSessionRequestTime: callback for requesting the current time
 * @RTPSessionNotifyNACK: callback for notifying NACK
178
 * @RTPSessionReconfigure: callback for requesting reconfiguration
179
180
181
182
183
184
185
186
 *
 * These callbacks can be installed on the session manager to get notification
 * when RTP and RTCP packets are ready for further processing. These callbacks
 * are not implemented with signals for performance reasons.
 */
typedef struct {
  RTPSessionProcessRTP  process_rtp;
  RTPSessionSendRTP     send_rtp;
187
  RTPSessionSyncRTCP    sync_rtcp;
188
  RTPSessionSendRTCP    send_rtcp;
189
  RTPSessionClockRate   clock_rate;
190
  RTPSessionReconsider  reconsider;
191
  RTPSessionRequestKeyUnit request_key_unit;
192
  RTPSessionRequestTime request_time;
193
  RTPSessionNotifyNACK  notify_nack;
194
  RTPSessionReconfigure reconfigure;
195
196
197
198
199
200
201
202
203
204
205
} RTPSessionCallbacks;

/**
 * RTPSession:
 * @lock: lock to protect the session
 * @source: the source of this session
 * @ssrcs: Hashtable of sources indexed by SSRC
 * @num_sources: the number of sources
 * @activecount: the number of active sources
 * @callbacks: callbacks
 * @user_data: user data passed in callbacks
206
 * @stats: session statistics
207
 * @conflicting_addresses: GList of conflicting addresses
208
209
210
211
212
213
 *
 * The RTP session manager object
 */
struct _RTPSession {
  GObject       object;

Wim Taymans's avatar
Wim Taymans committed
214
  GMutex        lock;
215
216

  guint         header_len;
217
  guint         mtu;
218

219
220
  GstStructure *sdes;

221
222
  guint         probation;

223
224
  GstRTPProfile rtp_profile;

225
226
227
  /* bandwidths */
  gboolean     recalc_bandwidth;
  guint        bandwidth;
228
  gdouble      rtcp_bandwidth;
229
230
231
  guint        rtcp_rr_bandwidth;
  guint        rtcp_rs_bandwidth;

232
  guint32       suggested_ssrc;
233
  gboolean      internal_ssrc_set;
234
235
236

  /* for sender/receiver counting */
  guint32       key;
237
238
239
  guint32       mask_idx;
  guint32       mask;
  GHashTable   *ssrcs[32];
240
241
  guint         total_sources;

242
  guint16       generation;
243
244
245
  GstClockTime  next_rtcp_check_time; /* tn */
  GstClockTime  last_rtcp_check_time; /* tp */
  GstClockTime  last_rtcp_send_time;  /* t_rr_last */
246
  GstClockTime  last_rtcp_interval;   /* T_rr */
247
  GstClockTime  start_time;
248
  gboolean      first_rtcp;
249
250
251
  gboolean      allow_early;

  GstClockTime  next_early_rtcp_time;
252

253
254
  gboolean      scheduled_bye;

255
256
257
258
259
260
261
  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;
262
  gpointer              request_key_unit_user_data;
263
  gpointer              request_time_user_data;
264
  gpointer              notify_nack_user_data;
265
  gpointer              reconfigure_user_data;
266
267

  RTPSessionStats stats;
268
  RTPSessionStats bye_stats;
269

270
  gboolean      favor_new;
271
  GstClockTime  rtcp_feedback_retention_window;
272
  guint         rtcp_immediate_feedback_threshold;
273

274
  GstClockTime last_keyframe_request;
275
  gboolean     last_keyframe_all_headers;
276
277

  gboolean      is_doing_ptp;
278
279

  GList         *conflicting_addresses;
280
281
282
283
284
285
286
287
288
289
290
291
};

/**
 * RTPSessionClass:
 * @on_new_ssrc: emited when a new source is found
 * @on_bye_ssrc: emited when a source is gone
 *
 * The session class.
 */
struct _RTPSessionClass {
  GObjectClass   parent_class;

292
293
294
  /* action signals */
  RTPSource* (*get_source_by_ssrc) (RTPSession *sess, guint32 ssrc);

295
296
297
298
  /* 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);
299
  void (*on_ssrc_active)    (RTPSession *sess, RTPSource *source);
Wim Taymans's avatar
Wim Taymans committed
300
  void (*on_ssrc_sdes)      (RTPSession *sess, RTPSource *source);
301
  void (*on_bye_ssrc)       (RTPSession *sess, RTPSource *source);
302
303
  void (*on_bye_timeout)    (RTPSession *sess, RTPSource *source);
  void (*on_timeout)        (RTPSession *sess, RTPSource *source);
304
  void (*on_sender_timeout) (RTPSession *sess, RTPSource *source);
305
306
  gboolean (*on_sending_rtcp) (RTPSession *sess, GstBuffer *buffer,
      gboolean early);
307
308
  void (*on_feedback_rtcp)  (RTPSession *sess, guint type, guint fbtype,
      guint sender_ssrc, guint media_ssrc, GstBuffer *fci);
309
  gboolean (*send_rtcp)     (RTPSession *sess, GstClockTime max_delay);
310
  void (*on_receiving_rtcp) (RTPSession *sess, GstBuffer *buffer);
311
312
313
314
315
316
};

GType rtp_session_get_type (void);

/* create and configure */
RTPSession*     rtp_session_new           (void);
317
void            rtp_session_set_callbacks          (RTPSession *sess,
318
319
		                                    RTPSessionCallbacks *callbacks,
                                                    gpointer user_data);
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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);
338
339
340
341
void            rtp_session_set_request_time_callback (RTPSession * sess,
                                                    RTPSessionRequestTime callback,
                                                    gpointer user_data);

342
343
344
345
346
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);

347
348
349
GstStructure *  rtp_session_get_sdes_struct        (RTPSession *sess);
void            rtp_session_set_sdes_struct        (RTPSession *sess, const GstStructure *sdes);

350
/* handling sources */
351
guint32         rtp_session_suggest_ssrc           (RTPSession *sess, gboolean *is_random);
352

353
gboolean        rtp_session_add_source             (RTPSession *sess, RTPSource *src);
354
355
guint           rtp_session_get_num_sources        (RTPSession *sess);
guint           rtp_session_get_num_active_sources (RTPSession *sess);
356
357
358
359
RTPSource*      rtp_session_get_source_by_ssrc     (RTPSession *sess, guint32 ssrc);
RTPSource*      rtp_session_create_source          (RTPSession *sess);

/* processing packets from receivers */
360
GstFlowReturn   rtp_session_process_rtp            (RTPSession *sess, GstBuffer *buffer,
361
                                                    GstClockTime current_time,
362
363
						    GstClockTime running_time,
                                                    guint64 ntpnstime);
364
GstFlowReturn   rtp_session_process_rtcp           (RTPSession *sess, GstBuffer *buffer,
365
366
                                                    GstClockTime current_time,
                                                    guint64 ntpnstime);
367
368

/* processing packets for sending */
369
void            rtp_session_update_send_caps       (RTPSession *sess, GstCaps *caps);
370
GstFlowReturn   rtp_session_send_rtp               (RTPSession *sess, gpointer data, gboolean is_list,
371
                                                    GstClockTime current_time, GstClockTime running_time);
372

373
/* scheduling bye */
374
375
void            rtp_session_mark_all_bye           (RTPSession *sess, const gchar *reason);
GstFlowReturn   rtp_session_schedule_bye           (RTPSession *sess, GstClockTime current_time);
376

377
/* get interval for next RTCP interval */
378
GstClockTime    rtp_session_next_timeout           (RTPSession *sess, GstClockTime current_time);
379
GstFlowReturn   rtp_session_on_timeout             (RTPSession *sess, GstClockTime current_time,
380
                                                    guint64 ntpnstime, GstClockTime running_time);
381

382
/* request the transmittion of an early RTCP packet */
383
gboolean        rtp_session_request_early_rtcp     (RTPSession * sess, GstClockTime current_time,
384
                                                    GstClockTime max_delay);
385

386
/* Notify session of a request for a new key unit */
387
388
gboolean        rtp_session_request_key_unit       (RTPSession * sess,
                                                    guint32 ssrc,
389
390
                                                    gboolean fir,
                                                    gint count);
391
392
393
394
395
gboolean        rtp_session_request_nack           (RTPSession * sess,
                                                    guint32 ssrc,
                                                    guint16 seqnum,
                                                    GstClockTime max_delay);

396

397
#endif /* __RTP_SESSION_H__ */