gstrtpbasedepayload.c 27.1 KB
Newer Older
1
/* GStreamer
Stefan Kost's avatar
Stefan Kost committed
2
 * Copyright (C) <2005> Philippe Khalaf <burger@speedy.org>
3
 * Copyright (C) <2005> Nokia Corporation <kai.vehmanen@nokia.com>
4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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
17 18
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
19 20
 */

21
/**
22
 * SECTION:gstrtpbasedepayload
23 24 25 26 27
 * @short_description: Base class for RTP depayloader
 *
 * Provides a base class for RTP depayloaders
 */

28
#include "gstrtpbasedepayload.h"
29

30 31
GST_DEBUG_CATEGORY_STATIC (rtpbasedepayload_debug);
#define GST_CAT_DEFAULT (rtpbasedepayload_debug)
32

Wim Taymans's avatar
Wim Taymans committed
33 34
#define GST_RTP_BASE_DEPAYLOAD_GET_PRIVATE(obj)  \
   (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_RTP_BASE_DEPAYLOAD, GstRTPBaseDepayloadPrivate))
35

Wim Taymans's avatar
Wim Taymans committed
36
struct _GstRTPBaseDepayloadPrivate
37
{
38 39 40 41
  GstClockTime npt_start;
  GstClockTime npt_stop;
  gdouble play_speed;
  gdouble play_scale;
42
  guint clock_base;
43

44
  gboolean discont;
Wim Taymans's avatar
Wim Taymans committed
45 46
  GstClockTime pts;
  GstClockTime dts;
47
  GstClockTime duration;
48

Wim Taymans's avatar
Wim Taymans committed
49 50
  guint32 last_seqnum;
  guint32 last_rtptime;
51
  guint32 next_seqnum;
52 53

  gboolean negotiated;
54 55

  GstCaps *last_caps;
56
  GstEvent *segment_event;
57 58
};

59 60 61 62 63 64 65 66 67
/* Filter signals and args */
enum
{
  /* FILL ME */
  LAST_SIGNAL
};

enum
{
68
  PROP_0,
Wim Taymans's avatar
Wim Taymans committed
69
  PROP_STATS,
70
  PROP_LAST
71 72
};

Wim Taymans's avatar
Wim Taymans committed
73 74
static void gst_rtp_base_depayload_finalize (GObject * object);
static void gst_rtp_base_depayload_set_property (GObject * object,
75
    guint prop_id, const GValue * value, GParamSpec * pspec);
Wim Taymans's avatar
Wim Taymans committed
76
static void gst_rtp_base_depayload_get_property (GObject * object,
77 78
    guint prop_id, GValue * value, GParamSpec * pspec);

Wim Taymans's avatar
Wim Taymans committed
79
static GstFlowReturn gst_rtp_base_depayload_chain (GstPad * pad,
Wim Taymans's avatar
Wim Taymans committed
80
    GstObject * parent, GstBuffer * in);
81 82
static GstFlowReturn gst_rtp_base_depayload_chain_list (GstPad * pad,
    GstObject * parent, GstBufferList * list);
Wim Taymans's avatar
Wim Taymans committed
83
static gboolean gst_rtp_base_depayload_handle_sink_event (GstPad * pad,
Wim Taymans's avatar
Wim Taymans committed
84
    GstObject * parent, GstEvent * event);
85

Wim Taymans's avatar
Wim Taymans committed
86
static GstStateChangeReturn gst_rtp_base_depayload_change_state (GstElement *
87
    element, GstStateChange transition);
88

Wim Taymans's avatar
Wim Taymans committed
89
static gboolean gst_rtp_base_depayload_packet_lost (GstRTPBaseDepayload *
90
    filter, GstEvent * event);
Wim Taymans's avatar
Wim Taymans committed
91
static gboolean gst_rtp_base_depayload_handle_event (GstRTPBaseDepayload *
92
    filter, GstEvent * event);
93

94
static GstElementClass *parent_class = NULL;
Wim Taymans's avatar
Wim Taymans committed
95
static void gst_rtp_base_depayload_class_init (GstRTPBaseDepayloadClass *
96
    klass);
97
static void gst_rtp_base_depayload_init (GstRTPBaseDepayload * rtpbasepayload,
Wim Taymans's avatar
Wim Taymans committed
98
    GstRTPBaseDepayloadClass * klass);
99 100
static GstEvent *create_segment_event (GstRTPBaseDepayload * filter,
    guint rtptime, GstClockTime position);
101 102

GType
Wim Taymans's avatar
Wim Taymans committed
103
gst_rtp_base_depayload_get_type (void)
104
{
Wim Taymans's avatar
Wim Taymans committed
105
  static GType rtp_base_depayload_type = 0;
106

Wim Taymans's avatar
Wim Taymans committed
107 108 109
  if (g_once_init_enter ((gsize *) & rtp_base_depayload_type)) {
    static const GTypeInfo rtp_base_depayload_info = {
      sizeof (GstRTPBaseDepayloadClass),
110 111
      NULL,
      NULL,
Wim Taymans's avatar
Wim Taymans committed
112
      (GClassInitFunc) gst_rtp_base_depayload_class_init,
113 114
      NULL,
      NULL,
Wim Taymans's avatar
Wim Taymans committed
115
      sizeof (GstRTPBaseDepayload),
116
      0,
Wim Taymans's avatar
Wim Taymans committed
117
      (GInstanceInitFunc) gst_rtp_base_depayload_init,
118 119
    };

Wim Taymans's avatar
Wim Taymans committed
120 121 122
    g_once_init_leave ((gsize *) & rtp_base_depayload_type,
        g_type_register_static (GST_TYPE_ELEMENT, "GstRTPBaseDepayload",
            &rtp_base_depayload_info, G_TYPE_FLAG_ABSTRACT));
123
  }
Wim Taymans's avatar
Wim Taymans committed
124
  return rtp_base_depayload_type;
125 126 127
}

static void
Wim Taymans's avatar
Wim Taymans committed
128
gst_rtp_base_depayload_class_init (GstRTPBaseDepayloadClass * klass)
129 130
{
  GObjectClass *gobject_class;
131
  GstElementClass *gstelement_class;
132 133

  gobject_class = G_OBJECT_CLASS (klass);
134
  gstelement_class = (GstElementClass *) klass;
135
  parent_class = g_type_class_peek_parent (klass);
136

Wim Taymans's avatar
Wim Taymans committed
137
  g_type_class_add_private (klass, sizeof (GstRTPBaseDepayloadPrivate));
138

Wim Taymans's avatar
Wim Taymans committed
139 140 141
  gobject_class->finalize = gst_rtp_base_depayload_finalize;
  gobject_class->set_property = gst_rtp_base_depayload_set_property;
  gobject_class->get_property = gst_rtp_base_depayload_get_property;
142

Wim Taymans's avatar
Wim Taymans committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

  /**
   * GstRTPBaseDepayload:stats:
   *
   * Various depayloader statistics retrieved atomically (and are therefore
   * synchroized with each other). This property return a GstStructure named
   * application/x-rtp-depayload-stats containing the following fields relating to
   * the last processed buffer and current state of the stream being depayloaded:
   *
   * <variablelist>
   *   <varlistentry>
   *     <term>clock-rate</term>
   *     <listitem><para>#G_TYPE_UINT, clock-rate of the
   *     stream</para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>npt-start</term>
   *     <listitem><para>#G_TYPE_UINT64, time of playback start
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>npt-stop</term>
   *     <listitem><para>#G_TYPE_UINT64, time of playback stop
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>play-speed</term>
   *     <listitem><para>#G_TYPE_DOUBLE, the playback speed
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>play-scale</term>
   *     <listitem><para>#G_TYPE_DOUBLE, the playback scale
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>running-time-dts</term>
   *     <listitem><para>#G_TYPE_UINT64, the last running-time of the
   *      last DTS
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>running-time-pts</term>
   *     <listitem><para>#G_TYPE_UINT64, the last running-time of the
   *      last PTS
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>seqnum</term>
   *     <listitem><para>#G_TYPE_UINT, the last seen seqnum
   *     </para></listitem>
   *   </varlistentry>
   *   <varlistentry>
   *     <term>timestamp</term>
   *     <listitem><para>#G_TYPE_UINT, the last seen RTP timestamp
   *     </para></listitem>
   *   </varlistentry>
   * </variablelist>
   **/
  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_STATS,
      g_param_spec_boxed ("stats", "Statistics", "Various statistics",
          GST_TYPE_STRUCTURE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));

Wim Taymans's avatar
Wim Taymans committed
206
  gstelement_class->change_state = gst_rtp_base_depayload_change_state;
207

Wim Taymans's avatar
Wim Taymans committed
208 209
  klass->packet_lost = gst_rtp_base_depayload_packet_lost;
  klass->handle_event = gst_rtp_base_depayload_handle_event;
210

211
  GST_DEBUG_CATEGORY_INIT (rtpbasedepayload_debug, "rtpbasedepayload", 0,
212 213 214 215
      "Base class for RTP Depayloaders");
}

static void
Wim Taymans's avatar
Wim Taymans committed
216 217
gst_rtp_base_depayload_init (GstRTPBaseDepayload * filter,
    GstRTPBaseDepayloadClass * klass)
218 219
{
  GstPadTemplate *pad_template;
Wim Taymans's avatar
Wim Taymans committed
220
  GstRTPBaseDepayloadPrivate *priv;
221

Wim Taymans's avatar
Wim Taymans committed
222
  priv = GST_RTP_BASE_DEPAYLOAD_GET_PRIVATE (filter);
223
  filter->priv = priv;
224

225
  GST_DEBUG_OBJECT (filter, "init");
226 227

  pad_template =
228
      gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "sink");
229 230
  g_return_if_fail (pad_template != NULL);
  filter->sinkpad = gst_pad_new_from_template (pad_template, "sink");
Wim Taymans's avatar
Wim Taymans committed
231
  gst_pad_set_chain_function (filter->sinkpad, gst_rtp_base_depayload_chain);
232 233
  gst_pad_set_chain_list_function (filter->sinkpad,
      gst_rtp_base_depayload_chain_list);
234
  gst_pad_set_event_function (filter->sinkpad,
Wim Taymans's avatar
Wim Taymans committed
235
      gst_rtp_base_depayload_handle_sink_event);
236 237 238
  gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);

  pad_template =
239
      gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
240 241
  g_return_if_fail (pad_template != NULL);
  filter->srcpad = gst_pad_new_from_template (pad_template, "src");
242
  gst_pad_use_fixed_caps (filter->srcpad);
243 244
  gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);

Wim Taymans's avatar
Wim Taymans committed
245 246 247 248
  priv->npt_start = 0;
  priv->npt_stop = -1;
  priv->play_speed = 1.0;
  priv->play_scale = 1.0;
249
  priv->clock_base = -1;
Wim Taymans's avatar
Wim Taymans committed
250 251 252 253
  priv->dts = -1;
  priv->pts = -1;
  priv->duration = -1;

254
  gst_segment_init (&filter->segment, GST_FORMAT_UNDEFINED);
255 256 257
}

static void
Wim Taymans's avatar
Wim Taymans committed
258
gst_rtp_base_depayload_finalize (GObject * object)
259
{
260
  G_OBJECT_CLASS (parent_class)->finalize (object);
261 262 263
}

static gboolean
Wim Taymans's avatar
Wim Taymans committed
264
gst_rtp_base_depayload_setcaps (GstRTPBaseDepayload * filter, GstCaps * caps)
265
{
Wim Taymans's avatar
Wim Taymans committed
266 267
  GstRTPBaseDepayloadClass *bclass;
  GstRTPBaseDepayloadPrivate *priv;
268
  gboolean res;
269 270
  GstStructure *caps_struct;
  const GValue *value;
271

272
  priv = filter->priv;
273

Wim Taymans's avatar
Wim Taymans committed
274
  bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (filter);
275

276 277 278 279 280 281 282 283 284 285 286
  GST_DEBUG_OBJECT (filter, "Set caps %" GST_PTR_FORMAT, caps);

  if (priv->last_caps) {
    if (gst_caps_is_equal (priv->last_caps, caps)) {
      res = TRUE;
      goto caps_not_changed;
    } else {
      gst_caps_unref (priv->last_caps);
      priv->last_caps = NULL;
    }
  }
287 288 289

  caps_struct = gst_caps_get_structure (caps, 0);

290 291 292 293 294 295
  /* get other values for newsegment */
  value = gst_structure_get_value (caps_struct, "npt-start");
  if (value && G_VALUE_HOLDS_UINT64 (value))
    priv->npt_start = g_value_get_uint64 (value);
  else
    priv->npt_start = 0;
296
  GST_DEBUG_OBJECT (filter, "NPT start %" G_GUINT64_FORMAT, priv->npt_start);
297 298 299 300 301 302 303

  value = gst_structure_get_value (caps_struct, "npt-stop");
  if (value && G_VALUE_HOLDS_UINT64 (value))
    priv->npt_stop = g_value_get_uint64 (value);
  else
    priv->npt_stop = -1;

304
  GST_DEBUG_OBJECT (filter, "NPT stop %" G_GUINT64_FORMAT, priv->npt_stop);
305

306 307 308 309 310 311 312 313 314 315 316 317
  value = gst_structure_get_value (caps_struct, "play-speed");
  if (value && G_VALUE_HOLDS_DOUBLE (value))
    priv->play_speed = g_value_get_double (value);
  else
    priv->play_speed = 1.0;

  value = gst_structure_get_value (caps_struct, "play-scale");
  if (value && G_VALUE_HOLDS_DOUBLE (value))
    priv->play_scale = g_value_get_double (value);
  else
    priv->play_scale = 1.0;

318 319 320 321 322 323
  value = gst_structure_get_value (caps_struct, "clock-base");
  if (value && G_VALUE_HOLDS_UINT (value))
    priv->clock_base = g_value_get_uint (value);
  else
    priv->clock_base = -1;

324
  if (bclass->set_caps) {
325
    res = bclass->set_caps (filter, caps);
326 327 328 329 330
    if (!res) {
      GST_WARNING_OBJECT (filter, "Subclass rejected caps %" GST_PTR_FORMAT,
          caps);
    }
  } else {
331
    res = TRUE;
332
  }
333

334 335
  priv->negotiated = res;

336 337 338
  if (priv->negotiated)
    priv->last_caps = gst_caps_ref (caps);

339
  return res;
340 341 342 343 344 345

caps_not_changed:
  {
    GST_DEBUG_OBJECT (filter, "Caps did not change");
    return res;
  }
346 347 348
}

static GstFlowReturn
349 350
gst_rtp_base_depayload_handle_buffer (GstRTPBaseDepayload * filter,
    GstRTPBaseDepayloadClass * bclass, GstBuffer * in)
351
{
Wim Taymans's avatar
Wim Taymans committed
352
  GstRTPBaseDepayloadPrivate *priv;
353
  GstFlowReturn ret = GST_FLOW_OK;
354
  GstBuffer *out_buf;
Wim Taymans's avatar
Wim Taymans committed
355
  GstClockTime pts, dts;
356
  guint16 seqnum;
357
  guint32 rtptime;
358
  gboolean discont, buf_discont;
359
  gint gap;
360
  GstRTPBuffer rtp = { NULL };
361

362 363 364 365 366
  priv = filter->priv;

  /* we must have a setcaps first */
  if (G_UNLIKELY (!priv->negotiated))
    goto not_negotiated;
367

368
  if (G_UNLIKELY (!gst_rtp_buffer_map (in, GST_MAP_READ, &rtp)))
369 370
    goto invalid_buffer;

371
  buf_discont = GST_BUFFER_IS_DISCONT (in);
372

Wim Taymans's avatar
Wim Taymans committed
373 374
  pts = GST_BUFFER_PTS (in);
  dts = GST_BUFFER_DTS (in);
375 376
  /* convert to running_time and save the timestamp, this is the timestamp
   * we put on outgoing buffers. */
Wim Taymans's avatar
Wim Taymans committed
377 378 379 380
  pts = gst_segment_to_running_time (&filter->segment, GST_FORMAT_TIME, pts);
  dts = gst_segment_to_running_time (&filter->segment, GST_FORMAT_TIME, dts);
  priv->pts = pts;
  priv->dts = dts;
381
  priv->duration = GST_BUFFER_DURATION (in);
382

Wim Taymans's avatar
Wim Taymans committed
383 384 385 386
  seqnum = gst_rtp_buffer_get_seq (&rtp);
  rtptime = gst_rtp_buffer_get_timestamp (&rtp);
  gst_rtp_buffer_unmap (&rtp);

Wim Taymans's avatar
Wim Taymans committed
387 388 389
  priv->last_seqnum = seqnum;
  priv->last_rtptime = rtptime;

390
  discont = buf_discont;
391

Wim Taymans's avatar
Wim Taymans committed
392
  GST_LOG_OBJECT (filter, "discont %d, seqnum %u, rtptime %u, pts %"
393
      GST_TIME_FORMAT ", dts %" GST_TIME_FORMAT, buf_discont, seqnum, rtptime,
Wim Taymans's avatar
Wim Taymans committed
394
      GST_TIME_ARGS (pts), GST_TIME_ARGS (dts));
395 396

  /* Check seqnum. This is a very simple check that makes sure that the seqnums
397
   * are strictly increasing, dropping anything that is out of the ordinary. We
398
   * can only do this when the next_seqnum is known. */
399
  if (G_LIKELY (priv->next_seqnum != -1)) {
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
    gap = gst_rtp_buffer_compare_seqnum (seqnum, priv->next_seqnum);

    /* if we have no gap, all is fine */
    if (G_UNLIKELY (gap != 0)) {
      GST_LOG_OBJECT (filter, "got packet %u, expected %u, gap %d", seqnum,
          priv->next_seqnum, gap);
      if (gap < 0) {
        /* seqnum > next_seqnum, we are missing some packets, this is always a
         * DISCONT. */
        GST_LOG_OBJECT (filter, "%d missing packets", gap);
        discont = TRUE;
      } else {
        /* seqnum < next_seqnum, we have seen this packet before or the sender
         * could be restarted. If the packet is not too old, we throw it away as
         * a duplicate, otherwise we mark discont and continue. 100 misordered
         * packets is a good threshold. See also RFC 4737. */
        if (gap < 100)
          goto dropping;

        GST_LOG_OBJECT (filter,
            "%d > 100, packet too old, sender likely restarted", gap);
        discont = TRUE;
      }
    }
  }
  priv->next_seqnum = (seqnum + 1) & 0xffff;

427
  if (G_UNLIKELY (discont)) {
428
    priv->discont = TRUE;
429 430 431 432 433 434 435
    if (!buf_discont) {
      /* we detected a seqnum discont but the buffer was not flagged with a discont,
       * set the discont flag so that the subclass can throw away old data. */
      GST_LOG_OBJECT (filter, "mark DISCONT on input buffer");
      in = gst_buffer_make_writable (in);
      GST_BUFFER_FLAG_SET (in, GST_BUFFER_FLAG_DISCONT);
    }
436 437
  }

438 439 440 441 442 443 444
  /* prepare segment event if needed */
  if (filter->need_newsegment) {
    priv->segment_event = create_segment_event (filter, rtptime,
        GST_BUFFER_PTS (in));
    filter->need_newsegment = FALSE;
  }

445 446 447
  if (G_UNLIKELY (bclass->process == NULL))
    goto no_process;

448 449 450
  /* let's send it out to processing */
  out_buf = bclass->process (filter, in);
  if (out_buf) {
Wim Taymans's avatar
Wim Taymans committed
451
    ret = gst_rtp_base_depayload_push (filter, out_buf);
452
  }
453

454
  return ret;
455 456

  /* ERRORS */
457 458 459
not_negotiated:
  {
    /* this is not fatal but should be filtered earlier */
Wim Taymans's avatar
Wim Taymans committed
460 461 462 463 464 465 466 467
    GST_ELEMENT_ERROR (filter, CORE, NEGOTIATION,
        ("No RTP format was negotiated."),
        ("Input buffers need to have RTP caps set on them. This is usually "
            "achieved by setting the 'caps' property of the upstream source "
            "element (often udpsrc or appsrc), or by putting a capsfilter "
            "element before the depayloader and setting the 'caps' property "
            "on that. Also see http://cgit.freedesktop.org/gstreamer/"
            "gst-plugins-good/tree/gst/rtp/README"));
468 469
    return GST_FLOW_NOT_NEGOTIATED;
  }
470 471 472 473 474 475 476
invalid_buffer:
  {
    /* this is not fatal but should be filtered earlier */
    GST_ELEMENT_WARNING (filter, STREAM, DECODE, (NULL),
        ("Received invalid RTP payload, dropping"));
    return GST_FLOW_OK;
  }
477 478 479 480 481 482 483 484 485 486 487 488
dropping:
  {
    GST_WARNING_OBJECT (filter, "%d <= 100, dropping old packet", gap);
    return GST_FLOW_OK;
  }
no_process:
  {
    /* this is not fatal but should be filtered earlier */
    GST_ELEMENT_ERROR (filter, STREAM, NOT_IMPLEMENTED, (NULL),
        ("The subclass does not have a process method"));
    return GST_FLOW_ERROR;
  }
489 490
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
static GstFlowReturn
gst_rtp_base_depayload_chain (GstPad * pad, GstObject * parent, GstBuffer * in)
{
  GstRTPBaseDepayloadClass *bclass;
  GstRTPBaseDepayload *basedepay;
  GstFlowReturn flow_ret;

  basedepay = GST_RTP_BASE_DEPAYLOAD_CAST (parent);

  bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (basedepay);

  flow_ret = gst_rtp_base_depayload_handle_buffer (basedepay, bclass, in);

  gst_buffer_unref (in);

  return flow_ret;
}

static GstFlowReturn
gst_rtp_base_depayload_chain_list (GstPad * pad, GstObject * parent,
    GstBufferList * list)
{
  GstRTPBaseDepayloadClass *bclass;
  GstRTPBaseDepayload *basedepay;
  GstFlowReturn flow_ret;
  GstBuffer *buffer;
  guint i, len;

  basedepay = GST_RTP_BASE_DEPAYLOAD_CAST (parent);

  bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (basedepay);

  flow_ret = GST_FLOW_OK;

  /* chain each buffer in list individually */
  len = gst_buffer_list_length (list);

  if (len == 0)
    goto done;

  for (i = 0; i < len; i++) {
    buffer = gst_buffer_list_get (list, i);

    /* Should we fix up any missing timestamps for list buffers here
     * (e.g. set to first or previous timestamp in list) or just assume
     * the's a jitterbuffer that will have done that for us? */
    flow_ret = gst_rtp_base_depayload_handle_buffer (basedepay, bclass, buffer);
    if (flow_ret != GST_FLOW_OK)
      break;
  }

done:

  gst_buffer_list_unref (list);

  return flow_ret;
}

549
static gboolean
Wim Taymans's avatar
Wim Taymans committed
550
gst_rtp_base_depayload_handle_event (GstRTPBaseDepayload * filter,
551
    GstEvent * event)
552 553
{
  gboolean res = TRUE;
554
  gboolean forward = TRUE;
555 556

  switch (GST_EVENT_TYPE (event)) {
557 558 559
    case GST_EVENT_FLUSH_STOP:
      gst_segment_init (&filter->segment, GST_FORMAT_UNDEFINED);
      filter->need_newsegment = TRUE;
560
      filter->priv->next_seqnum = -1;
561
      gst_event_replace (&filter->priv->segment_event, NULL);
562
      break;
563 564 565 566 567 568
    case GST_EVENT_CAPS:
    {
      GstCaps *caps;

      gst_event_parse_caps (event, &caps);

Wim Taymans's avatar
Wim Taymans committed
569
      res = gst_rtp_base_depayload_setcaps (filter, caps);
570 571 572
      forward = FALSE;
      break;
    }
Wim Taymans's avatar
Wim Taymans committed
573
    case GST_EVENT_SEGMENT:
574
    {
575
      gst_event_copy_segment (event, &filter->segment);
576 577
      /* don't pass the event downstream, we generate our own segment including
       * the NTP time and other things we receive in caps */
578
      forward = FALSE;
579
      break;
580
    }
581 582
    case GST_EVENT_CUSTOM_DOWNSTREAM:
    {
Wim Taymans's avatar
Wim Taymans committed
583
      GstRTPBaseDepayloadClass *bclass;
584

Wim Taymans's avatar
Wim Taymans committed
585
      bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (filter);
586 587 588 589

      if (gst_event_has_name (event, "GstRTPPacketLost")) {
        /* we get this event from the jitterbuffer when it considers a packet as
         * being lost. We send it to our packet_lost vmethod. The default
590
         * implementation will make time progress by pushing out a GAP event.
591
         * Subclasses can override and do one of the following:
592 593 594 595 596 597 598 599
         *  - Adjust timestamp/duration to something more accurate before
         *    calling the parent (default) packet_lost method.
         *  - do some more advanced error concealing on the already received
         *    (fragmented) packets.
         *  - ignore the packet lost.
         */
        if (bclass->packet_lost)
          res = bclass->packet_lost (filter, event);
600
        forward = FALSE;
601 602 603
      }
      break;
    }
604 605 606
    default:
      break;
  }
607 608 609 610 611 612

  if (forward)
    res = gst_pad_push_event (filter->srcpad, event);
  else
    gst_event_unref (event);

613 614 615
  return res;
}

616
static gboolean
Wim Taymans's avatar
Wim Taymans committed
617 618
gst_rtp_base_depayload_handle_sink_event (GstPad * pad, GstObject * parent,
    GstEvent * event)
619 620
{
  gboolean res = FALSE;
Wim Taymans's avatar
Wim Taymans committed
621 622
  GstRTPBaseDepayload *filter;
  GstRTPBaseDepayloadClass *bclass;
623

Wim Taymans's avatar
Wim Taymans committed
624
  filter = GST_RTP_BASE_DEPAYLOAD (parent);
Wim Taymans's avatar
Wim Taymans committed
625
  bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (filter);
626 627
  if (bclass->handle_event)
    res = bclass->handle_event (filter, event);
628 629
  else
    gst_event_unref (event);
630 631 632 633

  return res;
}

634
static GstEvent *
635 636
create_segment_event (GstRTPBaseDepayload * filter, guint rtptime,
    GstClockTime position)
637 638
{
  GstEvent *event;
639
  GstClockTime start, stop, running_time;
Wim Taymans's avatar
Wim Taymans committed
640
  GstRTPBaseDepayloadPrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
641
  GstSegment segment;
642 643 644

  priv = filter->priv;

645
  /* determining the start of the segment */
646 647 648 649 650 651 652 653 654 655
  start = 0;
  if (priv->clock_base != -1 && position != -1) {
    GstClockTime exttime, gap;

    exttime = priv->clock_base;
    gst_rtp_buffer_ext_timestamp (&exttime, rtptime);
    gap = gst_util_uint64_scale_int (exttime - priv->clock_base,
        filter->clock_rate, GST_SECOND);

    /* account for lost packets */
656 657 658 659 660 661
    if (position > gap) {
      GST_DEBUG_OBJECT (filter,
          "Found gap of %" GST_TIME_FORMAT ", adjusting start: %"
          GST_TIME_FORMAT " = %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT,
          GST_TIME_ARGS (gap), GST_TIME_ARGS (position - gap),
          GST_TIME_ARGS (position), GST_TIME_ARGS (gap));
662
      start = position - gap;
663
    }
664 665
  }

666
  /* determining the stop of the segment */
667
  stop = -1;
668
  if (priv->npt_stop != -1)
669
    stop = start + (priv->npt_stop - priv->npt_start);
670

671 672 673 674
  if (position == -1)
    position = 0;

  running_time = gst_segment_to_running_time (&filter->segment,
675
      GST_FORMAT_TIME, start);
676

Wim Taymans's avatar
Wim Taymans committed
677 678 679
  gst_segment_init (&segment, GST_FORMAT_TIME);
  segment.rate = priv->play_speed;
  segment.applied_rate = priv->play_scale;
680
  segment.start = start;
Wim Taymans's avatar
Wim Taymans committed
681 682 683
  segment.stop = stop;
  segment.time = priv->npt_start;
  segment.position = position;
684
  segment.base = running_time;
Wim Taymans's avatar
Wim Taymans committed
685

686 687
  GST_DEBUG_OBJECT (filter, "Creating segment event %" GST_SEGMENT_FORMAT,
      &segment);
Wim Taymans's avatar
Wim Taymans committed
688
  event = gst_event_new_segment (&segment);
689 690 691 692

  return event;
}

693
typedef struct
694
{
Wim Taymans's avatar
Wim Taymans committed
695 696
  GstRTPBaseDepayload *depayload;
  GstRTPBaseDepayloadClass *bclass;
697
} HeaderData;
698

Wim Taymans's avatar
Wim Taymans committed
699 700
static gboolean
set_headers (GstBuffer ** buffer, guint idx, HeaderData * data)
701
{
Wim Taymans's avatar
Wim Taymans committed
702 703
  GstRTPBaseDepayload *depayload = data->depayload;
  GstRTPBaseDepayloadPrivate *priv = depayload->priv;
Wim Taymans's avatar
Wim Taymans committed
704
  GstClockTime pts, dts, duration;
705

Wim Taymans's avatar
Wim Taymans committed
706
  *buffer = gst_buffer_make_writable (*buffer);
707

Wim Taymans's avatar
Wim Taymans committed
708 709 710 711 712 713 714 715 716 717 718 719
  pts = GST_BUFFER_PTS (*buffer);
  dts = GST_BUFFER_DTS (*buffer);
  duration = GST_BUFFER_DURATION (*buffer);

  /* apply last incomming timestamp and duration to outgoing buffer if
   * not otherwise set. */
  if (!GST_CLOCK_TIME_IS_VALID (pts))
    GST_BUFFER_PTS (*buffer) = priv->pts;
  if (!GST_CLOCK_TIME_IS_VALID (dts))
    GST_BUFFER_DTS (*buffer) = priv->dts;
  if (!GST_CLOCK_TIME_IS_VALID (duration))
    GST_BUFFER_DURATION (*buffer) = priv->duration;
720

721 722 723 724 725
  if (G_UNLIKELY (depayload->priv->discont)) {
    GST_LOG_OBJECT (depayload, "Marking DISCONT on output buffer");
    GST_BUFFER_FLAG_SET (*buffer, GST_BUFFER_FLAG_DISCONT);
    depayload->priv->discont = FALSE;
  }
726

Wim Taymans's avatar
Wim Taymans committed
727 728 729 730 731
  /* make sure we only set the timestamp on the first packet */
  priv->pts = GST_CLOCK_TIME_NONE;
  priv->dts = GST_CLOCK_TIME_NONE;
  priv->duration = GST_CLOCK_TIME_NONE;

Wim Taymans's avatar
Wim Taymans committed
732
  return TRUE;
733 734 735
}

static GstFlowReturn
Wim Taymans's avatar
Wim Taymans committed
736
gst_rtp_base_depayload_prepare_push (GstRTPBaseDepayload * filter,
Wim Taymans's avatar
Wim Taymans committed
737
    gboolean is_list, gpointer obj)
738 739 740 741
{
  HeaderData data;

  data.depayload = filter;
Wim Taymans's avatar
Wim Taymans committed
742
  data.bclass = GST_RTP_BASE_DEPAYLOAD_GET_CLASS (filter);
743 744

  if (is_list) {
Wim Taymans's avatar
Wim Taymans committed
745 746
    GstBufferList **blist = obj;
    gst_buffer_list_foreach (*blist, (GstBufferListFunc) set_headers, &data);
747
  } else {
Wim Taymans's avatar
Wim Taymans committed
748
    GstBuffer **buf = obj;
Wim Taymans's avatar
Wim Taymans committed
749
    set_headers (buf, 0, &data);
750
  }
751

752
  /* if this is the first buffer send a NEWSEGMENT */
753 754 755
  if (G_UNLIKELY (filter->priv->segment_event)) {
    gst_pad_push_event (filter->srcpad, filter->priv->segment_event);
    filter->priv->segment_event = NULL;
756 757 758
    GST_DEBUG_OBJECT (filter, "Pushed newsegment event on this first buffer");
  }

759
  return GST_FLOW_OK;
760 761 762
}

/**
Wim Taymans's avatar
Wim Taymans committed
763 764
 * gst_rtp_base_depayload_push:
 * @filter: a #GstRTPBaseDepayload
765 766 767 768 769
 * @out_buf: a #GstBuffer
 *
 * Push @out_buf to the peer of @filter. This function takes ownership of
 * @out_buf.
 *
Wim Taymans's avatar
Wim Taymans committed
770 771
 * This function will by default apply the last incomming timestamp on
 * the outgoing buffer when it didn't have a timestamp already.
772
 *
773
 * Returns: a #GstFlowReturn.
774 775
 */
GstFlowReturn
Wim Taymans's avatar
Wim Taymans committed
776
gst_rtp_base_depayload_push (GstRTPBaseDepayload * filter, GstBuffer * out_buf)
777
{
778 779
  GstFlowReturn res;

Wim Taymans's avatar
Wim Taymans committed
780
  res = gst_rtp_base_depayload_prepare_push (filter, FALSE, &out_buf);
781 782 783 784 785 786 787 788 789 790

  if (G_LIKELY (res == GST_FLOW_OK))
    res = gst_pad_push (filter->srcpad, out_buf);
  else
    gst_buffer_unref (out_buf);

  return res;
}

/**
Wim Taymans's avatar
Wim Taymans committed
791 792
 * gst_rtp_base_depayload_push_list:
 * @filter: a #GstRTPBaseDepayload
793 794 795 796 797 798 799 800
 * @out_list: a #GstBufferList
 *
 * Push @out_list to the peer of @filter. This function takes ownership of
 * @out_list.
 *
 * Returns: a #GstFlowReturn.
 */
GstFlowReturn
Wim Taymans's avatar
Wim Taymans committed
801
gst_rtp_base_depayload_push_list (GstRTPBaseDepayload * filter,
802 803 804 805
    GstBufferList * out_list)
{
  GstFlowReturn res;

Wim Taymans's avatar
Wim Taymans committed
806
  res = gst_rtp_base_depayload_prepare_push (filter, TRUE, &out_list);
807 808 809 810 811 812 813

  if (G_LIKELY (res == GST_FLOW_OK))
    res = gst_pad_push_list (filter->srcpad, out_list);
  else
    gst_buffer_list_unref (out_list);

  return res;
814 815
}

816
/* convert the PacketLost event from a jitterbuffer to a GAP event.
817 818
 * subclasses can override this.  */
static gboolean
Wim Taymans's avatar
Wim Taymans committed
819
gst_rtp_base_depayload_packet_lost (GstRTPBaseDepayload * filter,
820 821
    GstEvent * event)
{
822
  GstClockTime timestamp, duration;
823 824 825 826 827 828 829 830 831 832 833 834
  GstEvent *sevent;
  const GstStructure *s;

  s = gst_event_get_structure (event);

  /* first start by parsing the timestamp and duration */
  timestamp = -1;
  duration = -1;

  gst_structure_get_clock_time (s, "timestamp", &timestamp);
  gst_structure_get_clock_time (s, "duration", &duration);

835 836
  /* send GAP event */
  sevent = gst_event_new_gap (timestamp, duration);
837 838 839 840

  return gst_pad_push_event (filter->srcpad, sevent);
}

841
static GstStateChangeReturn
Wim Taymans's avatar
Wim Taymans committed
842
gst_rtp_base_depayload_change_state (GstElement * element,
843
    GstStateChange transition)
844
{
Wim Taymans's avatar
Wim Taymans committed
845 846
  GstRTPBaseDepayload *filter;
  GstRTPBaseDepayloadPrivate *priv;
847
  GstStateChangeReturn ret;
848

Wim Taymans's avatar
Wim Taymans committed
849
  filter = GST_RTP_BASE_DEPAYLOAD (element);
850
  priv = filter->priv;
851 852

  switch (transition) {
853
    case GST_STATE_CHANGE_NULL_TO_READY:
854
      break;
855
    case GST_STATE_CHANGE_READY_TO_PAUSED:
856
      filter->need_newsegment = TRUE;
857 858 859 860
      priv->npt_start = 0;
      priv->npt_stop = -1;
      priv->play_speed = 1.0;
      priv->play_scale = 1.0;
861
      priv->clock_base = -1;
862 863
      priv->next_seqnum = -1;
      priv->negotiated = FALSE;
864
      priv->discont = FALSE;
865
      break;
866
    case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
867 868 869 870 871
      break;
    default:
      break;
  }

872 873
  ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);

874
  switch (transition) {
875
    case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
876
      break;
877
    case GST_STATE_CHANGE_PAUSED_TO_READY:
878
      gst_caps_replace (&priv->last_caps, NULL);
879
      gst_event_replace (&priv->segment_event, NULL);
880
      break;
881
    case GST_STATE_CHANGE_READY_TO_NULL:
882
      break;
883 884
    default:
      break;
885
  }
886
  return ret;
887 888
}

Wim Taymans's avatar
Wim Taymans committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907