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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
29 #include <sys/types.h>
43 # include <winsock2.h>
44 # include <ws2tcpip.h>
46 # define IN_MULTICAST(a) IN_CLASSD(a)
49 # include <sys/socket.h>
54 #define MAX_EMPTY_BLOCKS 200
56 #if defined(WIN32) || defined(UNDER_CE)
57 # define WINSOCK_STRERROR_SIZE 20
58 static const char *winsock_strerror( char *buf )
60 snprintf( buf, WINSOCK_STRERROR_SIZE, "Winsock error %d",
62 buf[WINSOCK_STRERROR_SIZE - 1] = '\0';
67 /*****************************************************************************
69 *****************************************************************************/
70 static int Open ( vlc_object_t * );
71 static void Close( vlc_object_t * );
73 #define SOUT_CFG_PREFIX "sout-udp-"
75 #define CACHING_TEXT N_("Caching value (ms)")
76 #define CACHING_LONGTEXT N_( \
77 "Allows you to modify the default caching value for UDP streams. This " \
78 "value should be set in millisecond units." )
80 #define TTL_TEXT N_("Time To Live")
81 #define TTL_LONGTEXT N_("Allows you to define the time to live of the " \
84 #define GROUP_TEXT N_("Group packets")
85 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
86 "or by groups. This allows you to give the number " \
87 "of packets that will be sent at a time. It " \
88 "helps reducing the scheduling load on " \
89 "heavily-loaded systems." )
90 #define RAW_TEXT N_("Raw write")
91 #define RAW_LONGTEXT N_("If you enable this option, packets will be sent " \
92 "directly, without trying to fill the MTU (ie, " \
93 "without trying to make the biggest possible packets " \
94 "in order to improve streaming)." )
97 set_description( _("UDP stream output") );
98 set_shortname( N_( "UDP" ) );
99 set_category( CAT_SOUT );
100 set_subcategory( SUBCAT_SOUT_ACO );
101 add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
102 add_integer( SOUT_CFG_PREFIX "ttl", 0, NULL,TTL_TEXT, TTL_LONGTEXT,
104 add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
106 add_suppressed_integer( SOUT_CFG_PREFIX "late" );
107 add_bool( SOUT_CFG_PREFIX "raw", 0, NULL, RAW_TEXT, RAW_LONGTEXT,
110 set_capability( "sout access", 100 );
111 add_shortcut( "udp" );
112 add_shortcut( "rtp" ); // Will work only with ts muxer
113 set_callbacks( Open, Close );
116 /*****************************************************************************
117 * Exported prototypes
118 *****************************************************************************/
120 static const char *ppsz_sout_options[] = {
128 static int Write ( sout_access_out_t *, block_t * );
129 static int WriteRaw( sout_access_out_t *, block_t * );
130 static int Seek ( sout_access_out_t *, off_t );
132 static void ThreadWrite( vlc_object_t * );
133 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
135 typedef struct sout_access_thread_t
139 sout_instance_t *p_sout;
141 block_fifo_t *p_fifo;
148 vlc_mutex_t blocks_lock;
149 block_t *p_empty_blocks;
152 } sout_access_thread_t;
154 struct sout_access_out_sys_t
156 int b_rtpts; // 1 if add rtp/ts header
157 uint16_t i_sequence_number;
164 sout_access_thread_t *p_thread;
166 vlc_bool_t b_mtu_warning;
169 #define DEFAULT_PORT 1234
171 /*****************************************************************************
172 * Open: open the file
173 *****************************************************************************/
174 static int Open( vlc_object_t *p_this )
176 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
177 sout_access_out_sys_t *p_sys;
184 network_socket_t socket_desc;
188 sout_CfgParse( p_access, SOUT_CFG_PREFIX,
189 ppsz_sout_options, p_access->p_cfg );
191 if( !( p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
193 msg_Err( p_access, "not enough memory" );
196 memset( p_sys, 0, sizeof(sout_access_out_sys_t) );
197 p_access->p_sys = p_sys;
199 if( p_access->psz_access != NULL &&
200 !strcmp( p_access->psz_access, "rtp" ) )
209 psz_parser = strdup( p_access->psz_name );
211 psz_dst_addr = psz_parser;
214 if ( *psz_parser == '[' )
216 while( *psz_parser && *psz_parser != ']' )
221 while( *psz_parser && *psz_parser != ':' )
225 if( *psz_parser == ':' )
229 i_dst_port = atoi( psz_parser );
231 if( i_dst_port <= 0 )
233 i_dst_port = DEFAULT_PORT;
237 vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
238 if( !p_sys->p_thread )
240 msg_Err( p_access, "out of memory" );
244 p_sys->p_thread->p_sout = p_access->p_sout;
245 p_sys->p_thread->b_die = 0;
246 p_sys->p_thread->b_error= 0;
247 p_sys->p_thread->p_fifo = block_FifoNew( p_access );
248 p_sys->p_thread->p_empty_blocks = NULL;
249 p_sys->p_thread->i_empty_depth = 0;
250 vlc_mutex_init( p_access, &p_sys->p_thread->blocks_lock );
252 /* FIXME: use net_OpenUDP API */
253 socket_desc.psz_server_addr = psz_dst_addr;
254 socket_desc.i_server_port = i_dst_port;
255 socket_desc.psz_bind_addr = "";
256 socket_desc.i_bind_port = 0;
257 socket_desc.i_handle = -1;
258 socket_desc.v6only = 0;
260 var_Get( p_access, SOUT_CFG_PREFIX "ttl", &val );
261 socket_desc.i_ttl = val.i_int;
263 p_sys->p_thread->p_private = (void*)&socket_desc;
264 p_network = module_Need( p_sys->p_thread, "network", "ipv4", VLC_TRUE );
265 if( p_network != NULL )
266 module_Unneed( p_sys->p_thread, p_network );
268 if( socket_desc.i_handle == -1 )
270 p_network = module_Need( p_sys->p_thread, "network", "ipv6", VLC_TRUE );
271 if( p_network != NULL )
272 module_Unneed( p_sys->p_thread, p_network );
274 if( socket_desc.i_handle == -1 )
276 msg_Err( p_access, "failed to open a connection (udp)" );
281 p_sys->p_thread->i_handle = socket_desc.i_handle;
282 net_StopRecv( socket_desc.i_handle );
284 var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
285 p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
287 var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
288 p_sys->p_thread->i_group = val.i_int;
290 p_sys->i_mtu = socket_desc.i_mtu;
292 if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
293 VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
295 msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
296 vlc_object_destroy( p_sys->p_thread );
300 srand( (uint32_t)mdate());
301 p_sys->p_buffer = NULL;
302 p_sys->i_sequence_number = rand()&0xffff;
303 p_sys->i_ssrc = rand()&0xffffffff;
305 var_Get( p_access, SOUT_CFG_PREFIX "raw", &val );
306 if( val.b_bool ) p_access->pf_write = WriteRaw;
307 else p_access->pf_write = Write;
309 p_access->pf_seek = Seek;
311 msg_Dbg( p_access, "udp access output opened(%s:%d)",
312 psz_dst_addr, i_dst_port );
314 free( psz_dst_addr );
316 /* update p_sout->i_out_pace_nocontrol */
317 p_access->p_sout->i_out_pace_nocontrol++;
322 /*****************************************************************************
323 * Close: close the target
324 *****************************************************************************/
325 static void Close( vlc_object_t * p_this )
327 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
328 sout_access_out_sys_t *p_sys = p_access->p_sys;
331 p_sys->p_thread->b_die = 1;
332 for( i = 0; i < 10; i++ )
334 block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
337 p_dummy->i_length = 0;
338 memset( p_dummy->p_buffer, 0, p_dummy->i_buffer );
339 block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
341 vlc_thread_join( p_sys->p_thread );
343 block_FifoRelease( p_sys->p_thread->p_fifo );
345 if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
346 while ( p_sys->p_thread->p_empty_blocks != NULL )
348 block_t *p_next = p_sys->p_thread->p_empty_blocks->p_next;
349 block_Release( p_sys->p_thread->p_empty_blocks );
350 p_sys->p_thread->p_empty_blocks = p_next;
352 vlc_mutex_destroy( &p_sys->p_thread->blocks_lock );
354 net_Close( p_sys->p_thread->i_handle );
356 /* update p_sout->i_out_pace_nocontrol */
357 p_access->p_sout->i_out_pace_nocontrol--;
359 msg_Dbg( p_access, "udp access output closed" );
363 /*****************************************************************************
364 * Write: standard write on a file descriptor.
365 *****************************************************************************/
366 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
368 sout_access_out_sys_t *p_sys = p_access->p_sys;
375 if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
377 msg_Warn( p_access, "packet size > MTU, you should probably "
378 "increase the MTU" );
379 p_sys->b_mtu_warning = VLC_TRUE;
382 /* Check if there is enough space in the buffer */
383 if( p_sys->p_buffer &&
384 p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
386 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < mdate() )
388 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
389 mdate() - p_sys->p_buffer->i_dts
390 - p_sys->p_thread->i_caching );
392 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
393 p_sys->p_buffer = NULL;
396 while( p_buffer->i_buffer )
398 int i_write = __MIN( p_buffer->i_buffer, p_sys->i_mtu );
402 if( !p_sys->p_buffer )
404 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
405 if( !p_sys->p_buffer ) break;
408 memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
409 p_buffer->p_buffer, i_write );
411 p_sys->p_buffer->i_buffer += i_write;
412 p_buffer->p_buffer += i_write;
413 p_buffer->i_buffer -= i_write;
414 if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
416 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
417 msg_Warn( p_access, "putting two PCRs at once" );
418 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
421 if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
424 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching
427 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
428 mdate() - p_sys->p_buffer->i_dts
429 - p_sys->p_thread->i_caching );
431 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
432 p_sys->p_buffer = NULL;
436 p_next = p_buffer->p_next;
437 block_Release( p_buffer );
441 return( p_sys->p_thread->b_error ? -1 : 0 );
444 /*****************************************************************************
445 * WriteRaw: write p_buffer without trying to fill mtu
446 *****************************************************************************/
447 static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
449 sout_access_out_sys_t *p_sys = p_access->p_sys;
452 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
453 while ( p_sys->p_thread->i_empty_depth >= MAX_EMPTY_BLOCKS )
455 p_buf = p_sys->p_thread->p_empty_blocks;
456 p_sys->p_thread->p_empty_blocks =
457 p_sys->p_thread->p_empty_blocks->p_next;
458 p_sys->p_thread->i_empty_depth--;
459 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
460 block_Release( p_buf );
461 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
463 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
465 block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
467 return( p_sys->p_thread->b_error ? -1 : 0 );
470 /*****************************************************************************
471 * Seek: seek to a specific location in a file
472 *****************************************************************************/
473 static int Seek( sout_access_out_t *p_access, off_t i_pos )
475 msg_Err( p_access, "UDP sout access cannot seek" );
479 /*****************************************************************************
480 * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
481 *****************************************************************************/
482 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
484 sout_access_out_sys_t *p_sys = p_access->p_sys;
487 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
488 while ( p_sys->p_thread->i_empty_depth > MAX_EMPTY_BLOCKS )
490 p_buffer = p_sys->p_thread->p_empty_blocks;
491 p_sys->p_thread->p_empty_blocks =
492 p_sys->p_thread->p_empty_blocks->p_next;
493 p_sys->p_thread->i_empty_depth--;
494 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
495 block_Release( p_buffer );
496 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
498 p_buffer = p_sys->p_thread->p_empty_blocks;
499 if ( p_buffer != NULL )
501 p_sys->p_thread->p_empty_blocks =
502 p_sys->p_thread->p_empty_blocks->p_next;
503 p_sys->p_thread->i_empty_depth--;
504 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
505 p_buffer->p_next = NULL;
506 p_buffer->i_flags = 0;
507 p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
511 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
512 p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
515 p_buffer->i_dts = i_dts;
516 p_buffer->i_buffer = 0;
520 mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
522 /* add rtp/ts header */
523 p_buffer->p_buffer[0] = 0x80;
524 p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
526 p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
527 p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
528 p_sys->i_sequence_number++;
530 p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
531 p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
532 p_buffer->p_buffer[6] = ( i_timestamp >> 8 )&0xff;
533 p_buffer->p_buffer[7] = i_timestamp&0xff;
535 p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
536 p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
537 p_buffer->p_buffer[10] = ( p_sys->i_ssrc >> 8 )&0xff;
538 p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
540 p_buffer->i_buffer = 12;
546 /*****************************************************************************
547 * ThreadWrite: Write a packet on the network at the good time.
548 *****************************************************************************/
549 static void ThreadWrite( vlc_object_t *p_this )
551 sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
552 mtime_t i_date_last = -1;
553 mtime_t i_to_send = p_thread->i_group;
554 int i_dropped_packets = 0;
555 #if defined(WIN32) || defined(UNDER_CE)
556 char strerror_buf[WINSOCK_STRERROR_SIZE];
557 # define strerror( x ) winsock_strerror( strerror_buf )
560 while( !p_thread->b_die )
563 mtime_t i_date, i_sent;
565 p_pk = block_FifoGet( p_thread->p_fifo );
567 i_date = p_thread->i_caching + p_pk->i_dts;
568 if( i_date_last > 0 )
570 if( i_date - i_date_last > 2000000 )
572 if( !i_dropped_packets )
573 msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
574 i_date - i_date_last );
576 vlc_mutex_lock( &p_thread->blocks_lock );
577 p_pk->p_next = p_thread->p_empty_blocks;
578 p_thread->p_empty_blocks = p_pk;
579 p_thread->i_empty_depth++;
580 vlc_mutex_unlock( &p_thread->blocks_lock );
582 i_date_last = i_date;
586 else if( i_date - i_date_last < -1000 )
588 if( !i_dropped_packets )
589 msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")",
590 i_date_last - i_date );
595 if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
598 i_to_send = p_thread->i_group;
600 if( send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 )
603 msg_Warn( p_thread, "send error: %s", strerror(errno) );
606 if( i_dropped_packets )
608 msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
609 i_dropped_packets = 0;
614 if ( i_sent > i_date + 20000 )
616 msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
621 vlc_mutex_lock( &p_thread->blocks_lock );
622 p_pk->p_next = p_thread->p_empty_blocks;
623 p_thread->p_empty_blocks = p_pk;
624 p_thread->i_empty_depth++;
625 vlc_mutex_unlock( &p_thread->blocks_lock );
627 i_date_last = i_date;