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