1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001-2007 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 *****************************************************************************/
34 #include <sys/types.h>
41 #include <vlc_block.h>
48 # include <winsock2.h>
49 # include <ws2tcpip.h>
51 # include <sys/socket.h>
54 #include <vlc_network.h>
56 #define MAX_EMPTY_BLOCKS 200
58 /*****************************************************************************
60 *****************************************************************************/
61 static int Open ( vlc_object_t * );
62 static void Close( vlc_object_t * );
64 #define SOUT_CFG_PREFIX "sout-udp-"
66 #define CACHING_TEXT N_("Caching value (ms)")
67 #define CACHING_LONGTEXT N_( \
68 "Default caching value for outbound UDP streams. This " \
69 "value should be set in milliseconds." )
71 #define GROUP_TEXT N_("Group packets")
72 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
73 "or by groups. You can choose the number " \
74 "of packets that will be sent at a time. It " \
75 "helps reducing the scheduling load on " \
76 "heavily-loaded systems." )
77 #define AUTO_MCAST_TEXT N_("Automatic multicast streaming")
78 #define AUTO_MCAST_LONGTEXT N_("Allocates an outbound multicast address " \
82 set_description( _("UDP stream output") );
83 set_shortname( "UDP" );
84 set_category( CAT_SOUT );
85 set_subcategory( SUBCAT_SOUT_ACO );
86 add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true );
87 add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
89 add_obsolete_integer( SOUT_CFG_PREFIX "late" );
90 add_obsolete_bool( SOUT_CFG_PREFIX "raw" );
91 add_bool( SOUT_CFG_PREFIX "auto-mcast", false, NULL, AUTO_MCAST_TEXT,
92 AUTO_MCAST_LONGTEXT, true );
94 set_capability( "sout access", 100 );
95 add_shortcut( "udp" );
96 set_callbacks( Open, Close );
99 /*****************************************************************************
100 * Exported prototypes
101 *****************************************************************************/
103 static const char *const ppsz_sout_options[] = {
110 /* Options handled by the libvlc network core */
111 static const char *const ppsz_core_options[] = {
119 static ssize_t Write ( sout_access_out_t *, block_t * );
120 static int Seek ( sout_access_out_t *, off_t );
122 static void ThreadWrite( vlc_object_t * );
123 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
124 static const char *MakeRandMulticast (int family, char *buf, size_t buflen);
126 typedef struct sout_access_thread_t
130 sout_instance_t *p_sout;
132 block_fifo_t *p_fifo;
139 block_fifo_t *p_empty_blocks;
140 } sout_access_thread_t;
142 struct sout_access_out_sys_t
149 sout_access_thread_t *p_thread;
153 #define DEFAULT_PORT 1234
155 /*****************************************************************************
156 * Open: open the file
157 *****************************************************************************/
158 static int Open( vlc_object_t *p_this )
160 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
161 sout_access_out_sys_t *p_sys;
163 char *psz_dst_addr = NULL;
168 config_ChainParse( p_access, SOUT_CFG_PREFIX,
169 ppsz_sout_options, p_access->p_cfg );
170 config_ChainParse( p_access, "",
171 ppsz_core_options, p_access->p_cfg );
173 if (var_Create (p_access, "dst-port", VLC_VAR_INTEGER)
174 || var_Create (p_access, "src-port", VLC_VAR_INTEGER)
175 || var_Create (p_access, "dst-addr", VLC_VAR_STRING)
176 || var_Create (p_access, "src-addr", VLC_VAR_STRING))
181 if( !( p_sys = calloc ( 1, sizeof( sout_access_out_sys_t ) ) ) )
183 msg_Err( p_access, "not enough memory" );
186 p_access->p_sys = p_sys;
188 i_dst_port = DEFAULT_PORT;
189 if (var_GetBool (p_access, SOUT_CFG_PREFIX"auto-mcast"))
191 char buf[INET6_ADDRSTRLEN];
192 if (MakeRandMulticast (AF_INET, buf, sizeof (buf)) != NULL)
193 psz_dst_addr = strdup (buf);
197 char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
199 if (psz_parser[0] == '[')
200 psz_parser = strchr (psz_parser, ']');
202 psz_parser = strchr (psz_parser ?: psz_dst_addr, ':');
203 if (psz_parser != NULL)
205 *psz_parser++ = '\0';
206 i_dst_port = atoi (psz_parser);
211 vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
212 if( !p_sys->p_thread )
214 msg_Err( p_access, "out of memory" );
220 vlc_object_attach( p_sys->p_thread, p_access );
221 p_sys->p_thread->p_sout = p_access->p_sout;
222 p_sys->p_thread->b_die = 0;
223 p_sys->p_thread->b_error= 0;
224 p_sys->p_thread->p_fifo = block_FifoNew( p_access );
225 p_sys->p_thread->p_empty_blocks = block_FifoNew( p_access );
227 i_handle = net_ConnectDgram( p_this, psz_dst_addr, i_dst_port, -1,
233 msg_Err( p_access, "failed to create raw UDP socket" );
234 vlc_object_release (p_sys->p_thread);
240 char addr[NI_MAXNUMERICHOST];
243 if (net_GetSockAddress (i_handle, addr, &port) == 0)
245 msg_Dbg (p_access, "source: %s port %d", addr, port);
246 var_SetString (p_access, "src-addr", addr);
247 var_SetInteger (p_access, "src-port", port);
250 if (net_GetPeerAddress (i_handle, addr, &port) == 0)
252 msg_Dbg (p_access, "destination: %s port %d", addr, port);
253 var_SetString (p_access, "dst-addr", addr);
254 var_SetInteger (p_access, "dst-port", port);
257 p_sys->p_thread->i_handle = i_handle;
258 shutdown( i_handle, SHUT_RD );
260 p_sys->p_thread->i_caching =
261 (int64_t)1000 * var_GetInteger( p_access, SOUT_CFG_PREFIX "caching");
262 p_sys->p_thread->i_group =
263 var_GetInteger( p_access, SOUT_CFG_PREFIX "group" );
265 p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
266 p_sys->p_buffer = NULL;
268 if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
269 VLC_THREAD_PRIORITY_HIGHEST, false ) )
271 msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
272 net_Close (i_handle);
273 vlc_object_release( p_sys->p_thread );
278 p_access->pf_write = Write;
279 p_access->pf_seek = Seek;
281 /* update p_sout->i_out_pace_nocontrol */
282 p_access->p_sout->i_out_pace_nocontrol++;
287 /*****************************************************************************
288 * Close: close the target
289 *****************************************************************************/
290 static void Close( vlc_object_t * p_this )
292 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
293 sout_access_out_sys_t *p_sys = p_access->p_sys;
296 vlc_object_kill( p_sys->p_thread );
297 block_FifoWake( p_sys->p_thread->p_fifo );
299 for( i = 0; i < 10; i++ )
301 block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
304 p_dummy->i_length = 0;
305 memset( p_dummy->p_buffer, 0, p_dummy->i_buffer );
306 block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
308 vlc_thread_join( p_sys->p_thread );
310 block_FifoRelease( p_sys->p_thread->p_fifo );
311 block_FifoRelease( p_sys->p_thread->p_empty_blocks );
313 if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
315 net_Close( p_sys->p_thread->i_handle );
317 vlc_object_detach( p_sys->p_thread );
318 vlc_object_release( p_sys->p_thread );
319 /* update p_sout->i_out_pace_nocontrol */
320 p_access->p_sout->i_out_pace_nocontrol--;
322 msg_Dbg( p_access, "UDP access output closed" );
326 /*****************************************************************************
327 * Write: standard write on a file descriptor.
328 *****************************************************************************/
329 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
331 sout_access_out_sys_t *p_sys = p_access->p_sys;
338 mtime_t now = mdate();
340 if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
342 msg_Warn( p_access, "packet size > MTU, you should probably "
343 "increase the MTU" );
344 p_sys->b_mtu_warning = true;
347 /* Check if there is enough space in the buffer */
348 if( p_sys->p_buffer &&
349 p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
351 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < now )
353 msg_Dbg( p_access, "late packet for UDP input (" I64Fd ")",
354 now - p_sys->p_buffer->i_dts
355 - p_sys->p_thread->i_caching );
357 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
358 p_sys->p_buffer = NULL;
361 i_len += p_buffer->i_buffer;
362 while( p_buffer->i_buffer )
364 int i_payload_size = p_sys->i_mtu;
366 int i_write = __MIN( p_buffer->i_buffer, i_payload_size );
370 if( !p_sys->p_buffer )
372 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
373 if( !p_sys->p_buffer ) break;
376 memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
377 p_buffer->p_buffer, i_write );
379 p_sys->p_buffer->i_buffer += i_write;
380 p_buffer->p_buffer += i_write;
381 p_buffer->i_buffer -= i_write;
382 if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
384 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
385 msg_Warn( p_access, "putting two PCRs at once" );
386 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
389 if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
392 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < now )
394 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
395 mdate() - p_sys->p_buffer->i_dts
396 - p_sys->p_thread->i_caching );
398 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
399 p_sys->p_buffer = NULL;
403 p_next = p_buffer->p_next;
404 block_Release( p_buffer );
408 return( p_sys->p_thread->b_error ? -1 : i_len );
411 /*****************************************************************************
412 * Seek: seek to a specific location in a file
413 *****************************************************************************/
414 static int Seek( sout_access_out_t *p_access, off_t i_pos )
416 msg_Err( p_access, "UDP sout access cannot seek" );
420 /*****************************************************************************
421 * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
422 *****************************************************************************/
423 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
425 sout_access_out_sys_t *p_sys = p_access->p_sys;
428 while ( block_FifoCount( p_sys->p_thread->p_empty_blocks ) > MAX_EMPTY_BLOCKS )
430 p_buffer = block_FifoGet( p_sys->p_thread->p_empty_blocks );
431 block_Release( p_buffer );
434 if( block_FifoCount( p_sys->p_thread->p_empty_blocks ) == 0 )
436 p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
440 p_buffer = block_FifoGet(p_sys->p_thread->p_empty_blocks );
441 p_buffer->i_flags = 0;
442 p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
445 p_buffer->i_dts = i_dts;
446 p_buffer->i_buffer = 0;
451 /*****************************************************************************
452 * ThreadWrite: Write a packet on the network at the good time.
453 *****************************************************************************/
454 static void ThreadWrite( vlc_object_t *p_this )
456 sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
457 mtime_t i_date_last = -1;
458 mtime_t i_to_send = p_thread->i_group;
459 int i_dropped_packets = 0;
461 while( !p_thread->b_die )
464 mtime_t i_date, i_sent;
466 if( (i++ % 1000)==0 ) {
469 block_t *p_tmp = p_thread->p_empty_blocks->p_first;
470 while( p_tmp ) { p_tmp = p_tmp->p_next; i++;}
471 p_tmp = p_thread->p_fifo->p_first;
472 while( p_tmp ) { p_tmp = p_tmp->p_next; j++;}
473 msg_Dbg( p_thread, "fifo depth: %d/%d, empty blocks: %d/%d",
474 p_thread->p_fifo->i_depth, j,p_thread->p_empty_blocks->i_depth,i );
477 p_pk = block_FifoGet( p_thread->p_fifo );
479 continue; /* forced wake-up */
481 i_date = p_thread->i_caching + p_pk->i_dts;
482 if( i_date_last > 0 )
484 if( i_date - i_date_last > 2000000 )
486 if( !i_dropped_packets )
487 msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
488 i_date - i_date_last );
490 block_FifoPut( p_thread->p_empty_blocks, p_pk );
492 i_date_last = i_date;
496 else if( i_date - i_date_last < -1000 )
498 if( !i_dropped_packets )
499 msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")",
500 i_date_last - i_date );
505 if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
508 i_to_send = p_thread->i_group;
510 ssize_t val = send( p_thread->i_handle, p_pk->p_buffer,
514 msg_Warn( p_thread, "send error: %m" );
517 if( i_dropped_packets )
519 msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
520 i_dropped_packets = 0;
525 if ( i_sent > i_date + 20000 )
527 msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
532 block_FifoPut( p_thread->p_empty_blocks, p_pk );
534 i_date_last = i_date;
539 static const char *MakeRandMulticast (int family, char *buf, size_t buflen)
541 uint32_t rand = (getpid() & 0xffff)
542 | (uint32_t)(((mdate () >> 10) & 0xffff) << 16);
549 struct in6_addr addr;
550 memcpy (&addr, "\xff\x38\x00\x00" "\x00\x00\x00\x00"
551 "\x00\x00\x00\x00", 12);
553 memcpy (addr.s6_addr + 12, &(uint32_t){ htonl (rand) }, 4);
554 return inet_ntop (family, &addr, buf, buflen);
561 addr.s_addr = htonl ((rand & 0xffffff) | 0xe8000000);
562 return inet_ntop (family, &addr, buf, buflen);
566 errno = EAFNOSUPPORT;