git.sesse.net Git - vlc/blob - modules/access/rtp/session.c

   1 /**
   2  * @file session.c
   3  * @brief RTP session handling
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2008 Rémi Denis-Courmont
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2.0
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21  ****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 #include <stdlib.h>
  28 #include <assert.h>
  29 #include <errno.h>
  30
  31 #include <vlc/vlc.h>
  32 #include <vlc_demux.h>
  33
  34 #include "rtp.h"
  35
  36 typedef struct rtp_source_t rtp_source_t;
  37
  38 /** State for a RTP session: */
  39 struct rtp_session_t
  40 {
  41     rtp_source_t **srcv;
  42     unsigned       srcc;
  43     uint8_t        ptc;
  44     rtp_pt_t      *ptv;
  45 };
  46
  47 static rtp_source_t *
  48 rtp_source_create (demux_t *, const rtp_session_t *, uint32_t, uint16_t);
  49 static void
  50 rtp_source_destroy (demux_t *, const rtp_session_t *, rtp_source_t *);
  51
  52 static void rtp_decode (demux_t *, const rtp_session_t *, rtp_source_t *);
  53
  54 /**
  55  * Creates a new RTP session.
  56  */
  57 rtp_session_t *
  58 rtp_session_create (demux_t *demux)
  59 {
  60     rtp_session_t *session = malloc (sizeof (*session));
  61     if (session == NULL)
  62         return NULL;
  63
  64     session->srcv = NULL;
  65     session->srcc = 0;
  66     session->ptc = 0;
  67     session->ptv = NULL;
  68
  69     (void)demux;
  70     return session;
  71 }
  72
  73
  74 /**
  75  * Destroys an RTP session.
  76  */
  77 void rtp_session_destroy (demux_t *demux, rtp_session_t *session)
  78 {
  79     for (unsigned i = 0; i < session->srcc; i++)
  80         rtp_source_destroy (demux, session, session->srcv[i]);
  81
  82     free (session->srcv);
  83     free (session->ptv);
  84     free (session);
  85     (void)demux;
  86 }
  87
  88 static void *no_init (demux_t *demux)
  89 {
  90     (void)demux;
  91     return NULL;
  92 }
  93
  94 static void no_destroy (demux_t *demux, void *opaque)
  95 {
  96     (void)demux; (void)opaque;
  97 }
  98
  99 static void no_decode (demux_t *demux, void *opaque, block_t *block)
 100 {
 101     (void)demux; (void)opaque;
 102     block_Release (block);
 103 }
 104
 105 /**
 106  * Adds a payload type to an RTP session.
 107  */
 108 int rtp_add_type (demux_t *demux, rtp_session_t *ses, const rtp_pt_t *pt)
 109 {
 110     if (ses->srcc > 0)
 111     {
 112         msg_Err (demux, "cannot change RTP payload formats during session");
 113         return EINVAL;
 114     }
 115
 116     rtp_pt_t *ppt = realloc (ses->ptv, (ses->ptc + 1) * sizeof (rtp_pt_t));
 117     if (ppt == NULL)
 118         return ENOMEM;
 119
 120     ses->ptv = ppt;
 121     ppt += ses->ptc++;
 122
 123     ppt->init = pt->init ? pt->init : no_init;
 124     ppt->destroy = pt->destroy ? pt->destroy : no_destroy;
 125     ppt->decode = pt->decode ? pt->decode : no_decode;
 126     ppt->frequency = pt->frequency;
 127     ppt->number = pt->number;
 128     msg_Dbg (demux, "added payload type %"PRIu8" (f = %"PRIu32" Hz)",
 129              ppt->number, ppt->frequency);
 130
 131     assert (ppt->frequency > 0); /* SIGFPE! */
 132     (void)demux;
 133     return 0;
 134 }
 135
 136 /** State for an RTP source */
 137 struct rtp_source_t
 138 {
 139     uint32_t ssrc;
 140     uint32_t jitter;  /* interarrival delay jitter estimate */
 141     mtime_t  last_rx; /* last received packet local timestamp */
 142     uint32_t last_ts; /* last received packet RTP timestamp */
 143
 144     uint16_t bad_seq; /* tentatively next expected sequence for resync */
 145     uint16_t max_seq; /* next expected sequence */
 146
 147     uint16_t last_seq; /* sequence of the next dequeued packet */
 148     block_t *blocks; /* re-ordered blocks queue */
 149     void    *opaque[0]; /* Per-source private payload data */
 150 };
 151
 152 /**
 153  * Initializes a new RTP source within an RTP session.
 154  */
 155 static rtp_source_t *
 156 rtp_source_create (demux_t *demux, const rtp_session_t *session,
 157                    uint32_t ssrc, uint16_t init_seq)
 158 {
 159     rtp_source_t *source;
 160
 161     source = malloc (sizeof (*source) + (sizeof (void *) * session->ptc));
 162     if (source == NULL)
 163         return NULL;
 164
 165     source->ssrc = ssrc;
 166     source->jitter = 0;
 167     source->max_seq = source->bad_seq = init_seq;
 168     source->last_seq = init_seq - 1;
 169     source->blocks = NULL;
 170
 171     /* Initializes all payload */
 172     for (unsigned i = 0; i < session->ptc; i++)
 173         source->opaque[i] = session->ptv[i].init (demux);
 174
 175     msg_Dbg (demux, "added RTP source (%08x)", ssrc);
 176     return source;
 177 }
 178
 179
 180 /**
 181  * Destroys an RTP source and its associated streams.
 182  */
 183 static void
 184 rtp_source_destroy (demux_t *demux, const rtp_session_t *session,
 185                     rtp_source_t *source)
 186 {
 187     msg_Dbg (demux, "removing RTP source (%08x)", source->ssrc);
 188
 189     for (unsigned i = 0; i < session->ptc; i++)
 190         session->ptv[i].destroy (demux, source->opaque[i]);
 191     block_ChainRelease (source->blocks);
 192     free (source);
 193 }
 194
 195 static inline uint16_t rtp_seq (const block_t *block)
 196 {
 197     assert (block->i_buffer >= 4);
 198     return GetWBE (block->p_buffer + 2);
 199 }
 200
 201 static inline uint32_t rtp_timestamp (const block_t *block)
 202 {
 203     assert (block->i_buffer >= 12);
 204     return GetDWBE (block->p_buffer + 4);
 205 }
 206
 207 static const struct rtp_pt_t *
 208 rtp_find_ptype (const rtp_session_t *session, rtp_source_t *source,
 209                 const block_t *block, void **pt_data)
 210 {
 211     uint8_t ptype = rtp_ptype (block);
 212
 213     for (unsigned i = 0; i < session->ptc; i++)
 214     {
 215         if (session->ptv[i].number == ptype)
 216         {
 217             if (pt_data != NULL)
 218                 *pt_data = source->opaque[i];
 219             return &session->ptv[i];
 220         }
 221     }
 222     return NULL;
 223 }
 224
 225 /**
 226  * Receives an RTP packet and queues it. Not a cancellation point.
 227  *
 228  * @param demux VLC demux object
 229  * @param session RTP session receiving the packet
 230  * @param block RTP packet including the RTP header
 231  */
 232 void
 233 rtp_queue (demux_t *demux, rtp_session_t *session, block_t *block)
 234 {
 235     demux_sys_t *p_sys = demux->p_sys;
 236
 237     /* RTP header sanity checks (see RFC 3550) */
 238     if (block->i_buffer < 12)
 239         goto drop;
 240     if ((block->p_buffer[0] >> 6 ) != 2) /* RTP version number */
 241         goto drop;
 242
 243     /* Remove padding if present */
 244     if (block->p_buffer[0] & 0x20)
 245     {
 246         uint8_t padding = block->p_buffer[block->i_buffer - 1];
 247         if ((padding == 0) || (block->i_buffer < (12u + padding)))
 248             goto drop; /* illegal value */
 249
 250         block->i_buffer -= padding;
 251     }
 252
 253     mtime_t        now = mdate ();
 254     rtp_source_t  *src  = NULL;
 255     const uint16_t seq  = rtp_seq (block);
 256     const uint32_t ssrc = GetDWBE (block->p_buffer + 8);
 257
 258     /* In most case, we know this source already */
 259     for (unsigned i = 0, max = session->srcc; i < max; i++)
 260     {
 261         rtp_source_t *tmp = session->srcv[i];
 262         if (tmp->ssrc == ssrc)
 263         {
 264             src = tmp;
 265             break;
 266         }
 267
 268         /* RTP source garbage collection */
 269         if ((tmp->last_rx + (p_sys->timeout * CLOCK_FREQ)) < now)
 270         {
 271             rtp_source_destroy (demux, session, tmp);
 272             if (--session->srcc > 0)
 273                 session->srcv[i] = session->srcv[session->srcc - 1];
 274         }
 275     }
 276
 277     if (src == NULL)
 278     {
 279         /* New source */
 280         if (session->srcc >= p_sys->max_src)
 281         {
 282             msg_Warn (demux, "too many RTP sessions");
 283             goto drop;
 284         }
 285
 286         rtp_source_t **tab;
 287         tab = realloc (session->srcv, (session->srcc + 1) * sizeof (*tab));
 288         if (tab == NULL)
 289             goto drop;
 290         session->srcv = tab;
 291
 292         src = rtp_source_create (demux, session, ssrc, seq);
 293         if (src == NULL)
 294             goto drop;
 295
 296         tab[session->srcc++] = src;
 297         /* Cannot compute jitter yet */
 298     }
 299     else
 300     {
 301         const rtp_pt_t *pt = rtp_find_ptype (session, src, block, NULL);
 302
 303         if (pt != NULL)
 304         {
 305             /* Recompute jitter estimate.
 306              * That is computed from the RTP timestamps and the system clock.
 307              * It is independent of RTP sequence. */
 308             uint32_t freq = pt->frequency;
 309             int64_t ts = rtp_timestamp (block);
 310             int64_t d = ((now - src->last_rx) * freq) / CLOCK_FREQ;
 311             d        -=    ts - src->last_ts;
 312             if (d < 0) d = -d;
 313             src->jitter += ((d - src->jitter) + 8) >> 4;
 314         }
 315     }
 316     src->last_rx = now;
 317     src->last_ts = rtp_timestamp (block);
 318
 319     /* Check sequence number */
 320     /* NOTE: the sequence number is per-source,
 321      * but is independent from the payload type. */
 322     int delta_seq = seq - src->max_seq;
 323     if ((delta_seq > 0) ? (delta_seq > p_sys->max_dropout)
 324                         : (-delta_seq > p_sys->max_misorder))
 325     {
 326         msg_Dbg (demux, "sequence discontinuity"
 327                  " (got: %"PRIu16", expected: %"PRIu16")", seq, src->max_seq);
 328         if (seq == src->bad_seq)
 329         {
 330             src->max_seq = src->bad_seq = seq + 1;
 331             src->last_seq = seq - 0x7fffe; /* hack for rtp_decode() */
 332             msg_Warn (demux, "sequence resynchronized");
 333             block_ChainRelease (src->blocks);
 334             src->blocks = NULL;
 335         }
 336         else
 337         {
 338             src->bad_seq = seq + 1;
 339             goto drop;
 340         }
 341     }
 342     else
 343     if (delta_seq >= 0)
 344         src->max_seq = seq + 1;
 345
 346     /* Queues the block in sequence order,
 347      * hence there is a single queue for all payload types. */
 348     block_t **pp = &src->blocks;
 349     for (block_t *prev = *pp; prev != NULL; prev = *pp)
 350     {
 351         int delta_seq = seq - rtp_seq (prev);
 352         if (delta_seq < 0)
 353             break;
 354         if (delta_seq == 0)
 355         {
 356             msg_Dbg (demux, "duplicate packet (sequence: %"PRIu16")", seq);
 357             goto drop; /* duplicate */
 358         }
 359         pp = &prev->p_next;
 360     }
 361     block->p_next = *pp;
 362     *pp = block;
 363
 364     /*rtp_decode (demux, session, src);*/
 365     return;
 366
 367 drop:
 368     block_Release (block);
 369 }
 370
 371
 372 static void
 373 rtp_decode (demux_t *demux, const rtp_session_t *session, rtp_source_t *src)
 374 {
 375     block_t *block = src->blocks;
 376
 377     assert (block);
 378     src->blocks = block->p_next;
 379     block->p_next = NULL;
 380
 381     /* Discontinuity detection */
 382     uint16_t delta_seq = rtp_seq (block) - (src->last_seq + 1);
 383     if (delta_seq != 0)
 384     {
 385         if (delta_seq >= 0x8000)
 386         {   /* Unrecoverable if later packets have already been dequeued */
 387             msg_Warn (demux, "ignoring late packet (sequence: %"PRIu16")",
 388                       rtp_seq (block));
 389             goto drop;
 390         }
 391         block->i_flags |= BLOCK_FLAG_DISCONTINUITY;
 392     }
 393     src->last_seq = rtp_seq (block);
 394
 395     /* Match the payload type */
 396     void *pt_data;
 397     const rtp_pt_t *pt = rtp_find_ptype (session, src, block, &pt_data);
 398     if (pt == NULL)
 399     {
 400         msg_Dbg (demux, "unknown payload (%"PRIu8")",
 401                  rtp_ptype (block));
 402         goto drop;
 403     }
 404
 405     /* Computes the PTS from the RTP timestamp and payload RTP frequency.
 406      * DTS is unknown. Also, while the clock frequency depends on the payload
 407      * format, a single source MUST only use payloads of a chosen frequency.
 408      * Otherwise it would be impossible to compute consistent timestamps. */
 409     /* FIXME: handle timestamp wrap properly */
 410     /* TODO: inter-medias/sessions sync (using RTCP-SR) */
 411     const uint32_t timestamp = rtp_timestamp (block);
 412     block->i_pts = UINT64_C(1) * CLOCK_FREQ * timestamp / pt->frequency;
 413
 414     /* CSRC count */
 415     size_t skip = 12u + (block->p_buffer[0] & 0x0F) * 4;
 416
 417     /* Extension header (ignored for now) */
 418     if (block->p_buffer[0] & 0x10)
 419     {
 420         skip += 4;
 421         if (block->i_buffer < skip)
 422             goto drop;
 423
 424         skip += 4 * GetWBE (block->p_buffer + skip - 2);
 425     }
 426
 427     if (block->i_buffer < skip)
 428         goto drop;
 429
 430     block->p_buffer += skip;
 431     block->i_buffer -= skip;
 432
 433     pt->decode (demux, pt_data, block);
 434     return;
 435
 436 drop:
 437     block_Release (block);
 438 }
 439
 440
 441 /**
 442  * Dequeues an RTP packet and pass it to decoder. Not cancellation-safe(?).
 443  *
 444  * @param demux VLC demux object
 445  * @param session RTP session receiving the packet
 446  * @param deadlinep pointer to deadline to call rtp_dequeue() again
 447  * @return true if the buffer is not empty, false otherwise.
 448  * In the later case, *deadlinep is undefined.
 449  */
 450 bool rtp_dequeue (demux_t *demux, const rtp_session_t *session,
 451                   mtime_t *restrict deadlinep)
 452 {
 453     mtime_t now = mdate ();
 454     bool pending = false;
 455
 456     for (unsigned i = 0, max = session->srcc; i < max; i++)
 457     {
 458         rtp_source_t *src = session->srcv[i];
 459         block_t *block;
 460
 461         /* Because of IP packet delay variation (IPDV), we need to guesstimate
 462          * how long to wait for a missing packet in the RTP sequence
 463          * (see RFC3393 for background on IPDV).
 464          *
 465          * This situation occurs if a packet got lost, or if the network has
 466          * re-ordered packets. Unfortunately, the MSL is 2 minutes, orders of
 467          * magnitude too long for multimedia. We need a tradeoff.
 468          * If we underestimated IPDV, we may have to discard valid but late
 469          * packets. If we overestimate it, we will either cause too much
 470          * delay, or worse, underflow our downstream buffers, as we wait for
 471          * definitely a lost packets.
 472          *
 473          * The rest of the "de-jitter buffer" work is done by the interval
 474          * LibVLC E/S-out clock synchronization. Here, we need to bother about
 475          * re-ordering packets, as decoders can't cope with mis-ordered data.
 476          */
 477         while (((block = src->blocks)) != NULL)
 478         {
 479             if ((int16_t)(rtp_seq (block) - (src->last_seq + 1)) <= 0)
 480             {   /* Next (or earlier) block ready, no need to wait */
 481                 rtp_decode (demux, session, src);
 482                 continue;
 483             }
 484
 485             /* Wait for 3 times the inter-arrival delay variance (about 99.7%
 486              * match for random gaussian jitter). Additionnaly, we implicitly
 487              * wait for misordering times the packetization time.
 488              */
 489             mtime_t deadline = src->last_rx;
 490             const rtp_pt_t *pt = rtp_find_ptype (session, src, block, NULL);
 491             if (pt)
 492                 deadline += UINT64_C(3) * CLOCK_FREQ * src->jitter
 493                             / pt->frequency;
 494
 495             if (now >= deadline)
 496             {
 497                 rtp_decode (demux, session, src);
 498                 continue;
 499             }
 500             if (*deadlinep > deadline)
 501                 *deadlinep = deadline;
 502             pending = true; /* packet pending in buffer */
 503             break;
 504         }
 505     }
 506     return pending;
 507 }