String fixes
[vlc.git] / modules / access / udp.c
1 /*****************************************************************************
2  * udp.c: raw UDP & RTP input module
3  *****************************************************************************
4  * Copyright (C) 2001-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          Tristan Leteurtre <tooney@via.ecp.fr>
9  *          Laurent Aimar <fenrir@via.ecp.fr>
10  *          Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
11  *
12  * Reviewed: 23 October 2003, Jean-Paul Saman <jpsaman _at_ videolan _dot_ org>
13  *
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
27  *****************************************************************************/
28
29 /*****************************************************************************
30  * Preamble
31  *****************************************************************************/
32 #include <stdlib.h>
33
34 #include <vlc/vlc.h>
35 #include <vlc/input.h>
36
37 #include "network.h"
38
39 /*****************************************************************************
40  * Module descriptor
41  *****************************************************************************/
42 #define CACHING_TEXT N_("Caching value in ms")
43 #define CACHING_LONGTEXT N_( \
44     "Caching value for UDP streams. This " \
45     "value should be set in milliseconds." )
46
47 #define AUTO_MTU_TEXT N_("Autodetection of MTU")
48 #define AUTO_MTU_LONGTEXT N_( \
49     "Automatically detect the line's MTU. This will increase the size if" \
50     " truncated packets are found" )
51
52 #define RTP_LATE_TEXT N_("RTP reordering timeout in ms")
53 #define RTP_LATE_LONGTEXT N_( \
54     "VLC reorders RTP packets. The input will wait for late packets at most "\
55     "the time specified here (in milliseconds)." )
56
57 static int  Open ( vlc_object_t * );
58 static void Close( vlc_object_t * );
59
60 vlc_module_begin();
61     set_shortname( _("UDP/RTP" ) );
62     set_description( _("UDP/RTP input") );
63     set_category( CAT_INPUT );
64     set_subcategory( SUBCAT_INPUT_ACCESS );
65
66     add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
67                  CACHING_LONGTEXT, VLC_TRUE );
68     add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
69
70     add_bool( "udp-auto-mtu", 1, NULL,
71               AUTO_MTU_TEXT, AUTO_MTU_LONGTEXT, VLC_TRUE );
72
73     set_capability( "access2", 0 );
74     add_shortcut( "udp" );
75     add_shortcut( "udpstream" );
76     add_shortcut( "udp4" );
77     add_shortcut( "udp6" );
78     add_shortcut( "rtp" );
79     add_shortcut( "rtp4" );
80     add_shortcut( "rtp6" );
81     set_callbacks( Open, Close );
82 vlc_module_end();
83
84 /*****************************************************************************
85  * Local prototypes
86  *****************************************************************************/
87 #define RTP_HEADER_LEN 12
88
89 static block_t *BlockUDP( access_t * );
90 static block_t *BlockRTP( access_t * );
91 static block_t *BlockChoose( access_t * );
92 static int Control( access_t *, int, va_list );
93
94 struct access_sys_t
95 {
96     int fd;
97
98     int i_mtu;
99     vlc_bool_t b_auto_mtu;
100
101     /* reorder rtp packets when out-of-sequence */
102     mtime_t i_rtp_late;
103     uint16_t i_last_seqno;
104     block_t *p_list;
105     block_t *p_end;
106 };
107
108 /*****************************************************************************
109  * Open: open the socket
110  *****************************************************************************/
111 static int Open( vlc_object_t *p_this )
112 {
113     access_t     *p_access = (access_t*)p_this;
114     access_sys_t *p_sys;
115
116     char *psz_name = strdup( p_access->psz_path );
117     char *psz_parser, *psz_server_addr, *psz_bind_addr = "";
118     int  i_bind_port, i_server_port = 0;
119
120     /* First set ipv4/ipv6 */
121     var_Create( p_access, "ipv4", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
122     var_Create( p_access, "ipv6", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
123
124     if( *p_access->psz_access )
125     {
126         vlc_value_t val;
127         /* Find out which shortcut was used */
128         if( !strncmp( p_access->psz_access, "udp4", 6 ) ||
129             !strncmp( p_access->psz_access, "rtp4", 6 ))
130         {
131             val.b_bool = VLC_TRUE;
132             var_Set( p_access, "ipv4", val );
133
134             val.b_bool = VLC_FALSE;
135             var_Set( p_access, "ipv6", val );
136         }
137         else if( !strncmp( p_access->psz_access, "udp6", 6 ) ||
138                  !strncmp( p_access->psz_access, "rtp6", 6 ) )
139         {
140             val.b_bool = VLC_TRUE;
141             var_Set( p_access, "ipv6", val );
142
143             val.b_bool = VLC_FALSE;
144             var_Set( p_access, "ipv4", val );
145         }
146     }
147
148     i_bind_port = var_CreateGetInteger( p_access, "server-port" );
149
150     /* Parse psz_name syntax :
151      * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
152     psz_parser = strchr( psz_name, '@' );
153     if( psz_parser != NULL )
154     {
155         /* Found bind address and/or bind port */
156         *psz_parser++ = '\0';
157         psz_bind_addr = psz_parser;
158
159         if( *psz_parser == '[' )
160             /* skips bracket'd IPv6 address */
161             psz_parser = strchr( psz_parser, ']' );
162
163         if( psz_parser != NULL )
164         {
165             psz_parser = strchr( psz_parser, ':' );
166             if( psz_parser != NULL )
167             {
168                 *psz_parser++ = '\0';
169                 i_bind_port = atoi( psz_parser );
170             }
171         }
172     }
173
174     psz_server_addr = psz_name;
175     if( *psz_server_addr == '[' )
176         /* skips bracket'd IPv6 address */
177         psz_parser = strchr( psz_name, ']' );
178
179     if( psz_parser != NULL )
180     {
181         psz_parser = strchr( psz_parser, ':' );
182         if( psz_parser != NULL )
183         {
184             *psz_parser++ = '\0';
185             i_server_port = atoi( psz_parser );
186         }
187     }
188
189     msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
190              psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
191
192     /* Set up p_access */
193     p_access->pf_read = NULL;
194     p_access->pf_block = BlockChoose;
195     p_access->pf_control = Control;
196     p_access->pf_seek = NULL;
197     p_access->info.i_update = 0;
198     p_access->info.i_size = 0;
199     p_access->info.i_pos = 0;
200     p_access->info.b_eof = VLC_FALSE;
201     p_access->info.b_prebuffered = VLC_FALSE;
202     p_access->info.i_title = 0;
203     p_access->info.i_seekpoint = 0;
204
205     p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
206     p_sys->fd = net_OpenUDP( p_access, psz_bind_addr, i_bind_port,
207                                       psz_server_addr, i_server_port );
208     if( p_sys->fd < 0 )
209     {
210         msg_Err( p_access, "cannot open socket" );
211         free( psz_name );
212         free( p_sys );
213         return VLC_EGENERIC;
214     }
215     free( psz_name );
216
217     net_StopSend( p_sys->fd );
218
219     /* FIXME */
220     p_sys->i_mtu = var_CreateGetInteger( p_access, "mtu" );
221     if( p_sys->i_mtu <= 1 )
222         p_sys->i_mtu  = 1500;   /* Avoid problem */
223
224     p_sys->b_auto_mtu = var_CreateGetBool( p_access, "udp-auto-mtu" );;
225
226     /* Update default_pts to a suitable value for udp access */
227     var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
228
229
230     /* RTP reordering for out-of-sequence packets */
231     p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
232     p_sys->i_last_seqno = 0;
233     p_sys->p_list = NULL;
234     p_sys->p_end = NULL;
235     return VLC_SUCCESS;
236 }
237
238 /*****************************************************************************
239  * Close: free unused data structures
240  *****************************************************************************/
241 static void Close( vlc_object_t *p_this )
242 {
243     access_t     *p_access = (access_t*)p_this;
244     access_sys_t *p_sys = p_access->p_sys;
245
246     block_ChainRelease( p_sys->p_list );
247     net_Close( p_sys->fd );
248     free( p_sys );
249 }
250
251 /*****************************************************************************
252  * Control:
253  *****************************************************************************/
254 static int Control( access_t *p_access, int i_query, va_list args )
255 {
256     access_sys_t *p_sys = p_access->p_sys;
257     vlc_bool_t   *pb_bool;
258     int          *pi_int;
259     int64_t      *pi_64;
260
261     switch( i_query )
262     {
263         /* */
264         case ACCESS_CAN_SEEK:
265         case ACCESS_CAN_FASTSEEK:
266         case ACCESS_CAN_PAUSE:
267         case ACCESS_CAN_CONTROL_PACE:
268             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
269             *pb_bool = VLC_FALSE;
270             break;
271         /* */
272         case ACCESS_GET_MTU:
273             pi_int = (int*)va_arg( args, int * );
274             *pi_int = p_sys->i_mtu;
275             break;
276
277         case ACCESS_GET_PTS_DELAY:
278             pi_64 = (int64_t*)va_arg( args, int64_t * );
279             *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
280             break;
281
282         /* */
283         case ACCESS_SET_PAUSE_STATE:
284         case ACCESS_GET_TITLE_INFO:
285         case ACCESS_SET_TITLE:
286         case ACCESS_SET_SEEKPOINT:
287         case ACCESS_SET_PRIVATE_ID_STATE:
288             return VLC_EGENERIC;
289
290         default:
291             msg_Warn( p_access, "unimplemented query in control" );
292             return VLC_EGENERIC;
293
294     }
295     return VLC_SUCCESS;
296 }
297
298 /*****************************************************************************
299  * BlockUDP:
300  *****************************************************************************/
301 static block_t *BlockUDP( access_t *p_access )
302 {
303     access_sys_t *p_sys = p_access->p_sys;
304     block_t      *p_block;
305
306     /* Read data */
307     p_block = block_New( p_access, p_sys->i_mtu );
308     p_block->i_buffer = net_Read( p_access, p_sys->fd, NULL,
309                                   p_block->p_buffer, p_sys->i_mtu,
310                                   VLC_FALSE );
311     if( p_block->i_buffer <= 0 )
312     {
313         block_Release( p_block );
314         return NULL;
315     }
316
317     if( (p_block->i_buffer >= p_sys->i_mtu) && p_sys->b_auto_mtu &&
318         p_sys->i_mtu < 32767 )
319     {
320         /* Increase by 100% */
321         p_sys->i_mtu *= 2;
322         msg_Dbg( p_access, "increasing MTU to %d", p_sys->i_mtu );
323     }
324
325     return p_block;
326 }
327
328 /*
329  * rtp_ChainInsert - insert a p_block in the chain and
330  * look at the sequence numbers.
331  */
332 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
333 {
334     access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
335     block_t *p_prev = NULL;
336     block_t *p = p_sys->p_end;
337     uint16_t i_new = (uint16_t) p_block->i_dts;
338     uint16_t i_tmp = 0;
339
340     if( !p_sys->p_list )
341     {
342         p_sys->p_list = p_block;
343         p_sys->p_end = p_block;
344         return VLC_TRUE;
345     }
346     /* walk through the queue from top down since the new packet is in 
347     most cases just appended to the end */
348
349     for( ;; )
350     {
351         i_tmp = i_new - (uint16_t) p->i_dts;
352
353         if( !i_tmp )   /* trash duplicate */
354             break; 
355
356         if ( i_tmp < 32768 )
357         {   /* insert after this block ( i_new > p->i_dts ) */
358             p_block->p_next = p->p_next;
359             p->p_next = p_block;
360             p_block->p_prev = p;
361             if (p_prev)
362             {
363                 p_prev->p_prev = p_block;
364                 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d", 
365                     (uint16_t) p->i_dts, i_new );
366             }
367             else 
368             {
369                 p_sys->p_end = p_block;
370             }
371             return VLC_TRUE;
372         }
373         if( p == p_sys->p_list )
374         {   /* we've reached bottom of chain */
375             i_tmp = p_sys->i_last_seqno - i_new;
376             if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
377             {
378                 msg_Dbg(p_access, "RTP reordering: prepend %d before %d", 
379                         i_new, (uint16_t) p->i_dts );
380                 p_block->p_next = p;
381                 p->p_prev = p_block;
382                 p_sys->p_list = p_block;
383                 return VLC_TRUE;
384             }
385
386             if( !i_tmp )   /* trash duplicate */
387                 break;    
388
389             /* reordering failed - append the packet to the end of queue */
390             msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
391                 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts, 
392                 (uint16_t) p_sys->p_end->i_dts);
393             p_sys->p_end->p_next = p_block;
394             p_block->p_prev = p_sys->p_end;
395             p_sys->p_end = p_block;
396             return VLC_TRUE;
397         }
398         p_prev = p;
399         p = p->p_prev;
400     }
401     block_Release( p_block );
402     return VLC_FALSE;
403 }
404
405 /*****************************************************************************
406  * BlockParseRTP/BlockRTP:
407  *****************************************************************************/
408 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
409 {
410     int      i_rtp_version;
411     int      i_CSRC_count;
412     int      i_payload_type;
413     int      i_skip = 0;
414     int      i_extension_flag = 0;
415     int      i_extension_length = 0;
416     uint16_t i_sequence_number = 0;
417
418     if( p_block == NULL )
419         return NULL;
420
421     if( p_block->i_buffer < RTP_HEADER_LEN )
422         goto trash;
423
424     /* Parse the header and make some verifications.
425      * See RFC 3550. */
426     i_rtp_version     = ( p_block->p_buffer[0] & 0xC0 ) >> 6;
427     i_CSRC_count      = p_block->p_buffer[0] & 0x0F;
428     i_extension_flag  = p_block->p_buffer[0] & 0x10;
429     i_payload_type    = p_block->p_buffer[1] & 0x7F;
430     i_sequence_number = (p_block->p_buffer[2] << 8 ) + p_block->p_buffer[3];
431
432     if( i_rtp_version != 2 )
433         msg_Dbg( p_access, "RTP version is %u, should be 2", i_rtp_version );
434
435     if( i_payload_type == 14 || i_payload_type == 32)
436         i_skip = 4;
437     else if( i_payload_type !=  33 )
438         msg_Dbg( p_access, "unsupported RTP payload type (%u)", i_payload_type );
439     if( i_extension_flag )
440         i_extension_length = 4 +
441             4 * ( (p_block->p_buffer[14] << 8) + p_block->p_buffer[15] );
442
443     /* Skip header + CSRC extension field n*(32 bits) + extension */
444     i_skip += RTP_HEADER_LEN + 4*i_CSRC_count + i_extension_length;
445
446     if( i_skip >= p_block->i_buffer )
447         goto trash;
448
449     /* Return the packet without the RTP header, remember seqno in i_dts */
450     p_block->i_buffer -= i_skip;
451     p_block->p_buffer += i_skip;
452     p_block->i_pts = mdate();
453     p_block->i_dts = (mtime_t) i_sequence_number;
454
455 #if 0
456     /* Emulate packet loss */
457     if ( (i_sequence_number % 4000) == 0)
458     {
459         msg_Warn( p_access, "Emulating packet drop" );
460         block_Release( p_block );
461         return NULL;
462     }
463 #endif
464
465     return p_block;
466
467
468 trash:
469     msg_Warn( p_access, "received a too short packet for RTP" );
470     block_Release( p_block );
471     return NULL;
472 }
473
474 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
475 {
476     access_sys_t *p_sys = p_access->p_sys;
477     mtime_t   i_first = mdate();
478     int       i_count = 0;
479     block_t   *p = p_block;
480
481     for( ;; )
482     {
483         mtime_t i_date = mdate();
484
485         if( p && rtp_ChainInsert( p_access, p ))
486             i_count++;
487
488         /* Require at least 2 packets in the buffer */
489         if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
490             break;
491
492         p = BlockParseRTP( p_access, BlockUDP( p_access ));
493         if( !p && (i_date - i_first) > p_sys->i_rtp_late ) 
494         {
495             msg_Err( p_access, "error in RTP prebuffering!" );
496             break;
497         }
498     }
499
500     msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
501     p_access->info.b_prebuffered = VLC_TRUE;
502     p = p_sys->p_list;
503     p_sys->p_list = p_sys->p_list->p_next;
504     p_sys->i_last_seqno = (uint16_t) p->i_dts;
505     p->p_next = NULL;
506     return p;
507 }
508
509 static block_t *BlockRTP( access_t *p_access )
510 {
511     access_sys_t *p_sys = p_access->p_sys;
512     block_t *p;
513
514     while ( !p_sys->p_list || 
515              ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
516     {
517         p = BlockParseRTP( p_access, BlockUDP( p_access ));
518
519         if ( !p ) 
520             return NULL;
521
522         rtp_ChainInsert( p_access, p );
523     }
524
525     p = p_sys->p_list;
526     p_sys->p_list = p_sys->p_list->p_next;
527     p_sys->i_last_seqno++;
528     if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
529     {
530         msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
531                  p_sys->i_last_seqno, (uint16_t) p->i_dts );
532         p_sys->i_last_seqno = (uint16_t) p->i_dts;
533     }
534     p->p_next = NULL;
535     return p;
536 }
537
538 /*****************************************************************************
539  * BlockChoose: decide between RTP and UDP
540  *****************************************************************************/
541 static block_t *BlockChoose( access_t *p_access )
542 {
543     block_t *p_block;
544     int     i_rtp_version;
545     int     i_CSRC_count;
546     int     i_payload_type;
547
548     if( ( p_block = BlockUDP( p_access ) ) == NULL )
549         return NULL;
550
551     if( p_block->p_buffer[0] == 0x47 )
552     {
553         msg_Dbg( p_access, "detected TS over raw UDP" );
554         p_access->pf_block = BlockUDP;
555         p_access->info.b_prebuffered = VLC_TRUE;
556         return p_block;
557     }
558
559     if( p_block->i_buffer < RTP_HEADER_LEN )
560         return p_block;
561
562     /* Parse the header and make some verifications.
563      * See RFC 3550. */
564
565     i_rtp_version  = ( p_block->p_buffer[0] & 0xC0 ) >> 6;
566     i_CSRC_count   = ( p_block->p_buffer[0] & 0x0F );
567     i_payload_type = ( p_block->p_buffer[1] & 0x7F );
568
569     if( i_rtp_version != 2 )
570     {
571         msg_Dbg( p_access, "no supported RTP header detected" );
572         p_access->pf_block = BlockUDP;
573         p_access->info.b_prebuffered = VLC_TRUE;
574         return p_block;
575     }
576
577     switch( i_payload_type )
578     {
579         case 33:
580             msg_Dbg( p_access, "detected TS over RTP" );
581             p_access->psz_demux = strdup( "ts" );
582             break;
583
584         case 14:
585             msg_Dbg( p_access, "detected MPEG audio over RTP" );
586             p_access->psz_demux = strdup( "mpga" );
587             break;
588
589         case 32:
590             msg_Dbg( p_access, "detected MPEG video over RTP" );
591             p_access->psz_demux = strdup( "mpgv" );
592             break;
593
594         default:
595             msg_Dbg( p_access, "no RTP header detected" );
596             p_access->pf_block = BlockUDP;
597             p_access->info.b_prebuffered = VLC_TRUE;
598             return p_block;
599     }
600
601     if( !BlockParseRTP( p_access, p_block )) return NULL;
602
603     p_access->pf_block = BlockRTP;
604
605     return BlockPrebufferRTP( p_access, p_block );
606 }