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