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 /* Big pile of stuff missing form glibc 2.5 */
40 #if defined (HAVE_NETINET_UDPLITE_H)
41 # include <netinet/udplite.h>
42 #elif defined (__linux__)
43 # define UDPLITE_SEND_CSCOV 10
44 # define UDPLITE_RECV_CSCOV 11
47 #ifndef SOCK_DCCP /* provisional API */
54 # define IPPROTO_DCCP 33 /* IANA */
57 #ifndef IPPROTO_UDPLITE
58 # define IPPROTO_UDPLITE 136 /* from IANA */
61 # define SOL_UDPLITE IPPROTO_UDPLITE
66 /*****************************************************************************
68 *****************************************************************************/
69 #define CACHING_TEXT N_("Caching value in ms")
70 #define CACHING_LONGTEXT N_( \
71 "Caching value for UDP streams. This " \
72 "value should be set in milliseconds." )
74 #define RTP_LATE_TEXT N_("RTP reordering timeout in ms")
75 #define RTP_LATE_LONGTEXT N_( \
76 "VLC reorders RTP packets. The input will wait for late packets at most "\
77 "the time specified here (in milliseconds)." )
79 static int Open ( vlc_object_t * );
80 static void Close( vlc_object_t * );
83 set_shortname( _("UDP/RTP" ) );
84 set_description( _("UDP/RTP input") );
85 set_category( CAT_INPUT );
86 set_subcategory( SUBCAT_INPUT_ACCESS );
88 add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
89 CACHING_LONGTEXT, VLC_TRUE );
90 add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
91 add_obsolete_bool( "udp-auto-mtu" );
93 set_capability( "access2", 0 );
94 add_shortcut( "udp" );
95 add_shortcut( "udpstream" );
96 add_shortcut( "udp4" );
97 add_shortcut( "udp6" );
98 add_shortcut( "rtp" );
99 add_shortcut( "rtp4" );
100 add_shortcut( "rtp6" );
101 add_shortcut( "udplite" );
102 add_shortcut( "rtptcp" );
103 add_shortcut( "dccp" );
105 set_callbacks( Open, Close );
108 /*****************************************************************************
110 *****************************************************************************/
111 #define RTP_HEADER_LEN 12
113 static block_t *BlockUDP( access_t * );
114 static block_t *BlockTCP( access_t * );
115 static block_t *BlockRTP( access_t * );
116 static block_t *BlockChoose( access_t * );
117 static int Control( access_t *, int, va_list );
123 vlc_bool_t b_framed_rtp;
125 /* reorder rtp packets when out-of-sequence */
126 uint16_t i_last_seqno;
130 block_t *p_partial_frame; /* Partial Framed RTP packet */
133 /*****************************************************************************
134 * Open: open the socket
135 *****************************************************************************/
136 static int Open( vlc_object_t *p_this )
138 access_t *p_access = (access_t*)p_this;
141 char *psz_name = strdup( p_access->psz_path );
143 const char *psz_server_addr, *psz_bind_addr = "";
144 int i_bind_port, i_server_port = 0;
145 int fam = AF_UNSPEC, proto = IPPROTO_UDP;
147 if (strlen (p_access->psz_access) >= 3)
149 switch (p_access->psz_access[3])
159 if (strcmp (p_access->psz_access + 3, "lite") == 0)
160 proto = IPPROTO_UDPLITE;
162 if (strcmp (p_access->psz_access + 3, "tcp") == 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 /* Set up p_access */
214 access_InitFields( p_access );
215 ACCESS_SET_CALLBACKS( NULL, BlockChoose, Control, NULL );
216 p_access->info.b_prebuffered = VLC_FALSE;
217 MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
218 memset (p_sys, 0, sizeof (*p_sys));
223 case IPPROTO_UDPLITE:
224 p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
225 psz_server_addr, i_server_port, fam,
230 p_sys->fd = net_ConnectTCP( p_access, psz_server_addr, i_server_port );
231 p_sys->b_framed_rtp = VLC_TRUE;
236 p_sys->fd = net_Connect( p_access, psz_server_addr, i_server_port,
237 SOCK_DCCP, IPPROTO_DCCP );
240 msg_Err( p_access, "DCCP support not compiled-in!" );
245 if( p_sys->fd == -1 )
247 msg_Err( p_access, "cannot open socket" );
252 shutdown( p_sys->fd, SHUT_WR );
254 #ifdef UDPLITE_RECV_CSCOV
255 if (proto == IPPROTO_UDPLITE)
256 /* UDP header: 8 bytes + RTP header: 12 bytes (or more) */
257 setsockopt (p_sys->fd, SOL_UDPLITE, UDPLITE_RECV_CSCOV,
258 &(int){ 20 }, sizeof (int));
261 if (p_sys->b_framed_rtp)
263 /* We don't do autodetection and prebuffering in case of framing */
264 p_access->pf_block = BlockRTP;
267 /* Update default_pts to a suitable value for udp access */
268 var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
270 /* RTP reordering for out-of-sequence packets */
271 p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
272 p_sys->i_last_seqno = 0;
273 p_sys->p_list = NULL;
278 /*****************************************************************************
279 * Close: free unused data structures
280 *****************************************************************************/
281 static void Close( vlc_object_t *p_this )
283 access_t *p_access = (access_t*)p_this;
284 access_sys_t *p_sys = p_access->p_sys;
286 block_ChainRelease( p_sys->p_list );
287 net_Close( p_sys->fd );
291 /*****************************************************************************
293 *****************************************************************************/
294 static int Control( access_t *p_access, int i_query, va_list args )
303 case ACCESS_CAN_SEEK:
304 case ACCESS_CAN_FASTSEEK:
305 case ACCESS_CAN_PAUSE:
306 case ACCESS_CAN_CONTROL_PACE:
307 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
308 *pb_bool = VLC_FALSE;
312 pi_int = (int*)va_arg( args, int * );
316 case ACCESS_GET_PTS_DELAY:
317 pi_64 = (int64_t*)va_arg( args, int64_t * );
318 *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
322 case ACCESS_SET_PAUSE_STATE:
323 case ACCESS_GET_TITLE_INFO:
324 case ACCESS_SET_TITLE:
325 case ACCESS_SET_SEEKPOINT:
326 case ACCESS_SET_PRIVATE_ID_STATE:
330 msg_Warn( p_access, "unimplemented query in control" );
337 /*****************************************************************************
339 *****************************************************************************/
340 static block_t *BlockUDP( access_t *p_access )
342 access_sys_t *p_sys = p_access->p_sys;
346 p_block = block_New( p_access, MTU );
347 p_block->i_buffer = net_Read( p_access, p_sys->fd, NULL,
348 p_block->p_buffer, MTU, VLC_FALSE );
349 if( p_block->i_buffer < 0 )
351 block_Release( p_block );
355 return block_Realloc( p_block, 0, p_block->i_buffer );
358 /*****************************************************************************
359 * BlockTCP: Framed RTP/AVP packet reception for COMEDIA (see RFC4571)
360 *****************************************************************************/
361 static block_t *BlockTCP( access_t *p_access )
363 access_sys_t *p_sys = p_access->p_sys;
364 block_t *p_block = p_sys->p_partial_frame;
366 if( p_access->info.b_eof )
369 if( p_block == NULL )
371 /* MTU should always be 65535 in this case */
372 p_sys->p_partial_frame = p_block = block_New( p_access, 2 + MTU );
377 /* Read RTP framing */
378 if (p_block->i_buffer < 2)
380 /* FIXME: not very efficient */
381 int i_read = net_Read( p_access, p_sys->fd, NULL,
382 p_block->p_buffer + p_block->i_buffer,
383 2 - p_block->i_buffer, VLC_FALSE );
387 p_block->i_buffer += i_read;
388 if (p_block->i_buffer < 2)
392 uint16_t framelen = GetWLE( p_block->p_buffer );
396 int i_read = net_Read( p_access, p_sys->fd, NULL,
397 p_block->p_buffer + p_block->i_buffer,
398 2 + framelen - p_block->i_buffer, VLC_FALSE );
402 p_block->i_buffer += i_read;
405 if( p_block->i_buffer < (2 + framelen) )
406 return NULL; // incomplete frame
408 /* Hide framing from RTP layer */
409 p_block->p_buffer += 2;
410 p_block->i_buffer -= 2;
411 p_sys->p_partial_frame = NULL;
415 p_access->info.b_eof = VLC_TRUE;
416 block_Release( p_block );
417 p_sys->p_partial_frame = NULL;
423 * rtp_ChainInsert - insert a p_block in the chain and
424 * look at the sequence numbers.
426 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
428 access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
429 block_t *p_prev = NULL;
430 block_t *p = p_sys->p_end;
431 uint16_t i_new = (uint16_t) p_block->i_dts;
436 p_sys->p_list = p_block;
437 p_sys->p_end = p_block;
440 /* walk through the queue from top down since the new packet is in
441 most cases just appended to the end */
445 i_tmp = i_new - (uint16_t) p->i_dts;
447 if( !i_tmp ) /* trash duplicate */
451 { /* insert after this block ( i_new > p->i_dts ) */
452 p_block->p_next = p->p_next;
457 p_prev->p_prev = p_block;
458 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d",
459 (uint16_t) p->i_dts, i_new );
463 p_sys->p_end = p_block;
467 if( p == p_sys->p_list )
468 { /* we've reached bottom of chain */
469 i_tmp = p_sys->i_last_seqno - i_new;
470 if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
472 msg_Dbg(p_access, "RTP reordering: prepend %d before %d",
473 i_new, (uint16_t) p->i_dts );
476 p_sys->p_list = p_block;
480 if( !i_tmp ) /* trash duplicate */
483 /* reordering failed - append the packet to the end of queue */
484 msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
485 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts,
486 (uint16_t) p_sys->p_end->i_dts);
487 p_sys->p_end->p_next = p_block;
488 p_block->p_prev = p_sys->p_end;
489 p_sys->p_end = p_block;
495 block_Release( p_block );
499 /*****************************************************************************
500 * BlockParseRTP/BlockRTP:
501 *****************************************************************************/
502 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
505 size_t i_skip = RTP_HEADER_LEN;
507 if( p_block == NULL )
510 if( p_block->i_buffer < RTP_HEADER_LEN )
512 msg_Dbg( p_access, "short RTP packet received" );
516 /* Parse the header and make some verifications.
519 if( ( p_block->p_buffer[0] >> 6 ) != 2)
521 msg_Dbg( p_access, "RTP version is %u instead of 2",
522 p_block->p_buffer[0] >> 6 );
526 uint8_t pad = (p_block->p_buffer[0] & 0x20)
527 ? p_block->p_buffer[p_block->i_buffer - 1] : 0;
529 i_skip += (p_block->p_buffer[0] & 0x0F) * 4;
531 if (p_block->p_buffer[0] & 0x10) /* Extension header */
534 if ((size_t)p_block->i_buffer < i_skip)
537 i_skip += 4 * GetWBE( p_block->p_buffer + i_skip - 2 );
540 i_payload_type = p_block->p_buffer[1] & 0x7F;
542 /* Remember sequence number in i_dts */
543 p_block->i_pts = mdate();
544 p_block->i_dts = (mtime_t) GetWBE( p_block->p_buffer + 2 );
546 /* FIXME: use rtpmap */
547 switch( i_payload_type )
549 case 14: // MPA: MPEG Audio (RFC2250, §3.4)
550 i_skip += 4; // 32 bits RTP/MPA header
553 case 32: // MPV: MPEG Video (RFC2250, §3.5)
554 i_skip += 4; // 32 bits RTP/MPV header
555 if( (size_t)p_block->i_buffer < i_skip )
557 if( p_block->p_buffer[i_skip - 3] & 0x4 )
559 /* MPEG2 Video extension header */
560 /* TODO: shouldn't we skip this too ? */
564 case 33: // MP2: MPEG TS (RFC2250, §2)
565 /* plain TS over RTP */
569 msg_Dbg( p_access, "unsupported RTP payload type: %u", i_payload_type );
573 if( (size_t)p_block->i_buffer < (i_skip + pad) )
576 /* Remove the RTP header */
577 p_block->i_buffer -= i_skip;
578 p_block->p_buffer += i_skip;
580 /* This is the place for deciphering and authentication */
582 /* Remove padding (at the end) */
583 p_block->i_buffer -= pad;
586 /* Emulate packet loss */
587 if ( (i_sequence_number % 4000) == 0)
589 msg_Warn( p_access, "Emulating packet drop" );
590 block_Release( p_block );
598 block_Release( p_block );
602 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
604 access_sys_t *p_sys = p_access->p_sys;
605 mtime_t i_first = mdate();
607 block_t *p = p_block;
611 mtime_t i_date = mdate();
613 if( p && rtp_ChainInsert( p_access, p ))
616 /* Require at least 2 packets in the buffer */
617 if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
620 p = BlockParseRTP( p_access, BlockUDP( p_access ) );
621 if( !p && (i_date - i_first) > p_sys->i_rtp_late )
623 msg_Err( p_access, "error in RTP prebuffering!" );
628 msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
629 p_access->info.b_prebuffered = VLC_TRUE;
631 p_sys->p_list = p_sys->p_list->p_next;
632 p_sys->i_last_seqno = (uint16_t) p->i_dts;
637 static block_t *BlockRTP( access_t *p_access )
639 access_sys_t *p_sys = p_access->p_sys;
642 while ( !p_sys->p_list ||
643 ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
645 p = BlockParseRTP( p_access,
646 p_sys->b_framed_rtp ? BlockTCP( p_access )
647 : BlockUDP( p_access ) );
651 rtp_ChainInsert( p_access, p );
655 p_sys->p_list = p_sys->p_list->p_next;
656 p_sys->i_last_seqno++;
657 if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
659 msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
660 p_sys->i_last_seqno, (uint16_t) p->i_dts );
661 p_sys->i_last_seqno = (uint16_t) p->i_dts;
667 /*****************************************************************************
668 * BlockChoose: decide between RTP and UDP
669 *****************************************************************************/
670 static block_t *BlockChoose( access_t *p_access )
676 if( ( p_block = BlockUDP( p_access ) ) == NULL )
679 if( p_block->p_buffer[0] == 0x47 )
681 msg_Dbg( p_access, "detected TS over raw UDP" );
682 p_access->pf_block = BlockUDP;
683 p_access->info.b_prebuffered = VLC_TRUE;
687 if( p_block->i_buffer < RTP_HEADER_LEN )
690 /* Parse the header and make some verifications.
693 i_rtp_version = p_block->p_buffer[0] >> 6;
694 i_payload_type = ( p_block->p_buffer[1] & 0x7F );
696 if( i_rtp_version != 2 )
698 msg_Dbg( p_access, "no supported RTP header detected" );
699 p_access->pf_block = BlockUDP;
700 p_access->info.b_prebuffered = VLC_TRUE;
704 switch( i_payload_type )
707 msg_Dbg( p_access, "detected MPEG2 TS over RTP" );
708 p_access->psz_demux = strdup( "ts" );
712 msg_Dbg( p_access, "detected MPEG Audio over RTP" );
713 p_access->psz_demux = strdup( "mpga" );
717 msg_Dbg( p_access, "detected MPEG Video over RTP" );
718 p_access->psz_demux = strdup( "mpgv" );
722 msg_Dbg( p_access, "no RTP header detected" );
723 p_access->pf_block = BlockUDP;
724 p_access->info.b_prebuffered = VLC_TRUE;
728 if( !BlockParseRTP( p_access, p_block )) return NULL;
730 p_access->pf_block = BlockRTP;
732 return BlockPrebufferRTP( p_access, p_block );