Another forgotten file
[vlc.git] / modules / access_output / udp.c
1 /*****************************************************************************
2  * udp.c
3  *****************************************************************************
4  * Copyright (C) 2001-2005 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA  02111, 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
55 /*****************************************************************************
56  * Module descriptor
57  *****************************************************************************/
58 static int  Open ( vlc_object_t * );
59 static void Close( vlc_object_t * );
60
61 #define SOUT_CFG_PREFIX "sout-udp-"
62
63 #define CACHING_TEXT N_("Caching value (ms)")
64 #define CACHING_LONGTEXT N_( \
65     "Allows you to modify the default caching value for UDP streams. This " \
66     "value should be set in millisecond units." )
67
68 #define TTL_TEXT N_("Time To Live")
69 #define TTL_LONGTEXT N_("Allows you to define the time to live of the " \
70                         "outgoing stream.")
71
72 #define GROUP_TEXT N_("Group packets")
73 #define GROUP_LONGTEXT N_("Packets can be sent one by one at the right time " \
74                           "or by groups. This allows you to give the number " \
75                           "of packets that will be sent at a time. It " \
76                           "helps reducing the scheduling load on " \
77                           "heavily-loaded systems." )
78 #define LATE_TEXT N_("Late delay (ms)" )
79 #define LATE_LONGTEXT N_("Late packets are dropped. This allows you to give " \
80                        "the time (in milliseconds) a packet is allowed to be" \
81                        " late.")
82 #define RAW_TEXT N_("Raw write")
83 #define RAW_LONGTEXT N_("If you enable this option, packets will be sent " \
84                        "directly, without trying to fill the MTU (ie, " \
85                        "without trying to make the biggest possible packets " \
86                        "in order to improve streaming)." )
87
88 vlc_module_begin();
89     set_description( _("UDP stream output") );
90     set_shortname( N_( "UDP" ) );
91     set_category( CAT_SOUT );
92     set_subcategory( SUBCAT_SOUT_ACO );
93     add_integer( SOUT_CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
94     add_integer( SOUT_CFG_PREFIX "ttl", 0, NULL,TTL_TEXT, TTL_LONGTEXT,
95                                  VLC_TRUE );
96     add_integer( SOUT_CFG_PREFIX "group", 1, NULL, GROUP_TEXT, GROUP_LONGTEXT,
97                                  VLC_TRUE );
98     add_integer( SOUT_CFG_PREFIX "late", 0, NULL, LATE_TEXT, LATE_LONGTEXT,
99                                  VLC_TRUE );
100     add_bool( SOUT_CFG_PREFIX "raw",  0, NULL, RAW_TEXT, RAW_LONGTEXT,
101                                  VLC_TRUE );
102
103     set_capability( "sout access", 100 );
104     add_shortcut( "udp" );
105     add_shortcut( "rtp" ); // Will work only with ts muxer
106     set_callbacks( Open, Close );
107 vlc_module_end();
108
109 /*****************************************************************************
110  * Exported prototypes
111  *****************************************************************************/
112
113 static const char *ppsz_sout_options[] = {
114     "caching",
115     "ttl",
116     "group",
117     "late",
118     "raw",
119     NULL
120 };
121
122 static int  Write   ( sout_access_out_t *, block_t * );
123 static int  WriteRaw( sout_access_out_t *, block_t * );
124 static int  Seek    ( sout_access_out_t *, off_t  );
125
126 static void ThreadWrite( vlc_object_t * );
127 static block_t *NewUDPPacket( sout_access_out_t *, mtime_t );
128
129 typedef struct sout_access_thread_t
130 {
131     VLC_COMMON_MEMBERS
132
133     sout_instance_t *p_sout;
134
135     block_fifo_t *p_fifo;
136
137     int         i_handle;
138
139     int64_t     i_caching;
140     int64_t     i_late;
141     int         i_group;
142
143 } sout_access_thread_t;
144
145 struct sout_access_out_sys_t
146 {
147     int                 b_rtpts;  // 1 if add rtp/ts header
148     uint16_t            i_sequence_number;
149     uint32_t            i_ssrc;
150
151     int                 i_mtu;
152
153     block_t             *p_buffer;
154
155     sout_access_thread_t *p_thread;
156
157     vlc_bool_t          b_mtu_warning;
158 };
159
160 #define DEFAULT_PORT 1234
161
162 /*****************************************************************************
163  * Open: open the file
164  *****************************************************************************/
165 static int Open( vlc_object_t *p_this )
166 {
167     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
168     sout_access_out_sys_t   *p_sys;
169
170     char                *psz_parser;
171     char                *psz_dst_addr;
172     int                 i_dst_port;
173
174     module_t            *p_network;
175     network_socket_t    socket_desc;
176
177     vlc_value_t         val;
178
179     sout_CfgParse( p_access, SOUT_CFG_PREFIX,
180                    ppsz_sout_options, p_access->p_cfg );
181
182     if( !( p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
183     {
184         msg_Err( p_access, "not enough memory" );
185         return VLC_EGENERIC;
186     }
187     memset( p_sys, 0, sizeof(sout_access_out_sys_t) );
188     p_access->p_sys = p_sys;
189
190     if( p_access->psz_access != NULL &&
191         !strcmp( p_access->psz_access, "rtp" ) )
192     {
193         msg_Warn( p_access, "be careful that rtp output only works with ts "
194                   "payload (not an error)" );
195         p_sys->b_rtpts = 1;
196     }
197     else
198     {
199         p_sys->b_rtpts = 0;
200     }
201
202     psz_parser = strdup( p_access->psz_name );
203
204     psz_dst_addr = psz_parser;
205     i_dst_port = 0;
206
207     if ( *psz_parser == '[' )
208     {
209         while( *psz_parser && *psz_parser != ']' )
210         {
211             psz_parser++;
212         }
213     }
214     while( *psz_parser && *psz_parser != ':' )
215     {
216         psz_parser++;
217     }
218     if( *psz_parser == ':' )
219     {
220         *psz_parser = '\0';
221         psz_parser++;
222         i_dst_port = atoi( psz_parser );
223     }
224     if( i_dst_port <= 0 )
225     {
226         i_dst_port = DEFAULT_PORT;
227     }
228
229     p_sys->p_thread =
230         vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
231     if( !p_sys->p_thread )
232     {
233         msg_Err( p_access, "out of memory" );
234         return VLC_EGENERIC;
235     }
236
237     p_sys->p_thread->p_sout = p_access->p_sout;
238     p_sys->p_thread->b_die  = 0;
239     p_sys->p_thread->b_error= 0;
240     p_sys->p_thread->p_fifo = block_FifoNew( p_access );
241
242     socket_desc.psz_server_addr = psz_dst_addr;
243     socket_desc.i_server_port   = i_dst_port;
244     socket_desc.psz_bind_addr   = "";
245     socket_desc.i_bind_port     = 0;
246
247     var_Get( p_access, SOUT_CFG_PREFIX "ttl", &val );
248     socket_desc.i_ttl = val.i_int;
249
250     p_sys->p_thread->p_private = (void*)&socket_desc;
251     if( !( p_network = module_Need( p_sys->p_thread, "network", NULL, 0 ) ) )
252     {
253         msg_Err( p_access, "failed to open a connection (udp)" );
254         return VLC_EGENERIC;
255     }
256     module_Unneed( p_sys->p_thread, p_network );
257
258     p_sys->p_thread->i_handle = socket_desc.i_handle;
259
260     var_Get( p_access, SOUT_CFG_PREFIX "caching", &val );
261     p_sys->p_thread->i_caching = (int64_t)val.i_int * 1000;
262
263     var_Get( p_access, SOUT_CFG_PREFIX "group", &val );
264     p_sys->p_thread->i_group = val.i_int;
265
266     var_Get( p_access, SOUT_CFG_PREFIX "late", &val );
267     p_sys->p_thread->i_late = (int64_t)val.i_int * 1000;
268
269     p_sys->i_mtu = socket_desc.i_mtu;
270
271 #ifdef WIN32
272     if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
273                            VLC_THREAD_PRIORITY_HIGHEST, VLC_FALSE ) )
274 #else
275     if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
276                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
277 #endif
278     {
279         msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
280         vlc_object_destroy( p_sys->p_thread );
281         return VLC_EGENERIC;
282     }
283
284     srand( (uint32_t)mdate());
285     p_sys->p_buffer          = NULL;
286     p_sys->i_sequence_number = rand()&0xffff;
287     p_sys->i_ssrc            = rand()&0xffffffff;
288
289     var_Get( p_access, SOUT_CFG_PREFIX "raw", &val );
290     if( val.b_bool )  p_access->pf_write = WriteRaw;
291     else p_access->pf_write = Write;
292
293     p_access->pf_seek = Seek;
294
295     msg_Dbg( p_access, "udp access output opened(%s:%d)",
296              psz_dst_addr, i_dst_port );
297
298     free( psz_dst_addr );
299
300     /* update p_sout->i_out_pace_nocontrol */
301     p_access->p_sout->i_out_pace_nocontrol++;
302
303     return VLC_SUCCESS;
304 }
305
306 /*****************************************************************************
307  * Close: close the target
308  *****************************************************************************/
309 static void Close( vlc_object_t * p_this )
310 {
311     sout_access_out_t     *p_access = (sout_access_out_t*)p_this;
312     sout_access_out_sys_t *p_sys = p_access->p_sys;
313     int i;
314
315     p_sys->p_thread->b_die = 1;
316     for( i = 0; i < 10; i++ )
317     {
318         block_t *p_dummy = block_New( p_access, p_sys->i_mtu );
319         p_dummy->i_dts = 0;
320         p_dummy->i_pts = 0;
321         p_dummy->i_length = 0;
322         block_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
323     }
324     vlc_thread_join( p_sys->p_thread );
325
326     block_FifoRelease( p_sys->p_thread->p_fifo );
327
328     if( p_sys->p_buffer ) block_Release( p_sys->p_buffer );
329
330     net_Close( p_sys->p_thread->i_handle );
331
332     /* update p_sout->i_out_pace_nocontrol */
333     p_access->p_sout->i_out_pace_nocontrol--;
334
335     msg_Dbg( p_access, "udp access output closed" );
336     free( p_sys );
337 }
338
339 /*****************************************************************************
340  * Write: standard write on a file descriptor.
341  *****************************************************************************/
342 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
343 {
344     sout_access_out_sys_t *p_sys = p_access->p_sys;
345
346     while( p_buffer )
347     {
348         block_t *p_next;
349         int i_packets = 0;
350
351         if( !p_sys->b_mtu_warning && p_buffer->i_buffer > p_sys->i_mtu )
352         {
353             msg_Warn( p_access, "packet size > MTU, you should probably "
354                       "increase the MTU" );
355             p_sys->b_mtu_warning = VLC_TRUE;
356         }
357
358         /* Check if there is enough space in the buffer */
359         if( p_sys->p_buffer &&
360             p_sys->p_buffer->i_buffer + p_buffer->i_buffer > p_sys->i_mtu )
361         {
362             block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
363             p_sys->p_buffer = NULL;
364         }
365
366         while( p_buffer->i_buffer )
367         {
368             int i_write = __MIN( p_buffer->i_buffer, p_sys->i_mtu );
369
370             i_packets++;
371
372             if( !p_sys->p_buffer )
373             {
374                 p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
375                 if( !p_sys->p_buffer ) break;
376             }
377
378             memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_buffer,
379                     p_buffer->p_buffer, i_write );
380
381             p_sys->p_buffer->i_buffer += i_write;
382             p_buffer->p_buffer += i_write;
383             p_buffer->i_buffer -= i_write;
384             if ( p_buffer->i_flags & BLOCK_FLAG_CLOCK )
385             {
386                 if ( p_sys->p_buffer->i_flags & BLOCK_FLAG_CLOCK )
387                     msg_Warn( p_access, "putting two PCRs at once" );
388                 p_sys->p_buffer->i_flags |= BLOCK_FLAG_CLOCK;
389             }
390
391             if( p_sys->p_buffer->i_buffer == p_sys->i_mtu || i_packets > 1 )
392             {
393                 /* Flush */
394                 block_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
395                 p_sys->p_buffer = NULL;
396             }
397         }
398
399         p_next = p_buffer->p_next;
400         block_Release( p_buffer );
401         p_buffer = p_next;
402     }
403
404     return( p_sys->p_thread->b_error ? -1 : 0 );
405 }
406
407 /*****************************************************************************
408  * WriteRaw: write p_buffer without trying to fill mtu
409  *****************************************************************************/
410 static int WriteRaw( sout_access_out_t *p_access, block_t *p_buffer )
411 {
412     sout_access_out_sys_t   *p_sys = p_access->p_sys;
413
414     block_FifoPut( p_sys->p_thread->p_fifo, p_buffer );
415
416     return( p_sys->p_thread->b_error ? -1 : 0 );
417 }
418
419 /*****************************************************************************
420  * Seek: seek to a specific location in a file
421  *****************************************************************************/
422 static int Seek( sout_access_out_t *p_access, off_t i_pos )
423 {
424     msg_Err( p_access, "UDP sout access cannot seek" );
425     return -1;
426 }
427
428 /*****************************************************************************
429  * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
430  *****************************************************************************/
431 static block_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
432 {
433     sout_access_out_sys_t *p_sys = p_access->p_sys;
434     block_t *p_buffer;
435
436     p_buffer = block_New( p_access->p_sout, p_sys->i_mtu );
437     p_buffer->i_dts = i_dts;
438     p_buffer->i_buffer = 0;
439
440     if( p_sys->b_rtpts )
441     {
442         mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
443
444         /* add rtp/ts header */
445         p_buffer->p_buffer[0] = 0x80;
446         p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
447
448         p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
449         p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
450         p_sys->i_sequence_number++;
451
452         p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
453         p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
454         p_buffer->p_buffer[6] = ( i_timestamp >>  8 )&0xff;
455         p_buffer->p_buffer[7] = i_timestamp&0xff;
456
457         p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
458         p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
459         p_buffer->p_buffer[10] = ( p_sys->i_ssrc >>  8 )&0xff;
460         p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
461
462         p_buffer->i_buffer = 12;
463     }
464
465     return p_buffer;
466 }
467
468 /*****************************************************************************
469  * ThreadWrite: Write a packet on the network at the good time.
470  *****************************************************************************/
471 static void ThreadWrite( vlc_object_t *p_this )
472 {
473     sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
474     mtime_t              i_date_last = -1;
475     mtime_t              i_to_send = p_thread->i_group;
476     int                  i_dropped_packets = 0;
477
478     while( !p_thread->b_die )
479     {
480         block_t *p_pk;
481         mtime_t       i_date, i_sent;
482
483         p_pk = block_FifoGet( p_thread->p_fifo );
484
485         i_date = p_thread->i_caching + p_pk->i_dts;
486         if( i_date_last > 0 )
487         {
488             if( i_date - i_date_last > 2000000 )
489             {
490                 if( !i_dropped_packets )
491                     msg_Dbg( p_thread, "mmh, hole ("I64Fd" > 2s) -> drop",
492                              i_date - i_date_last );
493
494                 block_Release( p_pk  );
495                 i_date_last = i_date;
496                 i_dropped_packets++;
497                 continue;
498             }
499             else if( i_date - i_date_last < -15000 )
500             {
501                 if( !i_dropped_packets )
502                     msg_Dbg( p_thread, "mmh, packets in the past ("I64Fd")"
503                              " -> drop", i_date - i_date_last );
504
505                 block_Release( p_pk  );
506                 i_date_last = i_date;
507                 i_dropped_packets++;
508                 continue;
509             }
510         }
511
512         i_sent = mdate();
513         if( p_thread->i_late > 0 && i_sent > i_date + p_thread->i_late )
514         {
515             if( !i_dropped_packets )
516             {
517                 msg_Dbg( p_thread, "late packet to send (" I64Fd ") -> drop",
518                          i_sent - i_date );
519             }
520             block_Release( p_pk  );
521             i_date_last = i_date;
522             i_dropped_packets++;
523             continue;
524         }
525
526         i_to_send--;
527         if ( !i_to_send || (p_pk->i_flags & BLOCK_FLAG_CLOCK) )
528         {
529             mwait( i_date );
530             i_to_send = p_thread->i_group;
531         }
532         send( p_thread->i_handle, p_pk->p_buffer, p_pk->i_buffer, 0 );
533
534         if( i_dropped_packets )
535         {
536             msg_Dbg( p_thread, "dropped %i packets", i_dropped_packets );
537             i_dropped_packets = 0;
538         }
539
540 #if 1
541         i_sent = mdate();
542         if ( i_sent > i_date + 20000 )
543         {
544             msg_Dbg( p_thread, "packet has been sent too late (" I64Fd ")",
545                      i_sent - i_date );
546         }
547 #endif
548
549         block_Release( p_pk  );
550         i_date_last = i_date;
551     }
552 }