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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <sys/types.h>
40 #include <vlc_block.h>
47 # include <winsock2.h>
48 # include <ws2tcpip.h>
50 # include <sys/socket.h>
53 #include <vlc_network.h>
55 #define MAX_EMPTY_BLOCKS 200
57 /*****************************************************************************
59 *****************************************************************************/
60 static int Open ( vlc_object_t * );
61 static void Close( vlc_object_t * );
63 #define SOUT_CFG_PREFIX "sout-udp-"
65 #define CACHING_TEXT N_("Caching value (ms)")
66 #define CACHING_LONGTEXT N_( \
67 "Default caching value for outbound UDP streams. This " \
68 "value should be set in milliseconds." )
70 #define GROUP_TEXT N_("Group packets")
71 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
72 "or by groups. You can choose the number " \
73 "of packets that will be sent at a time. It " \
74 "helps reducing the scheduling load on " \
75 "heavily-loaded systems." )
78 set_description( N_("UDP stream output") )
79 set_shortname( "UDP" )
80 set_category( CAT_SOUT )
81 set_subcategory( SUBCAT_SOUT_ACO )
82 add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
83 add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
85 add_obsolete_integer( SOUT_CFG_PREFIX "late" )
86 add_obsolete_bool( SOUT_CFG_PREFIX "raw" )
88 set_capability( "sout access", 0 )
90 set_callbacks( Open, Close )
93 /*****************************************************************************
95 *****************************************************************************/
97 static const char *const ppsz_sout_options[] = {
103 /* Options handled by the libvlc network core */
104 static const char *const ppsz_core_options[] = {
112 static ssize_t Write ( sout_access_out_t *, block_t * );
113 static int Seek ( sout_access_out_t *, off_t );
114 static int Control( sout_access_out_t *, int, va_list );
116 static void* ThreadWrite( void * );
117 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
119 struct sout_access_out_sys_t
126 block_fifo_t *p_fifo;
127 block_fifo_t *p_empty_blocks;
133 #define DEFAULT_PORT 1234
135 /*****************************************************************************
136 * Open: open the file
137 *****************************************************************************/
138 static int Open( vlc_object_t *p_this )
140 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
141 sout_access_out_sys_t *p_sys;
143 char *psz_dst_addr = NULL;
148 config_ChainParse( p_access, SOUT_CFG_PREFIX,
149 ppsz_sout_options, p_access->p_cfg );
150 config_ChainParse( p_access, "",
151 ppsz_core_options, p_access->p_cfg );
153 if (var_Create (p_access, "dst-port", VLC_VAR_INTEGER)
154 || var_Create (p_access, "src-port", VLC_VAR_INTEGER)
155 || var_Create (p_access, "dst-addr", VLC_VAR_STRING)
156 || var_Create (p_access, "src-addr", VLC_VAR_STRING))
161 if( !( p_sys = malloc ( sizeof( *p_sys ) ) ) )
163 p_access->p_sys = p_sys;
165 i_dst_port = DEFAULT_PORT;
166 char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
173 if (psz_parser[0] == '[')
174 psz_parser = strchr (psz_parser, ']');
176 psz_parser = strchr (psz_parser ? psz_parser : psz_dst_addr, ':');
177 if (psz_parser != NULL)
179 *psz_parser++ = '\0';
180 i_dst_port = atoi (psz_parser);
183 i_handle = net_ConnectDgram( p_this, psz_dst_addr, i_dst_port, -1,
189 msg_Err( p_access, "failed to create raw UDP socket" );
195 char addr[NI_MAXNUMERICHOST];
198 if (net_GetSockAddress (i_handle, addr, &port) == 0)
200 msg_Dbg (p_access, "source: %s port %d", addr, port);
201 var_SetString (p_access, "src-addr", addr);
202 var_SetInteger (p_access, "src-port", port);
205 if (net_GetPeerAddress (i_handle, addr, &port) == 0)
207 msg_Dbg (p_access, "destination: %s port %d", addr, port);
208 var_SetString (p_access, "dst-addr", addr);
209 var_SetInteger (p_access, "dst-port", port);
212 shutdown( i_handle, SHUT_RD );
214 p_sys->i_caching = UINT64_C(1000)
215 * var_GetInteger( p_access, SOUT_CFG_PREFIX "caching");
216 p_sys->i_handle = i_handle;
217 p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
218 p_sys->b_mtu_warning = false;
219 p_sys->p_fifo = block_FifoNew();
220 p_sys->p_empty_blocks = block_FifoNew();
221 p_sys->p_buffer = NULL;
223 if( vlc_clone( &p_sys->thread, ThreadWrite, p_access,
224 VLC_THREAD_PRIORITY_HIGHEST ) )
226 msg_Err( p_access, "cannot spawn sout access thread" );
227 block_FifoRelease( p_sys->p_fifo );
228 block_FifoRelease( p_sys->p_empty_blocks );
229 net_Close (i_handle);
234 p_access->pf_write = Write;
235 p_access->pf_seek = Seek;
236 p_access->pf_control = Control;
241 /*****************************************************************************
242 * Close: close the target
243 *****************************************************************************/
244 static void Close( vlc_object_t * p_this )
246 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
247 sout_access_out_sys_t *p_sys = p_access->p_sys;
249 vlc_cancel( p_sys->thread );
250 vlc_join( p_sys->thread, NULL );
251 block_FifoRelease( p_sys->p_fifo );
252 block_FifoRelease( p_sys->p_empty_blocks );
254 if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
256 net_Close( p_sys->i_handle );
260 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
266 case ACCESS_OUT_CONTROLS_PACE:
267 *va_arg( args, bool * ) = false;
276 /*****************************************************************************
277 * Write: standard write on a file descriptor.
278 *****************************************************************************/
279 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
281 sout_access_out_sys_t *p_sys = p_access->p_sys;
288 mtime_t now = mdate();
290 if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
292 msg_Warn( p_access, "packet size > MTU, you should probably "
293 "increase the MTU" );
294 p_sys->b_mtu_warning = true;
297 /* Check if there is enough space in the buffer */
298 if( p_sys->p_buffer &&
299 p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
301 if( p_sys->p_buffer->i_dts + p_sys->i_caching < now )
303 msg_Dbg( p_access, "late packet for UDP input (%"PRId64 ")",
304 now - p_sys->p_buffer->i_dts
305 - p_sys->i_caching );
307 block_FifoPut( p_sys->p_fifo, p_sys->p_buffer );
308 p_sys->p_buffer = NULL;
311 i_len += p_buffer->i_buffer;
312 while( p_buffer->i_buffer )
314 size_t i_payload_size = p_sys->i_mtu;
315 size_t i_write = __MIN( p_buffer->i_buffer, i_payload_size );
319 if( !p_sys->p_buffer )
321 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
322 if( !p_sys->p_buffer ) break;
325 memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
326 p_buffer->p_buffer, i_write );
328 p_sys->p_buffer->i_buffer += i_write;
329 p_buffer->p_buffer += i_write;
330 p_buffer->i_buffer -= i_write;
331 if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
333 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
334 msg_Warn( p_access, "putting two PCRs at once" );
335 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
338 if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
341 if( p_sys->p_buffer->i_dts + p_sys->i_caching < now )
343 msg_Dbg( p_access, "late packet for udp input (%"PRId64 ")",
344 mdate() - p_sys->p_buffer->i_dts
345 - p_sys->i_caching );
347 block_FifoPut( p_sys->p_fifo, p_sys->p_buffer );
348 p_sys->p_buffer = NULL;
352 p_next = p_buffer->p_next;
353 block_Release( p_buffer );
360 /*****************************************************************************
361 * Seek: seek to a specific location in a file
362 *****************************************************************************/
363 static int Seek( sout_access_out_t *p_access, off_t i_pos )
366 msg_Err( p_access, "UDP sout access cannot seek" );
370 /*****************************************************************************
371 * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
372 *****************************************************************************/
373 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
375 sout_access_out_sys_t *p_sys = p_access->p_sys;
378 while ( block_FifoCount( p_sys->p_empty_blocks ) > MAX_EMPTY_BLOCKS )
380 p_buffer = block_FifoGet( p_sys->p_empty_blocks );
381 block_Release( p_buffer );
384 if( block_FifoCount( p_sys->p_empty_blocks ) == 0 )
386 p_buffer = block_Alloc( p_sys->i_mtu );
390 p_buffer = block_FifoGet(p_sys->p_empty_blocks );
391 p_buffer->i_flags = 0;
392 p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
395 p_buffer->i_dts = i_dts;
396 p_buffer->i_buffer = 0;
401 /*****************************************************************************
402 * ThreadWrite: Write a packet on the network at the good time.
403 *****************************************************************************/
404 static void* ThreadWrite( void *data )
406 sout_access_out_t *p_access = data;
407 sout_access_out_sys_t *p_sys = p_access->p_sys;
408 mtime_t i_date_last = -1;
409 const unsigned i_group = var_GetInteger( p_access,
410 SOUT_CFG_PREFIX "group" );
411 mtime_t i_to_send = i_group;
412 unsigned i_dropped_packets = 0;
416 block_t *p_pk = block_FifoGet( p_sys->p_fifo );
417 mtime_t i_date, i_sent;
419 i_date = p_sys->i_caching + p_pk->i_dts;
420 if( i_date_last > 0 )
422 if( i_date - i_date_last > 2000000 )
424 if( !i_dropped_packets )
425 msg_Dbg( p_access, "mmh, hole (%"PRId64" > 2s) -> drop",
426 i_date - i_date_last );
428 block_FifoPut( p_sys->p_empty_blocks, p_pk );
430 i_date_last = i_date;
434 else if( i_date - i_date_last < -1000 )
436 if( !i_dropped_packets )
437 msg_Dbg( p_access, "mmh, packets in the past (%"PRId64")",
438 i_date_last - i_date );
442 block_cleanup_push( p_pk );
444 if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
449 if ( send( p_sys->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 ) == -1 )
450 msg_Warn( p_access, "send error: %m" );
453 if( i_dropped_packets )
455 msg_Dbg( p_access, "dropped %i packets", i_dropped_packets );
456 i_dropped_packets = 0;
461 if ( i_sent > i_date + 20000 )
463 msg_Dbg( p_access, "packet has been sent too late (%"PRId64 ")",
468 block_FifoPut( p_sys->p_empty_blocks, p_pk );
470 i_date_last = i_date;