subprojects/gst-plugins-good/gst/rtpmanager/gstrtpbin.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 __GST_RTP_BIN_H__
  21 #define __GST_RTP_BIN_H__
  22
  23 #include <gst/gst.h>
  24
  25 #include "rtpsession.h"
  26 #include "gstrtpsession.h"
  27 #include "rtpjitterbuffer.h"
  28
  29 #define GST_TYPE_RTP_BIN \
  30   (gst_rtp_bin_get_type())
  31 #define GST_RTP_BIN(obj) \
  32   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_RTP_BIN,GstRtpBin))
  33 #define GST_RTP_BIN_CLASS(klass) \
  34   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_RTP_BIN,GstRtpBinClass))
  35 #define GST_IS_RTP_BIN(obj) \
  36   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_RTP_BIN))
  37 #define GST_IS_RTP_BIN_CLASS(klass) \
  38   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_RTP_BIN))
  39
  40 typedef enum
  41 {
  42   GST_RTP_BIN_RTCP_SYNC_ALWAYS,
  43   GST_RTP_BIN_RTCP_SYNC_INITIAL,
  44   GST_RTP_BIN_RTCP_SYNC_RTP
  45 } GstRTCPSync;
  46
  47 typedef struct _GstRtpBin GstRtpBin;
  48 typedef struct _GstRtpBinClass GstRtpBinClass;
  49 typedef struct _GstRtpBinPrivate GstRtpBinPrivate;
  50
  51 struct _GstRtpBin {
  52   GstBin         bin;
  53
  54   /*< private >*/
  55   /* default latency for sessions */
  56   guint           latency_ms;
  57   guint64         latency_ns;
  58   gboolean        drop_on_latency;
  59   gboolean        do_lost;
  60   gboolean        ignore_pt;
  61   gboolean        ntp_sync;
  62   gint            rtcp_sync;
  63   guint           rtcp_sync_interval;
  64   RTPJitterBufferMode buffer_mode;
  65   gboolean        buffering;
  66   gboolean        use_pipeline_clock;
  67   GstRtpNtpTimeSource ntp_time_source;
  68   gboolean        send_sync_event;
  69   GstClockTime    buffer_start;
  70   gboolean        do_retransmission;
  71   GstRTPProfile   rtp_profile;
  72   gboolean        rtcp_sync_send_time;
  73   gint            max_rtcp_rtp_time_diff;
  74   guint32         max_dropout_time;
  75   guint32         max_misorder_time;
  76   gboolean        rfc7273_sync;
  77   gboolean        add_reference_timestamp_meta;
  78   guint           max_streams;
  79   guint64         max_ts_offset_adjustment;
  80   gint64          max_ts_offset;
  81   gboolean        max_ts_offset_is_set;
  82   guint64         min_ts_offset;
  83   gboolean        min_ts_offset_is_set;
  84   guint           ts_offset_smoothing_factor;
  85
  86   /* a list of session */
  87   GSList         *sessions;
  88
  89   /* a list of clients, these are streams with the same CNAME */
  90   GSList         *clients;
  91
  92   /* the default SDES items for sessions */
  93   GstStructure   *sdes;
  94
  95   /* the default FEC decoder factories for sessions */
  96   GstStructure   *fec_decoders;
  97
  98   /* the default FEC encoder factories for sessions */
  99   GstStructure   *fec_encoders;
 100
 101   /*< private >*/
 102   GstRtpBinPrivate *priv;
 103 };
 104
 105 struct _GstRtpBinClass {
 106   GstBinClass  parent_class;
 107
 108   /* get the caps for pt */
 109   GstCaps*    (*request_pt_map)       (GstRtpBin *rtpbin, guint session, guint pt);
 110
 111   void        (*payload_type_change)  (GstRtpBin *rtpbin, guint session, guint pt);
 112
 113   void        (*new_jitterbuffer)     (GstRtpBin *rtpbin, GstElement *jitterbuffer, guint session, guint32 ssrc);
 114
 115   void        (*new_storage)     (GstRtpBin *rtpbin, GstElement *jitterbuffer, guint session);
 116
 117   /* action signals */
 118   void        (*clear_pt_map)         (GstRtpBin *rtpbin);
 119   void        (*reset_sync)           (GstRtpBin *rtpbin);
 120   GstElement* (*get_session)          (GstRtpBin *rtpbin, guint session);
 121   RTPSession* (*get_internal_session) (GstRtpBin *rtpbin, guint session);
 122   GstElement* (*get_storage)          (GstRtpBin *rtpbin, guint session);
 123   GObject*    (*get_internal_storage) (GstRtpBin *rtpbin, guint session);
 124   void        (*clear_ssrc)           (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 125
 126   /* session manager signals */
 127   void     (*on_new_ssrc)       (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 128   void     (*on_ssrc_collision) (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 129   void     (*on_ssrc_validated) (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 130   void     (*on_ssrc_active)    (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 131   void     (*on_ssrc_sdes)      (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 132   void     (*on_bye_ssrc)       (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 133   void     (*on_bye_timeout)    (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 134   void     (*on_timeout)        (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 135   void     (*on_sender_timeout) (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 136   void     (*on_npt_stop)       (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 137
 138   GstElement* (*request_rtp_encoder)  (GstRtpBin *rtpbin, guint session);
 139   GstElement* (*request_rtp_decoder)  (GstRtpBin *rtpbin, guint session);
 140   GstElement* (*request_rtcp_encoder) (GstRtpBin *rtpbin, guint session);
 141   GstElement* (*request_rtcp_decoder) (GstRtpBin *rtpbin, guint session);
 142
 143   GstElement* (*request_aux_sender)   (GstRtpBin *rtpbin, guint session);
 144   GstElement* (*request_aux_receiver) (GstRtpBin *rtpbin, guint session);
 145
 146   GstElement* (*request_fec_encoder)  (GstRtpBin *rtpbin, guint session);
 147   GstElement* (*request_fec_decoder)  (GstRtpBin *rtpbin, guint session);
 148
 149   GstElement* (*request_jitterbuffer) (GstRtpBin *rtpbin, guint session);
 150
 151   void     (*on_new_sender_ssrc)      (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 152   void     (*on_sender_ssrc_active)   (GstRtpBin *rtpbin, guint session, guint32 ssrc);
 153 };
 154
 155 GType gst_rtp_bin_get_type (void);
 156
 157 GST_ELEMENT_REGISTER_DECLARE (rtpbin);
 158
 159 #endif /* __GST_RTP_BIN_H__ */