gst/rtpmanager/rtpjitterbuffer.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_JITTER_BUFFER_H__
  21 #define __RTP_JITTER_BUFFER_H__
  22
  23 #include <gst/gst.h>
  24 #include <gst/rtp/gstrtcpbuffer.h>
  25
  26 typedef struct _RTPJitterBuffer RTPJitterBuffer;
  27 typedef struct _RTPJitterBufferClass RTPJitterBufferClass;
  28 typedef struct _RTPJitterBufferItem RTPJitterBufferItem;
  29
  30 #define RTP_TYPE_JITTER_BUFFER             (rtp_jitter_buffer_get_type())
  31 #define RTP_JITTER_BUFFER(src)             (G_TYPE_CHECK_INSTANCE_CAST((src),RTP_TYPE_JITTER_BUFFER,RTPJitterBuffer))
  32 #define RTP_JITTER_BUFFER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),RTP_TYPE_JITTER_BUFFER,RTPJitterBufferClass))
  33 #define RTP_IS_JITTER_BUFFER(src)          (G_TYPE_CHECK_INSTANCE_TYPE((src),RTP_TYPE_JITTER_BUFFER))
  34 #define RTP_IS_JITTER_BUFFER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),RTP_TYPE_JITTER_BUFFER))
  35 #define RTP_JITTER_BUFFER_CAST(src)        ((RTPJitterBuffer *)(src))
  36
  37 /**
  38  * RTPJitterBufferMode:
  39  *
  40  * RTP_JITTER_BUFFER_MODE_NONE: don't do any skew correction, outgoing
  41  *    timestamps are calculated directly from the RTP timestamps. This mode is
  42  *    good for recording but not for real-time applications.
  43  * RTP_JITTER_BUFFER_MODE_SLAVE: calculate the skew between sender and receiver
  44  *    and produce smoothed adjusted outgoing timestamps. This mode is good for
  45  *    low latency communications.
  46  * RTP_JITTER_BUFFER_MODE_BUFFER: buffer packets between low/high watermarks.
  47  *    This mode is good for streaming communication.
  48  * RTP_JITTER_BUFFER_MODE_SYNCED: sender and receiver clocks are synchronized,
  49  *    like #RTP_JITTER_BUFFER_MODE_SLAVE but skew is assumed to be 0. Good for
  50  *    low latency communication when sender and receiver clocks are
  51  *    synchronized and there is thus no clock skew.
  52  * RTP_JITTER_BUFFER_MODE_LAST: last buffer mode.
  53  *
  54  * The different buffer modes for a jitterbuffer.
  55  */
  56 typedef enum {
  57   RTP_JITTER_BUFFER_MODE_NONE    = 0,
  58   RTP_JITTER_BUFFER_MODE_SLAVE   = 1,
  59   RTP_JITTER_BUFFER_MODE_BUFFER  = 2,
  60   RTP_JITTER_BUFFER_MODE_SYNCED  = 3,
  61   RTP_JITTER_BUFFER_MODE_LAST
  62 } RTPJitterBufferMode;
  63
  64 #define RTP_TYPE_JITTER_BUFFER_MODE (rtp_jitter_buffer_mode_get_type())
  65 GType rtp_jitter_buffer_mode_get_type (void);
  66
  67 #define RTP_JITTER_BUFFER_MAX_WINDOW 512
  68 /**
  69  * RTPJitterBuffer:
  70  *
  71  * A JitterBuffer in the #RTPSession
  72  */
  73 struct _RTPJitterBuffer {
  74   GObject        object;
  75
  76   GQueue        *packets;
  77
  78   RTPJitterBufferMode mode;
  79
  80   GstClockTime   delay;
  81
  82   /* for buffering */
  83   gboolean          buffering;
  84   guint64           low_level;
  85   guint64           high_level;
  86
  87   /* for calculating skew */
  88   GstClockTime   base_time;
  89   GstClockTime   base_rtptime;
  90   guint32        clock_rate;
  91   GstClockTime   base_extrtp;
  92   GstClockTime   prev_out_time;
  93   guint64        ext_rtptime;
  94   guint64        last_rtptime;
  95   gint64         window[RTP_JITTER_BUFFER_MAX_WINDOW];
  96   guint          window_pos;
  97   guint          window_size;
  98   gboolean       window_filling;
  99   gint64         window_min;
 100   gint64         skew;
 101   gint64         prev_send_diff;
 102 };
 103
 104 struct _RTPJitterBufferClass {
 105   GObjectClass   parent_class;
 106 };
 107
 108 /**
 109  * RTPJitterBufferItem:
 110  * @data: the data of the item
 111  * @next: pointer to next item
 112  * @prev: pointer to previous item
 113  * @type: the type of @data
 114  * @dts: input DTS
 115  * @pts: output PTS
 116  * @seqnum: seqnum
 117  * @count: amount of seqnum in this item
 118  * @rtptime: rtp timestamp
 119  *
 120  * An object containing an RTP packet or event.
 121  */
 122 struct _RTPJitterBufferItem {
 123   gpointer data;
 124   GList *next;
 125   GList *prev;
 126   guint type;
 127   GstClockTime dts;
 128   GstClockTime pts;
 129   guint seqnum;
 130   guint count;
 131   guint rtptime;
 132 };
 133
 134 GType rtp_jitter_buffer_get_type (void);
 135
 136 /* managing lifetime */
 137 RTPJitterBuffer*      rtp_jitter_buffer_new              (void);
 138
 139 RTPJitterBufferMode   rtp_jitter_buffer_get_mode         (RTPJitterBuffer *jbuf);
 140 void                  rtp_jitter_buffer_set_mode         (RTPJitterBuffer *jbuf, RTPJitterBufferMode mode);
 141
 142 GstClockTime          rtp_jitter_buffer_get_delay        (RTPJitterBuffer *jbuf);
 143 void                  rtp_jitter_buffer_set_delay        (RTPJitterBuffer *jbuf, GstClockTime delay);
 144
 145 void                  rtp_jitter_buffer_set_clock_rate   (RTPJitterBuffer *jbuf, guint32 clock_rate);
 146 guint32               rtp_jitter_buffer_get_clock_rate   (RTPJitterBuffer *jbuf);
 147
 148 void                  rtp_jitter_buffer_reset_skew       (RTPJitterBuffer *jbuf);
 149
 150 gboolean              rtp_jitter_buffer_insert           (RTPJitterBuffer *jbuf,
 151                                                           RTPJitterBufferItem *item,
 152                                                           gboolean *tail, gint *percent);
 153 RTPJitterBufferItem * rtp_jitter_buffer_peek             (RTPJitterBuffer *jbuf);
 154 RTPJitterBufferItem * rtp_jitter_buffer_pop              (RTPJitterBuffer *jbuf, gint *percent);
 155
 156 void                  rtp_jitter_buffer_flush            (RTPJitterBuffer *jbuf,
 157                                                           GFunc free_func, gpointer user_data);
 158
 159 gboolean              rtp_jitter_buffer_is_buffering     (RTPJitterBuffer * jbuf);
 160 void                  rtp_jitter_buffer_set_buffering    (RTPJitterBuffer * jbuf, gboolean buffering);
 161 gint                  rtp_jitter_buffer_get_percent      (RTPJitterBuffer * jbuf);
 162
 163 guint                 rtp_jitter_buffer_num_packets      (RTPJitterBuffer *jbuf);
 164 guint32               rtp_jitter_buffer_get_ts_diff      (RTPJitterBuffer *jbuf);
 165
 166 void                  rtp_jitter_buffer_get_sync         (RTPJitterBuffer *jbuf, guint64 *rtptime,
 167                                                           guint64 *timestamp, guint32 *clock_rate,
 168                                                           guint64 *last_rtptime);
 169
 170 #endif /* __RTP_JITTER_BUFFER_H__ */