1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001-2005 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Eric Petit <titer@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
29 #include <sys/types.h>
37 #include <vlc_block.h>
44 # include <winsock2.h>
45 # include <ws2tcpip.h>
47 # include <sys/socket.h>
50 #include <vlc_network.h>
52 #if defined (HAVE_NETINET_UDPLITE_H)
53 # include <netinet/udplite.h>
54 #elif defined (__linux__)
55 # define UDPLITE_SEND_CSCOV 10
56 # define UDPLITE_RECV_CSCOV 11
59 #ifndef IPPROTO_UDPLITE
60 # define IPPROTO_UDPLITE 136 /* from IANA */
63 # define SOL_UDPLITE IPPROTO_UDPLITE
66 #define MAX_EMPTY_BLOCKS 200
68 #if defined(WIN32) || defined(UNDER_CE)
69 # define WINSOCK_STRERROR_SIZE 20
70 static const char *winsock_strerror( char *buf )
72 snprintf( buf, WINSOCK_STRERROR_SIZE, "Winsock error %d",
74 buf[WINSOCK_STRERROR_SIZE - 1] = '\0';
79 /*****************************************************************************
81 *****************************************************************************/
82 static int Open ( vlc_object_t * );
83 static void Close( vlc_object_t * );
85 #define SOUT_CFG_PREFIX "sout-udp-"
87 #define CACHING_TEXT N_("Caching value (ms)")
88 #define CACHING_LONGTEXT N_( \
89 "Default caching value for outbound UDP streams. This " \
90 "value should be set in milliseconds." )
92 #define GROUP_TEXT N_("Group packets")
93 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
94 "or by groups. You can choose the number " \
95 "of packets that will be sent at a time. It " \
96 "helps reducing the scheduling load on " \
97 "heavily-loaded systems." )
98 #define RAW_TEXT N_("Raw write")
99 #define RAW_LONGTEXT N_("Packets will be sent " \
100 "directly, without trying to fill the MTU (ie, " \
101 "without trying to make the biggest possible packets " \
102 "in order to improve streaming)." )
105 set_description( _("UDP stream output") );
106 set_shortname( "UDP" );
107 set_category( CAT_SOUT );
108 set_subcategory( SUBCAT_SOUT_ACO );
109 add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
110 add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
112 add_suppressed_integer( SOUT_CFG_PREFIX "late" );
113 add_bool( SOUT_CFG_PREFIX "raw", 0, NULL, RAW_TEXT, RAW_LONGTEXT,
116 set_capability( "sout access", 100 );
117 add_shortcut( "udp" );
118 add_shortcut( "rtp" ); // Will work only with ts muxer
119 add_shortcut( "udplite" );
120 set_callbacks( Open, Close );
123 /*****************************************************************************
124 * Exported prototypes
125 *****************************************************************************/
127 static const char *ppsz_sout_options[] = {
134 /* Options handled by the libvlc network core */
135 static const char *ppsz_core_options[] = {
143 static int Write ( sout_access_out_t *, block_t * );
144 static int WriteRaw( sout_access_out_t *, block_t * );
145 static int Seek ( sout_access_out_t *, off_t );
147 static void ThreadWrite( vlc_object_t * );
148 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
150 typedef struct sout_access_thread_t
154 sout_instance_t *p_sout;
156 block_fifo_t *p_fifo;
163 block_fifo_t *p_empty_blocks;
165 } sout_access_thread_t;
167 struct sout_access_out_sys_t
169 int b_rtpts; // 1 if add rtp/ts header
170 uint16_t i_sequence_number;
177 sout_access_thread_t *p_thread;
179 vlc_bool_t b_mtu_warning;
182 #define DEFAULT_PORT 1234
183 #define RTP_HEADER_LENGTH 12
185 /*****************************************************************************
186 * Open: open the file
187 *****************************************************************************/
188 static int Open( vlc_object_t *p_this )
190 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
191 sout_access_out_sys_t *p_sys;
195 int i_dst_port, proto = IPPROTO_UDP, cscov = 8;
196 const char *protoname = "UDP";
202 config_ChainParse( p_access, SOUT_CFG_PREFIX,
203 ppsz_sout_options, p_access->p_cfg );
204 config_ChainParse( p_access, "",
205 ppsz_core_options, p_access->p_cfg );
207 if( !( p_sys = calloc ( 1, sizeof( sout_access_out_sys_t ) ) ) )
209 msg_Err( p_access, "not enough memory" );
212 p_access->p_sys = p_sys;
214 if( p_access->psz_access != NULL )
216 if (strcmp (p_access->psz_access, "rtp") == 0)
217 p_sys->b_rtpts = VLC_TRUE;
218 if (strcmp (p_access->psz_access, "udplite") == 0)
220 protoname = "UDP-Lite";
221 proto = IPPROTO_UDPLITE;
222 p_sys->b_rtpts = VLC_TRUE;
226 cscov += RTP_HEADER_LENGTH;
228 psz_parser = strdup( p_access->psz_path );
230 psz_dst_addr = psz_parser;
233 if ( *psz_parser == '[' )
235 while( *psz_parser && *psz_parser != ']' )
240 while( *psz_parser && *psz_parser != ':' )
244 if( *psz_parser == ':' )
248 i_dst_port = atoi( psz_parser );
250 if( i_dst_port <= 0 )
252 i_dst_port = DEFAULT_PORT;
255 if (var_Create (p_access, "dst-port", VLC_VAR_INTEGER)
256 || var_Create (p_access, "src-port", VLC_VAR_INTEGER)
257 || var_Create (p_access, "dst-addr", VLC_VAR_STRING)
258 || var_Create (p_access, "src-addr", VLC_VAR_STRING))
262 vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
263 if( !p_sys->p_thread )
265 msg_Err( p_access, "out of memory" );
269 vlc_object_attach( p_sys->p_thread, p_access );
270 p_sys->p_thread->p_sout = p_access->p_sout;
271 p_sys->p_thread->b_die = 0;
272 p_sys->p_thread->b_error= 0;
273 p_sys->p_thread->p_fifo = block_FifoNew( p_access );
274 p_sys->p_thread->p_empty_blocks = block_FifoNew( p_access );
276 i_handle = net_ConnectDgram( p_this, psz_dst_addr, i_dst_port, -1, proto );
279 msg_Err( p_access, "failed to create %s socket", protoname );
284 char addr[NI_MAXNUMERICHOST];
287 if (net_GetSockAddress (i_handle, addr, &port) == 0)
289 msg_Dbg (p_access, "source: %s port %d", addr, port);
290 var_SetString (p_access, "src-addr", addr);
291 var_SetInteger (p_access, "src-port", port);
294 if (net_GetPeerAddress (i_handle, addr, &port) == 0)
296 msg_Dbg (p_access, "destination: %s port %d", addr, port);
297 var_SetString (p_access, "dst-addr", addr);
298 var_SetInteger (p_access, "dst-port", port);
301 p_sys->p_thread->i_handle = i_handle;
302 net_StopRecv( i_handle );
304 #ifdef UDPLITE_SEND_CSCOV
305 if (proto == IPPROTO_UDPLITE)
306 setsockopt (i_handle, SOL_UDPLITE, UDPLITE_SEND_CSCOV,
307 &cscov, sizeof (cscov));
310 var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
311 p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
313 var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
314 p_sys->p_thread->i_group = val.i_int;
316 p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
318 if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
319 VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
321 msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
322 vlc_object_destroy( p_sys->p_thread );
326 srand( (uint32_t)mdate());
327 p_sys->p_buffer = NULL;
328 p_sys->i_sequence_number = rand()&0xffff;
329 p_sys->i_ssrc = rand()&0xffffffff;
331 var_Get( p_access, SOUT_CFG_PREFIX "raw", &val );
332 if( val.b_bool ) p_access->pf_write = WriteRaw;
333 else p_access->pf_write = Write;
335 p_access->pf_seek = Seek;
337 msg_Dbg( p_access, "%s access output opened(%s:%d)",
338 protoname, psz_dst_addr, i_dst_port );
340 free( psz_dst_addr );
342 /* update p_sout->i_out_pace_nocontrol */
343 p_access->p_sout->i_out_pace_nocontrol++;
348 /*****************************************************************************
349 * Close: close the target
350 *****************************************************************************/
351 static void Close( vlc_object_t * p_this )
353 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
354 sout_access_out_sys_t *p_sys = p_access->p_sys;
357 p_sys->p_thread->b_die = 1;
358 for( i = 0; i < 10; i++ )
360 block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
363 p_dummy->i_length = 0;
364 memset( p_dummy->p_buffer, 0, p_dummy->i_buffer );
365 block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
367 vlc_thread_join( p_sys->p_thread );
369 block_FifoRelease( p_sys->p_thread->p_fifo );
370 block_FifoRelease( p_sys->p_thread->p_empty_blocks );
372 if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
374 net_Close( p_sys->p_thread->i_handle );
376 vlc_object_detach( p_sys->p_thread );
377 vlc_object_destroy( p_sys->p_thread );
378 /* update p_sout->i_out_pace_nocontrol */
379 p_access->p_sout->i_out_pace_nocontrol--;
381 msg_Dbg( p_access, "UDP access output closed" );
385 /*****************************************************************************
386 * Write: standard write on a file descriptor.
387 *****************************************************************************/
388 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
390 sout_access_out_sys_t *p_sys = p_access->p_sys;
397 if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
399 msg_Warn( p_access, "packet size > MTU, you should probably "
400 "increase the MTU" );
401 p_sys->b_mtu_warning = VLC_TRUE;
404 /* Check if there is enough space in the buffer */
405 if( p_sys->p_buffer &&
406 p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
408 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < mdate() )
410 msg_Dbg( p_access, "late packet for UDP input (" I64Fd ")",
411 mdate() - p_sys->p_buffer->i_dts
412 - p_sys->p_thread->i_caching );
414 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
415 p_sys->p_buffer = NULL;
418 while( p_buffer->i_buffer )
420 int i_payload_size = p_sys->i_mtu;
422 i_payload_size -= RTP_HEADER_LENGTH;
424 int i_write = __MIN( p_buffer->i_buffer, i_payload_size );
428 if( !p_sys->p_buffer )
430 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
431 if( !p_sys->p_buffer ) break;
434 memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
435 p_buffer->p_buffer, i_write );
437 p_sys->p_buffer->i_buffer += i_write;
438 p_buffer->p_buffer += i_write;
439 p_buffer->i_buffer -= i_write;
440 if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
442 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
443 msg_Warn( p_access, "putting two PCRs at once" );
444 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
447 if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
450 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching
453 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
454 mdate() - p_sys->p_buffer->i_dts
455 - p_sys->p_thread->i_caching );
457 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
458 p_sys->p_buffer = NULL;
462 p_next = p_buffer->p_next;
463 block_Release( p_buffer );
467 return( p_sys->p_thread->b_error ? -1 : 0 );
470 /*****************************************************************************
471 * WriteRaw: write p_buffer without trying to fill mtu
472 *****************************************************************************/
473 static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
475 sout_access_out_sys_t *p_sys = p_access->p_sys;
478 while ( p_sys->p_thread->p_empty_blocks->i_depth >= MAX_EMPTY_BLOCKS )
480 p_buf = block_FifoGet(p_sys->p_thread->p_empty_blocks);
481 block_Release( p_buf );
484 block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
486 return( p_sys->p_thread->b_error ? -1 : 0 );
489 /*****************************************************************************
490 * Seek: seek to a specific location in a file
491 *****************************************************************************/
492 static int Seek( sout_access_out_t *p_access, off_t i_pos )
494 msg_Err( p_access, "UDP sout access cannot seek" );
498 /*****************************************************************************
499 * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
500 *****************************************************************************/
501 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
503 sout_access_out_sys_t *p_sys = p_access->p_sys;
506 while ( p_sys->p_thread->p_empty_blocks->i_depth > MAX_EMPTY_BLOCKS )
508 p_buffer = block_FifoGet( p_sys->p_thread->p_empty_blocks );
509 block_Release( p_buffer );
512 if( p_sys->p_thread->p_empty_blocks->i_depth == 0 )
514 p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
518 p_buffer = block_FifoGet(p_sys->p_thread->p_empty_blocks );
519 p_buffer->i_flags = 0;
520 p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
523 p_buffer->i_dts = i_dts;
524 p_buffer->i_buffer = 0;
528 mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
530 /* add rtp/ts header */
531 p_buffer->p_buffer[0] = 0x80;
532 p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
534 p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
535 p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
536 p_sys->i_sequence_number++;
538 p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
539 p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
540 p_buffer->p_buffer[6] = ( i_timestamp >> 8 )&0xff;
541 p_buffer->p_buffer[7] = i_timestamp&0xff;
543 p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
544 p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
545 p_buffer->p_buffer[10] = ( p_sys->i_ssrc >> 8 )&0xff;
546 p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
548 p_buffer->i_buffer = RTP_HEADER_LENGTH;
554 /*****************************************************************************
555 * ThreadWrite: Write a packet on the network at the good time.
556 *****************************************************************************/
557 static void ThreadWrite( vlc_object_t *p_this )
559 sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
560 mtime_t i_date_last = -1;
561 mtime_t i_to_send = p_thread->i_group;
562 int i_dropped_packets = 0;
563 #if defined(WIN32) || defined(UNDER_CE)
564 char strerror_buf[WINSOCK_STRERROR_SIZE];
565 # define strerror( x ) winsock_strerror( strerror_buf )
568 while( !p_thread->b_die )
571 mtime_t i_date, i_sent;
573 if( (i++ % 1000)==0 ) {
576 block_t *p_tmp = p_thread->p_empty_blocks->p_first;
577 while( p_tmp ) { p_tmp = p_tmp->p_next; i++;}
578 p_tmp = p_thread->p_fifo->p_first;
579 while( p_tmp ) { p_tmp = p_tmp->p_next; j++;}
580 msg_Err( p_thread, "fifo depth: %d/%d, empty blocks: %d/%d",
581 p_thread->p_fifo->i_depth, j,p_thread->p_empty_blocks->i_depth,i );
584 p_pk = block_FifoGet( p_thread->p_fifo );
586 i_date = p_thread->i_caching + p_pk->i_dts;
587 if( i_date_last > 0 )
589 if( i_date - i_date_last > 2000000 )
591 if( !i_dropped_packets )
592 msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
593 i_date - i_date_last );
595 block_FifoPut( p_thread->p_empty_blocks, p_pk );
597 i_date_last = i_date;
601 else if( i_date - i_date_last < -1000 )
603 if( !i_dropped_packets )
604 msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")",
605 i_date_last - i_date );
610 if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
613 i_to_send = p_thread->i_group;
615 if( send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 )
618 msg_Warn( p_thread, "send error: %s", strerror(errno) );
621 if( i_dropped_packets )
623 msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
624 i_dropped_packets = 0;
629 if ( i_sent > i_date + 20000 )
631 msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
636 block_FifoPut( p_thread->p_empty_blocks, p_pk );
638 i_date_last = i_date;