1 /*****************************************************************************
2 * udp.c: raw UDP & RTP input module
3 *****************************************************************************
4 * Copyright (C) 2001-2005 the VideoLAN team
5 * Copyright (C) 2007 Remi Denis-Courmont
8 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * Tristan Leteurtre <tooney@via.ecp.fr>
10 * Laurent Aimar <fenrir@via.ecp.fr>
11 * Jean-Paul Saman <jpsaman #_at_# m2x dot nl>
14 * Reviewed: 23 October 2003, Jean-Paul Saman <jpsaman _at_ videolan _dot_ org>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
29 *****************************************************************************/
31 /*****************************************************************************
33 *****************************************************************************/
36 #include <vlc_access.h>
37 #include <vlc_network.h>
39 #ifndef SOCK_DCCP /* provisional API */
46 # define IPPROTO_DCCP 33 /* IANA */
49 #ifndef IPPROTO_UDPLITE
50 # define IPPROTO_UDPLITE 136 /* from IANA */
55 /*****************************************************************************
57 *****************************************************************************/
58 #define CACHING_TEXT N_("Caching value in ms")
59 #define CACHING_LONGTEXT N_( \
60 "Caching value for UDP streams. This " \
61 "value should be set in milliseconds." )
63 #define RTP_LATE_TEXT N_("RTP reordering timeout in ms")
64 #define RTP_LATE_LONGTEXT N_( \
65 "VLC reorders RTP packets. The input will wait for late packets at most "\
66 "the time specified here (in milliseconds)." )
68 static int Open ( vlc_object_t * );
69 static void Close( vlc_object_t * );
72 set_shortname( _("UDP/RTP" ) );
73 set_description( _("UDP/RTP input") );
74 set_category( CAT_INPUT );
75 set_subcategory( SUBCAT_INPUT_ACCESS );
77 add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
78 CACHING_LONGTEXT, VLC_TRUE );
79 add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
80 add_obsolete_bool( "udp-auto-mtu" );
82 set_capability( "access2", 0 );
83 add_shortcut( "udp" );
84 add_shortcut( "udpstream" );
85 add_shortcut( "udp4" );
86 add_shortcut( "udp6" );
87 add_shortcut( "rtp" );
88 add_shortcut( "rtp4" );
89 add_shortcut( "rtp6" );
90 add_shortcut( "udplite" );
91 add_shortcut( "rtptcp" );
92 add_shortcut( "dccp" );
94 set_callbacks( Open, Close );
97 /*****************************************************************************
99 *****************************************************************************/
100 #define RTP_HEADER_LEN 12
102 static block_t *BlockUDP( access_t * );
103 static block_t *BlockTCP( access_t * );
104 static block_t *BlockRTP( access_t * );
105 static block_t *BlockChoose( access_t * );
106 static int Control( access_t *, int, va_list );
112 vlc_bool_t b_framed_rtp;
114 /* reorder rtp packets when out-of-sequence */
115 uint16_t i_last_seqno;
119 block_t *p_partial_frame; /* Partial Framed RTP packet */
122 /*****************************************************************************
123 * Open: open the socket
124 *****************************************************************************/
125 static int Open( vlc_object_t *p_this )
127 access_t *p_access = (access_t*)p_this;
130 char *psz_name = strdup( p_access->psz_path );
132 const char *psz_server_addr, *psz_bind_addr = "";
133 int i_bind_port, i_server_port = 0;
134 int fam = AF_UNSPEC, proto = IPPROTO_UDP;
136 if (strlen (p_access->psz_access) >= 3)
138 switch (p_access->psz_access[3])
148 if (strcmp (p_access->psz_access + 3, "lite") == 0)
149 proto = IPPROTO_UDPLITE;
151 if (strcmp (p_access->psz_access + 3, "tcp") == 0)
154 if (strcmp (p_access->psz_access, "dccp") == 0)
155 proto = IPPROTO_DCCP;
158 i_bind_port = var_CreateGetInteger( p_access, "server-port" );
160 /* Parse psz_name syntax :
161 * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
162 psz_parser = strchr( psz_name, '@' );
163 if( psz_parser != NULL )
165 /* Found bind address and/or bind port */
166 *psz_parser++ = '\0';
167 psz_bind_addr = psz_parser;
169 if( psz_bind_addr[0] == '[' )
170 /* skips bracket'd IPv6 address */
171 psz_parser = strchr( psz_parser, ']' );
173 if( psz_parser != NULL )
175 psz_parser = strchr( psz_parser, ':' );
176 if( psz_parser != NULL )
178 *psz_parser++ = '\0';
179 i_bind_port = atoi( psz_parser );
184 psz_server_addr = psz_name;
185 psz_parser = ( psz_server_addr[0] == '[' )
186 ? strchr( psz_name, ']' ) /* skips bracket'd IPv6 address */
189 if( psz_parser != NULL )
191 psz_parser = strchr( psz_parser, ':' );
192 if( psz_parser != NULL )
194 *psz_parser++ = '\0';
195 i_server_port = atoi( psz_parser );
199 msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
200 psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
202 /* Set up p_access */
203 access_InitFields( p_access );
204 ACCESS_SET_CALLBACKS( NULL, BlockChoose, Control, NULL );
205 p_access->info.b_prebuffered = VLC_FALSE;
206 MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
207 memset (p_sys, 0, sizeof (*p_sys));
212 case IPPROTO_UDPLITE:
213 p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
214 psz_server_addr, i_server_port, fam,
219 p_sys->fd = net_ConnectTCP( p_access, psz_server_addr, i_server_port );
220 p_sys->b_framed_rtp = VLC_TRUE;
225 p_sys->fd = net_Connect( p_access, psz_server_addr, i_server_port,
226 SOCK_DCCP, IPPROTO_DCCP );
229 msg_Err( p_access, "DCCP support not compiled-in!" );
234 if( p_sys->fd == -1 )
236 msg_Err( p_access, "cannot open socket" );
241 shutdown( p_sys->fd, SHUT_WR );
243 net_SetCSCov (p_sys->fd, -1, 12);
245 if (p_sys->b_framed_rtp)
247 /* We don't do autodetection and prebuffering in case of framing */
248 p_access->pf_block = BlockRTP;
251 /* Update default_pts to a suitable value for udp access */
252 var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
254 /* RTP reordering for out-of-sequence packets */
255 p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
256 p_sys->i_last_seqno = 0;
257 p_sys->p_list = NULL;
262 /*****************************************************************************
263 * Close: free unused data structures
264 *****************************************************************************/
265 static void Close( vlc_object_t *p_this )
267 access_t *p_access = (access_t*)p_this;
268 access_sys_t *p_sys = p_access->p_sys;
270 block_ChainRelease( p_sys->p_list );
271 net_Close( p_sys->fd );
275 /*****************************************************************************
277 *****************************************************************************/
278 static int Control( access_t *p_access, int i_query, va_list args )
287 case ACCESS_CAN_SEEK:
288 case ACCESS_CAN_FASTSEEK:
289 case ACCESS_CAN_PAUSE:
290 case ACCESS_CAN_CONTROL_PACE:
291 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
292 *pb_bool = VLC_FALSE;
296 pi_int = (int*)va_arg( args, int * );
300 case ACCESS_GET_PTS_DELAY:
301 pi_64 = (int64_t*)va_arg( args, int64_t * );
302 *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
306 case ACCESS_SET_PAUSE_STATE:
307 case ACCESS_GET_TITLE_INFO:
308 case ACCESS_SET_TITLE:
309 case ACCESS_SET_SEEKPOINT:
310 case ACCESS_SET_PRIVATE_ID_STATE:
314 msg_Warn( p_access, "unimplemented query in control" );
321 /*****************************************************************************
323 *****************************************************************************/
324 static block_t *BlockUDP( access_t *p_access )
326 access_sys_t *p_sys = p_access->p_sys;
330 p_block = block_New( p_access, MTU );
331 p_block->i_buffer = net_Read( p_access, p_sys->fd, NULL,
332 p_block->p_buffer, MTU, VLC_FALSE );
333 if( p_block->i_buffer < 0 )
335 block_Release( p_block );
339 return block_Realloc( p_block, 0, p_block->i_buffer );
342 /*****************************************************************************
343 * BlockTCP: Framed RTP/AVP packet reception for COMEDIA (see RFC4571)
344 *****************************************************************************/
345 static block_t *BlockTCP( access_t *p_access )
347 access_sys_t *p_sys = p_access->p_sys;
348 block_t *p_block = p_sys->p_partial_frame;
350 if( p_access->info.b_eof )
353 if( p_block == NULL )
355 /* MTU should always be 65535 in this case */
356 p_sys->p_partial_frame = p_block = block_New( p_access, 2 + MTU );
361 /* Read RTP framing */
362 if (p_block->i_buffer < 2)
364 /* FIXME: not very efficient */
365 int i_read = net_Read( p_access, p_sys->fd, NULL,
366 p_block->p_buffer + p_block->i_buffer,
367 2 - p_block->i_buffer, VLC_FALSE );
371 p_block->i_buffer += i_read;
372 if (p_block->i_buffer < 2)
376 uint16_t framelen = GetWLE( p_block->p_buffer );
380 int i_read = net_Read( p_access, p_sys->fd, NULL,
381 p_block->p_buffer + p_block->i_buffer,
382 2 + framelen - p_block->i_buffer, VLC_FALSE );
386 p_block->i_buffer += i_read;
389 if( p_block->i_buffer < (2 + framelen) )
390 return NULL; // incomplete frame
392 /* Hide framing from RTP layer */
393 p_block->p_buffer += 2;
394 p_block->i_buffer -= 2;
395 p_sys->p_partial_frame = NULL;
399 p_access->info.b_eof = VLC_TRUE;
400 block_Release( p_block );
401 p_sys->p_partial_frame = NULL;
407 * rtp_ChainInsert - insert a p_block in the chain and
408 * look at the sequence numbers.
410 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
412 access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
413 block_t *p_prev = NULL;
414 block_t *p = p_sys->p_end;
415 uint16_t i_new = (uint16_t) p_block->i_dts;
420 p_sys->p_list = p_block;
421 p_sys->p_end = p_block;
424 /* walk through the queue from top down since the new packet is in
425 most cases just appended to the end */
429 i_tmp = i_new - (uint16_t) p->i_dts;
431 if( !i_tmp ) /* trash duplicate */
435 { /* insert after this block ( i_new > p->i_dts ) */
436 p_block->p_next = p->p_next;
441 p_prev->p_prev = p_block;
442 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d",
443 (uint16_t) p->i_dts, i_new );
447 p_sys->p_end = p_block;
451 if( p == p_sys->p_list )
452 { /* we've reached bottom of chain */
453 i_tmp = p_sys->i_last_seqno - i_new;
454 if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
456 msg_Dbg(p_access, "RTP reordering: prepend %d before %d",
457 i_new, (uint16_t) p->i_dts );
460 p_sys->p_list = p_block;
464 if( !i_tmp ) /* trash duplicate */
467 /* reordering failed - append the packet to the end of queue */
468 msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
469 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts,
470 (uint16_t) p_sys->p_end->i_dts);
471 p_sys->p_end->p_next = p_block;
472 p_block->p_prev = p_sys->p_end;
473 p_sys->p_end = p_block;
479 block_Release( p_block );
483 /*****************************************************************************
484 * BlockParseRTP/BlockRTP:
485 *****************************************************************************/
486 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
489 size_t i_skip = RTP_HEADER_LEN;
491 if( p_block == NULL )
494 if( p_block->i_buffer < RTP_HEADER_LEN )
496 msg_Dbg( p_access, "short RTP packet received" );
500 /* Parse the header and make some verifications.
503 if( ( p_block->p_buffer[0] >> 6 ) != 2)
505 msg_Dbg( p_access, "RTP version is %u instead of 2",
506 p_block->p_buffer[0] >> 6 );
510 uint8_t pad = (p_block->p_buffer[0] & 0x20)
511 ? p_block->p_buffer[p_block->i_buffer - 1] : 0;
513 i_skip += (p_block->p_buffer[0] & 0x0F) * 4;
515 if (p_block->p_buffer[0] & 0x10) /* Extension header */
518 if ((size_t)p_block->i_buffer < i_skip)
521 i_skip += 4 * GetWBE( p_block->p_buffer + i_skip - 2 );
524 i_payload_type = p_block->p_buffer[1] & 0x7F;
526 /* Remember sequence number in i_dts */
527 p_block->i_pts = mdate();
528 p_block->i_dts = (mtime_t) GetWBE( p_block->p_buffer + 2 );
530 /* FIXME: use rtpmap */
531 switch( i_payload_type )
533 case 14: // MPA: MPEG Audio (RFC2250, §3.4)
534 i_skip += 4; // 32 bits RTP/MPA header
537 case 32: // MPV: MPEG Video (RFC2250, §3.5)
538 i_skip += 4; // 32 bits RTP/MPV header
539 if( (size_t)p_block->i_buffer < i_skip )
541 if( p_block->p_buffer[i_skip - 3] & 0x4 )
543 /* MPEG2 Video extension header */
544 /* TODO: shouldn't we skip this too ? */
548 case 33: // MP2: MPEG TS (RFC2250, §2)
549 /* plain TS over RTP */
553 msg_Dbg( p_access, "unsupported RTP payload type: %u", i_payload_type );
557 if( (size_t)p_block->i_buffer < (i_skip + pad) )
560 /* Remove the RTP header */
561 p_block->i_buffer -= i_skip;
562 p_block->p_buffer += i_skip;
564 /* This is the place for deciphering and authentication */
566 /* Remove padding (at the end) */
567 p_block->i_buffer -= pad;
570 /* Emulate packet loss */
571 if ( (i_sequence_number % 4000) == 0)
573 msg_Warn( p_access, "Emulating packet drop" );
574 block_Release( p_block );
582 block_Release( p_block );
586 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
588 access_sys_t *p_sys = p_access->p_sys;
589 mtime_t i_first = mdate();
591 block_t *p = p_block;
595 mtime_t i_date = mdate();
597 if( p && rtp_ChainInsert( p_access, p ))
600 /* Require at least 2 packets in the buffer */
601 if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
604 p = BlockParseRTP( p_access, BlockUDP( p_access ) );
605 if( !p && (i_date - i_first) > p_sys->i_rtp_late )
607 msg_Err( p_access, "error in RTP prebuffering!" );
612 msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
613 p_access->info.b_prebuffered = VLC_TRUE;
615 p_sys->p_list = p_sys->p_list->p_next;
616 p_sys->i_last_seqno = (uint16_t) p->i_dts;
621 static block_t *BlockRTP( access_t *p_access )
623 access_sys_t *p_sys = p_access->p_sys;
626 while ( !p_sys->p_list ||
627 ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
629 p = BlockParseRTP( p_access,
630 p_sys->b_framed_rtp ? BlockTCP( p_access )
631 : BlockUDP( p_access ) );
635 rtp_ChainInsert( p_access, p );
639 p_sys->p_list = p_sys->p_list->p_next;
640 p_sys->i_last_seqno++;
641 if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
643 msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
644 p_sys->i_last_seqno, (uint16_t) p->i_dts );
645 p_sys->i_last_seqno = (uint16_t) p->i_dts;
651 /*****************************************************************************
652 * BlockChoose: decide between RTP and UDP
653 *****************************************************************************/
654 static block_t *BlockChoose( access_t *p_access )
660 if( ( p_block = BlockUDP( p_access ) ) == NULL )
663 if( p_block->p_buffer[0] == 0x47 )
665 msg_Dbg( p_access, "detected TS over raw UDP" );
666 p_access->pf_block = BlockUDP;
667 p_access->info.b_prebuffered = VLC_TRUE;
671 if( p_block->i_buffer < RTP_HEADER_LEN )
674 /* Parse the header and make some verifications.
677 i_rtp_version = p_block->p_buffer[0] >> 6;
678 i_payload_type = ( p_block->p_buffer[1] & 0x7F );
680 if( i_rtp_version != 2 )
682 msg_Dbg( p_access, "no supported RTP header detected" );
683 p_access->pf_block = BlockUDP;
684 p_access->info.b_prebuffered = VLC_TRUE;
688 switch( i_payload_type )
691 msg_Dbg( p_access, "detected MPEG2 TS over RTP" );
692 p_access->psz_demux = strdup( "ts" );
696 msg_Dbg( p_access, "detected MPEG Audio over RTP" );
697 p_access->psz_demux = strdup( "mpga" );
701 msg_Dbg( p_access, "detected MPEG Video over RTP" );
702 p_access->psz_demux = strdup( "mpgv" );
706 msg_Dbg( p_access, "no RTP header detected" );
707 p_access->pf_block = BlockUDP;
708 p_access->info.b_prebuffered = VLC_TRUE;
712 if( !BlockParseRTP( p_access, p_block )) return NULL;
714 p_access->pf_block = BlockRTP;
716 return BlockPrebufferRTP( p_access, p_block );