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 );
80 add_integer( "rtp-late", 100, NULL, RTP_LATE_TEXT, RTP_LATE_LONGTEXT, VLC_TRUE );
82 add_obsolete_bool( "udp-auto-mtu" );
84 set_capability( "access2", 0 );
85 add_shortcut( "udp" );
86 add_shortcut( "udpstream" );
87 add_shortcut( "udp4" );
88 add_shortcut( "udp6" );
89 add_shortcut( "rtp" );
90 add_shortcut( "rtp4" );
91 add_shortcut( "rtp6" );
92 add_shortcut( "udplite" );
93 add_shortcut( "rtptcp" ); /* tcp name is already taken */
94 add_shortcut( "dccp" );
96 set_callbacks( Open, Close );
99 /*****************************************************************************
101 *****************************************************************************/
102 #define RTP_HEADER_LEN 12
104 static block_t *BlockUDP( access_t * );
105 static block_t *BlockStartRTP( access_t * );
106 static block_t *BlockRTP( access_t * );
107 static block_t *BlockChoose( access_t * );
108 static int Control( access_t *, int, va_list );
114 vlc_bool_t b_framed_rtp, b_comedia;
116 /* reorder rtp packets when out-of-sequence */
117 uint16_t i_last_seqno;
121 block_t *p_partial_frame; /* Partial Framed RTP packet */
124 /*****************************************************************************
125 * Open: open the socket
126 *****************************************************************************/
127 static int Open( vlc_object_t *p_this )
129 access_t *p_access = (access_t*)p_this;
132 char *psz_name = strdup( p_access->psz_path );
134 const char *psz_server_addr, *psz_bind_addr = "";
135 int i_bind_port, i_server_port = 0;
136 int fam = AF_UNSPEC, proto = IPPROTO_UDP;
138 /* Set up p_access */
139 access_InitFields( p_access );
140 ACCESS_SET_CALLBACKS( NULL, BlockStartRTP, Control, NULL );
141 p_access->info.b_prebuffered = VLC_FALSE;
142 MALLOC_ERR( p_access->p_sys, access_sys_t ); p_sys = p_access->p_sys;
143 memset (p_sys, 0, sizeof (*p_sys));
145 if (strlen (p_access->psz_access) > 0)
147 switch (p_access->psz_access[strlen (p_access->psz_access) - 1])
158 if (strcmp (p_access->psz_access, "udplite") == 0)
159 proto = IPPROTO_UDPLITE;
161 if (strncmp (p_access->psz_access, "udp", 3 ) == 0 )
162 p_access->pf_block = BlockChoose;
164 if (strcmp (p_access->psz_access, "rtptcp") == 0)
167 if (strcmp (p_access->psz_access, "dccp") == 0)
168 proto = IPPROTO_DCCP;
171 i_bind_port = var_CreateGetInteger( p_access, "server-port" );
173 /* Parse psz_name syntax :
174 * [serveraddr[:serverport]][@[bindaddr]:[bindport]] */
175 psz_parser = strchr( psz_name, '@' );
176 if( psz_parser != NULL )
178 /* Found bind address and/or bind port */
179 *psz_parser++ = '\0';
180 psz_bind_addr = psz_parser;
182 if( psz_bind_addr[0] == '[' )
183 /* skips bracket'd IPv6 address */
184 psz_parser = strchr( psz_parser, ']' );
186 if( psz_parser != NULL )
188 psz_parser = strchr( psz_parser, ':' );
189 if( psz_parser != NULL )
191 *psz_parser++ = '\0';
192 i_bind_port = atoi( psz_parser );
197 psz_server_addr = psz_name;
198 psz_parser = ( psz_server_addr[0] == '[' )
199 ? strchr( psz_name, ']' ) /* skips bracket'd IPv6 address */
202 if( psz_parser != NULL )
204 psz_parser = strchr( psz_parser, ':' );
205 if( psz_parser != NULL )
207 *psz_parser++ = '\0';
208 i_server_port = atoi( psz_parser );
212 msg_Dbg( p_access, "opening server=%s:%d local=%s:%d",
213 psz_server_addr, i_server_port, psz_bind_addr, i_bind_port );
215 /* Hmm, the net_* connection functions may need to be unified... */
219 case IPPROTO_UDPLITE:
220 p_sys->fd = net_OpenDgram( p_access, psz_bind_addr, i_bind_port,
221 psz_server_addr, i_server_port, fam,
226 p_sys->fd = net_ConnectTCP( p_access, psz_server_addr, i_server_port );
227 p_access->pf_block = BlockRTP;
228 p_sys->b_comedia = p_sys->b_framed_rtp = VLC_TRUE;
233 p_sys->fd = net_Connect( p_access, psz_server_addr, i_server_port,
234 SOCK_DCCP, IPPROTO_DCCP );
237 msg_Err( p_access, "DCCP support not compiled-in!" );
239 p_sys->b_comedia = VLC_TRUE;
243 if( p_sys->fd == -1 )
245 msg_Err( p_access, "cannot open socket" );
250 shutdown( p_sys->fd, SHUT_WR );
251 net_SetCSCov (p_sys->fd, -1, 12);
253 /* Update default_pts to a suitable value for udp access */
254 var_Create( p_access, "udp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
256 /* RTP reordering for out-of-sequence packets */
257 p_sys->i_rtp_late = var_CreateGetInteger( p_access, "rtp-late" ) * 1000;
258 p_sys->i_last_seqno = 0;
259 p_sys->p_list = NULL;
264 /*****************************************************************************
265 * Close: free unused data structures
266 *****************************************************************************/
267 static void Close( vlc_object_t *p_this )
269 access_t *p_access = (access_t*)p_this;
270 access_sys_t *p_sys = p_access->p_sys;
272 block_ChainRelease( p_sys->p_list );
273 net_Close( p_sys->fd );
277 /*****************************************************************************
279 *****************************************************************************/
280 static int Control( access_t *p_access, int i_query, va_list args )
289 case ACCESS_CAN_SEEK:
290 case ACCESS_CAN_FASTSEEK:
291 case ACCESS_CAN_PAUSE:
292 case ACCESS_CAN_CONTROL_PACE:
293 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
294 *pb_bool = VLC_FALSE;
298 pi_int = (int*)va_arg( args, int * );
302 case ACCESS_GET_PTS_DELAY:
303 pi_64 = (int64_t*)va_arg( args, int64_t * );
304 *pi_64 = var_GetInteger( p_access, "udp-caching" ) * 1000;
308 case ACCESS_SET_PAUSE_STATE:
309 case ACCESS_GET_TITLE_INFO:
310 case ACCESS_SET_TITLE:
311 case ACCESS_SET_SEEKPOINT:
312 case ACCESS_SET_PRIVATE_ID_STATE:
313 case ACCESS_GET_CONTENT_TYPE:
317 msg_Warn( p_access, "unimplemented query in control" );
324 /*****************************************************************************
326 *****************************************************************************/
327 static block_t *BlockUDP( access_t *p_access )
329 access_sys_t *p_sys = p_access->p_sys;
333 if( p_access->info.b_eof )
337 p_block = block_New( p_access, MTU );
338 len = net_Read( p_access, p_sys->fd, NULL,
339 p_block->p_buffer, MTU, VLC_FALSE );
341 || ( p_sys->b_comedia && ( len == 0 ) ) )
343 if( p_sys->b_comedia )
345 p_access->info.b_eof = VLC_TRUE;
346 msg_Dbg( p_access, "connection-oriented media hangup" );
348 block_Release( p_block );
352 return block_Realloc( p_block, 0, p_block->i_buffer = len );
355 /*****************************************************************************
356 * BlockTCP: Framed RTP/AVP packet reception for COMEDIA (see RFC4571)
357 *****************************************************************************/
358 static block_t *BlockTCP( access_t *p_access )
360 access_sys_t *p_sys = p_access->p_sys;
361 block_t *p_block = p_sys->p_partial_frame;
363 if( p_access->info.b_eof )
366 if( p_block == NULL )
368 /* MTU should always be 65535 in this case */
369 p_sys->p_partial_frame = p_block = block_New( p_access, 2 + MTU );
374 /* Read RTP framing */
375 if (p_block->i_buffer < 2)
377 int i_read = net_Read( p_access, p_sys->fd, NULL,
378 p_block->p_buffer + p_block->i_buffer,
379 2 - p_block->i_buffer, VLC_FALSE );
383 p_block->i_buffer += i_read;
384 if (p_block->i_buffer < 2)
388 uint16_t framelen = GetWLE( p_block->p_buffer );
392 int i_read = net_Read( p_access, p_sys->fd, NULL,
393 p_block->p_buffer + p_block->i_buffer,
394 2 + framelen - p_block->i_buffer, VLC_FALSE );
398 p_block->i_buffer += i_read;
401 if( p_block->i_buffer < (2u + framelen) )
402 return NULL; // incomplete frame
404 /* Hide framing from RTP layer */
405 p_block->p_buffer += 2;
406 p_block->i_buffer -= 2;
407 p_sys->p_partial_frame = NULL;
411 p_access->info.b_eof = VLC_TRUE;
412 block_Release( p_block );
413 p_sys->p_partial_frame = NULL;
419 * rtp_ChainInsert - insert a p_block in the chain and
420 * look at the sequence numbers.
422 static inline vlc_bool_t rtp_ChainInsert( access_t *p_access, block_t *p_block )
424 access_sys_t *p_sys = (access_sys_t *) p_access->p_sys;
425 block_t *p_prev = NULL;
426 block_t *p = p_sys->p_end;
427 uint16_t i_new = (uint16_t) p_block->i_dts;
432 p_sys->p_list = p_block;
433 p_sys->p_end = p_block;
436 /* walk through the queue from top down since the new packet is in
437 most cases just appended to the end */
441 i_tmp = i_new - (uint16_t) p->i_dts;
443 if( !i_tmp ) /* trash duplicate */
447 { /* insert after this block ( i_new > p->i_dts ) */
448 p_block->p_next = p->p_next;
453 p_prev->p_prev = p_block;
454 msg_Dbg(p_access, "RTP reordering: insert after %d, new %d",
455 (uint16_t) p->i_dts, i_new );
459 p_sys->p_end = p_block;
463 if( p == p_sys->p_list )
464 { /* we've reached bottom of chain */
465 i_tmp = p_sys->i_last_seqno - i_new;
466 if( !p_access->info.b_prebuffered || (i_tmp > 32767) )
468 msg_Dbg(p_access, "RTP reordering: prepend %d before %d",
469 i_new, (uint16_t) p->i_dts );
472 p_sys->p_list = p_block;
476 if( !i_tmp ) /* trash duplicate */
479 /* reordering failed - append the packet to the end of queue */
480 msg_Dbg(p_access, "RTP: sequence changed (or buffer too small) "
481 "new: %d, buffer %d...%d", i_new, (uint16_t) p->i_dts,
482 (uint16_t) p_sys->p_end->i_dts);
483 p_sys->p_end->p_next = p_block;
484 p_block->p_prev = p_sys->p_end;
485 p_sys->p_end = p_block;
491 block_Release( p_block );
495 /*****************************************************************************
496 * BlockParseRTP: decapsulate the RTP packet and return it
497 *****************************************************************************/
498 static block_t *BlockParseRTP( access_t *p_access, block_t *p_block )
501 size_t i_skip = RTP_HEADER_LEN;
503 if( p_block == NULL )
506 if( p_block->i_buffer < RTP_HEADER_LEN )
508 msg_Dbg( p_access, "short RTP packet received" );
512 /* Parse the header and make some verifications.
515 if( ( p_block->p_buffer[0] >> 6 ) != 2)
517 msg_Dbg( p_access, "RTP version is %u instead of 2",
518 p_block->p_buffer[0] >> 6 );
522 uint8_t pad = (p_block->p_buffer[0] & 0x20)
523 ? p_block->p_buffer[p_block->i_buffer - 1] : 0;
525 i_skip += (p_block->p_buffer[0] & 0x0F) * 4;
527 if (p_block->p_buffer[0] & 0x10) /* Extension header */
530 if ((size_t)p_block->i_buffer < i_skip)
533 i_skip += 4 * GetWBE( p_block->p_buffer + i_skip - 2 );
536 i_payload_type = p_block->p_buffer[1] & 0x7F;
538 /* Remember sequence number in i_dts */
539 p_block->i_pts = mdate();
540 p_block->i_dts = (mtime_t) GetWBE( p_block->p_buffer + 2 );
542 /* FIXME: use rtpmap */
543 const char *psz_demux = NULL;
545 switch( i_payload_type )
547 case 14: // MPA: MPEG Audio (RFC2250, §3.4)
548 i_skip += 4; // 32 bits RTP/MPA header
552 case 32: // MPV: MPEG Video (RFC2250, §3.5)
553 i_skip += 4; // 32 bits RTP/MPV header
554 if( (size_t)p_block->i_buffer < i_skip )
556 if( p_block->p_buffer[i_skip - 3] & 0x4 )
558 /* MPEG2 Video extension header */
559 /* TODO: shouldn't we skip this too ? */
564 case 33: // MP2: MPEG TS (RFC2250, §2)
565 /* plain TS over RTP */
569 case 72: /* muxed SR */
570 case 73: /* muxed RR */
571 case 74: /* muxed SDES */
572 case 75: /* muxed BYE */
573 case 76: /* muxed APP */
574 goto trash; /* ooh! ignoring RTCP is evil! */
577 msg_Dbg( p_access, "unsupported RTP payload type: %u", i_payload_type );
581 if( (size_t)p_block->i_buffer < (i_skip + pad) )
584 /* Remove the RTP header */
585 p_block->i_buffer -= i_skip;
586 p_block->p_buffer += i_skip;
588 /* This is the place for deciphering and authentication */
590 /* Remove padding (at the end) */
591 p_block->i_buffer -= pad;
594 /* Emulate packet loss */
595 if ( (i_sequence_number % 4000) == 0)
597 msg_Warn( p_access, "Emulating packet drop" );
598 block_Release( p_block );
603 if( !p_access->psz_demux || !*p_access->psz_demux )
605 free( p_access->psz_demux );
606 p_access->psz_demux = strdup( psz_demux );
612 block_Release( p_block );
616 /*****************************************************************************
617 * BlockRTP: receives an RTP packet, parses it, queues it queue,
618 * then dequeues the oldest packet and returns it to input/demux.
619 ****************************************************************************/
620 static block_t *BlockRTP( access_t *p_access )
622 access_sys_t *p_sys = p_access->p_sys;
625 while ( !p_sys->p_list ||
626 ( mdate() - p_sys->p_list->i_pts ) < p_sys->i_rtp_late )
628 p = BlockParseRTP( p_access,
629 p_sys->b_framed_rtp ? BlockTCP( p_access )
630 : BlockUDP( p_access ) );
634 rtp_ChainInsert( p_access, p );
638 p_sys->p_list = p_sys->p_list->p_next;
639 p_sys->i_last_seqno++;
640 if( p_sys->i_last_seqno != (uint16_t) p->i_dts )
642 msg_Dbg( p_access, "RTP: packet(s) lost, expected %d, got %d",
643 p_sys->i_last_seqno, (uint16_t) p->i_dts );
644 p_sys->i_last_seqno = (uint16_t) p->i_dts;
650 /*****************************************************************************
651 * BlockPrebufferRTP: waits until we have at least two RTP datagrams,
652 * so that we can synchronize the RTP sequence number.
653 * This is only useful for non-reliable transport protocols.
654 ****************************************************************************/
655 static block_t *BlockPrebufferRTP( access_t *p_access, block_t *p_block )
657 access_sys_t *p_sys = p_access->p_sys;
658 mtime_t i_first = mdate();
660 block_t *p = p_block;
662 if( BlockParseRTP( p_access, p_block ) == NULL )
667 mtime_t i_date = mdate();
669 if( p && rtp_ChainInsert( p_access, p ))
672 /* Require at least 2 packets in the buffer */
673 if( i_count > 2 && (i_date - i_first) > p_sys->i_rtp_late )
676 p = BlockParseRTP( p_access, BlockUDP( p_access ) );
677 if( !p && (i_date - i_first) > p_sys->i_rtp_late )
679 msg_Err( p_access, "error in RTP prebuffering!" );
684 msg_Dbg( p_access, "RTP: prebuffered %d packets", i_count - 1 );
685 p_access->info.b_prebuffered = VLC_TRUE;
687 p_sys->p_list = p_sys->p_list->p_next;
688 p_sys->i_last_seqno = (uint16_t) p->i_dts;
693 static block_t *BlockStartRTP( access_t *p_access )
695 p_access->pf_block = BlockRTP;
696 return BlockPrebufferRTP( p_access, BlockUDP( p_access ) );
700 /*****************************************************************************
701 * BlockChoose: decide between RTP and UDP
702 *****************************************************************************/
703 static block_t *BlockChoose( access_t *p_access )
709 if( ( p_block = BlockUDP( p_access ) ) == NULL )
712 if( p_block->p_buffer[0] == 0x47 )
714 msg_Dbg( p_access, "detected TS over raw UDP" );
715 p_access->pf_block = BlockUDP;
716 p_access->info.b_prebuffered = VLC_TRUE;
720 if( p_block->i_buffer < RTP_HEADER_LEN )
723 /* Parse the header and make some verifications.
726 i_rtp_version = p_block->p_buffer[0] >> 6;
727 i_payload_type = ( p_block->p_buffer[1] & 0x7F );
729 if( i_rtp_version != 2 )
731 msg_Dbg( p_access, "no supported RTP header detected" );
732 p_access->pf_block = BlockUDP;
733 p_access->info.b_prebuffered = VLC_TRUE;
737 switch( i_payload_type )
740 msg_Dbg( p_access, "detected MPEG2 TS over RTP" );
741 p_access->psz_demux = strdup( "ts" );
745 msg_Dbg( p_access, "detected MPEG Audio over RTP" );
746 p_access->psz_demux = strdup( "mpga" );
750 msg_Dbg( p_access, "detected MPEG Video over RTP" );
751 p_access->psz_demux = strdup( "mpgv" );
755 msg_Dbg( p_access, "no RTP header detected" );
756 p_access->pf_block = BlockUDP;
757 p_access->info.b_prebuffered = VLC_TRUE;
761 p_access->pf_block = BlockRTP;
762 return BlockPrebufferRTP( p_access, p_block );