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

   1 /**
   2  * @file rtp.c
   3  * @brief Real-Time Protocol (RTP) demux module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright (C) 2001-2005 the VideoLAN team
   7  * Copyright © 2007-2008 Rémi Denis-Courmont
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2.0
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  22  ****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include <config.h>
  26 #endif
  27 #include <stdarg.h>
  28 #include <assert.h>
  29
  30 #include <vlc_common.h>
  31 #include <vlc_demux.h>
  32 #include <vlc_aout.h>
  33 #include <vlc_network.h>
  34 #ifdef HAVE_POLL
  35 # include <poll.h>
  36 #endif
  37 #include <vlc_plugin.h>
  38
  39 #include <vlc_codecs.h>
  40
  41 #include "rtp.h"
  42 #include <srtp.h>
  43
  44 #define RTP_CACHING_TEXT N_("RTP de-jitter buffer length (msec)")
  45 #define RTP_CACHING_LONGTEXT N_( \
  46     "How long to wait for late RTP packets (and delay the performance)." )
  47
  48 #define SRTP_KEY_TEXT N_("SRTP key (hexadecimal)")
  49 #define SRTP_KEY_LONGTEXT N_( \
  50     "RTP packets will be authenticated and deciphered "\
  51     "with this Secure RTP master shared secret key.")
  52
  53 #define SRTP_SALT_TEXT N_("SRTP salt (hexadecimal)")
  54 #define SRTP_SALT_LONGTEXT N_( \
  55     "Secure RTP requires a (non-secret) master salt value.")
  56
  57 #define RTP_MAX_SRC_TEXT N_("Maximum RTP sources")
  58 #define RTP_MAX_SRC_LONGTEXT N_( \
  59     "How many distinct active RTP sources are allowed at a time." )
  60
  61 #define RTP_TIMEOUT_TEXT N_("RTP source timeout (sec)")
  62 #define RTP_TIMEOUT_LONGTEXT N_( \
  63     "How long to wait for any packet before a source is expired.")
  64
  65 #define RTP_MAX_DROPOUT_TEXT N_("Maximum RTP sequence number dropout")
  66 #define RTP_MAX_DROPOUT_LONGTEXT N_( \
  67     "RTP packets will be discarded if they are too much ahead (i.e. in the " \
  68     "future) by this many packets from the last received packet." )
  69
  70 #define RTP_MAX_MISORDER_TEXT N_("Maximum RTP sequence number misordering")
  71 #define RTP_MAX_MISORDER_LONGTEXT N_( \
  72     "RTP packets will be discarded if they are too far behind (i.e. in the " \
  73     "past) by this many packets from the last received packet." )
  74
  75 static int  Open (vlc_object_t *);
  76 static void Close (vlc_object_t *);
  77
  78 /*
  79  * Module descriptor
  80  */
  81 vlc_module_begin ();
  82     set_shortname (_("RTP"));
  83     set_description (_("(Experimental) Real-Time Protocol demuxer"));
  84     set_category (CAT_INPUT);
  85     set_subcategory (SUBCAT_INPUT_DEMUX);
  86     set_capability ("access_demux", 10);
  87     set_callbacks (Open, Close);
  88
  89     add_integer ("rtp-caching", 1000, NULL, RTP_CACHING_TEXT,
  90                  RTP_CACHING_LONGTEXT, true);
  91         change_integer_range (0, 65535);
  92     add_string ("srtp-key", "", NULL,
  93                 SRTP_KEY_TEXT, SRTP_KEY_LONGTEXT, false);
  94     add_string ("srtp-salt", "", NULL,
  95                 SRTP_SALT_TEXT, SRTP_SALT_LONGTEXT, false);
  96     add_integer ("rtp-max-src", 1, NULL, RTP_MAX_SRC_TEXT,
  97                  RTP_MAX_SRC_LONGTEXT, true);
  98         change_integer_range (1, 255);
  99     add_integer ("rtp-timeout", 5, NULL, RTP_TIMEOUT_TEXT,
 100                  RTP_TIMEOUT_LONGTEXT, true);
 101     add_integer ("rtp-max-dropout", 3000, NULL, RTP_MAX_DROPOUT_TEXT,
 102                  RTP_MAX_DROPOUT_LONGTEXT, true);
 103         change_integer_range (0, 32767);
 104     add_integer ("rtp-max-misorder", 100, NULL, RTP_MAX_MISORDER_TEXT,
 105                  RTP_MAX_MISORDER_LONGTEXT, true);
 106         change_integer_range (0, 32767);
 107
 108     add_shortcut ("dccp");
 109     /*add_shortcut ("sctp");*/
 110     add_shortcut ("rtptcp"); /* "tcp" is already taken :( */
 111     add_shortcut ("rtp");
 112     add_shortcut ("udplite");
 113 vlc_module_end ();
 114
 115 /*
 116  * TODO: so much stuff
 117  * - send RTCP-RR and RTCP-BYE
 118  * - dynamic payload types (need SDP parser)
 119  * - multiple medias (need SDP parser, and RTCP-SR parser for lip-sync)
 120  * - support for access_filter in case of stream_Demux (MPEG-TS)
 121  */
 122
 123 #ifndef IPPROTO_DCCP
 124 # define IPPROTO_DCCP 33 /* IANA */
 125 #endif
 126
 127 #ifndef IPPROTO_UDPLITE
 128 # define IPPROTO_UDPLITE 136 /* from IANA */
 129 #endif
 130
 131
 132 /*
 133  * Local prototypes
 134  */
 135 static int Demux (demux_t *);
 136 static int Control (demux_t *, int i_query, va_list args);
 137 static int extract_port (char **phost);
 138
 139 /**
 140  * Probes and initializes.
 141  */
 142 static int Open (vlc_object_t *obj)
 143 {
 144     demux_t *demux = (demux_t *)obj;
 145     int tp; /* transport protocol */
 146
 147     if (!strcmp (demux->psz_access, "dccp"))
 148         tp = IPPROTO_DCCP;
 149     else
 150     if (!strcmp (demux->psz_access, "rtptcp"))
 151         tp = IPPROTO_TCP;
 152     else
 153     if (!strcmp (demux->psz_access, "rtp"))
 154         tp = IPPROTO_UDP;
 155     else
 156     if (!strcmp (demux->psz_access, "udplite"))
 157         tp = IPPROTO_UDPLITE;
 158     else
 159         return VLC_EGENERIC;
 160
 161     char *tmp = strdup (demux->psz_path);
 162     char *shost = tmp;
 163     if (shost == NULL)
 164         return VLC_ENOMEM;
 165
 166     char *dhost = strchr (shost, '@');
 167     if (dhost)
 168         *dhost++ = '\0';
 169
 170     /* Parses the port numbers */
 171     int sport = 0, dport = 0;
 172     sport = extract_port (&shost);
 173     if (dhost != NULL)
 174         dport = extract_port (&dhost);
 175     if (dport == 0)
 176         dport = 5004; /* avt-profile-1 port */
 177
 178     /* Try to connect */
 179     int fd = -1, rtcp_fd = -1;
 180
 181     switch (tp)
 182     {
 183         case IPPROTO_UDP:
 184         case IPPROTO_UDPLITE:
 185             fd = net_OpenDgram (obj, dhost, (dport + 1) & ~1,
 186                                 shost, (sport + 1) & ~1, AF_UNSPEC, tp);
 187             if (fd == -1)
 188                 break;
 189             rtcp_fd = net_OpenDgram (obj, dhost, dport | 1, shost,
 190                                      sport ? (sport | 1) : 0, AF_UNSPEC, tp);
 191             break;
 192
 193          case IPPROTO_DCCP:
 194 #ifndef SOCK_DCCP /* provisional API (FIXME) */
 195 # ifdef __linux__
 196 #  define SOCK_DCCP 6
 197 # endif
 198 #endif
 199 #ifdef SOCK_DCCP
 200             var_Create (obj, "dccp-service", VLC_VAR_STRING);
 201             var_SetString (obj, "dccp-service", "RTPV"); /* FIXME: RTPA? */
 202             fd = net_Connect (obj, shost, (sport + 1) & ~1, SOCK_DCCP, tp);
 203 #else
 204             msg_Err (obj, "DCCP support not included");
 205 #endif
 206             break;
 207
 208         case IPPROTO_TCP:
 209             fd = net_Connect (obj, shost, (sport + 1) & ~1, SOCK_STREAM, tp);
 210             break;
 211     }
 212
 213     free (tmp);
 214     if (fd == -1)
 215         return VLC_EGENERIC;
 216     net_SetCSCov (fd, -1, 12);
 217
 218     /* Initializes demux */
 219     demux_sys_t *p_sys = malloc (sizeof (*p_sys));
 220     if (p_sys == NULL)
 221     {
 222         net_Close (fd);
 223         if (rtcp_fd != -1)
 224             net_Close (rtcp_fd);
 225         return VLC_EGENERIC;
 226     }
 227
 228     p_sys->srtp         = NULL;
 229     p_sys->fd           = fd;
 230     p_sys->caching      = var_CreateGetInteger (obj, "rtp-caching");
 231     p_sys->max_src      = var_CreateGetInteger (obj, "rtp-max-src");
 232     p_sys->timeout      = var_CreateGetInteger (obj, "rtp-timeout");
 233     p_sys->max_dropout  = var_CreateGetInteger (obj, "rtp-max-dropout");
 234     p_sys->max_misorder = var_CreateGetInteger (obj, "rtp-max-misorder");
 235     p_sys->autodetect   = true;
 236     p_sys->framed_rtp   = (tp == IPPROTO_TCP);
 237
 238     demux->pf_demux   = Demux;
 239     demux->pf_control = Control;
 240     demux->p_sys      = p_sys;
 241
 242     p_sys->session = rtp_session_create (demux);
 243     if (p_sys->session == NULL)
 244         goto error;
 245
 246     char *key = var_CreateGetNonEmptyString (demux, "srtp-key");
 247     if (key)
 248     {
 249         p_sys->srtp = srtp_create (SRTP_ENCR_AES_CM, SRTP_AUTH_HMAC_SHA1, 10,
 250                                    SRTP_PRF_AES_CM, SRTP_RCC_MODE1);
 251         if (p_sys->srtp == NULL)
 252         {
 253             free (key);
 254             goto error;
 255         }
 256
 257         char *salt = var_CreateGetNonEmptyString (demux, "srtp-salt");
 258         errno = srtp_setkeystring (p_sys->srtp, key, salt ? salt : "");
 259         free (salt);
 260         free (key);
 261         if (errno)
 262         {
 263             msg_Err (obj, "bad SRTP key/salt combination (%m)");
 264             goto error;
 265         }
 266     }
 267
 268     return VLC_SUCCESS;
 269
 270 error:
 271     Close (obj);
 272     return VLC_EGENERIC;
 273 }
 274
 275
 276 /**
 277  * Releases resources
 278  */
 279 static void Close (vlc_object_t *obj)
 280 {
 281     demux_t *demux = (demux_t *)obj;
 282     demux_sys_t *p_sys = demux->p_sys;
 283
 284     if (p_sys->srtp)
 285         srtp_destroy (p_sys->srtp);
 286     if (p_sys->session)
 287         rtp_session_destroy (demux, p_sys->session);
 288     if (p_sys->rtcp_fd != -1)
 289         net_Close (p_sys->rtcp_fd);
 290     net_Close (p_sys->fd);
 291     free (p_sys);
 292 }
 293
 294
 295 /**
 296  * Extracts port number from "[host]:port" or "host:port" strings,
 297  * and remove brackets from the host name.
 298  * @param phost pointer to the string upon entry,
 299  * pointer to the hostname upon return.
 300  * @return port number, 0 if missing.
 301  */
 302 static int extract_port (char **phost)
 303 {
 304     char *host = *phost, *port;
 305
 306     if (host[0] == '[')
 307     {
 308         host = *++phost; /* skip '[' */
 309         port = strchr (host, ']');
 310         if (port)
 311             *port++ = '\0'; /* skip ']' */
 312     }
 313     else
 314         port = strchr (host, ':');
 315
 316     if (port == NULL)
 317         return 0;
 318     *port++ = '\0'; /* skip ':' */
 319     return atoi (port);
 320 }
 321
 322
 323 /**
 324  * Control callback
 325  */
 326 static int Control (demux_t *demux, int i_query, va_list args)
 327 {
 328     demux_sys_t *p_sys = demux->p_sys;
 329
 330     switch (i_query)
 331     {
 332         case DEMUX_GET_POSITION:
 333         {
 334             float *v = va_arg (args, float *);
 335             *v = 0.;
 336             return 0;
 337         }
 338
 339         case DEMUX_GET_LENGTH:
 340         case DEMUX_GET_TIME:
 341         {
 342             int64_t *v = va_arg (args, int64_t *);
 343             *v = 0;
 344             return 0;
 345         }
 346
 347         case DEMUX_GET_PTS_DELAY:
 348         {
 349             int64_t *v = va_arg (args, int64_t *);
 350             *v = p_sys->caching;
 351             return 0;
 352         }
 353     }
 354
 355     return VLC_EGENERIC;
 356 }
 357
 358
 359 /**
 360  * Checks if a file descriptor is hung up.
 361  */
 362 static bool fd_dead (int fd)
 363 {
 364     struct pollfd ufd = { .fd = fd, };
 365
 366     return (poll (&ufd, 1, 0) == 1) && (ufd.revents & POLLHUP);
 367 }
 368
 369
 370 /**
 371  * Gets a datagram from the network, or NULL in case of fatal error.
 372  */
 373 static block_t *rtp_dgram_recv (demux_t *demux, int fd)
 374 {
 375     block_t *block = block_Alloc (0xffff);
 376     ssize_t len;
 377
 378     do
 379     {
 380         len = net_Read (VLC_OBJECT (demux), fd, NULL,
 381                                 block->p_buffer, block->i_buffer, false);
 382         if (((len <= 0) && fd_dead (fd))
 383          || !vlc_object_alive (demux))
 384         {
 385             block_Release (block);
 386             return NULL;
 387         }
 388     }
 389     while (len == -1);
 390
 391     return block_Realloc (block, 0, len);
 392 }
 393
 394 /**
 395  * Gets a framed RTP packet, or NULL in case of fatal error.
 396  */
 397 static block_t *rtp_stream_recv (demux_t *demux, int fd)
 398 {
 399     ssize_t len = 0;
 400     uint8_t hdr[2]; /* frame header */
 401
 402     /* Receives the RTP frame header */
 403     do
 404     {
 405         ssize_t val = net_Read (VLC_OBJECT (demux), fd, NULL,
 406                                 hdr + len, 2 - len, false);
 407         if (val <= 0)
 408             return NULL;
 409         len += val;
 410     }
 411     while (len < 2);
 412
 413     block_t *block = block_Alloc (GetWBE (hdr));
 414
 415     /* Receives the RTP packet */
 416     for (ssize_t i = 0; i < len;)
 417     {
 418         ssize_t val;
 419
 420         val = net_Read (VLC_OBJECT (demux), fd, NULL,
 421                         block->p_buffer + i, block->i_buffer - i, false);
 422         if (val <= 0)
 423         {
 424             block_Release (block);
 425             return NULL;
 426         }
 427         i += val;
 428     }
 429
 430     return block;
 431 }
 432
 433
 434 /*
 435  * Generic packet handlers
 436  */
 437
 438 static void *codec_init (demux_t *demux, es_format_t *fmt)
 439 {
 440     return es_out_Add (demux->out, fmt);
 441 }
 442
 443 static void codec_destroy (demux_t *demux, void *data)
 444 {
 445     if (data)
 446         es_out_Del (demux->out, (es_out_id_t *)data);
 447 }
 448
 449 /* Send a packet to decoder */
 450 static void codec_decode (demux_t *demux, void *data, block_t *block)
 451 {
 452     if (data)
 453     {
 454         block->i_dts = 0; /* RTP does not specify this */
 455         es_out_Control (demux->out, ES_OUT_SET_PCR,
 456                         block->i_pts - demux->p_sys->caching * 1000);
 457         es_out_Send (demux->out, (es_out_id_t *)data, block);
 458     }
 459     else
 460         block_Release (block);
 461 }
 462
 463
 464 static void *stream_init (demux_t *demux, const char *name)
 465 {
 466     return stream_DemuxNew (demux, name, demux->out);
 467 }
 468
 469 static void stream_destroy (demux_t *demux, void *data)
 470 {
 471     if (data)
 472         stream_DemuxDelete ((stream_t *)data);
 473     (void)demux;
 474 }
 475
 476 /* Send a packet to a chained demuxer */
 477 static void stream_decode (demux_t *demux, void *data, block_t *block)
 478 {
 479     if (data)
 480         stream_DemuxSend ((stream_t *)data, block);
 481     else
 482         block_Release (block);
 483     (void)demux;
 484 }
 485
 486 /*
 487  * Static payload types handler
 488  */
 489
 490 /* PT=0
 491  * PCMU: G.711 µ-law (RFC3551)
 492  */
 493 static void *pcmu_init (demux_t *demux)
 494 {
 495     es_format_t fmt;
 496
 497     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('u', 'l', 'a', 'w'));
 498     fmt.audio.i_rate = 8000;
 499     fmt.audio.i_channels = 1;
 500     return codec_init (demux, &fmt);
 501 }
 502
 503 /* PT=8
 504  * PCMA: G.711 A-law (RFC3551)
 505  */
 506 static void *pcma_init (demux_t *demux)
 507 {
 508     es_format_t fmt;
 509
 510     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('a', 'l', 'a', 'w'));
 511     fmt.audio.i_rate = 8000;
 512     fmt.audio.i_channels = 1;
 513     return codec_init (demux, &fmt);
 514 }
 515
 516 /* PT=10,11
 517  * L16: 16-bits (network byte order) PCM
 518  */
 519 static void *l16s_init (demux_t *demux)
 520 {
 521     es_format_t fmt;
 522
 523     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
 524     fmt.audio.i_rate = 44100;
 525     fmt.audio.i_channels = 2;
 526     return codec_init (demux, &fmt);
 527 }
 528
 529 static void *l16m_init (demux_t *demux)
 530 {
 531     es_format_t fmt;
 532
 533     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
 534     fmt.audio.i_rate = 44100;
 535     fmt.audio.i_channels = 1;
 536     return codec_init (demux, &fmt);
 537 }
 538
 539 /* PT=14
 540  * MPA: MPEG Audio (RFC2250, §3.4)
 541  */
 542 static void *mpa_init (demux_t *demux)
 543 {
 544     es_format_t fmt;
 545
 546     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('m', 'p', 'g', 'a'));
 547     fmt.audio.i_channels = 2;
 548     return codec_init (demux, &fmt);
 549 }
 550
 551 static void mpa_decode (demux_t *demux, void *data, block_t *block)
 552 {
 553     if (block->i_buffer < 4)
 554     {
 555         block_Release (block);
 556         return;
 557     }
 558
 559     block->i_buffer -= 4; /* 32-bits RTP/MPA header */
 560     block->p_buffer += 4;
 561
 562     codec_decode (demux, data, block);
 563 }
 564
 565
 566 /* PT=32
 567  * MPV: MPEG Video (RFC2250, §3.5)
 568  */
 569 static void *mpv_init (demux_t *demux)
 570 {
 571     es_format_t fmt;
 572
 573     es_format_Init (&fmt, VIDEO_ES, VLC_FOURCC ('m', 'p', 'g', 'v'));
 574     return codec_init (demux, &fmt);
 575 }
 576
 577 static void mpv_decode (demux_t *demux, void *data, block_t *block)
 578 {
 579     if (block->i_buffer < 4)
 580     {
 581         block_Release (block);
 582         return;
 583     }
 584
 585     block->i_buffer -= 4; /* 32-bits RTP/MPV header */
 586     block->p_buffer += 4;
 587 #if 0
 588     if (block->p_buffer[-3] & 0x4)
 589     {
 590         /* MPEG2 Video extension header */
 591         /* TODO: shouldn't we skip this too ? */
 592     }
 593 #endif
 594     codec_decode (demux, data, block);
 595 }
 596
 597
 598 /* PT=33
 599  * MP2: MPEG TS (RFC2250, §2)
 600  */
 601 static void *ts_init (demux_t *demux)
 602 {
 603     return stream_init (demux, "ts");
 604 }
 605
 606
 607 /*
 608  * Dynamic payload type handlers
 609  * Hmm, none implemented yet.
 610  */
 611
 612 /**
 613  * Processing callback
 614  */
 615 static int Demux (demux_t *demux)
 616 {
 617     demux_sys_t *p_sys = demux->p_sys;
 618     block_t     *block;
 619
 620     block = p_sys->framed_rtp
 621         ? rtp_stream_recv (demux, p_sys->fd)
 622         : rtp_dgram_recv (demux, p_sys->fd);
 623     if (!block)
 624         return 0;
 625
 626     if (block->i_buffer < 2)
 627         goto drop;
 628
 629     const uint8_t ptype = block->p_buffer[1] & 0x7F;
 630     if (ptype >= 72 && ptype <= 76)
 631         goto drop; /* Muxed RTCP, ignore for now */
 632
 633     if (p_sys->srtp)
 634     {
 635         size_t len = block->i_buffer;
 636         if (srtp_recv (p_sys->srtp, block->p_buffer, &len))
 637         {
 638             msg_Dbg (demux, "SRTP authentication/decryption failed");
 639             goto drop;
 640         }
 641         block->i_buffer = len;
 642     }
 643
 644     /* Not using SDP, we need to guess the payload format used */
 645     /* see http://www.iana.org/assignments/rtp-parameters */
 646     if (p_sys->autodetect)
 647     {
 648         rtp_pt_t pt = {
 649             .init = NULL,
 650             .destroy = codec_destroy,
 651             .decode = codec_decode,
 652             .frequency = 0,
 653             .number = ptype,
 654         };
 655         switch (ptype)
 656         {
 657           case 0:
 658             msg_Dbg (demux, "detected G.711 mu-law");
 659             pt.init = pcmu_init;
 660             pt.frequency = 8000;
 661             break;
 662
 663           case 8:
 664             msg_Dbg (demux, "detected G.711 A-law");
 665             pt.init = pcma_init;
 666             pt.frequency = 8000;
 667             break;
 668
 669           case 10:
 670             msg_Dbg (demux, "detected stereo PCM");
 671             pt.init = l16s_init;
 672             pt.frequency = 44100;
 673             break;
 674
 675           case 11:
 676             msg_Dbg (demux, "detected mono PCM");
 677             pt.init = l16m_init;
 678             pt.frequency = 44100;
 679             break;
 680
 681           case 14:
 682             msg_Dbg (demux, "detected MPEG Audio");
 683             pt.init = mpa_init;
 684             pt.decode = mpa_decode;
 685             pt.frequency = 90000;
 686             break;
 687
 688           case 32:
 689             msg_Dbg (demux, "detected MPEG Video");
 690             pt.init = mpv_init;
 691             pt.decode = mpv_decode;
 692             pt.frequency = 90000;
 693             break;
 694
 695           case 33:
 696             msg_Dbg (demux, "detected MPEG2 TS");
 697             pt.init = ts_init;
 698             pt.destroy = stream_destroy;
 699             pt.decode = stream_decode;
 700             pt.frequency = 90000;
 701             break;
 702
 703           default:
 704             goto drop;
 705         }
 706         rtp_add_type (demux, p_sys->session, &pt);
 707         p_sys->autodetect = false;
 708     }
 709     rtp_receive (demux, p_sys->session, block);
 710
 711     return 1;
 712 drop:
 713     block_Release (block);
 714     return 1;
 715 }