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.0
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 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 ****************************************************************************/
30 #include <vlc_common.h>
31 #include <vlc_demux.h>
33 #include <vlc_network.h>
34 #include <vlc_plugin.h>
36 #include <vlc_codecs.h>
41 #define RTP_CACHING_TEXT N_("RTP de-jitter buffer length (msec)")
42 #define RTP_CACHING_LONGTEXT N_( \
43 "How long to wait for late RTP packets (and delay the performance)." )
45 #define RTCP_PORT_TEXT N_("RTCP (local) port")
46 #define RTCP_PORT_LONGTEXT N_( \
47 "RTCP packets will be received on this transport protocol port. " \
48 "If zero, multiplexed RTP/RTCP is used.")
50 #define SRTP_KEY_TEXT N_("SRTP key (hexadecimal)")
51 #define SRTP_KEY_LONGTEXT N_( \
52 "RTP packets will be authenticated and deciphered "\
53 "with this Secure RTP master shared secret key.")
55 #define SRTP_SALT_TEXT N_("SRTP salt (hexadecimal)")
56 #define SRTP_SALT_LONGTEXT N_( \
57 "Secure RTP requires a (non-secret) master salt value.")
59 #define RTP_MAX_SRC_TEXT N_("Maximum RTP sources")
60 #define RTP_MAX_SRC_LONGTEXT N_( \
61 "How many distinct active RTP sources are allowed at a time." )
63 #define RTP_TIMEOUT_TEXT N_("RTP source timeout (sec)")
64 #define RTP_TIMEOUT_LONGTEXT N_( \
65 "How long to wait for any packet before a source is expired.")
67 #define RTP_MAX_DROPOUT_TEXT N_("Maximum RTP sequence number dropout")
68 #define RTP_MAX_DROPOUT_LONGTEXT N_( \
69 "RTP packets will be discarded if they are too much ahead (i.e. in the " \
70 "future) by this many packets from the last received packet." )
72 #define RTP_MAX_MISORDER_TEXT N_("Maximum RTP sequence number misordering")
73 #define RTP_MAX_MISORDER_LONGTEXT N_( \
74 "RTP packets will be discarded if they are too far behind (i.e. in the " \
75 "past) by this many packets from the last received packet." )
77 static int Open (vlc_object_t *);
78 static void Close (vlc_object_t *);
84 set_shortname (N_("RTP"))
85 set_description (N_("Real-Time Protocol (RTP) input"))
86 set_category (CAT_INPUT)
87 set_subcategory (SUBCAT_INPUT_DEMUX)
88 set_capability ("access_demux", 0)
89 set_callbacks (Open, Close)
91 add_integer ("rtp-caching", 1000, NULL, RTP_CACHING_TEXT,
92 RTP_CACHING_LONGTEXT, true)
93 change_integer_range (0, 65535)
95 add_integer ("rtcp-port", 0, NULL, RTCP_PORT_TEXT,
96 RTCP_PORT_LONGTEXT, false)
97 change_integer_range (0, 65535)
99 add_string ("srtp-key", "", NULL,
100 SRTP_KEY_TEXT, SRTP_KEY_LONGTEXT, false)
101 add_string ("srtp-salt", "", NULL,
102 SRTP_SALT_TEXT, SRTP_SALT_LONGTEXT, false)
103 add_integer ("rtp-max-src", 1, NULL, RTP_MAX_SRC_TEXT,
104 RTP_MAX_SRC_LONGTEXT, true)
105 change_integer_range (1, 255)
106 add_integer ("rtp-timeout", 5, NULL, RTP_TIMEOUT_TEXT,
107 RTP_TIMEOUT_LONGTEXT, true)
108 add_integer ("rtp-max-dropout", 3000, NULL, RTP_MAX_DROPOUT_TEXT,
109 RTP_MAX_DROPOUT_LONGTEXT, true)
110 change_integer_range (0, 32767)
111 add_integer ("rtp-max-misorder", 100, NULL, RTP_MAX_MISORDER_TEXT,
112 RTP_MAX_MISORDER_LONGTEXT, true)
113 change_integer_range (0, 32767)
115 add_shortcut ("dccp")
116 /*add_shortcut ("sctp")*/
117 add_shortcut ("rtptcp") /* "tcp" is already taken :( */
119 add_shortcut ("udplite")
123 * TODO: so much stuff
124 * - send RTCP-RR and RTCP-BYE
125 * - dynamic payload types (need SDP parser)
126 * - multiple medias (need SDP parser, and RTCP-SR parser for lip-sync)
127 * - support for stream_filter in case of stream_Demux (MPEG-TS)
131 # define IPPROTO_DCCP 33 /* IANA */
134 #ifndef IPPROTO_UDPLITE
135 # define IPPROTO_UDPLITE 136 /* from IANA */
142 static int Demux (demux_t *);
143 static int Control (demux_t *, int i_query, va_list args);
144 static int extract_port (char **phost);
147 * Probes and initializes.
149 static int Open (vlc_object_t *obj)
151 demux_t *demux = (demux_t *)obj;
152 int tp; /* transport protocol */
154 if (!strcmp (demux->psz_access, "dccp"))
157 if (!strcmp (demux->psz_access, "rtptcp"))
160 if (!strcmp (demux->psz_access, "rtp"))
163 if (!strcmp (demux->psz_access, "udplite"))
164 tp = IPPROTO_UDPLITE;
168 char *tmp = strdup (demux->psz_path);
173 char *dhost = strchr (shost, '@');
177 /* Parses the port numbers */
178 int sport = 0, dport = 0;
179 sport = extract_port (&shost);
181 dport = extract_port (&dhost);
183 dport = 5004; /* avt-profile-1 port */
185 int rtcp_dport = var_CreateGetInteger (obj, "rtcp-port");
188 int fd = -1, rtcp_fd = -1;
193 case IPPROTO_UDPLITE:
194 fd = net_OpenDgram (obj, dhost, dport,
195 shost, sport, AF_UNSPEC, tp);
198 if (rtcp_dport > 0) /* XXX: source port is unknown */
199 rtcp_fd = net_OpenDgram (obj, dhost, rtcp_dport, shost, 0,
204 #ifndef SOCK_DCCP /* provisional API (FIXME) */
210 var_Create (obj, "dccp-service", VLC_VAR_STRING);
211 var_SetString (obj, "dccp-service", "RTPV"); /* FIXME: RTPA? */
212 fd = net_Connect (obj, shost, sport, SOCK_DCCP, tp);
214 msg_Err (obj, "DCCP support not included");
219 fd = net_Connect (obj, shost, sport, SOCK_STREAM, tp);
226 net_SetCSCov (fd, -1, 12);
228 /* Initializes demux */
229 demux_sys_t *p_sys = malloc (sizeof (*p_sys));
238 vlc_mutex_init (&p_sys->lock);
239 vlc_cond_init (&p_sys->wait);
242 p_sys->rtcp_fd = rtcp_fd;
243 p_sys->caching = var_CreateGetInteger (obj, "rtp-caching");
244 p_sys->max_src = var_CreateGetInteger (obj, "rtp-max-src");
245 p_sys->timeout = var_CreateGetInteger (obj, "rtp-timeout");
246 p_sys->max_dropout = var_CreateGetInteger (obj, "rtp-max-dropout");
247 p_sys->max_misorder = var_CreateGetInteger (obj, "rtp-max-misorder");
248 p_sys->framed_rtp = (tp == IPPROTO_TCP);
251 demux->pf_demux = Demux;
252 demux->pf_control = Control;
253 demux->p_sys = p_sys;
255 p_sys->session = rtp_session_create (demux);
256 if (p_sys->session == NULL)
259 char *key = var_CreateGetNonEmptyString (demux, "srtp-key");
262 p_sys->srtp = srtp_create (SRTP_ENCR_AES_CM, SRTP_AUTH_HMAC_SHA1, 10,
263 SRTP_PRF_AES_CM, SRTP_RCC_MODE1);
264 if (p_sys->srtp == NULL)
270 char *salt = var_CreateGetNonEmptyString (demux, "srtp-salt");
271 errno = srtp_setkeystring (p_sys->srtp, key, salt ? salt : "");
276 msg_Err (obj, "bad SRTP key/salt combination (%m)");
281 if (vlc_clone (&p_sys->thread, rtp_thread, demux,
282 VLC_THREAD_PRIORITY_INPUT))
284 p_sys->thread_ready = true;
296 static void Close (vlc_object_t *obj)
298 demux_t *demux = (demux_t *)obj;
299 demux_sys_t *p_sys = demux->p_sys;
301 if (p_sys->thread_ready)
303 vlc_cancel (p_sys->thread);
304 vlc_join (p_sys->thread, NULL);
306 vlc_cond_destroy (&p_sys->wait);
307 vlc_mutex_destroy (&p_sys->lock);
310 srtp_destroy (p_sys->srtp);
312 rtp_session_destroy (demux, p_sys->session);
313 if (p_sys->rtcp_fd != -1)
314 net_Close (p_sys->rtcp_fd);
315 net_Close (p_sys->fd);
321 * Extracts port number from "[host]:port" or "host:port" strings,
322 * and remove brackets from the host name.
323 * @param phost pointer to the string upon entry,
324 * pointer to the hostname upon return.
325 * @return port number, 0 if missing.
327 static int extract_port (char **phost)
329 char *host = *phost, *port;
333 host = ++*phost; /* skip '[' */
334 port = strchr (host, ']');
336 *port++ = '\0'; /* skip ']' */
339 port = strchr (host, ':');
343 *port++ = '\0'; /* skip ':' */
351 static int Control (demux_t *demux, int i_query, va_list args)
353 demux_sys_t *p_sys = demux->p_sys;
357 case DEMUX_GET_POSITION:
359 float *v = va_arg (args, float *);
364 case DEMUX_GET_LENGTH:
367 int64_t *v = va_arg (args, int64_t *);
372 case DEMUX_GET_PTS_DELAY:
374 int64_t *v = va_arg (args, int64_t *);
375 *v = p_sys->caching * 1000;
379 case DEMUX_CAN_PAUSE:
381 case DEMUX_CAN_CONTROL_PACE:
383 bool *v = (bool*)va_arg( args, bool * );
394 * Generic packet handlers
397 static void *codec_init (demux_t *demux, es_format_t *fmt)
399 return es_out_Add (demux->out, fmt);
402 static void codec_destroy (demux_t *demux, void *data)
405 es_out_Del (demux->out, (es_out_id_t *)data);
408 /* Send a packet to decoder */
409 static void codec_decode (demux_t *demux, void *data, block_t *block)
413 block->i_dts = 0; /* RTP does not specify this */
414 es_out_Control (demux->out, ES_OUT_SET_PCR, block->i_pts );
415 es_out_Send (demux->out, (es_out_id_t *)data, block);
418 block_Release (block);
422 static void *stream_init (demux_t *demux, const char *name)
424 return stream_DemuxNew (demux, name, demux->out);
427 static void stream_destroy (demux_t *demux, void *data)
430 stream_Delete ((stream_t *)data);
434 /* Send a packet to a chained demuxer */
435 static void stream_decode (demux_t *demux, void *data, block_t *block)
438 stream_DemuxSend ((stream_t *)data, block);
440 block_Release (block);
445 * Static payload types handler
449 * PCMU: G.711 µ-law (RFC3551)
451 static void *pcmu_init (demux_t *demux)
455 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_MULAW);
456 fmt.audio.i_rate = 8000;
457 fmt.audio.i_channels = 1;
458 return codec_init (demux, &fmt);
464 static void *gsm_init (demux_t *demux)
468 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_GSM);
469 fmt.audio.i_rate = 8000;
470 fmt.audio.i_channels = 1;
471 return codec_init (demux, &fmt);
475 * PCMA: G.711 A-law (RFC3551)
477 static void *pcma_init (demux_t *demux)
481 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_ALAW);
482 fmt.audio.i_rate = 8000;
483 fmt.audio.i_channels = 1;
484 return codec_init (demux, &fmt);
488 * L16: 16-bits (network byte order) PCM
490 static void *l16s_init (demux_t *demux)
494 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16B);
495 fmt.audio.i_rate = 44100;
496 fmt.audio.i_channels = 2;
497 return codec_init (demux, &fmt);
500 static void *l16m_init (demux_t *demux)
504 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_S16B);
505 fmt.audio.i_rate = 44100;
506 fmt.audio.i_channels = 1;
507 return codec_init (demux, &fmt);
513 static void *qcelp_init (demux_t *demux)
517 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_QCELP);
518 fmt.audio.i_rate = 8000;
519 fmt.audio.i_channels = 1;
520 return codec_init (demux, &fmt);
524 * MPA: MPEG Audio (RFC2250, §3.4)
526 static void *mpa_init (demux_t *demux)
530 es_format_Init (&fmt, AUDIO_ES, VLC_CODEC_MPGA);
531 fmt.audio.i_channels = 2;
532 fmt.b_packetized = false;
533 return codec_init (demux, &fmt);
536 static void mpa_decode (demux_t *demux, void *data, block_t *block)
538 if (block->i_buffer < 4)
540 block_Release (block);
544 block->i_buffer -= 4; /* 32-bits RTP/MPA header */
545 block->p_buffer += 4;
547 codec_decode (demux, data, block);
552 * MPV: MPEG Video (RFC2250, §3.5)
554 static void *mpv_init (demux_t *demux)
558 es_format_Init (&fmt, VIDEO_ES, VLC_CODEC_MPGV);
559 fmt.b_packetized = false;
560 return codec_init (demux, &fmt);
563 static void mpv_decode (demux_t *demux, void *data, block_t *block)
565 if (block->i_buffer < 4)
567 block_Release (block);
571 block->i_buffer -= 4; /* 32-bits RTP/MPV header */
572 block->p_buffer += 4;
574 if (block->p_buffer[-3] & 0x4)
576 /* MPEG2 Video extension header */
577 /* TODO: shouldn't we skip this too ? */
580 codec_decode (demux, data, block);
585 * MP2: MPEG TS (RFC2250, §2)
587 static void *ts_init (demux_t *demux)
589 return stream_init (demux, *demux->psz_demux ? demux->psz_demux : "ts");
593 /* Not using SDP, we need to guess the payload format used */
594 /* see http://www.iana.org/assignments/rtp-parameters */
595 int rtp_autodetect (demux_t *demux, rtp_session_t *session,
596 const block_t *block)
598 uint8_t ptype = rtp_ptype (block);
601 .destroy = codec_destroy,
602 .decode = codec_decode,
607 /* Remember to keep this in sync with modules/services_discovery/sap.c */
611 msg_Dbg (demux, "detected G.711 mu-law");
617 msg_Dbg (demux, "detected GSM");
623 msg_Dbg (demux, "detected G.711 A-law");
629 msg_Dbg (demux, "detected stereo PCM");
631 pt.frequency = 44100;
635 msg_Dbg (demux, "detected mono PCM");
637 pt.frequency = 44100;
641 msg_Dbg (demux, "detected QCELP");
642 pt.init = qcelp_init;
647 msg_Dbg (demux, "detected MPEG Audio");
649 pt.decode = mpa_decode;
650 pt.frequency = 90000;
654 msg_Dbg (demux, "detected MPEG Video");
656 pt.decode = mpv_decode;
657 pt.frequency = 90000;
661 msg_Dbg (demux, "detected MPEG2 TS");
663 pt.destroy = stream_destroy;
664 pt.decode = stream_decode;
665 pt.frequency = 90000;
671 rtp_add_type (demux, session, &pt);
676 * Dynamic payload type handlers
677 * Hmm, none implemented yet.
681 * Processing callback
683 static int Demux (demux_t *demux)
685 return rtp_process (demux) ? 0 : 1;