Blame gst/rtp/gstrtpulpfecdec.c

Packit 1f69a5
/* GStreamer plugin for forward error correction
Packit 1f69a5
 * Copyright (C) 2017 Pexip
Packit 1f69a5
 *
Packit 1f69a5
 * This library is free software; you can redistribute it and/or
Packit 1f69a5
 * modify it under the terms of the GNU Lesser General Public
Packit 1f69a5
 * License as published by the Free Software Foundation; either
Packit 1f69a5
 * version 2.1 of the License, or (at your option) any later version.
Packit 1f69a5
 *
Packit 1f69a5
 * This library is distributed in the hope that it will be useful,
Packit 1f69a5
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 1f69a5
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 1f69a5
 * Lesser General Public License for more details.
Packit 1f69a5
 *
Packit 1f69a5
 * You should have received a copy of the GNU Lesser General Public
Packit 1f69a5
 * License along with this library; if not, write to the Free Software
Packit 1f69a5
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Packit 1f69a5
 *
Packit 1f69a5
 * Author: Mikhail Fludkov <misha@pexip.com>
Packit 1f69a5
 */
Packit 1f69a5
Packit 1f69a5
/**
Packit 1f69a5
 * SECTION:element-rtpulpfecdec
Packit 1f69a5
 * @short_description: Generic RTP Forward Error Correction (FEC) decoder
Packit 1f69a5
 * @title: rtpulpfecdec
Packit 1f69a5
 *
Packit 1f69a5
 * Generic Forward Error Correction (FEC) decoder for Uneven Level
Packit 1f69a5
 * Protection (ULP) as described in RFC 5109.
Packit 1f69a5
 *
Packit 1f69a5
 * This element will work in combination with an upstream #GstRtpStorage
Packit 1f69a5
 * element and attempt to recover packets declared lost through custom
Packit 1f69a5
 * 'GstRTPPacketLost' events, usually emitted by #GstRtpJitterBuffer.
Packit 1f69a5
 *
Packit 1f69a5
 * As such, this element cannot be usefully used from the command line,
Packit 1f69a5
 * because a reference to the upstream storage object needs to be
Packit 1f69a5
 * provided to it through its #GstRtpUlpFecDec:storage property, example
Packit 1f69a5
 * programs are available at
Packit 1f69a5
 * <https://github.com/sdroege/gstreamer-rs/blob/master/examples/src/bin/rtpfecserver.rs>
Packit 1f69a5
 * and
Packit 1f69a5
 * <https://github.com/sdroege/gstreamer-rs/blob/master/examples/src/bin/rtpfecclient.rs>.
Packit 1f69a5
 *
Packit 1f69a5
 * Additionally, the payload types of the protection packets *must* be
Packit 1f69a5
 * provided to this element via its #GstRtpUlpFecDec:pt property.
Packit 1f69a5
 *
Packit 1f69a5
 * When using #GstRtpBin, this element should be inserted through the
Packit 1f69a5
 * #GstRtpBin::request-fec-decoder signal.
Packit 1f69a5
 *
Packit 1f69a5
 * See also: #GstRtpUlpFecEnc, #GstRtpBin, #GstRtpStorage
Packit 1f69a5
 * Since: 1.14
Packit 1f69a5
 */
Packit 1f69a5
Packit 1f69a5
#include <gst/rtp/gstrtpbuffer.h>
Packit 1f69a5
#include <gst/rtp/gstrtp-enumtypes.h>
Packit 1f69a5
Packit 1f69a5
#include "rtpulpfeccommon.h"
Packit 1f69a5
#include "gstrtpulpfecdec.h"
Packit 1f69a5
Packit 1f69a5
static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
Packit 1f69a5
    GST_PAD_SINK,
Packit 1f69a5
    GST_PAD_ALWAYS,
Packit 1f69a5
    GST_STATIC_CAPS ("application/x-rtp")
Packit 1f69a5
    );
Packit 1f69a5
Packit 1f69a5
static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
Packit 1f69a5
    GST_PAD_SRC,
Packit 1f69a5
    GST_PAD_ALWAYS,
Packit 1f69a5
    GST_STATIC_CAPS ("application/x-rtp")
Packit 1f69a5
    );
Packit 1f69a5
Packit 1f69a5
enum
Packit 1f69a5
{
Packit 1f69a5
  PROP_0,
Packit 1f69a5
  PROP_PT,
Packit 1f69a5
  PROP_STORAGE,
Packit 1f69a5
  PROP_RECOVERED,
Packit 1f69a5
  PROP_UNRECOVERED,
Packit 1f69a5
  N_PROPERTIES
Packit 1f69a5
};
Packit 1f69a5
Packit 1f69a5
#define DEFAULT_FEC_PT 0
Packit 1f69a5
Packit 1f69a5
static GParamSpec *klass_properties[N_PROPERTIES] = { NULL, };
Packit 1f69a5
Packit 1f69a5
GST_DEBUG_CATEGORY (gst_rtp_ulpfec_dec_debug);
Packit 1f69a5
#define GST_CAT_DEFAULT (gst_rtp_ulpfec_dec_debug)
Packit 1f69a5
Packit 1f69a5
G_DEFINE_TYPE (GstRtpUlpFecDec, gst_rtp_ulpfec_dec, GST_TYPE_ELEMENT);
Packit 1f69a5
Packit 1f69a5
#define RTP_FEC_MAP_INFO_NTH(dec, data) (&g_array_index (\
Packit 1f69a5
    ((GstRtpUlpFecDec *)dec)->info_arr, \
Packit 1f69a5
    RtpUlpFecMapInfo, \
Packit 1f69a5
    GPOINTER_TO_UINT(data)))
Packit 1f69a5
Packit 1f69a5
static gint
Packit 1f69a5
_compare_fec_map_info (gconstpointer a, gconstpointer b, gpointer userdata)
Packit 1f69a5
{
Packit 1f69a5
  guint16 aseq =
Packit 1f69a5
      gst_rtp_buffer_get_seq (&RTP_FEC_MAP_INFO_NTH (userdata, a)->rtp);
Packit 1f69a5
  guint16 bseq =
Packit 1f69a5
      gst_rtp_buffer_get_seq (&RTP_FEC_MAP_INFO_NTH (userdata, b)->rtp);
Packit 1f69a5
  return gst_rtp_buffer_compare_seqnum (bseq, aseq);
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_start (GstRtpUlpFecDec * self, GstBufferList * buflist,
Packit 1f69a5
    guint8 fec_pt, guint16 lost_seq)
Packit 1f69a5
{
Packit 1f69a5
  guint fec_packets = 0;
Packit 1f69a5
  gsize i;
Packit 1f69a5
Packit 1f69a5
  g_assert (NULL == self->info_media);
Packit 1f69a5
  g_assert (0 == self->info_fec->len);
Packit 1f69a5
  g_assert (0 == self->info_arr->len);
Packit 1f69a5
Packit 1f69a5
  g_array_set_size (self->info_arr, gst_buffer_list_length (buflist));
Packit 1f69a5
Packit 1f69a5
  for (i = 0;
Packit 1f69a5
      i < gst_buffer_list_length (buflist) && !self->lost_packet_from_storage;
Packit 1f69a5
      ++i) {
Packit 1f69a5
    GstBuffer *buffer = gst_buffer_list_get (buflist, i);
Packit 1f69a5
    RtpUlpFecMapInfo *info = RTP_FEC_MAP_INFO_NTH (self, i);
Packit 1f69a5
Packit 1f69a5
    if (!rtp_ulpfec_map_info_map (gst_buffer_ref (buffer), info))
Packit 1f69a5
      g_assert_not_reached ();
Packit 1f69a5
Packit 1f69a5
    if (fec_pt == gst_rtp_buffer_get_payload_type (&info->rtp)) {
Packit 1f69a5
      GST_DEBUG_RTP_PACKET (self, "rtp header (fec)", &info->rtp);
Packit 1f69a5
Packit 1f69a5
      ++fec_packets;
Packit 1f69a5
      if (rtp_ulpfec_buffer_is_valid (&info->rtp)) {
Packit 1f69a5
        GST_DEBUG_FEC_PACKET (self, &info->rtp);
Packit 1f69a5
        g_ptr_array_add (self->info_fec, GUINT_TO_POINTER (i));
Packit 1f69a5
      }
Packit 1f69a5
    } else {
Packit 1f69a5
      GST_LOG_RTP_PACKET (self, "rtp header (incoming)", &info->rtp);
Packit 1f69a5
Packit 1f69a5
      if (lost_seq == gst_rtp_buffer_get_seq (&info->rtp)) {
Packit 1f69a5
        GST_DEBUG_OBJECT (self, "Received lost packet from from the storage");
Packit 1f69a5
        g_list_free (self->info_media);
Packit 1f69a5
        self->info_media = NULL;
Packit 1f69a5
        self->lost_packet_from_storage = TRUE;
Packit 1f69a5
      }
Packit 1f69a5
      self->info_media =
Packit 1f69a5
          g_list_insert_sorted_with_data (self->info_media,
Packit 1f69a5
          GUINT_TO_POINTER (i), _compare_fec_map_info, self);
Packit 1f69a5
    }
Packit 1f69a5
  }
Packit 1f69a5
  if (!self->lost_packet_from_storage) {
Packit 1f69a5
    self->fec_packets_received += fec_packets;
Packit 1f69a5
    self->fec_packets_rejected += fec_packets - self->info_fec->len;
Packit 1f69a5
  }
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_stop (GstRtpUlpFecDec * self)
Packit 1f69a5
{
Packit 1f69a5
  g_array_set_size (self->info_arr, 0);
Packit 1f69a5
  g_ptr_array_set_size (self->info_fec, 0);
Packit 1f69a5
  g_list_free (self->info_media);
Packit 1f69a5
  self->info_media = NULL;
Packit 1f69a5
  self->lost_packet_from_storage = FALSE;
Packit 1f69a5
  self->lost_packet_returned = FALSE;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static guint64
Packit 1f69a5
gst_rtp_ulpfec_dec_get_media_buffers_mask (GstRtpUlpFecDec * self,
Packit 1f69a5
    guint16 fec_seq_base)
Packit 1f69a5
{
Packit 1f69a5
  guint64 mask = 0;
Packit 1f69a5
  GList *it;
Packit 1f69a5
Packit 1f69a5
  for (it = self->info_media; it; it = it->next) {
Packit 1f69a5
    RtpUlpFecMapInfo *info = RTP_FEC_MAP_INFO_NTH (self, it->data);
Packit 1f69a5
    mask |=
Packit 1f69a5
        rtp_ulpfec_packet_mask_from_seqnum (gst_rtp_buffer_get_seq (&info->rtp),
Packit 1f69a5
        fec_seq_base, TRUE);
Packit 1f69a5
  }
Packit 1f69a5
  return mask;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static gboolean
Packit 1f69a5
gst_rtp_ulpfec_dec_is_recovered_pt_valid (GstRtpUlpFecDec * self, gint media_pt,
Packit 1f69a5
    guint8 recovered_pt)
Packit 1f69a5
{
Packit 1f69a5
  GList *it;
Packit 1f69a5
  if (media_pt == recovered_pt)
Packit 1f69a5
    return TRUE;
Packit 1f69a5
Packit 1f69a5
  for (it = self->info_media; it; it = it->next) {
Packit 1f69a5
    RtpUlpFecMapInfo *info = RTP_FEC_MAP_INFO_NTH (self, it->data);
Packit 1f69a5
    if (gst_rtp_buffer_get_payload_type (&info->rtp) == recovered_pt)
Packit 1f69a5
      return TRUE;
Packit 1f69a5
  }
Packit 1f69a5
  return FALSE;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static GstBuffer *
Packit 1f69a5
gst_rtp_ulpfec_dec_recover_from_fec (GstRtpUlpFecDec * self,
Packit 1f69a5
    RtpUlpFecMapInfo * info_fec, guint32 ssrc, gint media_pt, guint16 seq,
Packit 1f69a5
    guint8 * dst_pt)
Packit 1f69a5
{
Packit 1f69a5
  guint64 fec_mask = rtp_ulpfec_buffer_get_mask (&info_fec->rtp);
Packit 1f69a5
  gboolean fec_mask_long = rtp_ulpfec_buffer_get_fechdr (&info_fec->rtp)->L;
Packit 1f69a5
  guint16 fec_seq_base = rtp_ulpfec_buffer_get_seq_base (&info_fec->rtp);
Packit 1f69a5
  GstBuffer *ret;
Packit 1f69a5
  GList *it;
Packit 1f69a5
Packit 1f69a5
  g_array_set_size (self->scratch_buf, 0);
Packit 1f69a5
  rtp_buffer_to_ulpfec_bitstring (&info_fec->rtp, self->scratch_buf, TRUE,
Packit 1f69a5
      fec_mask_long);
Packit 1f69a5
Packit 1f69a5
  for (it = self->info_media; it; it = it->next) {
Packit 1f69a5
    RtpUlpFecMapInfo *info = RTP_FEC_MAP_INFO_NTH (self, it->data);
Packit 1f69a5
    guint64 packet_mask =
Packit 1f69a5
        rtp_ulpfec_packet_mask_from_seqnum (gst_rtp_buffer_get_seq (&info->rtp),
Packit 1f69a5
        fec_seq_base, TRUE);
Packit 1f69a5
Packit 1f69a5
    if (fec_mask & packet_mask) {
Packit 1f69a5
      fec_mask ^= packet_mask;
Packit 1f69a5
      rtp_buffer_to_ulpfec_bitstring (&info->rtp, self->scratch_buf, FALSE,
Packit 1f69a5
          fec_mask_long);
Packit 1f69a5
    }
Packit 1f69a5
  }
Packit 1f69a5
Packit 1f69a5
  ret =
Packit 1f69a5
      rtp_ulpfec_bitstring_to_media_rtp_buffer (self->scratch_buf,
Packit 1f69a5
      fec_mask_long, ssrc, seq);
Packit 1f69a5
  if (ret) {
Packit 1f69a5
    /* We are about to put recovered packet back in self->info_media to be able
Packit 1f69a5
     * to reuse it later for recovery of other packets
Packit 1f69a5
     **/
Packit 1f69a5
    gint i = self->info_arr->len;
Packit 1f69a5
    RtpUlpFecMapInfo *info;
Packit 1f69a5
    guint8 recovered_pt;
Packit 1f69a5
Packit 1f69a5
    g_array_set_size (self->info_arr, self->info_arr->len + 1);
Packit 1f69a5
    info = RTP_FEC_MAP_INFO_NTH (self, i);
Packit 1f69a5
Packit 1f69a5
    if (!rtp_ulpfec_map_info_map (gst_buffer_ref (ret), info)) {
Packit 1f69a5
      GST_WARNING_OBJECT (self, "Invalid recovered packet");
Packit 1f69a5
      goto recovered_packet_invalid;
Packit 1f69a5
    }
Packit 1f69a5
Packit 1f69a5
    recovered_pt = gst_rtp_buffer_get_payload_type (&info->rtp);
Packit 1f69a5
    if (!gst_rtp_ulpfec_dec_is_recovered_pt_valid (self, media_pt,
Packit 1f69a5
            recovered_pt)) {
Packit 1f69a5
      GST_WARNING_OBJECT (self,
Packit 1f69a5
          "Recovered packet has unexpected payload type (%u)", recovered_pt);
Packit 1f69a5
      goto recovered_packet_invalid;
Packit 1f69a5
    }
Packit 1f69a5
Packit 1f69a5
    GST_DEBUG_RTP_PACKET (self, "rtp header (recovered)", &info->rtp);
Packit 1f69a5
    self->info_media =
Packit 1f69a5
        g_list_insert_sorted_with_data (self->info_media, GUINT_TO_POINTER (i),
Packit 1f69a5
        _compare_fec_map_info, self);
Packit 1f69a5
    *dst_pt = recovered_pt;
Packit 1f69a5
  }
Packit 1f69a5
  return ret;
Packit 1f69a5
Packit 1f69a5
recovered_packet_invalid:
Packit 1f69a5
  g_array_set_size (self->info_arr, self->info_arr->len - 1);
Packit 1f69a5
  gst_buffer_unref (ret);
Packit 1f69a5
  return NULL;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static GstBuffer *
Packit 1f69a5
gst_rtp_ulpfec_dec_recover_from_storage (GstRtpUlpFecDec * self,
Packit 1f69a5
    guint8 * dst_pt, guint16 * dst_seq)
Packit 1f69a5
{
Packit 1f69a5
  RtpUlpFecMapInfo *info;
Packit 1f69a5
Packit 1f69a5
  if (self->lost_packet_returned)
Packit 1f69a5
    return NULL;
Packit 1f69a5
Packit 1f69a5
  g_assert (g_list_length (self->info_media) == 1);
Packit 1f69a5
Packit 1f69a5
  info = RTP_FEC_MAP_INFO_NTH (self, self->info_media->data);
Packit 1f69a5
  *dst_seq = gst_rtp_buffer_get_seq (&info->rtp);
Packit 1f69a5
  *dst_pt = gst_rtp_buffer_get_payload_type (&info->rtp);
Packit 1f69a5
  self->lost_packet_returned = TRUE;
Packit 1f69a5
  GST_DEBUG_RTP_PACKET (self, "rtp header (recovered)", &info->rtp);
Packit 1f69a5
  return gst_buffer_ref (info->rtp.buffer);
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
/* __has_builtin only works with clang, so test compiler version for gcc */
Packit 1f69a5
/* Intel compiler and MSVC probably have their own things as well */
Packit 1f69a5
/* TODO: make sure we use builtin for clang as well */
Packit 1f69a5
#if defined(__GNUC__) && __GNUC__ >= 4
Packit 1f69a5
#define rtp_ulpfec_ctz64 __builtin_ctzll
Packit 1f69a5
#else
Packit 1f69a5
static inline gint
Packit 1f69a5
rtp_ulpfec_ctz64_inline (guint64 mask)
Packit 1f69a5
{
Packit 1f69a5
  gint nth_bit = 0;
Packit 1f69a5
Packit 1f69a5
  do {
Packit 1f69a5
    if ((mask & 1))
Packit 1f69a5
      return nth_bit;
Packit 1f69a5
    mask = mask >> 1;
Packit 1f69a5
  } while (++nth_bit < 64);
Packit 1f69a5
Packit 1f69a5
  return -1;                    /* should not be reached, since mask must not be 0 */
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
#define rtp_ulpfec_ctz64 rtp_ulpfec_ctz64_inline
Packit 1f69a5
#endif
Packit 1f69a5
Packit 1f69a5
static GstBuffer *
Packit 1f69a5
gst_rtp_ulpfec_dec_recover (GstRtpUlpFecDec * self, guint32 ssrc, gint media_pt,
Packit 1f69a5
    guint8 * dst_pt, guint16 * dst_seq)
Packit 1f69a5
{
Packit 1f69a5
  guint64 media_mask = 0;
Packit 1f69a5
  gint media_mask_seq_base = -1;
Packit 1f69a5
  gsize i;
Packit 1f69a5
Packit 1f69a5
  if (self->lost_packet_from_storage)
Packit 1f69a5
    return gst_rtp_ulpfec_dec_recover_from_storage (self, dst_pt, dst_seq);
Packit 1f69a5
Packit 1f69a5
  /* Looking for a FEC packet which can be used for recovery */
Packit 1f69a5
  for (i = 0; i < self->info_fec->len; ++i) {
Packit 1f69a5
    RtpUlpFecMapInfo *info = RTP_FEC_MAP_INFO_NTH (self,
Packit 1f69a5
        g_ptr_array_index (self->info_fec, i));
Packit 1f69a5
    guint16 seq_base = rtp_ulpfec_buffer_get_seq_base (&info->rtp);
Packit 1f69a5
    guint64 fec_mask = rtp_ulpfec_buffer_get_mask (&info->rtp);
Packit 1f69a5
    guint64 missing_packets_mask;
Packit 1f69a5
Packit 1f69a5
    if (media_mask_seq_base != (gint) seq_base) {
Packit 1f69a5
      media_mask_seq_base = seq_base;
Packit 1f69a5
      media_mask = gst_rtp_ulpfec_dec_get_media_buffers_mask (self, seq_base);
Packit 1f69a5
    }
Packit 1f69a5
Packit 1f69a5
    /* media_mask has 1s if packet exist.
Packit 1f69a5
     * fec_mask is the mask of protected packets
Packit 1f69a5
     * The statement below excludes existing packets from the protected. So
Packit 1f69a5
     * we are left with 1s only for missing packets which can be recovered
Packit 1f69a5
     * by this FEC packet. */
Packit 1f69a5
    missing_packets_mask = fec_mask & (~media_mask);
Packit 1f69a5
Packit 1f69a5
    /* Do we have any 1s? Checking if current FEC packet can be used for recovery */
Packit 1f69a5
    if (0 != missing_packets_mask) {
Packit 1f69a5
      guint trailing_zeros = rtp_ulpfec_ctz64 (missing_packets_mask);
Packit 1f69a5
Packit 1f69a5
      /* Is it the only 1 in the mask? Checking if we lacking single packet in
Packit 1f69a5
       * that case FEC packet can be used for recovery */
Packit 1f69a5
      if (missing_packets_mask == (G_GUINT64_CONSTANT (1) << trailing_zeros)) {
Packit 1f69a5
        GstBuffer *ret;
Packit 1f69a5
Packit 1f69a5
        *dst_seq =
Packit 1f69a5
            seq_base + (RTP_ULPFEC_SEQ_BASE_OFFSET_MAX (TRUE) - trailing_zeros);
Packit 1f69a5
        ret =
Packit 1f69a5
            gst_rtp_ulpfec_dec_recover_from_fec (self, info, ssrc, media_pt,
Packit 1f69a5
            *dst_seq, dst_pt);
Packit 1f69a5
        if (ret)
Packit 1f69a5
          return ret;
Packit 1f69a5
      }
Packit 1f69a5
    }
Packit 1f69a5
  }
Packit 1f69a5
  return NULL;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static GstFlowReturn
Packit 1f69a5
gst_rtp_ulpfec_dec_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
Packit 1f69a5
{
Packit 1f69a5
  GstRtpUlpFecDec *self = GST_RTP_ULPFEC_DEC (parent);
Packit 1f69a5
Packit 1f69a5
  if (G_LIKELY (GST_FLOW_OK == self->chain_return_val)) {
Packit 1f69a5
    if (G_UNLIKELY (self->unset_discont_flag)) {
Packit 1f69a5
      self->unset_discont_flag = FALSE;
Packit 1f69a5
      buf = gst_buffer_make_writable (buf);
Packit 1f69a5
      GST_BUFFER_FLAG_UNSET (buf, GST_BUFFER_FLAG_DISCONT);
Packit 1f69a5
    }
Packit 1f69a5
    return gst_pad_push (self->srcpad, buf);
Packit 1f69a5
  }
Packit 1f69a5
Packit 1f69a5
  gst_buffer_unref (buf);
Packit 1f69a5
  return self->chain_return_val;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static gboolean
Packit 1f69a5
gst_rtp_ulpfec_dec_handle_packet_loss (GstRtpUlpFecDec * self, guint16 seqnum,
Packit 1f69a5
    GstClockTime timestamp, GstClockTime duration)
Packit 1f69a5
{
Packit 1f69a5
  gint caps_pt = self->have_caps_pt ? self->caps_pt : -1;
Packit 1f69a5
  gboolean ret = TRUE;
Packit 1f69a5
  GstBufferList *buflist =
Packit 1f69a5
      rtp_storage_get_packets_for_recovery (self->storage, self->fec_pt,
Packit 1f69a5
      self->caps_ssrc, seqnum);
Packit 1f69a5
Packit 1f69a5
  if (buflist) {
Packit 1f69a5
    GstBuffer *recovered_buffer = NULL;
Packit 1f69a5
    guint16 recovered_seq = 0;
Packit 1f69a5
    guint8 recovered_pt = 0;
Packit 1f69a5
Packit 1f69a5
    gst_rtp_ulpfec_dec_start (self, buflist, self->fec_pt, seqnum);
Packit 1f69a5
Packit 1f69a5
    while (NULL != (recovered_buffer =
Packit 1f69a5
            gst_rtp_ulpfec_dec_recover (self, self->caps_ssrc, caps_pt,
Packit 1f69a5
                &recovered_pt, &recovered_seq))) {
Packit 1f69a5
      if (seqnum == recovered_seq) {
Packit 1f69a5
        recovered_buffer = gst_buffer_make_writable (recovered_buffer);
Packit 1f69a5
        GST_BUFFER_PTS (recovered_buffer) = timestamp;
Packit 1f69a5
        /* GST_BUFFER_DURATION (recovered_buffer) = duration;
Packit 1f69a5
         * JB does not set the duration, so we will not too */
Packit 1f69a5
Packit 1f69a5
        if (!self->lost_packet_from_storage)
Packit 1f69a5
          rtp_storage_put_recovered_packet (self->storage,
Packit 1f69a5
              gst_buffer_ref (recovered_buffer), recovered_pt, self->caps_ssrc,
Packit 1f69a5
              recovered_seq);
Packit 1f69a5
Packit 1f69a5
        GST_DEBUG_OBJECT (self,
Packit 1f69a5
            "Pushing recovered packet ssrc=0x%08x seq=%u %" GST_PTR_FORMAT,
Packit 1f69a5
            self->caps_ssrc, seqnum, recovered_buffer);
Packit 1f69a5
Packit 1f69a5
        ret = FALSE;
Packit 1f69a5
        self->unset_discont_flag = TRUE;
Packit 1f69a5
        self->chain_return_val = gst_pad_push (self->srcpad, recovered_buffer);
Packit 1f69a5
        break;
Packit 1f69a5
      }
Packit 1f69a5
Packit 1f69a5
      rtp_storage_put_recovered_packet (self->storage,
Packit 1f69a5
          recovered_buffer, recovered_pt, self->caps_ssrc, recovered_seq);
Packit 1f69a5
    }
Packit 1f69a5
Packit 1f69a5
    gst_rtp_ulpfec_dec_stop (self);
Packit 1f69a5
    gst_buffer_list_unref (buflist);
Packit 1f69a5
  }
Packit 1f69a5
Packit 1f69a5
  GST_DEBUG_OBJECT (self, "Packet lost ssrc=0x%08x seq=%u", self->caps_ssrc,
Packit 1f69a5
      seqnum);
Packit 1f69a5
Packit 1f69a5
  return ret;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static gboolean
Packit 1f69a5
gst_rtp_ulpfec_dec_handle_sink_event (GstPad * pad, GstObject * parent,
Packit 1f69a5
    GstEvent * event)
Packit 1f69a5
{
Packit 1f69a5
  GstRtpUlpFecDec *self = GST_RTP_ULPFEC_DEC (parent);
Packit 1f69a5
  gboolean forward = TRUE;
Packit 1f69a5
Packit 1f69a5
  GST_LOG_OBJECT (self, "Received event %" GST_PTR_FORMAT, event);
Packit 1f69a5
Packit 1f69a5
  if (GST_FLOW_OK == self->chain_return_val &&
Packit 1f69a5
      GST_EVENT_CUSTOM_DOWNSTREAM == GST_EVENT_TYPE (event) &&
Packit 1f69a5
      gst_event_has_name (event, "GstRTPPacketLost")) {
Packit 1f69a5
    guint seqnum;
Packit 1f69a5
    GstClockTime timestamp, duration;
Packit 1f69a5
Packit 1f69a5
    g_assert (self->have_caps_ssrc);
Packit 1f69a5
    g_assert (self->storage);
Packit 1f69a5
Packit 1f69a5
    if (!gst_structure_get (gst_event_get_structure (event),
Packit 1f69a5
            "seqnum", G_TYPE_UINT, &seqnum,
Packit 1f69a5
            "timestamp", G_TYPE_UINT64, &timestamp,
Packit 1f69a5
            "duration", G_TYPE_UINT64, &duration, NULL))
Packit 1f69a5
      g_assert_not_reached ();
Packit 1f69a5
Packit 1f69a5
    forward =
Packit 1f69a5
        gst_rtp_ulpfec_dec_handle_packet_loss (self, seqnum, timestamp,
Packit 1f69a5
        duration);
Packit 1f69a5
    if (forward)
Packit 1f69a5
      ++self->packets_unrecovered;
Packit 1f69a5
    else
Packit 1f69a5
      ++self->packets_recovered;
Packit 1f69a5
    GST_DEBUG_OBJECT (self, "Unrecovered / Recovered: %lu / %lu",
Packit 1f69a5
        (gulong) self->packets_unrecovered, (gulong) self->packets_recovered);
Packit 1f69a5
  } else if (GST_EVENT_CAPS == GST_EVENT_TYPE (event)) {
Packit 1f69a5
    GstCaps *caps;
Packit 1f69a5
    gboolean have_caps_pt = FALSE;
Packit 1f69a5
    gboolean have_caps_ssrc = FALSE;
Packit 1f69a5
    guint caps_ssrc = 0;
Packit 1f69a5
    gint caps_pt = 0;
Packit 1f69a5
Packit 1f69a5
    gst_event_parse_caps (event, &caps);
Packit 1f69a5
    have_caps_ssrc =
Packit 1f69a5
        gst_structure_get_uint (gst_caps_get_structure (caps, 0), "ssrc",
Packit 1f69a5
        &caps_ssrc);
Packit 1f69a5
    have_caps_pt =
Packit 1f69a5
        gst_structure_get_int (gst_caps_get_structure (caps, 0), "payload",
Packit 1f69a5
        &caps_pt);
Packit 1f69a5
Packit 1f69a5
    if (self->have_caps_ssrc != have_caps_ssrc || self->caps_ssrc != caps_ssrc)
Packit 1f69a5
      GST_DEBUG_OBJECT (self, "SSRC changed %u, 0x%08x -> %u, 0x%08x",
Packit 1f69a5
          self->have_caps_ssrc, self->caps_ssrc, have_caps_ssrc, caps_ssrc);
Packit 1f69a5
    if (self->have_caps_pt != have_caps_pt || self->caps_pt != caps_pt)
Packit 1f69a5
      GST_DEBUG_OBJECT (self, "PT changed %u, %u -> %u, %u",
Packit 1f69a5
          self->have_caps_pt, self->caps_pt, have_caps_pt, caps_pt);
Packit 1f69a5
Packit 1f69a5
    self->have_caps_ssrc = have_caps_ssrc;
Packit 1f69a5
    self->have_caps_pt = have_caps_pt;
Packit 1f69a5
    self->caps_ssrc = caps_ssrc;
Packit 1f69a5
    self->caps_pt = caps_pt;
Packit 1f69a5
  }
Packit 1f69a5
Packit 1f69a5
  if (forward)
Packit 1f69a5
    return gst_pad_push_event (self->srcpad, event);
Packit 1f69a5
  gst_event_unref (event);
Packit 1f69a5
  return TRUE;
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_init (GstRtpUlpFecDec * self)
Packit 1f69a5
{
Packit 1f69a5
  self->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
Packit 1f69a5
  self->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
Packit 1f69a5
  GST_PAD_SET_PROXY_CAPS (self->sinkpad);
Packit 1f69a5
  GST_PAD_SET_PROXY_ALLOCATION (self->sinkpad);
Packit 1f69a5
  gst_pad_set_chain_function (self->sinkpad,
Packit 1f69a5
      GST_DEBUG_FUNCPTR (gst_rtp_ulpfec_dec_chain));
Packit 1f69a5
  gst_pad_set_event_function (self->sinkpad,
Packit 1f69a5
      GST_DEBUG_FUNCPTR (gst_rtp_ulpfec_dec_handle_sink_event));
Packit 1f69a5
Packit 1f69a5
  gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
Packit 1f69a5
  gst_element_add_pad (GST_ELEMENT (self), self->sinkpad);
Packit 1f69a5
Packit 1f69a5
  self->fec_pt = DEFAULT_FEC_PT;
Packit 1f69a5
Packit 1f69a5
  self->chain_return_val = GST_FLOW_OK;
Packit 1f69a5
  self->have_caps_ssrc = FALSE;
Packit 1f69a5
  self->caps_ssrc = 0;
Packit 1f69a5
  self->info_fec = g_ptr_array_new ();
Packit 1f69a5
  self->info_arr = g_array_new (FALSE, TRUE, sizeof (RtpUlpFecMapInfo));
Packit 1f69a5
  g_array_set_clear_func (self->info_arr,
Packit 1f69a5
      (GDestroyNotify) rtp_ulpfec_map_info_unmap);
Packit 1f69a5
  self->scratch_buf = g_array_new (FALSE, TRUE, sizeof (guint8));
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_dispose (GObject * obj)
Packit 1f69a5
{
Packit 1f69a5
  GstRtpUlpFecDec *self = GST_RTP_ULPFEC_DEC (obj);
Packit 1f69a5
Packit 1f69a5
  GST_INFO_OBJECT (self,
Packit 1f69a5
      " ssrc=0x%08x pt=%u"
Packit 1f69a5
      " packets_recovered=%" G_GSIZE_FORMAT
Packit 1f69a5
      " packets_unrecovered=%" G_GSIZE_FORMAT,
Packit 1f69a5
      self->caps_ssrc, self->caps_pt,
Packit 1f69a5
      self->packets_recovered, self->packets_unrecovered);
Packit 1f69a5
Packit 1f69a5
  if (self->storage)
Packit 1f69a5
    g_object_unref (self->storage);
Packit 1f69a5
Packit 1f69a5
  g_assert (NULL == self->info_media);
Packit 1f69a5
  g_assert (0 == self->info_fec->len);
Packit 1f69a5
  g_assert (0 == self->info_arr->len);
Packit 1f69a5
Packit 1f69a5
  if (self->fec_packets_received) {
Packit 1f69a5
    GST_INFO_OBJECT (self,
Packit 1f69a5
        " fec_packets_received=%" G_GSIZE_FORMAT
Packit 1f69a5
        " fec_packets_rejected=%" G_GSIZE_FORMAT
Packit 1f69a5
        " packets_rejected=%" G_GSIZE_FORMAT,
Packit 1f69a5
        self->fec_packets_received,
Packit 1f69a5
        self->fec_packets_rejected, self->packets_rejected);
Packit 1f69a5
  }
Packit 1f69a5
Packit 1f69a5
  g_ptr_array_free (self->info_fec, TRUE);
Packit 1f69a5
  g_array_free (self->info_arr, TRUE);
Packit 1f69a5
  g_array_free (self->scratch_buf, TRUE);
Packit 1f69a5
Packit 1f69a5
  G_OBJECT_CLASS (gst_rtp_ulpfec_dec_parent_class)->dispose (obj);
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_set_property (GObject * object, guint prop_id,
Packit 1f69a5
    const GValue * value, GParamSpec * pspec)
Packit 1f69a5
{
Packit 1f69a5
  GstRtpUlpFecDec *self = GST_RTP_ULPFEC_DEC (object);
Packit 1f69a5
Packit 1f69a5
  switch (prop_id) {
Packit 1f69a5
    case PROP_PT:
Packit 1f69a5
      self->fec_pt = g_value_get_uint (value);
Packit 1f69a5
      break;
Packit 1f69a5
    case PROP_STORAGE:
Packit 1f69a5
      if (self->storage)
Packit 1f69a5
        g_object_unref (self->storage);
Packit 1f69a5
      self->storage = g_value_get_object (value);
Packit 1f69a5
      if (self->storage)
Packit 1f69a5
        g_object_ref (self->storage);
Packit 1f69a5
      break;
Packit 1f69a5
    default:
Packit 1f69a5
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit 1f69a5
      break;
Packit 1f69a5
  }
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_get_property (GObject * object, guint prop_id,
Packit 1f69a5
    GValue * value, GParamSpec * pspec)
Packit 1f69a5
{
Packit 1f69a5
  GstRtpUlpFecDec *self = GST_RTP_ULPFEC_DEC (object);
Packit 1f69a5
Packit 1f69a5
  switch (prop_id) {
Packit 1f69a5
    case PROP_PT:
Packit 1f69a5
      g_value_set_uint (value, self->fec_pt);
Packit 1f69a5
      break;
Packit 1f69a5
    case PROP_STORAGE:
Packit 1f69a5
      g_value_set_object (value, self->storage);
Packit 1f69a5
      break;
Packit 1f69a5
    case PROP_RECOVERED:
Packit 1f69a5
      g_value_set_uint (value, (guint) self->packets_recovered);
Packit 1f69a5
      break;
Packit 1f69a5
    case PROP_UNRECOVERED:
Packit 1f69a5
      g_value_set_uint (value, (guint) self->packets_unrecovered);
Packit 1f69a5
      break;
Packit 1f69a5
    default:
Packit 1f69a5
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit 1f69a5
      break;
Packit 1f69a5
  }
Packit 1f69a5
}
Packit 1f69a5
Packit 1f69a5
static void
Packit 1f69a5
gst_rtp_ulpfec_dec_class_init (GstRtpUlpFecDecClass * klass)
Packit 1f69a5
{
Packit 1f69a5
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit 1f69a5
  GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
Packit 1f69a5
Packit 1f69a5
  GST_DEBUG_CATEGORY_INIT (gst_rtp_ulpfec_dec_debug,
Packit 1f69a5
      "rtpulpfecdec", 0, "RTP FEC Decoder");
Packit 1f69a5
Packit 1f69a5
  gst_element_class_add_pad_template (element_class,
Packit 1f69a5
      gst_static_pad_template_get (&srctemplate));
Packit 1f69a5
  gst_element_class_add_pad_template (element_class,
Packit 1f69a5
      gst_static_pad_template_get (&sinktemplate));
Packit 1f69a5
Packit 1f69a5
  gst_element_class_set_static_metadata (element_class,
Packit 1f69a5
      "RTP FEC Decoder",
Packit 1f69a5
      "Codec/Depayloader/Network/RTP",
Packit 1f69a5
      "Decodes RTP FEC (RFC5109)", "Mikhail Fludkov <misha@pexip.com>");
Packit 1f69a5
Packit 1f69a5
  gobject_class->set_property =
Packit 1f69a5
      GST_DEBUG_FUNCPTR (gst_rtp_ulpfec_dec_set_property);
Packit 1f69a5
  gobject_class->get_property =
Packit 1f69a5
      GST_DEBUG_FUNCPTR (gst_rtp_ulpfec_dec_get_property);
Packit 1f69a5
  gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_rtp_ulpfec_dec_dispose);
Packit 1f69a5
Packit 1f69a5
  klass_properties[PROP_PT] = g_param_spec_uint ("pt", "pt",
Packit 1f69a5
      "FEC packets payload type", 0, 127,
Packit 1f69a5
      DEFAULT_FEC_PT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
Packit 1f69a5
  klass_properties[PROP_STORAGE] =
Packit 1f69a5
      g_param_spec_object ("storage", "RTP storage", "RTP storage",
Packit 1f69a5
      G_TYPE_OBJECT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
Packit 1f69a5
  klass_properties[PROP_RECOVERED] =
Packit 1f69a5
      g_param_spec_uint ("recovered", "recovered",
Packit 1f69a5
      "The number of recovered packets", 0, G_MAXUINT, 0,
Packit 1f69a5
      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
Packit 1f69a5
  klass_properties[PROP_UNRECOVERED] =
Packit 1f69a5
      g_param_spec_uint ("unrecovered", "unrecovered",
Packit 1f69a5
      "The number of unrecovered packets", 0, G_MAXUINT, 0,
Packit 1f69a5
      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
Packit 1f69a5
Packit 1f69a5
  g_object_class_install_properties (gobject_class, N_PROPERTIES,
Packit 1f69a5
      klass_properties);
Packit 1f69a5
Packit 1f69a5
  g_assert (rtp_ulpfec_ctz64 (G_GUINT64_CONSTANT (0x1)) == 0);
Packit 1f69a5
  g_assert (rtp_ulpfec_ctz64 (G_GUINT64_CONSTANT (0x8000000000000000)) == 63);
Packit 1f69a5
}