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;
 180
 181     switch (tp)
 182     {
 183         case IPPROTO_UDP:
 184         case IPPROTO_UDPLITE:
 185             fd = net_OpenDgram (obj, dhost, dport, shost, sport, AF_UNSPEC,
 186                                 tp);
 187             break;
 188
 189          case IPPROTO_DCCP:
 190 #ifndef SOCK_DCCP /* provisional API (FIXME) */
 191 # ifdef __linux__
 192 #  define SOCK_DCCP 6
 193 # endif
 194 #endif
 195 #ifdef SOCK_DCCP
 196             var_Create (obj, "dccp-service", VLC_VAR_STRING);
 197             var_SetString (obj, "dccp-service", "RTPV");
 198             fd = net_Connect (obj, shost, sport, SOCK_DCCP, tp);
 199 #else
 200             msg_Err (obj, "DCCP support not included");
 201 #endif
 202             break;
 203
 204         case IPPROTO_TCP:
 205             fd = net_Connect (obj, shost, sport, SOCK_STREAM, tp);
 206             break;
 207     }
 208
 209     free (tmp);
 210     if (fd == -1)
 211         return VLC_EGENERIC;
 212     net_SetCSCov (fd, -1, 12);
 213
 214     /* Initializes demux */
 215     demux_sys_t *p_sys = malloc (sizeof (*p_sys));
 216     if (p_sys == NULL)
 217     {
 218         net_Close (fd);
 219         return VLC_EGENERIC;
 220     }
 221
 222     p_sys->srtp         = NULL;
 223     p_sys->fd           = fd;
 224     p_sys->caching      = var_CreateGetInteger (obj, "rtp-caching");
 225     p_sys->max_src      = var_CreateGetInteger (obj, "rtp-max-src");
 226     p_sys->timeout      = var_CreateGetInteger (obj, "rtp-timeout");
 227     p_sys->max_dropout  = var_CreateGetInteger (obj, "rtp-max-dropout");
 228     p_sys->max_misorder = var_CreateGetInteger (obj, "rtp-max-misorder");
 229     p_sys->autodetect   = true;
 230     p_sys->framed_rtp   = (tp == IPPROTO_TCP);
 231
 232     demux->pf_demux   = Demux;
 233     demux->pf_control = Control;
 234     demux->p_sys      = p_sys;
 235
 236     p_sys->session = rtp_session_create (demux);
 237     if (p_sys->session == NULL)
 238         goto error;
 239
 240     char *key = var_GetNonEmptyString (demux, "srtp-key");
 241     if (key)
 242     {
 243         p_sys->srtp = srtp_create (SRTP_ENCR_AES_CM, SRTP_AUTH_HMAC_SHA1, 10,
 244                                    SRTP_PRF_AES_CM, SRTP_RCC_MODE1);
 245         if (p_sys->srtp == NULL)
 246         {
 247             free (key);
 248             goto error;
 249         }
 250
 251         char *salt = var_GetNonEmptyString (demux, "srtp-salt");
 252         errno = srtp_setkeystring (p_sys->srtp, key, salt ? salt : "");
 253         free (salt);
 254         free (key);
 255         if (errno)
 256         {
 257             msg_Err (obj, "bad SRTP key/salt combination (%m)");
 258             goto error;
 259         }
 260     }
 261
 262     return VLC_SUCCESS;
 263
 264 error:
 265     Close (obj);
 266     return VLC_EGENERIC;
 267 }
 268
 269
 270 /**
 271  * Releases resources
 272  */
 273 static void Close (vlc_object_t *obj)
 274 {
 275     demux_t *demux = (demux_t *)obj;
 276     demux_sys_t *p_sys = demux->p_sys;
 277
 278     if (p_sys->srtp)
 279         srtp_destroy (p_sys->srtp);
 280     if (p_sys->session)
 281         rtp_session_destroy (demux, p_sys->session);
 282     net_Close (p_sys->fd);
 283     free (p_sys);
 284 }
 285
 286
 287 /**
 288  * Extracts port number from "[host]:port" or "host:port" strings,
 289  * and remove brackets from the host name.
 290  * @param phost pointer to the string upon entry,
 291  * pointer to the hostname upon return.
 292  * @return port number, 0 if missing.
 293  */
 294 static int extract_port (char **phost)
 295 {
 296     char *host = *phost, *port;
 297
 298     if (host[0] == '[')
 299     {
 300         host = *++phost; /* skip '[' */
 301         port = strchr (host, ']');
 302         if (port)
 303             *port++ = '\0'; /* skip ']' */
 304     }
 305     else
 306         port = strchr (host, ':');
 307
 308     if (port == NULL)
 309         return 0;
 310     *port++ = '\0'; /* skip ':' */
 311     return atoi (port);
 312 }
 313
 314
 315 /**
 316  * Control callback
 317  */
 318 static int Control (demux_t *demux, int i_query, va_list args)
 319 {
 320     demux_sys_t *p_sys = demux->p_sys;
 321
 322     switch (i_query)
 323     {
 324         case DEMUX_GET_POSITION:
 325         {
 326             float *v = va_arg (args, float *);
 327             *v = 0.;
 328             return 0;
 329         }
 330
 331         case DEMUX_GET_LENGTH:
 332         case DEMUX_GET_TIME:
 333         {
 334             int64_t *v = va_arg (args, int64_t *);
 335             *v = 0;
 336             return 0;
 337         }
 338
 339         case DEMUX_GET_PTS_DELAY:
 340         {
 341             int64_t *v = va_arg (args, int64_t *);
 342             *v = p_sys->caching;
 343             return 0;
 344         }
 345     }
 346
 347     return VLC_EGENERIC;
 348 }
 349
 350
 351 /**
 352  * Checks if a file descriptor is hung up.
 353  */
 354 static bool fd_dead (int fd)
 355 {
 356     struct pollfd ufd = { .fd = fd, };
 357
 358     return (poll (&ufd, 1, 0) == 1) && (ufd.revents & POLLHUP);
 359 }
 360
 361
 362 /**
 363  * Gets a datagram from the network, or NULL in case of fatal error.
 364  */
 365 static block_t *rtp_dgram_recv (demux_t *demux, int fd)
 366 {
 367     block_t *block = block_Alloc (0xffff);
 368     ssize_t len;
 369
 370     do
 371     {
 372         len = net_Read (VLC_OBJECT (demux), fd, NULL,
 373                                 block->p_buffer, block->i_buffer, false);
 374         if (((len <= 0) && fd_dead (fd))
 375          || demux->b_die)
 376         {
 377             block_Release (block);
 378             return NULL;
 379         }
 380     }
 381     while (len == -1);
 382
 383     return block_Realloc (block, 0, len);
 384 }
 385
 386 /**
 387  * Gets a framed RTP packet, or NULL in case of fatal error.
 388  */
 389 static block_t *rtp_stream_recv (demux_t *demux, int fd)
 390 {
 391     ssize_t len = 0;
 392     uint8_t hdr[2]; /* frame header */
 393
 394     /* Receives the RTP frame header */
 395     do
 396     {
 397         ssize_t val = net_Read (VLC_OBJECT (demux), fd, NULL,
 398                                 hdr + len, 2 - len, false);
 399         if (val <= 0)
 400             return NULL;
 401         len += val;
 402     }
 403     while (len < 2);
 404
 405     block_t *block = block_Alloc (GetWBE (hdr));
 406
 407     /* Receives the RTP packet */
 408     for (ssize_t i = 0; i < len;)
 409     {
 410         ssize_t val;
 411
 412         val = net_Read (VLC_OBJECT (demux), fd, NULL,
 413                         block->p_buffer + i, block->i_buffer - i, false);
 414         if (val <= 0)
 415         {
 416             block_Release (block);
 417             return NULL;
 418         }
 419         i += val;
 420     }
 421
 422     return block;
 423 }
 424
 425
 426 /*
 427  * Generic packet handlers
 428  */
 429
 430 static void *codec_init (demux_t *demux, es_format_t *fmt)
 431 {
 432     return es_out_Add (demux->out, fmt);
 433 }
 434
 435 static void codec_destroy (demux_t *demux, void *data)
 436 {
 437     if (data)
 438         es_out_Del (demux->out, (es_out_id_t *)data);
 439 }
 440
 441 /* Send a packet to decoder */
 442 static void codec_decode (demux_t *demux, void *data, block_t *block)
 443 {
 444     if (data)
 445     {
 446         block->i_dts = 0; /* RTP does not specify this */
 447         es_out_Control (demux->out, ES_OUT_SET_PCR,
 448                         block->i_pts - demux->p_sys->caching * 1000);
 449         es_out_Send (demux->out, (es_out_id_t *)data, block);
 450     }
 451     else
 452         block_Release (block);
 453 }
 454
 455
 456 static void *stream_init (demux_t *demux, const char *name)
 457 {
 458     return stream_DemuxNew (demux, name, demux->out);
 459 }
 460
 461 static void stream_destroy (demux_t *demux, void *data)
 462 {
 463     if (data)
 464         stream_DemuxDelete ((stream_t *)data);
 465     (void)demux;
 466 }
 467
 468 /* Send a packet to a chained demuxer */
 469 static void stream_decode (demux_t *demux, void *data, block_t *block)
 470 {
 471     if (data)
 472         stream_DemuxSend ((stream_t *)data, block);
 473     else
 474         block_Release (block);
 475     (void)demux;
 476 }
 477
 478 /*
 479  * Static payload types handler
 480  */
 481
 482 /* PT=0
 483  * PCMU: G.711 µ-law (RFC3551)
 484  */
 485 static void *pcmu_init (demux_t *demux)
 486 {
 487     es_format_t fmt;
 488
 489     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('u', 'l', 'a', 'w'));
 490     fmt.audio.i_rate = 8000;
 491     fmt.audio.i_channels = 1;
 492     return codec_init (demux, &fmt);
 493 }
 494
 495 /* PT=8
 496  * PCMA: G.711 A-law (RFC3551)
 497  */
 498 static void *pcma_init (demux_t *demux)
 499 {
 500     es_format_t fmt;
 501
 502     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('a', 'l', 'a', 'w'));
 503     fmt.audio.i_rate = 8000;
 504     fmt.audio.i_channels = 1;
 505     return codec_init (demux, &fmt);
 506 }
 507
 508 /* PT=10,11
 509  * L16: 16-bits (network byte order) PCM
 510  */
 511 static void *l16s_init (demux_t *demux)
 512 {
 513     es_format_t fmt;
 514
 515     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
 516     fmt.audio.i_rate = 44100;
 517     fmt.audio.i_channels = 2;
 518     return codec_init (demux, &fmt);
 519 }
 520
 521 static void *l16m_init (demux_t *demux)
 522 {
 523     es_format_t fmt;
 524
 525     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
 526     fmt.audio.i_rate = 44100;
 527     fmt.audio.i_channels = 1;
 528     return codec_init (demux, &fmt);
 529 }
 530
 531 /* PT=14
 532  * MPA: MPEG Audio (RFC2250, §3.4)
 533  */
 534 static void *mpa_init (demux_t *demux)
 535 {
 536     es_format_t fmt;
 537
 538     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('m', 'p', 'g', 'a'));
 539     fmt.audio.i_channels = 2;
 540     return codec_init (demux, &fmt);
 541 }
 542
 543 static void mpa_decode (demux_t *demux, void *data, block_t *block)
 544 {
 545     if (block->i_buffer < 4)
 546     {
 547         block_Release (block);
 548         return;
 549     }
 550
 551     block->i_buffer -= 4; /* 32-bits RTP/MPA header */
 552     block->p_buffer += 4;
 553
 554     codec_decode (demux, data, block);
 555 }
 556
 557
 558 /* PT=32
 559  * MPV: MPEG Video (RFC2250, §3.5)
 560  */
 561 static void *mpv_init (demux_t *demux)
 562 {
 563     es_format_t fmt;
 564
 565     es_format_Init (&fmt, VIDEO_ES, VLC_FOURCC ('m', 'p', 'g', 'v'));
 566     return codec_init (demux, &fmt);
 567 }
 568
 569 static void mpv_decode (demux_t *demux, void *data, block_t *block)
 570 {
 571     if (block->i_buffer < 4)
 572     {
 573         block_Release (block);
 574         return;
 575     }
 576
 577     block->i_buffer -= 4; /* 32-bits RTP/MPV header */
 578     block->p_buffer += 4;
 579 #if 0
 580     if (block->p_buffer[-3] & 0x4)
 581     {
 582         /* MPEG2 Video extension header */
 583         /* TODO: shouldn't we skip this too ? */
 584     }
 585 #endif
 586     codec_decode (demux, data, block);
 587 }
 588
 589
 590 /* PT=33
 591  * MP2: MPEG TS (RFC2250, §2)
 592  */
 593 static void *ts_init (demux_t *demux)
 594 {
 595     return stream_init (demux, "ts");
 596 }
 597
 598
 599 /*
 600  * Dynamic payload type handlers
 601  * Hmm, none implemented yet.
 602  */
 603
 604 /**
 605  * Processing callback
 606  */
 607 static int Demux (demux_t *demux)
 608 {
 609     demux_sys_t *p_sys = demux->p_sys;
 610     block_t     *block;
 611
 612     block = p_sys->framed_rtp
 613         ? rtp_stream_recv (demux, p_sys->fd)
 614         : rtp_dgram_recv (demux, p_sys->fd);
 615     if (!block)
 616         return 0;
 617
 618     if (block->i_buffer < 2)
 619         goto drop;
 620
 621     const uint8_t ptype = block->p_buffer[1] & 0x7F;
 622     if (ptype >= 72 && ptype <= 76)
 623         goto drop; /* Muxed RTCP, ignore for now */
 624
 625     if (p_sys->srtp)
 626     {
 627         size_t len = block->i_buffer;
 628         if (srtp_recv (p_sys->srtp, block->p_buffer, &len))
 629         {
 630             msg_Dbg (demux, "SRTP authentication/decryption failed");
 631             goto drop;
 632         }
 633         block->i_buffer = len;
 634     }
 635
 636     /* Not using SDP, we need to guess the payload format used */
 637     /* see http://www.iana.org/assignments/rtp-parameters */
 638     if (p_sys->autodetect)
 639     {
 640         rtp_pt_t pt = {
 641             .init = NULL,
 642             .destroy = codec_destroy,
 643             .decode = codec_decode,
 644             .frequency = 0,
 645             .number = ptype,
 646         };
 647         switch (ptype)
 648         {
 649           case 0:
 650             msg_Dbg (demux, "detected G.711 mu-law");
 651             pt.init = pcmu_init;
 652             pt.frequency = 8000;
 653             break;
 654
 655           case 8:
 656             msg_Dbg (demux, "detected G.711 A-law");
 657             pt.init = pcma_init;
 658             pt.frequency = 8000;
 659             break;
 660
 661           case 10:
 662             msg_Dbg (demux, "detected stereo PCM");
 663             pt.init = l16s_init;
 664             pt.frequency = 44100;
 665             break;
 666
 667           case 11:
 668             msg_Dbg (demux, "detected mono PCM");
 669             pt.init = l16m_init;
 670             pt.frequency = 44100;
 671             break;
 672
 673           case 14:
 674             msg_Dbg (demux, "detected MPEG Audio");
 675             pt.init = mpa_init;
 676             pt.decode = mpa_decode;
 677             pt.frequency = 44100;
 678             break;
 679
 680           case 32:
 681             msg_Dbg (demux, "detected MPEG Video");
 682             pt.init = mpv_init;
 683             pt.decode = mpv_decode;
 684             pt.frequency = 90000;
 685             break;
 686
 687           case 33:
 688             msg_Dbg (demux, "detected MPEG2 TS");
 689             pt.init = ts_init;
 690             pt.destroy = stream_destroy;
 691             pt.decode = stream_decode;
 692             pt.frequency = 90000;
 693             break;
 694
 695           default:
 696             goto drop;
 697         }
 698         rtp_add_type (demux, p_sys->session, &pt);
 699         p_sys->autodetect = false;
 700     }
 701     rtp_receive (demux, p_sys->session, block);
 702
 703     return 1;
 704 drop:
 705     block_Release (block);
 706     return 1;
 707 }