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_LAST: last buffer mode.
  49  *
  50  * The different buffer modes for a jitterbuffer.
  51  */
  52 typedef enum {
  53   RTP_JITTER_BUFFER_MODE_NONE    = 0,
  54   RTP_JITTER_BUFFER_MODE_SLAVE   = 1,
  55   RTP_JITTER_BUFFER_MODE_BUFFER  = 2,
  56   RTP_JITTER_BUFFER_MODE_LAST
  57 } RTPJitterBufferMode;
  58
  59 #define RTP_TYPE_JITTER_BUFFER_MODE (rtp_jitter_buffer_mode_get_type())
  60 GType rtp_jitter_buffer_mode_get_type (void);
  61
  62 #define RTP_JITTER_BUFFER_MAX_WINDOW 512
  63 /**
  64  * RTPJitterBuffer:
  65  *
  66  * A JitterBuffer in the #RTPSession
  67  */
  68 struct _RTPJitterBuffer {
  69   GObject        object;
  70
  71   GQueue        *packets;
  72
  73   RTPJitterBufferMode mode;
  74
  75   GstClockTime   delay;
  76
  77   /* for buffering */
  78   gboolean          buffering;
  79   guint64           low_level;
  80   guint64           high_level;
  81
  82   /* for calculating skew */
  83   GstClockTime   base_time;
  84   GstClockTime   base_rtptime;
  85   guint32        clock_rate;
  86   GstClockTime   base_extrtp;
  87   GstClockTime   prev_out_time;
  88   guint64        ext_rtptime;
  89   guint64        last_rtptime;
  90   gint64         window[RTP_JITTER_BUFFER_MAX_WINDOW];
  91   guint          window_pos;
  92   guint          window_size;
  93   gboolean       window_filling;
  94   gint64         window_min;
  95   gint64         skew;
  96   gint64         prev_send_diff;
  97 };
  98
  99 struct _RTPJitterBufferClass {
 100   GObjectClass   parent_class;
 101 };
 102
 103 /**
 104  * RTPJitterBufferItem:
 105  * @data: the data of the item
 106  * @next: pointer to next item
 107  * @prev: pointer to previous item
 108  * @type: the type of @data
 109  * @dts: input DTS
 110  * @pts: output PTS
 111  * @seqnum: seqnum
 112  * @count: amount of seqnum in this item
 113  * @rtptime: rtp timestamp
 114  *
 115  * An object containing an RTP packet or event.
 116  */
 117 struct _RTPJitterBufferItem {
 118   gpointer data;
 119   GList *next;
 120   GList *prev;
 121   guint type;
 122   GstClockTime dts;
 123   GstClockTime pts;
 124   guint seqnum;
 125   guint count;
 126   guint rtptime;
 127 };
 128
 129 GType rtp_jitter_buffer_get_type (void);
 130
 131 /* managing lifetime */
 132 RTPJitterBuffer*      rtp_jitter_buffer_new              (void);
 133
 134 RTPJitterBufferMode   rtp_jitter_buffer_get_mode         (RTPJitterBuffer *jbuf);
 135 void                  rtp_jitter_buffer_set_mode         (RTPJitterBuffer *jbuf, RTPJitterBufferMode mode);
 136
 137 GstClockTime          rtp_jitter_buffer_get_delay        (RTPJitterBuffer *jbuf);
 138 void                  rtp_jitter_buffer_set_delay        (RTPJitterBuffer *jbuf, GstClockTime delay);
 139
 140 void                  rtp_jitter_buffer_set_clock_rate   (RTPJitterBuffer *jbuf, guint32 clock_rate);
 141 guint32               rtp_jitter_buffer_get_clock_rate   (RTPJitterBuffer *jbuf);
 142
 143 void                  rtp_jitter_buffer_reset_skew       (RTPJitterBuffer *jbuf);
 144
 145 gboolean              rtp_jitter_buffer_insert           (RTPJitterBuffer *jbuf,
 146                                                           RTPJitterBufferItem *item,
 147                                                           gboolean *tail, gint *percent);
 148 RTPJitterBufferItem * rtp_jitter_buffer_peek             (RTPJitterBuffer *jbuf);
 149 RTPJitterBufferItem * rtp_jitter_buffer_pop              (RTPJitterBuffer *jbuf, gint *percent);
 150
 151 void                  rtp_jitter_buffer_flush            (RTPJitterBuffer *jbuf,
 152                                                           GFunc free_func, gpointer user_data);
 153
 154 gboolean              rtp_jitter_buffer_is_buffering     (RTPJitterBuffer * jbuf);
 155 void                  rtp_jitter_buffer_set_buffering    (RTPJitterBuffer * jbuf, gboolean buffering);
 156 gint                  rtp_jitter_buffer_get_percent      (RTPJitterBuffer * jbuf);
 157
 158 guint                 rtp_jitter_buffer_num_packets      (RTPJitterBuffer *jbuf);
 159 guint32               rtp_jitter_buffer_get_ts_diff      (RTPJitterBuffer *jbuf);
 160
 161 void                  rtp_jitter_buffer_get_sync         (RTPJitterBuffer *jbuf, guint64 *rtptime,
 162                                                           guint64 *timestamp, guint32 *clock_rate,
 163                                                           guint64 *last_rtptime);
 164
 165 #endif /* __RTP_JITTER_BUFFER_H__ */