Fix plugin strings translation
[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->autodetect   = true;
248     p_sys->framed_rtp   = (tp == IPPROTO_TCP);
249     p_sys->dead         = false;
250
251     demux->pf_demux   = Demux;
252     demux->pf_control = Control;
253     demux->p_sys      = p_sys;
254
255     p_sys->session = rtp_session_create (demux);
256     if (p_sys->session == NULL)
257         goto error;
258
259     char *key = var_CreateGetNonEmptyString (demux, "srtp-key");
260     if (key)
261     {
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)
265         {
266             free (key);
267             goto error;
268         }
269
270         char *salt = var_CreateGetNonEmptyString (demux, "srtp-salt");
271         errno = srtp_setkeystring (p_sys->srtp, key, salt ? salt : "");
272         free (salt);
273         free (key);
274         if (errno)
275         {
276             msg_Err (obj, "bad SRTP key/salt combination (%m)");
277             goto error;
278         }
279     }
280
281     if (vlc_clone (&p_sys->thread, rtp_thread, demux,
282                    VLC_THREAD_PRIORITY_INPUT))
283         goto error;
284     p_sys->thread_ready = true;
285     return VLC_SUCCESS;
286
287 error:
288     Close (obj);
289     return VLC_EGENERIC;
290 }
291
292
293 /**
294  * Releases resources
295  */
296 static void Close (vlc_object_t *obj)
297 {
298     demux_t *demux = (demux_t *)obj;
299     demux_sys_t *p_sys = demux->p_sys;
300
301     if (p_sys->thread_ready)
302     {
303         vlc_cancel (p_sys->thread);
304         vlc_join (p_sys->thread, NULL);
305     }
306     vlc_cond_destroy (&p_sys->wait);
307     vlc_mutex_destroy (&p_sys->lock);
308
309     if (p_sys->srtp)
310         srtp_destroy (p_sys->srtp);
311     if (p_sys->session)
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);
316     free (p_sys);
317 }
318
319
320 /**
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.
326  */
327 static int extract_port (char **phost)
328 {
329     char *host = *phost, *port;
330
331     if (host[0] == '[')
332     {
333         host = ++*phost; /* skip '[' */
334         port = strchr (host, ']');
335         if (port)
336             *port++ = '\0'; /* skip ']' */
337     }
338     else
339         port = strchr (host, ':');
340
341     if (port == NULL)
342         return 0;
343     *port++ = '\0'; /* skip ':' */
344     return atoi (port);
345 }
346
347
348 /**
349  * Control callback
350  */
351 static int Control (demux_t *demux, int i_query, va_list args)
352 {
353     demux_sys_t *p_sys = demux->p_sys;
354
355     switch (i_query)
356     {
357         case DEMUX_GET_POSITION:
358         {
359             float *v = va_arg (args, float *);
360             *v = 0.;
361             return VLC_SUCCESS;
362         }
363
364         case DEMUX_GET_LENGTH:
365         case DEMUX_GET_TIME:
366         {
367             int64_t *v = va_arg (args, int64_t *);
368             *v = 0;
369             return VLC_SUCCESS;
370         }
371
372         case DEMUX_GET_PTS_DELAY:
373         {
374             int64_t *v = va_arg (args, int64_t *);
375             *v = p_sys->caching * 1000;
376             return VLC_SUCCESS;
377         }
378
379         case DEMUX_CAN_PAUSE:
380         case DEMUX_CAN_SEEK:
381         case DEMUX_CAN_CONTROL_PACE:
382         {
383             bool *v = (bool*)va_arg( args, bool * );
384             *v = false;
385             return VLC_SUCCESS;
386         }
387     }
388
389     return VLC_EGENERIC;
390 }
391
392
393 /*
394  * Generic packet handlers
395  */
396
397 static void *codec_init (demux_t *demux, es_format_t *fmt)
398 {
399     return es_out_Add (demux->out, fmt);
400 }
401
402 static void codec_destroy (demux_t *demux, void *data)
403 {
404     if (data)
405         es_out_Del (demux->out, (es_out_id_t *)data);
406 }
407
408 /* Send a packet to decoder */
409 static void codec_decode (demux_t *demux, void *data, block_t *block)
410 {
411     if (data)
412     {
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);
416     }
417     else
418         block_Release (block);
419 }
420
421
422 static void *stream_init (demux_t *demux, const char *name)
423 {
424     return stream_DemuxNew (demux, name, demux->out);
425 }
426
427 static void stream_destroy (demux_t *demux, void *data)
428 {
429     if (data)
430         stream_Delete ((stream_t *)data);
431     (void)demux;
432 }
433
434 /* Send a packet to a chained demuxer */
435 static void stream_decode (demux_t *demux, void *data, block_t *block)
436 {
437     if (data)
438         stream_DemuxSend ((stream_t *)data, block);
439     else
440         block_Release (block);
441     (void)demux;
442 }
443
444 /*
445  * Static payload types handler
446  */
447
448 /* PT=0
449  * PCMU: G.711 µ-law (RFC3551)
450  */
451 static void *pcmu_init (demux_t *demux)
452 {
453     es_format_t fmt;
454
455     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('u', 'l', 'a', 'w'));
456     fmt.audio.i_rate = 8000;
457     fmt.audio.i_channels = 1;
458     return codec_init (demux, &fmt);
459 }
460
461 /* PT=3
462  * GSM
463  */
464 static void *gsm_init (demux_t *demux)
465 {
466     es_format_t fmt;
467
468     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('g', 's', 'm', ' '));
469     fmt.audio.i_rate = 8000;
470     fmt.audio.i_channels = 1;
471     return codec_init (demux, &fmt);
472 }
473
474 /* PT=8
475  * PCMA: G.711 A-law (RFC3551)
476  */
477 static void *pcma_init (demux_t *demux)
478 {
479     es_format_t fmt;
480
481     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('a', 'l', 'a', 'w'));
482     fmt.audio.i_rate = 8000;
483     fmt.audio.i_channels = 1;
484     return codec_init (demux, &fmt);
485 }
486
487 /* PT=10,11
488  * L16: 16-bits (network byte order) PCM
489  */
490 static void *l16s_init (demux_t *demux)
491 {
492     es_format_t fmt;
493
494     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
495     fmt.audio.i_rate = 44100;
496     fmt.audio.i_channels = 2;
497     return codec_init (demux, &fmt);
498 }
499
500 static void *l16m_init (demux_t *demux)
501 {
502     es_format_t fmt;
503
504     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('s', '1', '6', 'b'));
505     fmt.audio.i_rate = 44100;
506     fmt.audio.i_channels = 1;
507     return codec_init (demux, &fmt);
508 }
509
510 /* PT=12
511  * QCELP
512  */
513 static void *qcelp_init (demux_t *demux)
514 {
515     es_format_t fmt;
516
517     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('Q', 'c', 'l', 'p'));
518     fmt.audio.i_rate = 8000;
519     fmt.audio.i_channels = 1;
520     return codec_init (demux, &fmt);
521 }
522
523 /* PT=14
524  * MPA: MPEG Audio (RFC2250, §3.4)
525  */
526 static void *mpa_init (demux_t *demux)
527 {
528     es_format_t fmt;
529
530     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC ('m', 'p', 'g', 'a'));
531     fmt.audio.i_channels = 2;
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     return codec_init (demux, &fmt);
559 }
560
561 static void mpv_decode (demux_t *demux, void *data, block_t *block)
562 {
563     if (block->i_buffer < 4)
564     {
565         block_Release (block);
566         return;
567     }
568
569     block->i_buffer -= 4; /* 32-bits RTP/MPV header */
570     block->p_buffer += 4;
571 #if 0
572     if (block->p_buffer[-3] & 0x4)
573     {
574         /* MPEG2 Video extension header */
575         /* TODO: shouldn't we skip this too ? */
576     }
577 #endif
578     codec_decode (demux, data, block);
579 }
580
581
582 /* PT=33
583  * MP2: MPEG TS (RFC2250, §2)
584  */
585 static void *ts_init (demux_t *demux)
586 {
587     return stream_init (demux, *demux->psz_demux ? demux->psz_demux : "ts");
588 }
589
590
591 /* Not using SDP, we need to guess the payload format used */
592 /* see http://www.iana.org/assignments/rtp-parameters */
593 int rtp_autodetect (demux_t *demux, rtp_session_t *session,
594                     const block_t *block)
595 {
596     uint8_t ptype = rtp_ptype (block);
597     rtp_pt_t pt = {
598         .init = NULL,
599         .destroy = codec_destroy,
600         .decode = codec_decode,
601         .frequency = 0,
602         .number = ptype,
603     };
604
605     switch (ptype)
606     {
607       case 0:
608         msg_Dbg (demux, "detected G.711 mu-law");
609         pt.init = pcmu_init;
610         pt.frequency = 8000;
611         break;
612
613       case 3:
614         msg_Dbg (demux, "detected GSM");
615         pt.init = gsm_init;
616         pt.frequency = 8000;
617         break;
618
619       case 8:
620         msg_Dbg (demux, "detected G.711 A-law");
621         pt.init = pcma_init;
622         pt.frequency = 8000;
623         break;
624
625       case 10:
626         msg_Dbg (demux, "detected stereo PCM");
627         pt.init = l16s_init;
628         pt.frequency = 44100;
629         break;
630
631       case 11:
632         msg_Dbg (demux, "detected mono PCM");
633         pt.init = l16m_init;
634         pt.frequency = 44100;
635         break;
636
637       case 12:
638         msg_Dbg (demux, "detected QCELP");
639         pt.init = qcelp_init;
640         pt.frequency = 8000;
641         break;
642
643       case 14:
644         msg_Dbg (demux, "detected MPEG Audio");
645         pt.init = mpa_init;
646         pt.decode = mpa_decode;
647         pt.frequency = 90000;
648         break;
649
650       case 32:
651         msg_Dbg (demux, "detected MPEG Video");
652         pt.init = mpv_init;
653         pt.decode = mpv_decode;
654         pt.frequency = 90000;
655         break;
656
657       case 33:
658         msg_Dbg (demux, "detected MPEG2 TS");
659         pt.init = ts_init;
660         pt.destroy = stream_destroy;
661         pt.decode = stream_decode;
662         pt.frequency = 90000;
663         break;
664
665       default:
666         return -1;
667     }
668     rtp_add_type (demux, session, &pt);
669     return 0;
670 }
671
672 /*
673  * Dynamic payload type handlers
674  * Hmm, none implemented yet.
675  */
676
677 /**
678  * Processing callback
679  */
680 static int Demux (demux_t *demux)
681 {
682     return rtp_process (demux) ? 0 : 1;
683 }