3 * @brief Real-Time Protocol (RTP) demux module for VLC media player
5 /*****************************************************************************
6 * Copyright (C) 2001-2005 the VideoLAN team
7 * Copyright © 2007-2009 Rémi Denis-Courmont
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.
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.
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 ****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_demux.h>
33 #include <vlc_network.h>
34 #include <vlc_plugin.h>
35 #include <vlc_dialog.h>
41 # include <vlc_gcrypt.h>
44 #define RTCP_PORT_TEXT N_("RTCP (local) port")
45 #define RTCP_PORT_LONGTEXT N_( \
46 "RTCP packets will be received on this transport protocol port. " \
47 "If zero, multiplexed RTP/RTCP is used.")
49 #define SRTP_KEY_TEXT N_("SRTP key (hexadecimal)")
50 #define SRTP_KEY_LONGTEXT N_( \
51 "RTP packets will be authenticated and deciphered "\
52 "with this Secure RTP master shared secret key.")
54 #define SRTP_SALT_TEXT N_("SRTP salt (hexadecimal)")
55 #define SRTP_SALT_LONGTEXT N_( \
56 "Secure RTP requires a (non-secret) master salt value.")
58 #define RTP_MAX_SRC_TEXT N_("Maximum RTP sources")
59 #define RTP_MAX_SRC_LONGTEXT N_( \
60 "How many distinct active RTP sources are allowed at a time." )
62 #define RTP_TIMEOUT_TEXT N_("RTP source timeout (sec)")
63 #define RTP_TIMEOUT_LONGTEXT N_( \
64 "How long to wait for any packet before a source is expired.")
66 #define RTP_MAX_DROPOUT_TEXT N_("Maximum RTP sequence number dropout")
67 #define RTP_MAX_DROPOUT_LONGTEXT N_( \
68 "RTP packets will be discarded if they are too much ahead (i.e. in the " \
69 "future) by this many packets from the last received packet." )
71 #define RTP_MAX_MISORDER_TEXT N_("Maximum RTP sequence number misordering")
72 #define RTP_MAX_MISORDER_LONGTEXT N_( \
73 "RTP packets will be discarded if they are too far behind (i.e. in the " \
74 "past) by this many packets from the last received packet." )
76 #define RTP_DYNAMIC_PT_TEXT N_("RTP payload format assumed for dynamic " \
78 #define RTP_DYNAMIC_PT_LONGTEXT N_( \
79 "This payload format will be assumed for dynamic payload types " \
80 "(between 96 and 127) if it can't be determined otherwise with " \
81 "out-of-band mappings (SDP)" )
83 static const char *const dynamic_pt_list[] = { "theora" };
84 static const char *const dynamic_pt_list_text[] = { "Theora Encoded Video" };
86 static int Open (vlc_object_t *);
87 static void Close (vlc_object_t *);
93 set_shortname (N_("RTP"))
94 set_description (N_("Real-Time Protocol (RTP) input"))
95 set_category (CAT_INPUT)
96 set_subcategory (SUBCAT_INPUT_DEMUX)
97 set_capability ("access_demux", 0)
98 set_callbacks (Open, Close)
100 add_integer ("rtcp-port", 0, RTCP_PORT_TEXT,
101 RTCP_PORT_LONGTEXT, false)
102 change_integer_range (0, 65535)
105 add_string ("srtp-key", "",
106 SRTP_KEY_TEXT, SRTP_KEY_LONGTEXT, false)
108 add_string ("srtp-salt", "",
109 SRTP_SALT_TEXT, SRTP_SALT_LONGTEXT, false)
112 add_integer ("rtp-max-src", 1, RTP_MAX_SRC_TEXT,
113 RTP_MAX_SRC_LONGTEXT, true)
114 change_integer_range (1, 255)
115 add_integer ("rtp-timeout", 5, RTP_TIMEOUT_TEXT,
116 RTP_TIMEOUT_LONGTEXT, true)
117 add_integer ("rtp-max-dropout", 3000, RTP_MAX_DROPOUT_TEXT,
118 RTP_MAX_DROPOUT_LONGTEXT, true)
119 change_integer_range (0, 32767)
120 add_integer ("rtp-max-misorder", 100, RTP_MAX_MISORDER_TEXT,
121 RTP_MAX_MISORDER_LONGTEXT, true)
122 change_integer_range (0, 32767)
123 add_string ("rtp-dynamic-pt", NULL, RTP_DYNAMIC_PT_TEXT,
124 RTP_DYNAMIC_PT_LONGTEXT, true)
125 change_string_list (dynamic_pt_list, dynamic_pt_list_text, NULL)
127 /*add_shortcut ("sctp")*/
128 add_shortcut ("dccp", "rtptcp", /* "tcp" is already taken :( */
133 * TODO: so much stuff
134 * - send RTCP-RR and RTCP-BYE
135 * - dynamic payload types (need SDP parser)
136 * - multiple medias (need SDP parser, and RTCP-SR parser for lip-sync)
137 * - support for stream_filter in case of stream_Demux (MPEG-TS)
141 # define IPPROTO_DCCP 33 /* IANA */
144 #ifndef IPPROTO_UDPLITE
145 # define IPPROTO_UDPLITE 136 /* from IANA */
152 static int Control (demux_t *, int i_query, va_list args);
153 static int extract_port (char **phost);
156 * Probes and initializes.
158 static int Open (vlc_object_t *obj)
160 demux_t *demux = (demux_t *)obj;
161 int tp; /* transport protocol */
163 if (!strcmp (demux->psz_access, "dccp"))
166 if (!strcmp (demux->psz_access, "rtptcp"))
169 if (!strcmp (demux->psz_access, "rtp"))
172 if (!strcmp (demux->psz_access, "udplite"))
173 tp = IPPROTO_UDPLITE;
177 char *tmp = strdup (demux->psz_location);
182 char *dhost = strchr (tmp, '@');
194 /* Parses the port numbers */
195 int sport = 0, dport = 0;
197 sport = extract_port (&shost);
199 dport = extract_port (&dhost);
201 dport = 5004; /* avt-profile-1 port */
203 int rtcp_dport = var_CreateGetInteger (obj, "rtcp-port");
206 int fd = -1, rtcp_fd = -1;
211 case IPPROTO_UDPLITE:
212 fd = net_OpenDgram (obj, dhost, dport, shost, sport, tp);
215 if (rtcp_dport > 0) /* XXX: source port is unknown */
216 rtcp_fd = net_OpenDgram (obj, dhost, rtcp_dport, shost, 0, tp);
220 #ifndef SOCK_DCCP /* provisional API (FIXME) */
226 var_Create (obj, "dccp-service", VLC_VAR_STRING);
227 var_SetString (obj, "dccp-service", "RTPV"); /* FIXME: RTPA? */
228 fd = net_Connect (obj, dhost, dport, SOCK_DCCP, tp);
230 msg_Err (obj, "DCCP support not included");
235 fd = net_Connect (obj, dhost, dport, SOCK_STREAM, tp);
242 net_SetCSCov (fd, -1, 12);
244 /* Initializes demux */
245 demux_sys_t *p_sys = malloc (sizeof (*p_sys));
258 p_sys->rtcp_fd = rtcp_fd;
259 p_sys->max_src = var_CreateGetInteger (obj, "rtp-max-src");
260 p_sys->timeout = var_CreateGetInteger (obj, "rtp-timeout")
262 p_sys->max_dropout = var_CreateGetInteger (obj, "rtp-max-dropout");
263 p_sys->max_misorder = var_CreateGetInteger (obj, "rtp-max-misorder");
264 p_sys->thread_ready = false;
265 p_sys->autodetect = true;
267 demux->pf_demux = NULL;
268 demux->pf_control = Control;
269 demux->p_sys = p_sys;
271 p_sys->session = rtp_session_create (demux);
272 if (p_sys->session == NULL)
276 char *key = var_CreateGetNonEmptyString (demux, "srtp-key");
280 p_sys->srtp = srtp_create (SRTP_ENCR_AES_CM, SRTP_AUTH_HMAC_SHA1, 10,
281 SRTP_PRF_AES_CM, SRTP_RCC_MODE1);
282 if (p_sys->srtp == NULL)
288 char *salt = var_CreateGetNonEmptyString (demux, "srtp-salt");
289 errno = srtp_setkeystring (p_sys->srtp, key, salt ? salt : "");
294 msg_Err (obj, "bad SRTP key/salt combination (%m)");
300 if (vlc_clone (&p_sys->thread,
301 (tp != IPPROTO_TCP) ? rtp_dgram_thread : rtp_stream_thread,
302 demux, VLC_THREAD_PRIORITY_INPUT))
304 p_sys->thread_ready = true;
316 static void Close (vlc_object_t *obj)
318 demux_t *demux = (demux_t *)obj;
319 demux_sys_t *p_sys = demux->p_sys;
321 if (p_sys->thread_ready)
323 vlc_cancel (p_sys->thread);
324 vlc_join (p_sys->thread, NULL);
329 srtp_destroy (p_sys->srtp);
332 rtp_session_destroy (demux, p_sys->session);
333 if (p_sys->rtcp_fd != -1)
334 net_Close (p_sys->rtcp_fd);
335 net_Close (p_sys->fd);
341 * Extracts port number from "[host]:port" or "host:port" strings,
342 * and remove brackets from the host name.
343 * @param phost pointer to the string upon entry,
344 * pointer to the hostname upon return.
345 * @return port number, 0 if missing.
347 static int extract_port (char **phost)
349 char *host = *phost, *port;
353 host = ++*phost; /* skip '[' */
354 port = strchr (host, ']');
356 *port++ = '\0'; /* skip ']' */
359 port = strchr (host, ':');
363 *port++ = '\0'; /* skip ':' */
371 static int Control (demux_t *demux, int i_query, va_list args)
375 case DEMUX_GET_POSITION:
377 float *v = va_arg (args, float *);
382 case DEMUX_GET_LENGTH:
385 int64_t *v = va_arg (args, int64_t *);
390 case DEMUX_GET_PTS_DELAY:
392 int64_t *v = va_arg (args, int64_t *);
393 *v = INT64_C(1000) * var_InheritInteger (demux, "network-caching");
397 case DEMUX_CAN_PAUSE:
399 case DEMUX_CAN_CONTROL_PACE:
401 bool *v = (bool*)va_arg( args, bool * );
412 * Generic packet handlers
415 void *codec_init (demux_t *demux, es_format_t *fmt)
417 return es_out_Add (demux->out, fmt);
420 void codec_destroy (demux_t *demux, void *data)
423 es_out_Del (demux->out, (es_out_id_t *)data);
426 /* Send a packet to decoder */
427 void codec_decode (demux_t *demux, void *data, block_t *block)
431 block->i_dts = VLC_TS_INVALID; /* RTP does not specify this */
432 es_out_Control (demux->out, ES_OUT_SET_PCR, block->i_pts );
433 es_out_Send (demux->out, (es_out_id_t *)data, block);
436 block_Release (block);
439 static void *stream_init (demux_t *demux, const char *name)
441 return stream_DemuxNew (demux, name, demux->out);
444 static void stream_destroy (demux_t *demux, void *data)
447 stream_Delete ((stream_t *)data);
451 /* Send a packet to a chained demuxer */
452 static void stream_decode (demux_t *demux, void *data, block_t *block)
455 stream_DemuxSend ((stream_t *)data, block);
457 block_Release (block);
461 static void *demux_init (demux_t *demux)
463 return stream_init (demux, demux->psz_demux);
467 * Static payload types handler
471 * PCMU: G.711 µ-law (RFC3551)
473 static void *pcmu_init (demux_t *demux)
477 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_MULAW);
478 fmt.audio.i_rate = 8000;
479 fmt.audio.i_channels = 1;
480 return codec_init (demux, &fmt);
486 static void *gsm_init (demux_t *demux)
490 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_GSM);
491 fmt.audio.i_rate = 8000;
492 fmt.audio.i_channels = 1;
493 return codec_init (demux, &fmt);
497 * PCMA: G.711 A-law (RFC3551)
499 static void *pcma_init (demux_t *demux)
503 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_ALAW);
504 fmt.audio.i_rate = 8000;
505 fmt.audio.i_channels = 1;
506 return codec_init (demux, &fmt);
510 * L16: 16-bits (network byte order) PCM
512 static void *l16s_init (demux_t *demux)
516 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16B);
517 fmt.audio.i_rate = 44100;
518 fmt.audio.i_channels = 2;
519 return codec_init (demux, &fmt);
522 static void *l16m_init (demux_t *demux)
526 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16B);
527 fmt.audio.i_rate = 44100;
528 fmt.audio.i_channels = 1;
529 return codec_init (demux, &fmt);
535 static void *qcelp_init (demux_t *demux)
539 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_QCELP);
540 fmt.audio.i_rate = 8000;
541 fmt.audio.i_channels = 1;
542 return codec_init (demux, &fmt);
546 * MPA: MPEG Audio (RFC2250, §3.4)
548 static void *mpa_init (demux_t *demux)
552 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_MPGA);
553 fmt.audio.i_channels = 2;
554 fmt.b_packetized = false;
555 return codec_init (demux, &fmt);
558 static void mpa_decode (demux_t *demux, void *data, block_t *block)
560 if (block->i_buffer < 4)
562 block_Release (block);
566 block->i_buffer -= 4; /* 32-bits RTP/MPA header */
567 block->p_buffer += 4;
569 codec_decode (demux, data, block);
574 * MPV: MPEG Video (RFC2250, §3.5)
576 static void *mpv_init (demux_t *demux)
580 es_format_Init (&fmt, VIDEO_ES, VLC_CODEC_MPGV);
581 fmt.b_packetized = false;
582 return codec_init (demux, &fmt);
585 static void mpv_decode (demux_t *demux, void *data, block_t *block)
587 if (block->i_buffer < 4)
589 block_Release (block);
593 block->i_buffer -= 4; /* 32-bits RTP/MPV header */
594 block->p_buffer += 4;
596 if (block->p_buffer[-3] & 0x4)
598 /* MPEG2 Video extension header */
599 /* TODO: shouldn't we skip this too ? */
602 codec_decode (demux, data, block);
607 * MP2: MPEG TS (RFC2250, §2)
609 static void *ts_init (demux_t *demux)
611 return stream_init (demux, *demux->psz_demux ? demux->psz_demux : "ts");
615 /* Not using SDP, we need to guess the payload format used */
616 /* see http://www.iana.org/assignments/rtp-parameters */
617 void rtp_autodetect (demux_t *demux, rtp_session_t *session,
618 const block_t *block)
620 uint8_t ptype = rtp_ptype (block);
623 .destroy = codec_destroy,
624 .decode = codec_decode,
629 /* Remember to keep this in sync with modules/services_discovery/sap.c */
633 msg_Dbg (demux, "detected G.711 mu-law");
639 msg_Dbg (demux, "detected GSM");
645 msg_Dbg (demux, "detected G.711 A-law");
651 msg_Dbg (demux, "detected stereo PCM");
653 pt.frequency = 44100;
657 msg_Dbg (demux, "detected mono PCM");
659 pt.frequency = 44100;
663 msg_Dbg (demux, "detected QCELP");
664 pt.init = qcelp_init;
669 msg_Dbg (demux, "detected MPEG Audio");
671 pt.decode = mpa_decode;
672 pt.frequency = 90000;
676 msg_Dbg (demux, "detected MPEG Video");
678 pt.decode = mpv_decode;
679 pt.frequency = 90000;
683 msg_Dbg (demux, "detected MPEG2 TS");
685 pt.destroy = stream_destroy;
686 pt.decode = stream_decode;
687 pt.frequency = 90000;
692 * If the rtp payload type is unknown then check demux if it is specified
694 if (!strcmp(demux->psz_demux, "h264")
695 || !strcmp(demux->psz_demux, "ts"))
697 msg_Dbg (demux, "dynamic payload format %s specified by demux",
699 pt.init = demux_init;
700 pt.destroy = stream_destroy;
701 pt.decode = stream_decode;
702 pt.frequency = 90000;
707 char *dynamic = var_InheritString(demux, "rtp-dynamic-pt");
710 else if (!strcmp(dynamic, "theora"))
712 msg_Dbg (demux, "assuming Theora Encoded Video");
713 pt.init = theora_init;
714 pt.destroy = xiph_destroy;
715 pt.decode = xiph_decode;
716 pt.frequency = 90000;
719 msg_Err (demux, "unknown dynamic payload format `%s' "
720 "specified", dynamic);
724 msg_Err (demux, "unspecified payload format (type %"PRIu8")", ptype);
725 msg_Info (demux, "A valid SDP is needed to parse this RTP stream.");
726 dialog_Fatal (demux, N_("SDP required"),
727 N_("A description in SDP format is required to receive the RTP "
728 "stream. Note that rtp:// URIs cannot work with dynamic "
729 "RTP payload format (%"PRIu8")."), ptype);
732 rtp_add_type (demux, session, &pt);
736 * Dynamic payload type handlers
737 * Hmm, none implemented yet apart from Xiph ones.