]> git.sesse.net Git - vlc/blob - modules/access_output/udp.c
access_output/udp.c: Fixed an old memleak.
[vlc] / modules / access_output / udp.c
1 /*****************************************************************************
2  * udp.c
3  *****************************************************************************
4  * Copyright (C) 2001-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Eric Petit <titer@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include <stdlib.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <string.h>
32 #include <errno.h>
33 #include <fcntl.h>
34
35 #include <vlc/vlc.h>
36 #include <vlc/sout.h>
37
38 #ifdef HAVE_UNISTD_H
39 #   include <unistd.h>
40 #endif
41
42 #ifdef WIN32
43 #   include <winsock2.h>
44 #   include <ws2tcpip.h>
45 #   ifndef IN_MULTICAST
46 #       define IN_MULTICAST(a) IN_CLASSD(a)
47 #   endif
48 #else
49 #   include <sys/socket.h>
50 #endif
51
52 #include "network.h"
53
54 #define MAX_EMPTY_BLOCKS 200
55
56 #if defined(WIN32) || defined(UNDER_CE)
57 # define WINSOCK_STRERROR_SIZE 20
58 static const char *winsock_strerror( char *buf )
59 {
60     snprintf( buf, WINSOCK_STRERROR_SIZE, "Winsock error %d",
61               WSAGetLastError( ) );
62     buf[WINSOCK_STRERROR_SIZE - 1] = '\0';
63     return buf;
64 }
65 #endif
66
67 /*****************************************************************************
68  * Module descriptor
69  *****************************************************************************/
70 static int  Open ( vlc_object_t * );
71 static void Close( vlc_object_t * );
72
73 #define SOUT_CFG_PREFIX "sout-udp-"
74
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." )
79
80 #define TTL_TEXT N_("Time-To-Live (TTL)")
81 #define TTL_LONGTEXT N_("Allows you to define the Time-To-Live of the " \
82                         "outgoing stream.")
83
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)." )
95
96 vlc_module_begin();
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,
103                                  VLC_TRUE );
104     add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
105                                  VLC_TRUE );
106     add_suppressed_integer( SOUT_CFG_PREFIX "late" );
107     add_bool( SOUT_CFG_PREFIX "raw",  0, NULL, RAW_TEXT, RAW_LONGTEXT,
108                                  VLC_TRUE );
109
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 );
114 vlc_module_end();
115
116 /*****************************************************************************
117  * Exported prototypes
118  *****************************************************************************/
119
120 static const char *ppsz_sout_options[] = {
121     "caching",
122     "ttl",
123     "group",
124     "raw",
125     NULL
126 };
127
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  );
131
132 static void ThreadWrite( vlc_object_t * );
133 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
134
135 typedef struct sout_access_thread_t
136 {
137     VLC_COMMON_MEMBERS
138
139     sout_instance_t *p_sout;
140
141     block_fifo_t *p_fifo;
142
143     int         i_handle;
144
145     int64_t     i_caching;
146     int         i_group;
147
148     vlc_mutex_t blocks_lock;
149     block_t     *p_empty_blocks;
150     int         i_empty_depth;
151
152 } sout_access_thread_t;
153
154 struct sout_access_out_sys_t
155 {
156     int                 b_rtpts;  // 1 if add rtp/ts header
157     uint16_t            i_sequence_number;
158     uint32_t            i_ssrc;
159
160     int                 i_mtu;
161
162     block_t             *p_buffer;
163
164     sout_access_thread_t *p_thread;
165
166     vlc_bool_t          b_mtu_warning;
167 };
168
169 #define DEFAULT_PORT 1234
170
171 /*****************************************************************************
172  * Open: open the file
173  *****************************************************************************/
174 static int Open( vlc_object_t *p_this )
175 {
176     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
177     sout_access_out_sys_t   *p_sys;
178
179     char                *psz_parser;
180     char                *psz_dst_addr;
181     int                 i_dst_port;
182
183     int                 i_handle;
184
185     vlc_value_t         val;
186
187     sout_CfgParse( p_access, SOUT_CFG_PREFIX,
188                    ppsz_sout_options, p_access->p_cfg );
189
190     if( !( p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
191     {
192         msg_Err( p_access, "not enough memory" );
193         return VLC_EGENERIC;
194     }
195     memset( p_sys, 0, sizeof(sout_access_out_sys_t) );
196     p_access->p_sys = p_sys;
197
198     if( p_access->psz_access != NULL &&
199         !strcmp( p_access->psz_access, "rtp" ) )
200     {
201         p_sys->b_rtpts = 1;
202     }
203     else
204     {
205         p_sys->b_rtpts = 0;
206     }
207
208     psz_parser = strdup( p_access->psz_name );
209
210     psz_dst_addr = psz_parser;
211     i_dst_port = 0;
212
213     if ( *psz_parser == '[' )
214     {
215         while( *psz_parser && *psz_parser != ']' )
216         {
217             psz_parser++;
218         }
219     }
220     while( *psz_parser && *psz_parser != ':' )
221     {
222         psz_parser++;
223     }
224     if( *psz_parser == ':' )
225     {
226         *psz_parser = '\0';
227         psz_parser++;
228         i_dst_port = atoi( psz_parser );
229     }
230     if( i_dst_port <= 0 )
231     {
232         i_dst_port = DEFAULT_PORT;
233     }
234
235     p_sys->p_thread =
236         vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
237     if( !p_sys->p_thread )
238     {
239         msg_Err( p_access, "out of memory" );
240         return VLC_EGENERIC;
241     }
242
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 );
250
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 );
253     if( i_handle == -1 )
254     {
255          msg_Err( p_access, "failed to open a connection (udp)" );
256          return VLC_EGENERIC;
257     }
258
259     p_sys->p_thread->i_handle = i_handle;
260     net_StopRecv( i_handle );
261
262     var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
263     p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
264
265     var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
266     p_sys->p_thread->i_group = val.i_int;
267
268     p_sys->i_mtu = var_CreateGetInteger( p_this, "mtu" );
269
270     if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
271                            VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
272     {
273         msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
274         vlc_object_destroy( p_sys->p_thread );
275         return VLC_EGENERIC;
276     }
277
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;
282
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;
286
287     p_access->pf_seek = Seek;
288
289     msg_Dbg( p_access, "udp access output opened(%s:%d)",
290              psz_dst_addr, i_dst_port );
291
292     free( psz_dst_addr );
293
294     /* update p_sout->i_out_pace_nocontrol */
295     p_access->p_sout->i_out_pace_nocontrol++;
296
297     return VLC_SUCCESS;
298 }
299
300 /*****************************************************************************
301  * Close: close the target
302  *****************************************************************************/
303 static void Close( vlc_object_t * p_this )
304 {
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;
307     int i;
308
309     p_sys->p_thread->b_die = 1;
310     for( i = 0; i < 10; i++ )
311     {
312         block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
313         p_dummy->i_dts = 0;
314         p_dummy->i_pts = 0;
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 );
318     }
319     vlc_thread_join( p_sys->p_thread );
320
321     block_FifoRelease( p_sys->p_thread->p_fifo );
322
323     if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
324     while ( p_sys->p_thread->p_empty_blocks != NULL )
325     {
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;
329     }
330     vlc_mutex_destroy( &p_sys->p_thread->blocks_lock );
331
332     net_Close( p_sys->p_thread->i_handle );
333
334     vlc_object_destroy( p_sys->p_thread );
335     /* update p_sout->i_out_pace_nocontrol */
336     p_access->p_sout->i_out_pace_nocontrol--;
337
338     msg_Dbg( p_access, "udp access output closed" );
339     free( p_sys );
340 }
341
342 /*****************************************************************************
343  * Write: standard write on a file descriptor.
344  *****************************************************************************/
345 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
346 {
347     sout_access_out_sys_t *p_sys = p_access->p_sys;
348
349     while( p_buffer )
350     {
351         block_t *p_next;
352         int i_packets = 0;
353
354         if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
355         {
356             msg_Warn( p_access, "packet size > MTU, you should probably "
357                       "increase the MTU" );
358             p_sys->b_mtu_warning = VLC_TRUE;
359         }
360
361         /* Check if there is enough space in the buffer */
362         if( p_sys->p_buffer &&
363             p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
364         {
365             if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching < mdate() )
366             {
367                 msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
368                          mdate() - p_sys->p_buffer->i_dts
369                           - p_sys->p_thread->i_caching );
370             }
371             block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
372             p_sys->p_buffer = NULL;
373         }
374
375         while( p_buffer->i_buffer )
376         {
377             int i_write = __MIN( p_buffer->i_buffer, p_sys->i_mtu );
378
379             i_packets++;
380
381             if( !p_sys->p_buffer )
382             {
383                 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
384                 if( !p_sys->p_buffer ) break;
385             }
386
387             memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
388                     p_buffer->p_buffer, i_write );
389
390             p_sys->p_buffer->i_buffer += i_write;
391             p_buffer->p_buffer += i_write;
392             p_buffer->i_buffer -= i_write;
393             if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
394             {
395                 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
396                     msg_Warn( p_access, "putting two PCRs at once" );
397                 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
398             }
399
400             if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
401             {
402                 /* Flush */
403                 if( p_sys->p_buffer->i_dts + p_sys->p_thread->i_caching
404                       < mdate() )
405                 {
406                     msg_Dbg( p_access, "late packet for udp input (" I64Fd ")",
407                              mdate() - p_sys->p_buffer->i_dts
408                               - p_sys->p_thread->i_caching );
409                 }
410                 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
411                 p_sys->p_buffer = NULL;
412             }
413         }
414
415         p_next = p_buffer->p_next;
416         block_Release( p_buffer );
417         p_buffer = p_next;
418     }
419
420     return( p_sys->p_thread->b_error ? -1 : 0 );
421 }
422
423 /*****************************************************************************
424  * WriteRaw: write p_buffer without trying to fill mtu
425  *****************************************************************************/
426 static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
427 {
428     sout_access_out_sys_t   *p_sys = p_access->p_sys;
429     block_t *p_buf;
430
431     vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
432     while ( p_sys->p_thread->i_empty_depth >= MAX_EMPTY_BLOCKS )
433     {
434         p_buf = p_sys->p_thread->p_empty_blocks;
435         p_sys->p_thread->p_empty_blocks =
436                     p_sys->p_thread->p_empty_blocks->p_next;
437         p_sys->p_thread->i_empty_depth--;
438         vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
439         block_Release( p_buf );
440         vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
441     }
442     vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
443
444     block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
445
446     return( p_sys->p_thread->b_error ? -1 : 0 );
447 }
448
449 /*****************************************************************************
450  * Seek: seek to a specific location in a file
451  *****************************************************************************/
452 static int Seek( sout_access_out_t *p_access, off_t i_pos )
453 {
454     msg_Err( p_access, "UDP sout access cannot seek" );
455     return -1;
456 }
457
458 /*****************************************************************************
459  * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
460  *****************************************************************************/
461 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
462 {
463     sout_access_out_sys_t *p_sys = p_access->p_sys;
464     block_t *p_buffer;
465
466     vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
467     while ( p_sys->p_thread->i_empty_depth > MAX_EMPTY_BLOCKS )
468     {
469         p_buffer = p_sys->p_thread->p_empty_blocks;
470         p_sys->p_thread->p_empty_blocks =
471                     p_sys->p_thread->p_empty_blocks->p_next;
472         p_sys->p_thread->i_empty_depth--;
473         vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
474         block_Release( p_buffer );
475         vlc_mutex_lock( &p_sys->p_thread->blocks_lock );
476     }
477     p_buffer = p_sys->p_thread->p_empty_blocks;
478     if ( p_buffer != NULL )
479     {
480         p_sys->p_thread->p_empty_blocks =
481                     p_sys->p_thread->p_empty_blocks->p_next;
482         p_sys->p_thread->i_empty_depth--;
483         vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
484         p_buffer->p_next = NULL;
485         p_buffer->i_flags = 0;
486         p_buffer = block_Realloc( p_buffer, 0, p_sys->i_mtu );
487     }
488     else
489     {
490         vlc_mutex_unlock( &p_sys->p_thread->blocks_lock );
491         p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
492     }
493
494     p_buffer->i_dts = i_dts;
495     p_buffer->i_buffer = 0;
496
497     if( p_sys->b_rtpts )
498     {
499         mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
500
501         /* add rtp/ts header */
502         p_buffer->p_buffer[0] = 0x80;
503         p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
504
505         p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
506         p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
507         p_sys->i_sequence_number++;
508
509         p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
510         p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
511         p_buffer->p_buffer[6] = ( i_timestamp >>  8 )&0xff;
512         p_buffer->p_buffer[7] = i_timestamp&0xff;
513
514         p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
515         p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
516         p_buffer->p_buffer[10] = ( p_sys->i_ssrc >>  8 )&0xff;
517         p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
518
519         p_buffer->i_buffer = 12;
520     }
521
522     return p_buffer;
523 }
524
525 /*****************************************************************************
526  * ThreadWrite: Write a packet on the network at the good time.
527  *****************************************************************************/
528 static void ThreadWrite( vlc_object_t *p_this )
529 {
530     sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
531     mtime_t              i_date_last = -1;
532     mtime_t              i_to_send = p_thread->i_group;
533     int                  i_dropped_packets = 0;
534 #if defined(WIN32) || defined(UNDER_CE)
535     char strerror_buf[WINSOCK_STRERROR_SIZE];
536 # define strerror( x ) winsock_strerror( strerror_buf )
537 #endif
538
539     while( !p_thread->b_die )
540     {
541         block_t *p_pk;
542         mtime_t       i_date, i_sent;
543
544         p_pk = block_FifoGet( p_thread->p_fifo );
545
546         i_date = p_thread->i_caching + p_pk->i_dts;
547         if( i_date_last > 0 )
548         {
549             if( i_date - i_date_last > 2000000 )
550             {
551                 if( !i_dropped_packets )
552                     msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
553                              i_date - i_date_last );
554
555                 vlc_mutex_lock( &p_thread->blocks_lock );
556                 p_pk->p_next = p_thread->p_empty_blocks;
557                 p_thread->p_empty_blocks = p_pk;
558                 p_thread->i_empty_depth++;
559                 vlc_mutex_unlock( &p_thread->blocks_lock );
560
561                 i_date_last = i_date;
562                 i_dropped_packets++;
563                 continue;
564             }
565             else if( i_date - i_date_last < -1000 )
566             {
567                 if( !i_dropped_packets )
568                     msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")",
569                              i_date_last - i_date );
570             }
571         }
572
573         i_to_send--;
574         if( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
575         {
576             mwait( i_date );
577             i_to_send = p_thread->i_group;
578         }
579         if( send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 )
580               == -1 )
581         {
582             msg_Warn( p_thread, "send error: %s", strerror(errno) );
583         }
584
585         if( i_dropped_packets )
586         {
587             msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
588             i_dropped_packets = 0;
589         }
590
591 #if 1
592         i_sent = mdate();
593         if ( i_sent > i_date + 20000 )
594         {
595             msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
596                      i_sent - i_date );
597         }
598 #endif
599
600         vlc_mutex_lock( &p_thread->blocks_lock );
601         p_pk->p_next = p_thread->p_empty_blocks;
602         p_thread->p_empty_blocks = p_pk;
603         p_thread->i_empty_depth++;
604         vlc_mutex_unlock( &p_thread->blocks_lock );
605
606         i_date_last = i_date;
607     }
608 }