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;
187 sout_CfgParse( p_access, SOUT_CFG_PREFIX,
188 ppsz_sout_options, p_access->p_cfg );
190 if( !( p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
192 msg_Err( p_access, "not enough memory" );
195 memset( p_sys, 0, sizeof(sout_access_out_sys_t) );
196 p_access->p_sys = p_sys;
198 if( p_access->psz_access != NULL &&
199 !strcmp( p_access->psz_access, "rtp" ) )
208 psz_parser = strdup( p_access->psz_name );
210 psz_dst_addr = psz_parser;
213 if ( *psz_parser == '[' )
215 while( *psz_parser && *psz_parser != ']' )
220 while( *psz_parser && *psz_parser != ':' )
224 if( *psz_parser == ':' )
228 i_dst_port = atoi( psz_parser );
230 if( i_dst_port <= 0 )
232 i_dst_port = DEFAULT_PORT;
236 vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
237 if( !p_sys->p_thread )
239 msg_Err( p_access, "out of memory" );
243 p_sys->p_thread->p_sout = p_access->p_sout;
244 p_sys->p_thread->b_die = 0;
245 p_sys->p_thread->b_error= 0;
246 p_sys->p_thread->p_fifo = block_FifoNew( p_access );
247 p_sys->p_thread->p_empty_blocks = NULL;
248 p_sys->p_thread->i_empty_depth = 0;
249 vlc_mutex_init( p_access, &p_sys->p_thread->blocks_lock );
251 var_Get( p_access, SOUT_CFG_PREFIX "ttl", &val );
252 i_handle = net_ConnectUDP( p_this, psz_dst_addr, i_dst_port, val.i_int );
255 msg_Err( p_access, "failed to open a connection (udp)" );
259 p_sys->p_thread->i_handle = i_handle;
260 net_StopRecv( i_handle );
262 var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
263 p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
265 var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
266 p_sys->p_thread->i_group = val.i_int;
268 p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
270 if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
271 VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
273 msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
274 vlc_object_destroy( p_sys->p_thread );
278 srand( (uint32_t)mdate());
279 p_sys->p_buffer = NULL;
280 p_sys->i_sequence_number = rand()&0xffff;
281 p_sys->i_ssrc = rand()&0xffffffff;
283 var_Get( p_access, SOUT_CFG_PREFIX "raw", &val );
284 if( val.b_bool ) p_access->pf_write = WriteRaw;
285 else p_access->pf_write = Write;
287 p_access->pf_seek = Seek;
289 msg_Dbg( p_access, "udp access output opened(%s:%d)",
290 psz_dst_addr, i_dst_port );
292 free( psz_dst_addr );
294 /* update p_sout->i_out_pace_nocontrol */
295 p_access->p_sout->i_out_pace_nocontrol++;
300 /*****************************************************************************
301 * Close: close the target
302 *****************************************************************************/
303 static void Close( vlc_object_t * p_this )
305 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
306 sout_access_out_sys_t *p_sys = p_access->p_sys;
309 p_sys->p_thread->b_die = 1;
310 for( i = 0; i < 10; i++ )
312 block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
315 p_dummy->i_length = 0;
316 memset( p_dummy->p_buffer, 0, p_dummy->i_buffer );
317 block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
319 vlc_thread_join( p_sys->p_thread );
321 block_FifoRelease( p_sys->p_thread->p_fifo );
323 if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
324 while ( p_sys->p_thread->p_empty_blocks != NULL )
326 block_t *p_next = p_sys->p_thread->p_empty_blocks->p_next;
327 block_Release( p_sys->p_thread->p_empty_blocks );
328 p_sys->p_thread->p_empty_blocks = p_next;
330 vlc_mutex_destroy( &p_sys->p_thread->blocks_lock );
332 net_Close( p_sys->p_thread->i_handle );
334 /* update p_sout->i_out_pace_nocontrol */
335 p_access->p_sout->i_out_pace_nocontrol--;
337 msg_Dbg( p_access, "udp access output closed" );
341 /*****************************************************************************
342 * Write: standard write on a file descriptor.
343 *****************************************************************************/
344 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
346 sout_access_out_sys_t *p_sys = p_access->p_sys;
353 if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
355 msg_Warn( p_access, "packet size > MTU, you should probably "
356 "increase the MTU" );
357 p_sys->b_mtu_warning = VLC_TRUE;
360 /* Check if there is enough space in the buffer */
361 if( p_sys->p_buffer &&
362 p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
364 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < mdate() )
366 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
367 mdate() - p_sys->p_buffer->i_dts
368 - p_sys->p_thread->i_caching );
370 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
371 p_sys->p_buffer = NULL;
374 while( p_buffer->i_buffer )
376 int i_write = __MIN( p_buffer->i_buffer, p_sys->i_mtu );
380 if( !p_sys->p_buffer )
382 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
383 if( !p_sys->p_buffer ) break;
386 memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
387 p_buffer->p_buffer, i_write );
389 p_sys->p_buffer->i_buffer += i_write;
390 p_buffer->p_buffer += i_write;
391 p_buffer->i_buffer -= i_write;
392 if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
394 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
395 msg_Warn( p_access, "putting two PCRs at once" );
396 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
399 if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
402 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching
405 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
406 mdate() - p_sys->p_buffer->i_dts
407 - p_sys->p_thread->i_caching );
409 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
410 p_sys->p_buffer = NULL;
414 p_next = p_buffer->p_next;
415 block_Release( p_buffer );
419 return( p_sys->p_thread->b_error ? -1 : 0 );
422 /*****************************************************************************
423 * WriteRaw: write p_buffer without trying to fill mtu
424 *****************************************************************************/
425 static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
427 sout_access_out_sys_t *p_sys = p_access->p_sys;
430 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
431 while ( p_sys->p_thread->i_empty_depth >= MAX_EMPTY_BLOCKS )
433 p_buf = p_sys->p_thread->p_empty_blocks;
434 p_sys->p_thread->p_empty_blocks =
435 p_sys->p_thread->p_empty_blocks->p_next;
436 p_sys->p_thread->i_empty_depth--;
437 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
438 block_Release( p_buf );
439 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
441 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
443 block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
445 return( p_sys->p_thread->b_error ? -1 : 0 );
448 /*****************************************************************************
449 * Seek: seek to a specific location in a file
450 *****************************************************************************/
451 static int Seek( sout_access_out_t *p_access, off_t i_pos )
453 msg_Err( p_access, "UDP sout access cannot seek" );
457 /*****************************************************************************
458 * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
459 *****************************************************************************/
460 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
462 sout_access_out_sys_t *p_sys = p_access->p_sys;
465 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
466 while ( p_sys->p_thread->i_empty_depth > MAX_EMPTY_BLOCKS )
468 p_buffer = p_sys->p_thread->p_empty_blocks;
469 p_sys->p_thread->p_empty_blocks =
470 p_sys->p_thread->p_empty_blocks->p_next;
471 p_sys->p_thread->i_empty_depth--;
472 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
473 block_Release( p_buffer );
474 vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
476 p_buffer = p_sys->p_thread->p_empty_blocks;
477 if ( p_buffer != NULL )
479 p_sys->p_thread->p_empty_blocks =
480 p_sys->p_thread->p_empty_blocks->p_next;
481 p_sys->p_thread->i_empty_depth--;
482 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
483 p_buffer->p_next = NULL;
484 p_buffer->i_flags = 0;
485 p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
489 vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
490 p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
493 p_buffer->i_dts = i_dts;
494 p_buffer->i_buffer = 0;
498 mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
500 /* add rtp/ts header */
501 p_buffer->p_buffer[0] = 0x80;
502 p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
504 p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
505 p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
506 p_sys->i_sequence_number++;
508 p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
509 p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
510 p_buffer->p_buffer[6] = ( i_timestamp >> 8 )&0xff;
511 p_buffer->p_buffer[7] = i_timestamp&0xff;
513 p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
514 p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
515 p_buffer->p_buffer[10] = ( p_sys->i_ssrc >> 8 )&0xff;
516 p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
518 p_buffer->i_buffer = 12;
524 /*****************************************************************************
525 * ThreadWrite: Write a packet on the network at the good time.
526 *****************************************************************************/
527 static void ThreadWrite( vlc_object_t *p_this )
529 sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
530 mtime_t i_date_last = -1;
531 mtime_t i_to_send = p_thread->i_group;
532 int i_dropped_packets = 0;
533 #if defined(WIN32) || defined(UNDER_CE)
534 char strerror_buf[WINSOCK_STRERROR_SIZE];
535 # define strerror( x ) winsock_strerror( strerror_buf )
538 while( !p_thread->b_die )
541 mtime_t i_date, i_sent;
543 p_pk = block_FifoGet( p_thread->p_fifo );
545 i_date = p_thread->i_caching + p_pk->i_dts;
546 if( i_date_last > 0 )
548 if( i_date - i_date_last > 2000000 )
550 if( !i_dropped_packets )
551 msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
552 i_date - i_date_last );
554 vlc_mutex_lock( &p_thread->blocks_lock );
555 p_pk->p_next = p_thread->p_empty_blocks;
556 p_thread->p_empty_blocks = p_pk;
557 p_thread->i_empty_depth++;
558 vlc_mutex_unlock( &p_thread->blocks_lock );
560 i_date_last = i_date;
564 else if( i_date - i_date_last < -1000 )
566 if( !i_dropped_packets )
567 msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")",
568 i_date_last - i_date );
573 if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
576 i_to_send = p_thread->i_group;
578 if( send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 )
581 msg_Warn( p_thread, "send error: %s", strerror(errno) );
584 if( i_dropped_packets )
586 msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
587 i_dropped_packets = 0;
592 if ( i_sent > i_date + 20000 )
594 msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
599 vlc_mutex_lock( &p_thread->blocks_lock );
600 p_pk->p_next = p_thread->p_empty_blocks;
601 p_thread->p_empty_blocks = p_pk;
602 p_thread->i_empty_depth++;
603 vlc_mutex_unlock( &p_thread->blocks_lock );
605 i_date_last = i_date;