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 *****************************************************************************/
40 #include <vlc_access.h>
41 #include <vlc_network.h>
43 #ifndef SOCK_DCCP /* provisional API */
50 # define IPPROTO_DCCP 33 /* IANA */
53 #ifndef IPPROTO_UDPLITE
54 # define IPPROTO_UDPLITE 136 /* from IANA */
59 /*****************************************************************************
61 *****************************************************************************/
62 #define CACHING_TEXT N_("Caching value in ms")
63 #define CACHING_LONGTEXT N_( \
64 "Caching value for UDP streams. This " \
65 "value should be set in milliseconds." )
67 #define RTP_LATE_TEXT N_("RTP reordering timeout in ms")
68 #define RTP_LATE_LONGTEXT N_( \
69 "VLC reorders RTP packets. The input will wait for late packets at most "\
70 "the time specified here (in milliseconds)." )
72 static int Open ( vlc_object_t * );
73 static void Close( vlc_object_t * );
76 set_shortname( _("UDP/RTP" ) );
77 set_description( _("UDP/RTP input") );
78 set_category( CAT_INPUT );
79 set_subcategory( SUBCAT_INPUT_ACCESS );
81 add_integer( "udp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
82 CACHING_LONGTEXT, VLC_TRUE );
83 add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
84 add_obsolete_bool( "udp-auto-mtu" );
86 set_capability( "access2", 0 );
87 add_shortcut( "udp" );
88 add_shortcut( "udpstream" );
89 add_shortcut( "udp4" );
90 add_shortcut( "udp6" );
91 add_shortcut( "rtp" );
92 add_shortcut( "rtp4" );
93 add_shortcut( "rtp6" );
94 add_shortcut( "udplite" );
95 add_shortcut( "rtptcp" ); /* tcp name is already taken */
96 add_shortcut( "dccp" );
98 set_callbacks( Open, Close );
101 /*****************************************************************************
103 *****************************************************************************/
104 #define RTP_HEADER_LEN 12
106 static block_t *BlockUDP( access_t * );
107 static block_t *BlockStartRTP( access_t * );
108 static block_t *BlockRTP( access_t * );
109 static block_t *BlockChoose( access_t * );
110 static int Control( access_t *, int, va_list );
116 vlc_bool_t b_framed_rtp, b_comedia;
118 /* reorder rtp packets when out-of-sequence */
119 uint16_t i_last_seqno;
123 block_t *p_partial_frame; /* Partial Framed RTP packet */
126 /*****************************************************************************
127 * Open: open the socket
128 *****************************************************************************/
129 static int Open( vlc_object_t *p_this )
131 access_t *p_access = (access_t*)p_this;
134 char *psz_name = strdup( p_access->psz_path );
136 const char *psz_server_addr, *psz_bind_addr = "";
137 int i_bind_port, i_server_port = 0;
138 int fam = AF_UNSPEC, proto = IPPROTO_UDP;
140 /* Set up p_access */
141 access_InitFields( p_access );
142 ACCESS_SET_CALLBACKS( NULL, BlockStartRTP, Control, NULL );
143 p_access->info.b_prebuffered = VLC_FALSE;
144 MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
145 memset (p_sys, 0, sizeof (*p_sys));
147 if (strlen (p_access->psz_access) > 0)
149 switch (p_access->psz_access[strlen (p_access->psz_access) - 1])
160 if (strcmp (p_access->psz_access, "udplite") == 0)
161 proto = IPPROTO_UDPLITE;
163 if (strncmp (p_access->psz_access, "udp", 3 ) == 0 )
164 p_access->pf_block = BlockChoose;
166 if (strcmp (p_access->psz_access, "rtptcp") == 0)
169 if (strcmp (p_access->psz_access, "dccp") == 0)
170 proto = IPPROTO_DCCP;
173 i_bind_port = var_CreateGetInteger( p_access, "server-port" );
175 /* Parse psz_name syntax :
176 * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
177 psz_parser = strchr( psz_name, '@' );
178 if( psz_parser != NULL )
180 /* Found bind address and/or bind port */
181 *psz_parser++ = '\0';
182 psz_bind_addr = psz_parser;
184 if( psz_bind_addr[0] == '[' )
185 /* skips bracket'd IPv6 address */
186 psz_parser = strchr( psz_parser, ']' );
188 if( psz_parser != NULL )
190 psz_parser = strchr( psz_parser, ':' );
191 if( psz_parser != NULL )
193 *psz_parser++ = '\0';
194 i_bind_port = atoi( psz_parser );
199 psz_server_addr = psz_name;
200 psz_parser = ( psz_server_addr[0] == '[' )
201 ? strchr( psz_name, ']' ) /* skips bracket'd IPv6 address */
204 if( psz_parser != NULL )
206 psz_parser = strchr( psz_parser, ':' );
207 if( psz_parser != NULL )
209 *psz_parser++ = '\0';
210 i_server_port = atoi( psz_parser );
214 msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
215 psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
217 /* Hmm, the net_* connection functions may need to be unified... */
221 case IPPROTO_UDPLITE:
222 p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
223 psz_server_addr, i_server_port, fam,
228 p_sys->fd = net_ConnectTCP( p_access, psz_server_addr, i_server_port );
229 p_access->pf_block = BlockRTP;
230 p_sys->b_comedia = p_sys->b_framed_rtp = VLC_TRUE;
235 var_Create( p_access, "dccp-service", VLC_VAR_STRING );
236 var_SetString( p_access, "dccp-service", "RTPV" );
237 p_sys->fd = net_Connect( p_access, psz_server_addr, i_server_port,
238 SOCK_DCCP, IPPROTO_DCCP );
241 msg_Err( p_access, "DCCP support not compiled-in!" );
243 p_sys->b_comedia = VLC_TRUE;
247 if( p_sys->fd == -1 )
249 msg_Err( p_access, "cannot open socket" );
254 shutdown( p_sys->fd, SHUT_WR );
255 net_SetCSCov (p_sys->fd, -1, 12);
257 /* Update default_pts to a suitable value for udp access */
258 var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
260 /* RTP reordering for out-of-sequence packets */
261 p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
262 p_sys->i_last_seqno = 0;
263 p_sys->p_list = NULL;
268 /*****************************************************************************
269 * Close: free unused data structures
270 *****************************************************************************/
271 static void Close( vlc_object_t *p_this )
273 access_t *p_access = (access_t*)p_this;
274 access_sys_t *p_sys = p_access->p_sys;
276 block_ChainRelease( p_sys->p_list );
277 net_Close( p_sys->fd );
281 /*****************************************************************************
283 *****************************************************************************/
284 static int Control( access_t *p_access, int i_query, va_list args )
293 case ACCESS_CAN_SEEK:
294 case ACCESS_CAN_FASTSEEK:
295 case ACCESS_CAN_PAUSE:
296 case ACCESS_CAN_CONTROL_PACE:
297 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
298 *pb_bool = VLC_FALSE;
302 pi_int = (int*)va_arg( args, int * );
306 case ACCESS_GET_PTS_DELAY:
307 pi_64 = (int64_t*)va_arg( args, int64_t * );
308 *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
312 case ACCESS_SET_PAUSE_STATE:
313 case ACCESS_GET_TITLE_INFO:
314 case ACCESS_SET_TITLE:
315 case ACCESS_SET_SEEKPOINT:
316 case ACCESS_SET_PRIVATE_ID_STATE:
317 case ACCESS_GET_CONTENT_TYPE:
321 msg_Warn( p_access, "unimplemented query in control" );
328 /*****************************************************************************
330 *****************************************************************************/
331 static block_t *BlockUDP( access_t *p_access )
333 access_sys_t *p_sys = p_access->p_sys;
337 if( p_access->info.b_eof )
341 p_block = block_New( p_access, MTU );
342 len = net_Read( p_access, p_sys->fd, NULL,
343 p_block->p_buffer, MTU, VLC_FALSE );
345 || ( p_sys->b_comedia && ( len == 0 ) ) )
347 if( p_sys->b_comedia )
349 p_access->info.b_eof = VLC_TRUE;
350 msg_Dbg( p_access, "connection-oriented media hangup" );
352 block_Release( p_block );
356 return block_Realloc( p_block, 0, p_block->i_buffer = len );
359 /*****************************************************************************
360 * BlockTCP: Framed RTP/AVP packet reception for COMEDIA (see RFC4571)
361 *****************************************************************************/
362 static block_t *BlockTCP( access_t *p_access )
364 access_sys_t *p_sys = p_access->p_sys;
365 block_t *p_block = p_sys->p_partial_frame;
367 if( p_access->info.b_eof )
370 if( p_block == NULL )
372 /* MTU should always be 65535 in this case */
373 p_sys->p_partial_frame = p_block = block_New( p_access, 2 + MTU );
378 /* Read RTP framing */
379 if (p_block->i_buffer < 2)
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 < (2u + 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: decapsulate the RTP packet and return it
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 const char *psz_demux = NULL;
549 switch( i_payload_type )
551 case 14: // MPA: MPEG Audio (RFC2250, §3.4)
552 i_skip += 4; // 32 bits RTP/MPA header
556 case 32: // MPV: MPEG Video (RFC2250, §3.5)
557 i_skip += 4; // 32 bits RTP/MPV header
558 if( (size_t)p_block->i_buffer < i_skip )
560 if( p_block->p_buffer[i_skip - 3] & 0x4 )
562 /* MPEG2 Video extension header */
563 /* TODO: shouldn't we skip this too ? */
568 case 33: // MP2: MPEG TS (RFC2250, §2)
569 /* plain TS over RTP */
573 case 72: /* muxed SR */
574 case 73: /* muxed RR */
575 case 74: /* muxed SDES */
576 case 75: /* muxed BYE */
577 case 76: /* muxed APP */
578 goto trash; /* ooh! ignoring RTCP is evil! */
581 msg_Dbg( p_access, "unsupported RTP payload type: %u", i_payload_type );
585 if( (size_t)p_block->i_buffer < (i_skip + pad) )
588 /* Remove the RTP header */
589 p_block->i_buffer -= i_skip;
590 p_block->p_buffer += i_skip;
592 /* This is the place for deciphering and authentication */
594 /* Remove padding (at the end) */
595 p_block->i_buffer -= pad;
598 /* Emulate packet loss */
599 if ( (i_sequence_number % 4000) == 0)
601 msg_Warn( p_access, "Emulating packet drop" );
602 block_Release( p_block );
607 if( !p_access->psz_demux || !*p_access->psz_demux )
609 free( p_access->psz_demux );
610 p_access->psz_demux = strdup( psz_demux );
616 block_Release( p_block );
620 /*****************************************************************************
621 * BlockRTP: receives an RTP packet, parses it, queues it queue,
622 * then dequeues the oldest packet and returns it to input/demux.
623 ****************************************************************************/
624 static block_t *BlockRTP( access_t *p_access )
626 access_sys_t *p_sys = p_access->p_sys;
629 while ( !p_sys->p_list ||
630 ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
632 p = BlockParseRTP( p_access,
633 p_sys->b_framed_rtp ? BlockTCP( p_access )
634 : BlockUDP( p_access ) );
638 rtp_ChainInsert( p_access, p );
642 p_sys->p_list = p_sys->p_list->p_next;
643 p_sys->i_last_seqno++;
644 if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
646 msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
647 p_sys->i_last_seqno, (uint16_t) p->i_dts );
648 p_sys->i_last_seqno = (uint16_t) p->i_dts;
654 /*****************************************************************************
655 * BlockPrebufferRTP: waits until we have at least two RTP datagrams,
656 * so that we can synchronize the RTP sequence number.
657 * This is only useful for non-reliable transport protocols.
658 ****************************************************************************/
659 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
661 access_sys_t *p_sys = p_access->p_sys;
662 mtime_t i_first = mdate();
664 block_t *p = p_block;
666 if( BlockParseRTP( p_access, p_block ) == NULL )
671 mtime_t i_date = mdate();
673 if( p && rtp_ChainInsert( p_access, p ))
676 /* Require at least 2 packets in the buffer */
677 if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
680 p = BlockParseRTP( p_access, BlockUDP( p_access ) );
681 if( !p && (i_date - i_first) > p_sys->i_rtp_late )
683 msg_Err( p_access, "error in RTP prebuffering!" );
688 msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
689 p_access->info.b_prebuffered = VLC_TRUE;
691 p_sys->p_list = p_sys->p_list->p_next;
692 p_sys->i_last_seqno = (uint16_t) p->i_dts;
697 static block_t *BlockStartRTP( access_t *p_access )
699 p_access->pf_block = BlockRTP;
700 return BlockPrebufferRTP( p_access, BlockUDP( p_access ) );
704 /*****************************************************************************
705 * BlockChoose: decide between RTP and UDP
706 *****************************************************************************/
707 static block_t *BlockChoose( access_t *p_access )
713 if( ( p_block = BlockUDP( p_access ) ) == NULL )
716 if( p_block->p_buffer[0] == 0x47 )
718 msg_Dbg( p_access, "detected TS over raw UDP" );
719 p_access->pf_block = BlockUDP;
720 p_access->info.b_prebuffered = VLC_TRUE;
724 if( p_block->i_buffer < RTP_HEADER_LEN )
727 /* Parse the header and make some verifications.
730 i_rtp_version = p_block->p_buffer[0] >> 6;
731 i_payload_type = ( p_block->p_buffer[1] & 0x7F );
733 if( i_rtp_version != 2 )
735 msg_Dbg( p_access, "no supported RTP header detected" );
736 p_access->pf_block = BlockUDP;
737 p_access->info.b_prebuffered = VLC_TRUE;
741 switch( i_payload_type )
744 msg_Dbg( p_access, "detected MPEG2 TS over RTP" );
745 p_access->psz_demux = strdup( "ts" );
749 msg_Dbg( p_access, "detected MPEG Audio over RTP" );
750 p_access->psz_demux = strdup( "mpga" );
754 msg_Dbg( p_access, "detected MPEG Video over RTP" );
755 p_access->psz_demux = strdup( "mpgv" );
759 msg_Dbg( p_access, "no RTP header detected" );
760 p_access->pf_block = BlockUDP;
761 p_access->info.b_prebuffered = VLC_TRUE;
765 p_access->pf_block = BlockRTP;
766 return BlockPrebufferRTP( p_access, p_block );