6fe59bbbaa3dea4b7e0bccabcfd33c9f01295d61
[vlc.git] / modules / access_output / udp.c
1 /*****************************************************************************
2  * udp.c
3  *****************************************************************************
4  * Copyright (C) 2001-2007 VLC authors and VideoLAN
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Eric Petit <titer@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33
34 #include <sys/types.h>
35 #include <unistd.h>
36 #include <assert.h>
37 #include <errno.h>
38
39 #include <vlc_sout.h>
40 #include <vlc_block.h>
41
42 #ifdef _WIN32
43 #   include <winsock2.h>
44 #   include <ws2tcpip.h>
45 #elif defined (HAVE_SYS_SOCKET_H)
46 #   include <sys/socket.h>
47 #endif
48
49 #include <vlc_network.h>
50
51 #define MAX_EMPTY_BLOCKS 200
52
53 /*****************************************************************************
54  * Module descriptor
55  *****************************************************************************/
56 static int  Open ( vlc_object_t * );
57 static void Close( vlc_object_t * );
58
59 #define SOUT_CFG_PREFIX "sout-udp-"
60
61 #define CACHING_TEXT N_("Caching value (ms)")
62 #define CACHING_LONGTEXT N_( \
63     "Default caching value for outbound UDP streams. This " \
64     "value should be set in milliseconds." )
65
66 #define GROUP_TEXT N_("Group packets")
67 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
68                           "or by groups. You can choose the number " \
69                           "of packets that will be sent at a time. It " \
70                           "helps reducing the scheduling load on " \
71                           "heavily-loaded systems." )
72
73 vlc_module_begin ()
74     set_description( N_("UDP stream output") )
75     set_shortname( "UDP" )
76     set_category( CAT_SOUT )
77     set_subcategory( SUBCAT_SOUT_ACO )
78     add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, CACHING_TEXT, CACHING_LONGTEXT, true )
79     add_integer( SOUT_CFG_PREFIX "group", 1, GROUP_TEXT, GROUP_LONGTEXT,
80                                  true )
81
82     set_capability( "sout access", 0 )
83     add_shortcut( "udp" )
84     set_callbacks( Open, Close )
85 vlc_module_end ()
86
87 /*****************************************************************************
88  * Exported prototypes
89  *****************************************************************************/
90
91 static const char *const ppsz_sout_options[] = {
92     "caching",
93     "group",
94     NULL
95 };
96
97 /* Options handled by the libvlc network core */
98 static const char *const ppsz_core_options[] = {
99     "dscp",
100     "ttl",
101     "miface",
102     NULL
103 };
104
105 static ssize_t Write   ( sout_access_out_t *, block_t * );
106 static int Control( sout_access_out_t *, int, va_list );
107
108 static void* ThreadWrite( void * );
109
110 typedef struct
111 {
112     vlc_tick_t    i_caching;
113     int           i_handle;
114     bool          b_mtu_warning;
115     size_t        i_mtu;
116
117     block_fifo_t *p_fifo;
118     block_t      *p_buffer;
119
120     vlc_thread_t  thread;
121 } sout_access_out_sys_t;
122
123 #define DEFAULT_PORT 1234
124
125 /*****************************************************************************
126  * Open: open the file
127  *****************************************************************************/
128 static int Open( vlc_object_t *p_this )
129 {
130     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
131     sout_access_out_sys_t   *p_sys;
132
133     char                *psz_dst_addr = NULL;
134     int                 i_dst_port;
135
136     int                 i_handle;
137
138     config_ChainParse( p_access, SOUT_CFG_PREFIX,
139                        ppsz_sout_options, p_access->p_cfg );
140     config_ChainParse( p_access, "",
141                        ppsz_core_options, p_access->p_cfg );
142
143     if (var_Create (p_access, "dst-port", VLC_VAR_INTEGER)
144      || var_Create (p_access, "src-port", VLC_VAR_INTEGER)
145      || var_Create (p_access, "dst-addr", VLC_VAR_STRING)
146      || var_Create (p_access, "src-addr", VLC_VAR_STRING))
147     {
148         return VLC_ENOMEM;
149     }
150
151     if( !( p_sys = malloc ( sizeof( *p_sys ) ) ) )
152         return VLC_ENOMEM;
153     p_access->p_sys = p_sys;
154
155     i_dst_port = DEFAULT_PORT;
156     char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
157     if( !psz_dst_addr )
158     {
159         free( p_sys );
160         return VLC_ENOMEM;
161     }
162
163     if (psz_parser[0] == '[')
164         psz_parser = strchr (psz_parser, ']');
165
166     psz_parser = strchr (psz_parser ? psz_parser : psz_dst_addr, ':');
167     if (psz_parser != NULL)
168     {
169         *psz_parser++ = '\0';
170         i_dst_port = atoi (psz_parser);
171     }
172
173     i_handle = net_ConnectDgram( p_this, psz_dst_addr, i_dst_port, -1,
174                                  IPPROTO_UDP );
175     free (psz_dst_addr);
176
177     if( i_handle == -1 )
178     {
179          msg_Err( p_access, "failed to create raw UDP socket" );
180          free (p_sys);
181          return VLC_EGENERIC;
182     }
183     else
184     {
185         char addr[NI_MAXNUMERICHOST];
186         int port;
187
188         if (net_GetSockAddress (i_handle, addr, &port) == 0)
189         {
190             msg_Dbg (p_access, "source: %s port %d", addr, port);
191             var_SetString (p_access, "src-addr", addr);
192             var_SetInteger (p_access, "src-port", port);
193         }
194
195         if (net_GetPeerAddress (i_handle, addr, &port) == 0)
196         {
197             msg_Dbg (p_access, "destination: %s port %d", addr, port);
198             var_SetString (p_access, "dst-addr", addr);
199             var_SetInteger (p_access, "dst-port", port);
200         }
201     }
202     shutdown( i_handle, SHUT_RD );
203
204     p_sys->i_caching = VLC_TICK_FROM_MS(
205                      var_GetInteger( p_access, SOUT_CFG_PREFIX "caching") );
206     p_sys->i_handle = i_handle;
207     p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
208     p_sys->b_mtu_warning = false;
209     p_sys->p_fifo = block_FifoNew();
210     p_sys->p_buffer = NULL;
211
212     if( vlc_clone( &p_sys->thread, ThreadWrite, p_access,
213                            VLC_THREAD_PRIORITY_HIGHEST ) )
214     {
215         msg_Err( p_access, "cannot spawn sout access thread" );
216         block_FifoRelease( p_sys->p_fifo );
217         net_Close (i_handle);
218         free (p_sys);
219         return VLC_EGENERIC;
220     }
221
222     p_access->pf_write = Write;
223     p_access->pf_control = Control;
224
225     return VLC_SUCCESS;
226 }
227
228 /*****************************************************************************
229  * Close: close the target
230  *****************************************************************************/
231 static void Close( vlc_object_t * p_this )
232 {
233     sout_access_out_t     *p_access = (sout_access_out_t*)p_this;
234     sout_access_out_sys_t *p_sys = p_access->p_sys;
235
236     vlc_cancel( p_sys->thread );
237     vlc_join( p_sys->thread, NULL );
238     block_FifoRelease( p_sys->p_fifo );
239
240     if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
241
242     net_Close( p_sys->i_handle );
243     free( p_sys );
244 }
245
246 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
247 {
248     (void)p_access;
249
250     switch( i_query )
251     {
252         case ACCESS_OUT_CONTROLS_PACE:
253             *va_arg( args, bool * ) = false;
254             break;
255
256         default:
257             return VLC_EGENERIC;
258     }
259     return VLC_SUCCESS;
260 }
261
262 /*****************************************************************************
263  * Write: standard write on a file descriptor.
264  *****************************************************************************/
265 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
266 {
267     sout_access_out_sys_t *p_sys = p_access->p_sys;
268     int i_len = 0;
269
270     while( p_buffer )
271     {
272         block_t *p_next;
273         int i_packets = 0;
274         vlc_tick_t now = vlc_tick_now();
275
276         if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
277         {
278             msg_Warn( p_access, "packet size > MTU, you should probably "
279                       "increase the MTU" );
280             p_sys->b_mtu_warning = true;
281         }
282
283         /* Check if there is enough space in the buffer */
284         if( p_sys->p_buffer &&
285             p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
286         {
287             if( p_sys->p_buffer->i_dts + p_sys->i_caching < now )
288             {
289                 msg_Dbg( p_access, "late packet for UDP input (%"PRId64 ")",
290                          now - p_sys->p_buffer->i_dts
291                           - p_sys->i_caching );
292             }
293             block_FifoPut( p_sys->p_fifo, p_sys->p_buffer );
294             p_sys->p_buffer = NULL;
295         }
296
297         i_len += p_buffer->i_buffer;
298         while( p_buffer->i_buffer )
299         {
300             size_t i_payload_size = p_sys->i_mtu;
301             size_t i_write = __MIN( p_buffer->i_buffer, i_payload_size );
302
303             i_packets++;
304
305             if( !p_sys->p_buffer )
306             {
307                 p_sys->p_buffer = block_Alloc( p_sys->i_mtu );
308                 if( !p_sys->p_buffer ) break;
309                 p_sys->p_buffer->i_dts = p_buffer->i_dts;
310                 p_sys->p_buffer->i_buffer = 0;
311             }
312
313             memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
314                     p_buffer->p_buffer, i_write );
315
316             p_sys->p_buffer->i_buffer += i_write;
317             p_buffer->p_buffer += i_write;
318             p_buffer->i_buffer -= i_write;
319             if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
320             {
321                 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
322                     msg_Warn( p_access, "putting two PCRs at once" );
323                 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
324             }
325
326             if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
327             {
328                 /* Flush */
329                 if( p_sys->p_buffer->i_dts + p_sys->i_caching < now )
330                 {
331                     msg_Dbg( p_access, "late packet for udp input (%"PRId64 ")",
332                              vlc_tick_now() - p_sys->p_buffer->i_dts
333                               - p_sys->i_caching );
334                 }
335                 block_FifoPut( p_sys->p_fifo, p_sys->p_buffer );
336                 p_sys->p_buffer = NULL;
337             }
338         }
339
340         p_next = p_buffer->p_next;
341         block_Release( p_buffer );
342         p_buffer = p_next;
343     }
344
345     return i_len;
346 }
347
348 /*****************************************************************************
349  * ThreadWrite: Write a packet on the network at the good time.
350  *****************************************************************************/
351 static void* ThreadWrite( void *data )
352 {
353     sout_access_out_t *p_access = data;
354     sout_access_out_sys_t *p_sys = p_access->p_sys;
355     vlc_tick_t i_date_last = -1;
356     const unsigned i_group = var_GetInteger( p_access,
357                                              SOUT_CFG_PREFIX "group" );
358     int i_to_send = i_group;
359     unsigned i_dropped_packets = 0;
360
361     for (;;)
362     {
363         block_t *p_pk = block_FifoGet( p_sys->p_fifo );
364         vlc_tick_t    i_date;
365
366         i_date = p_sys->i_caching + p_pk->i_dts;
367         if( i_date_last > 0 )
368         {
369             if( i_date - i_date_last > VLC_TICK_FROM_SEC(2) )
370             {
371                 if( !i_dropped_packets )
372                     msg_Dbg( p_access, "mmh, hole (%"PRId64" > 2s) -> drop",
373                              i_date - i_date_last );
374
375                 block_Release( p_pk );
376
377                 i_date_last = i_date;
378                 i_dropped_packets++;
379                 continue;
380             }
381             else if( i_date - i_date_last < VLC_TICK_FROM_MS(-1) )
382             {
383                 if( !i_dropped_packets )
384                     msg_Dbg( p_access, "mmh, packets in the past (%"PRId64")",
385                              i_date_last - i_date );
386             }
387         }
388
389         block_cleanup_push( p_pk );
390         i_to_send--;
391         if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
392         {
393             vlc_tick_wait( i_date );
394             i_to_send = i_group;
395         }
396         if ( send( p_sys->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 ) == -1 )
397             msg_Warn( p_access, "send error: %s", vlc_strerror_c(errno) );
398         vlc_cleanup_pop();
399
400         if( i_dropped_packets )
401         {
402             msg_Dbg( p_access, "dropped %i packets", i_dropped_packets );
403             i_dropped_packets = 0;
404         }
405
406         i_date_last = i_date;
407
408 #if 1
409         i_date = vlc_tick_now() - i_date;
410         if ( i_date > VLC_TICK_FROM_MS(20) )
411         {
412             msg_Dbg( p_access, "packet has been sent too late (%"PRId64 ")",
413                      i_date );
414         }
415 #endif
416
417         block_Release( p_pk );
418
419     }
420     return NULL;
421 }