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" ); /* tcp name is already taken */
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 *BlockStartRTP( 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, b_comedia;
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 /* Set up p_access */
137 access_InitFields( p_access );
138 ACCESS_SET_CALLBACKS( NULL, BlockStartRTP, Control, NULL );
139 p_access->info.b_prebuffered = VLC_FALSE;
140 MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
141 memset (p_sys, 0, sizeof (*p_sys));
143 if (strlen (p_access->psz_access) > 0)
145 switch (p_access->psz_access[strlen (p_access->psz_access) - 1])
156 if (strcmp (p_access->psz_access, "udplite") == 0)
157 proto = IPPROTO_UDPLITE;
159 if (strncmp (p_access->psz_access, "udp", 3 ) == 0 )
160 p_access->pf_block = BlockChoose;
162 if (strcmp (p_access->psz_access, "rtptcp") == 0)
165 if (strcmp (p_access->psz_access, "dccp") == 0)
166 proto = IPPROTO_DCCP;
169 i_bind_port = var_CreateGetInteger( p_access, "server-port" );
171 /* Parse psz_name syntax :
172 * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
173 psz_parser = strchr( psz_name, '@' );
174 if( psz_parser != NULL )
176 /* Found bind address and/or bind port */
177 *psz_parser++ = '\0';
178 psz_bind_addr = psz_parser;
180 if( psz_bind_addr[0] == '[' )
181 /* skips bracket'd IPv6 address */
182 psz_parser = strchr( psz_parser, ']' );
184 if( psz_parser != NULL )
186 psz_parser = strchr( psz_parser, ':' );
187 if( psz_parser != NULL )
189 *psz_parser++ = '\0';
190 i_bind_port = atoi( psz_parser );
195 psz_server_addr = psz_name;
196 psz_parser = ( psz_server_addr[0] == '[' )
197 ? strchr( psz_name, ']' ) /* skips bracket'd IPv6 address */
200 if( psz_parser != NULL )
202 psz_parser = strchr( psz_parser, ':' );
203 if( psz_parser != NULL )
205 *psz_parser++ = '\0';
206 i_server_port = atoi( psz_parser );
210 msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
211 psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
213 /* Hmm, the net_* connection functions may need to be unified... */
217 case IPPROTO_UDPLITE:
218 p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
219 psz_server_addr, i_server_port, fam,
224 p_sys->fd = net_ConnectTCP( p_access, psz_server_addr, i_server_port );
225 p_access->pf_block = BlockRTP;
226 p_sys->b_comedia = p_sys->b_framed_rtp = VLC_TRUE;
231 p_sys->fd = net_Connect( p_access, psz_server_addr, i_server_port,
232 SOCK_DCCP, IPPROTO_DCCP );
235 msg_Err( p_access, "DCCP support not compiled-in!" );
237 p_sys->b_comedia = VLC_TRUE;
241 if( p_sys->fd == -1 )
243 msg_Err( p_access, "cannot open socket" );
248 shutdown( p_sys->fd, SHUT_WR );
249 net_SetCSCov (p_sys->fd, -1, 12);
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:
311 case ACCESS_GET_CONTENT_TYPE:
315 msg_Warn( p_access, "unimplemented query in control" );
322 /*****************************************************************************
324 *****************************************************************************/
325 static block_t *BlockUDP( access_t *p_access )
327 access_sys_t *p_sys = p_access->p_sys;
331 if( p_access->info.b_eof )
335 p_block = block_New( p_access, MTU );
336 len = net_Read( p_access, p_sys->fd, NULL,
337 p_block->p_buffer, MTU, VLC_FALSE );
339 || ( p_sys->b_comedia && ( len == 0 ) ) )
341 if( p_sys->b_comedia )
343 p_access->info.b_eof = VLC_TRUE;
344 msg_Dbg( p_access, "connection-oriented media hangup" );
346 block_Release( p_block );
350 return block_Realloc( p_block, 0, p_block->i_buffer = len );
353 /*****************************************************************************
354 * BlockTCP: Framed RTP/AVP packet reception for COMEDIA (see RFC4571)
355 *****************************************************************************/
356 static block_t *BlockTCP( access_t *p_access )
358 access_sys_t *p_sys = p_access->p_sys;
359 block_t *p_block = p_sys->p_partial_frame;
361 if( p_access->info.b_eof )
364 if( p_block == NULL )
366 /* MTU should always be 65535 in this case */
367 p_sys->p_partial_frame = p_block = block_New( p_access, 2 + MTU );
372 /* Read RTP framing */
373 if (p_block->i_buffer < 2)
375 int i_read = net_Read( p_access, p_sys->fd, NULL,
376 p_block->p_buffer + p_block->i_buffer,
377 2 - p_block->i_buffer, VLC_FALSE );
381 p_block->i_buffer += i_read;
382 if (p_block->i_buffer < 2)
386 uint16_t framelen = GetWLE( p_block->p_buffer );
390 int i_read = net_Read( p_access, p_sys->fd, NULL,
391 p_block->p_buffer + p_block->i_buffer,
392 2 + framelen - p_block->i_buffer, VLC_FALSE );
396 p_block->i_buffer += i_read;
399 if( p_block->i_buffer < (2u + framelen) )
400 return NULL; // incomplete frame
402 /* Hide framing from RTP layer */
403 p_block->p_buffer += 2;
404 p_block->i_buffer -= 2;
405 p_sys->p_partial_frame = NULL;
409 p_access->info.b_eof = VLC_TRUE;
410 block_Release( p_block );
411 p_sys->p_partial_frame = NULL;
417 * rtp_ChainInsert - insert a p_block in the chain and
418 * look at the sequence numbers.
420 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
422 access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
423 block_t *p_prev = NULL;
424 block_t *p = p_sys->p_end;
425 uint16_t i_new = (uint16_t) p_block->i_dts;
430 p_sys->p_list = p_block;
431 p_sys->p_end = p_block;
434 /* walk through the queue from top down since the new packet is in
435 most cases just appended to the end */
439 i_tmp = i_new - (uint16_t) p->i_dts;
441 if( !i_tmp ) /* trash duplicate */
445 { /* insert after this block ( i_new > p->i_dts ) */
446 p_block->p_next = p->p_next;
451 p_prev->p_prev = p_block;
452 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d",
453 (uint16_t) p->i_dts, i_new );
457 p_sys->p_end = p_block;
461 if( p == p_sys->p_list )
462 { /* we've reached bottom of chain */
463 i_tmp = p_sys->i_last_seqno - i_new;
464 if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
466 msg_Dbg(p_access, "RTP reordering: prepend %d before %d",
467 i_new, (uint16_t) p->i_dts );
470 p_sys->p_list = p_block;
474 if( !i_tmp ) /* trash duplicate */
477 /* reordering failed - append the packet to the end of queue */
478 msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
479 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts,
480 (uint16_t) p_sys->p_end->i_dts);
481 p_sys->p_end->p_next = p_block;
482 p_block->p_prev = p_sys->p_end;
483 p_sys->p_end = p_block;
489 block_Release( p_block );
493 /*****************************************************************************
494 * BlockParseRTP: decapsulate the RTP packet and return it
495 *****************************************************************************/
496 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
499 size_t i_skip = RTP_HEADER_LEN;
501 if( p_block == NULL )
504 if( p_block->i_buffer < RTP_HEADER_LEN )
506 msg_Dbg( p_access, "short RTP packet received" );
510 /* Parse the header and make some verifications.
513 if( ( p_block->p_buffer[0] >> 6 ) != 2)
515 msg_Dbg( p_access, "RTP version is %u instead of 2",
516 p_block->p_buffer[0] >> 6 );
520 uint8_t pad = (p_block->p_buffer[0] & 0x20)
521 ? p_block->p_buffer[p_block->i_buffer - 1] : 0;
523 i_skip += (p_block->p_buffer[0] & 0x0F) * 4;
525 if (p_block->p_buffer[0] & 0x10) /* Extension header */
528 if ((size_t)p_block->i_buffer < i_skip)
531 i_skip += 4 * GetWBE( p_block->p_buffer + i_skip - 2 );
534 i_payload_type = p_block->p_buffer[1] & 0x7F;
536 /* Remember sequence number in i_dts */
537 p_block->i_pts = mdate();
538 p_block->i_dts = (mtime_t) GetWBE( p_block->p_buffer + 2 );
540 /* FIXME: use rtpmap */
541 const char *psz_demux = NULL;
543 switch( i_payload_type )
545 case 14: // MPA: MPEG Audio (RFC2250, §3.4)
546 i_skip += 4; // 32 bits RTP/MPA header
550 case 32: // MPV: MPEG Video (RFC2250, §3.5)
551 i_skip += 4; // 32 bits RTP/MPV header
552 if( (size_t)p_block->i_buffer < i_skip )
554 if( p_block->p_buffer[i_skip - 3] & 0x4 )
556 /* MPEG2 Video extension header */
557 /* TODO: shouldn't we skip this too ? */
562 case 33: // MP2: MPEG TS (RFC2250, §2)
563 /* plain TS over RTP */
567 case 72: /* muxed SR */
568 case 73: /* muxed RR */
569 case 74: /* muxed SDES */
570 case 75: /* muxed BYE */
571 case 76: /* muxed APP */
572 goto trash; /* ooh! ignoring RTCP is evil! */
575 msg_Dbg( p_access, "unsupported RTP payload type: %u", i_payload_type );
579 if( (size_t)p_block->i_buffer < (i_skip + pad) )
582 /* Remove the RTP header */
583 p_block->i_buffer -= i_skip;
584 p_block->p_buffer += i_skip;
586 /* This is the place for deciphering and authentication */
588 /* Remove padding (at the end) */
589 p_block->i_buffer -= pad;
592 /* Emulate packet loss */
593 if ( (i_sequence_number % 4000) == 0)
595 msg_Warn( p_access, "Emulating packet drop" );
596 block_Release( p_block );
601 if( !p_access->psz_demux || !*p_access->psz_demux )
603 free( p_access->psz_demux );
604 p_access->psz_demux = strdup( psz_demux );
610 block_Release( p_block );
614 /*****************************************************************************
615 * BlockRTP: receives an RTP packet, parses it, queues it queue,
616 * then dequeues the oldest packet and returns it to input/demux.
617 ****************************************************************************/
618 static block_t *BlockRTP( access_t *p_access )
620 access_sys_t *p_sys = p_access->p_sys;
623 while ( !p_sys->p_list ||
624 ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
626 p = BlockParseRTP( p_access,
627 p_sys->b_framed_rtp ? BlockTCP( p_access )
628 : BlockUDP( p_access ) );
632 rtp_ChainInsert( p_access, p );
636 p_sys->p_list = p_sys->p_list->p_next;
637 p_sys->i_last_seqno++;
638 if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
640 msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
641 p_sys->i_last_seqno, (uint16_t) p->i_dts );
642 p_sys->i_last_seqno = (uint16_t) p->i_dts;
648 /*****************************************************************************
649 * BlockPrebufferRTP: waits until we have at least two RTP datagrams,
650 * so that we can synchronize the RTP sequence number.
651 * This is only useful for non-reliable transport protocols.
652 ****************************************************************************/
653 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
655 access_sys_t *p_sys = p_access->p_sys;
656 mtime_t i_first = mdate();
658 block_t *p = p_block;
660 if( BlockParseRTP( p_access, p_block ) == NULL )
665 mtime_t i_date = mdate();
667 if( p && rtp_ChainInsert( p_access, p ))
670 /* Require at least 2 packets in the buffer */
671 if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
674 p = BlockParseRTP( p_access, BlockUDP( p_access ) );
675 if( !p && (i_date - i_first) > p_sys->i_rtp_late )
677 msg_Err( p_access, "error in RTP prebuffering!" );
682 msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
683 p_access->info.b_prebuffered = VLC_TRUE;
685 p_sys->p_list = p_sys->p_list->p_next;
686 p_sys->i_last_seqno = (uint16_t) p->i_dts;
691 static block_t *BlockStartRTP( access_t *p_access )
693 p_access->pf_block = BlockRTP;
694 return BlockPrebufferRTP( p_access, BlockUDP( p_access ) );
698 /*****************************************************************************
699 * BlockChoose: decide between RTP and UDP
700 *****************************************************************************/
701 static block_t *BlockChoose( access_t *p_access )
707 if( ( p_block = BlockUDP( p_access ) ) == NULL )
710 if( p_block->p_buffer[0] == 0x47 )
712 msg_Dbg( p_access, "detected TS over raw UDP" );
713 p_access->pf_block = BlockUDP;
714 p_access->info.b_prebuffered = VLC_TRUE;
718 if( p_block->i_buffer < RTP_HEADER_LEN )
721 /* Parse the header and make some verifications.
724 i_rtp_version = p_block->p_buffer[0] >> 6;
725 i_payload_type = ( p_block->p_buffer[1] & 0x7F );
727 if( i_rtp_version != 2 )
729 msg_Dbg( p_access, "no supported RTP header detected" );
730 p_access->pf_block = BlockUDP;
731 p_access->info.b_prebuffered = VLC_TRUE;
735 switch( i_payload_type )
738 msg_Dbg( p_access, "detected MPEG2 TS over RTP" );
739 p_access->psz_demux = strdup( "ts" );
743 msg_Dbg( p_access, "detected MPEG Audio over RTP" );
744 p_access->psz_demux = strdup( "mpga" );
748 msg_Dbg( p_access, "detected MPEG Video over RTP" );
749 p_access->psz_demux = strdup( "mpgv" );
753 msg_Dbg( p_access, "no RTP header detected" );
754 p_access->pf_block = BlockUDP;
755 p_access->info.b_prebuffered = VLC_TRUE;
759 p_access->pf_block = BlockRTP;
760 return BlockPrebufferRTP( p_access, p_block );