* modules/access_output/udp.c: removed unnecessary code.
[vlc.git] / modules / access_output / udp.c
1 /*****************************************************************************
2  * udp.c
3  *****************************************************************************
4  * Copyright (C) 2001, 2002 VideoLAN
5  * $Id: udp.c,v 1.10 2003/06/19 18:45:06 gbazin Exp $
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/input.h>
37 #include <vlc/sout.h>
38
39 #ifdef HAVE_UNISTD_H
40 #   include <unistd.h>
41 #endif
42
43 #ifdef WIN32
44 #   include <winsock2.h>
45 #   include <ws2tcpip.h>
46 #   ifndef IN_MULTICAST
47 #       define IN_MULTICAST(a) IN_CLASSD(a)
48 #   endif
49 #else
50 #   include <sys/socket.h>
51 #endif
52
53 #include "network.h"
54
55 #define DEFAULT_PORT 1234
56 #define LATENCY     100000
57 #define MAX_ERROR    500000
58 /*****************************************************************************
59  * Exported prototypes
60  *****************************************************************************/
61 static int     Open   ( vlc_object_t * );
62 static void    Close  ( vlc_object_t * );
63
64 static int     Write( sout_access_out_t *, sout_buffer_t * );
65 static int     Seek ( sout_access_out_t *, off_t  );
66
67 static void    ThreadWrite( vlc_object_t * );
68
69 static sout_buffer_t *NewUDPPacket( sout_access_out_t *, mtime_t );
70
71 /*****************************************************************************
72  * Module descriptor
73  *****************************************************************************/
74 #define CACHING_TEXT N_("caching value in ms")
75 #define CACHING_LONGTEXT N_( \
76     "Allows you to modify the default caching value for udp streams. This " \
77     "value should be set in miliseconds units." )
78
79 vlc_module_begin();
80     set_description( _("UDP stream ouput") );
81     add_category_hint( N_("udp stream output"), NULL , VLC_TRUE );
82     add_integer( "udp-sout-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
83     set_capability( "sout access", 100 );
84     add_shortcut( "udp" );
85     add_shortcut( "rtp" ); // Will work only with ts muxer
86     set_callbacks( Open, Close );
87 vlc_module_end();
88
89 typedef struct sout_access_thread_s
90 {
91     VLC_COMMON_MEMBERS
92
93     sout_instance_t *p_sout;
94
95     sout_fifo_t *p_fifo;
96
97     int         i_handle;
98
99 } sout_access_thread_t;
100
101 struct sout_access_out_sys_t
102 {
103     int                 b_rtpts;  // 1 if add rtp/ts header
104     uint16_t            i_sequence_number;
105     uint32_t            i_ssrc;
106
107     unsigned int        i_mtu;
108
109     sout_buffer_t       *p_buffer;
110
111     sout_access_thread_t *p_thread;
112
113 };
114
115 /*****************************************************************************
116  * Open: open the file
117  *****************************************************************************/
118 static int Open( vlc_object_t *p_this )
119 {
120     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
121     sout_access_out_sys_t   *p_sys;
122
123     char                *psz_parser;
124     char                *psz_dst_addr;
125     int                 i_dst_port;
126
127     module_t            *p_network;
128     network_socket_t    socket_desc;
129
130     if( !( p_sys = p_access->p_sys =
131                 malloc( sizeof( sout_access_out_sys_t ) ) ) )
132     {
133         msg_Err( p_access, "Not enough memory" );
134         return( VLC_EGENERIC );
135     }
136
137
138     if( p_access->psz_access != NULL &&
139         !strcmp( p_access->psz_access, "rtp" ) )
140     {
141         msg_Warn( p_access, "becarefull that rtp ouput work only with ts "
142                   "payload(not an error)" );
143         p_sys->b_rtpts = 1;
144     }
145     else
146     {
147         p_sys->b_rtpts = 0;
148     }
149
150     psz_parser = strdup( p_access->psz_name );
151
152     psz_dst_addr = psz_parser;
153     i_dst_port = 0;
154
155     if ( *psz_parser == '[' )
156     {
157         while( *psz_parser && *psz_parser != ']' )
158         {
159             psz_parser++;
160         }
161     }
162     while( *psz_parser && *psz_parser != ':' )
163     {
164         psz_parser++;
165     }
166     if( *psz_parser == ':' )
167     {
168         *psz_parser = '\0';
169         psz_parser++;
170         i_dst_port = atoi( psz_parser );
171     }
172     if( i_dst_port <= 0 )
173     {
174         i_dst_port = DEFAULT_PORT;
175     }
176
177     p_sys->p_thread =
178         vlc_object_create( p_access, sizeof( sout_access_thread_t ) );
179     if( !p_sys->p_thread )
180     {
181         msg_Err( p_access, "out of memory" );
182         return( VLC_EGENERIC );
183     }
184
185     p_sys->p_thread->p_sout = p_access->p_sout;
186     p_sys->p_thread->b_die  = 0;
187     p_sys->p_thread->b_error= 0;
188     p_sys->p_thread->p_fifo = sout_FifoCreate( p_access->p_sout );
189
190     socket_desc.i_type = NETWORK_UDP;
191     socket_desc.psz_server_addr = psz_dst_addr;
192     socket_desc.i_server_port   = i_dst_port;
193     socket_desc.psz_bind_addr   = "";
194     socket_desc.i_bind_port     = 0;
195     p_sys->p_thread->p_private = (void*)&socket_desc;
196     if( !( p_network = module_Need( p_sys->p_thread,
197                                     "network", "" ) ) )
198     {
199         msg_Err( p_access, "failed to open a connection (udp)" );
200         return( VLC_EGENERIC );
201     }
202     module_Unneed( p_sys->p_thread, p_network );
203
204     p_sys->p_thread->i_handle = socket_desc.i_handle;
205     p_sys->i_mtu     = socket_desc.i_mtu;
206
207     if( vlc_thread_create( p_sys->p_thread, "sout write thread", ThreadWrite,
208                            VLC_THREAD_PRIORITY_OUTPUT, VLC_FALSE ) )
209     {
210         msg_Err( p_access->p_sout, "cannot spawn sout access thread" );
211         vlc_object_destroy( p_sys->p_thread );
212         return( VLC_EGENERIC );
213     }
214
215     srand( (uint32_t)mdate());
216     p_sys->p_buffer          = NULL;
217     p_sys->i_sequence_number = rand()&0xffff;
218     p_sys->i_ssrc            = rand()&0xffffffff;
219
220     p_access->pf_write       = Write;
221     p_access->pf_seek        = Seek;
222
223     msg_Info( p_access, "Open: addr:`%s' port:`%d'",
224               psz_dst_addr, i_dst_port );
225
226     free( psz_dst_addr );
227     return VLC_SUCCESS;
228 }
229
230 /*****************************************************************************
231  * Close: close the target
232  *****************************************************************************/
233 static void Close( vlc_object_t * p_this )
234 {
235     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
236     sout_access_out_sys_t   *p_sys = p_access->p_sys;
237     int                 i;
238
239     p_sys->p_thread->b_die = 1;
240     for( i = 0; i < 10; i++ )
241     {
242         sout_buffer_t       *p_dummy;
243
244         p_dummy = sout_BufferNew( p_access->p_sout, p_sys->i_mtu );
245         p_dummy->i_dts = 0;
246         p_dummy->i_pts = 0;
247         p_dummy->i_length = 0;
248         sout_FifoPut( p_sys->p_thread->p_fifo, p_dummy );
249     }
250     vlc_thread_join( p_sys->p_thread );
251
252     sout_FifoDestroy( p_access->p_sout, p_sys->p_thread->p_fifo );
253
254     if( p_sys->p_buffer )
255     {
256         sout_BufferDelete( p_access->p_sout, p_sys->p_buffer );
257     }
258
259 #if defined( UNDER_CE )
260     CloseHandle( (HANDLE)p_sys->p_thread->i_handle );
261 #elif defined( WIN32 )
262     closesocket( p_sys->p_thread->i_handle );
263 #else
264     close( p_sys->p_thread->i_handle );
265 #endif
266
267     free( p_sys );
268     msg_Info( p_access, "Close" );
269 }
270
271 /*****************************************************************************
272  * Read: standard read on a file descriptor.
273  *****************************************************************************/
274 static int Write( sout_access_out_t *p_access, sout_buffer_t *p_buffer )
275 {
276     sout_access_out_sys_t   *p_sys = p_access->p_sys;
277     unsigned int i_write;
278
279     while( p_buffer )
280     {
281         sout_buffer_t *p_next;
282         if( p_buffer->i_size > p_sys->i_mtu )
283         {
284             msg_Warn( p_access, "arggggggggggggg packet size > mtu" );
285             i_write = p_sys->i_mtu;
286         }
287         else
288         {
289             i_write = p_buffer->i_size;
290         }
291
292         /* if we have enough data, enque the buffer */
293         if( p_sys->p_buffer &&
294             p_sys->p_buffer->i_size + i_write > p_sys->i_mtu )
295         {
296             sout_FifoPut( p_sys->p_thread->p_fifo, p_sys->p_buffer );
297             p_sys->p_buffer = NULL;
298         }
299
300         if( !p_sys->p_buffer )
301         {
302             p_sys->p_buffer = NewUDPPacket( p_access, p_buffer->i_dts );
303         }
304
305         if( p_buffer->i_size > 0 )
306         {
307             memcpy( p_sys->p_buffer->p_buffer + p_sys->p_buffer->i_size,
308                     p_buffer->p_buffer, i_write );
309             p_sys->p_buffer->i_size += i_write;
310         }
311         p_next = p_buffer->p_next;
312         sout_BufferDelete( p_access->p_sout, p_buffer );
313         p_buffer = p_next;
314     }
315
316     return( p_sys->p_thread->b_error ? -1 : 0 );
317 }
318
319 /*****************************************************************************
320  * Seek: seek to a specific location in a file
321  *****************************************************************************/
322 static int Seek( sout_access_out_t *p_access, off_t i_pos )
323 {
324
325     msg_Err( p_access, "udp sout access cannot seek" );
326     return( -1 );
327 }
328
329 /*****************************************************************************
330  * NewUDPPacket: allocate a new UDP packet of size p_sys->i_mtu
331  *****************************************************************************/
332 static sout_buffer_t *NewUDPPacket( sout_access_out_t *p_access, mtime_t i_dts)
333 {
334     sout_access_out_sys_t *p_sys = p_access->p_sys;
335     sout_buffer_t *p_buffer;
336
337     p_buffer = sout_BufferNew( p_access->p_sout, p_sys->i_mtu );
338     p_buffer->i_dts = i_dts;
339     p_buffer->i_size = 0;
340
341     if( p_sys->b_rtpts )
342     {
343         mtime_t i_timestamp = p_buffer->i_dts * 9 / 100;
344
345         /* add rtp/ts header */
346         p_buffer->p_buffer[0] = 0x80;
347         p_buffer->p_buffer[1] = 0x21; // mpeg2-ts
348
349         p_buffer->p_buffer[2] = ( p_sys->i_sequence_number >> 8 )&0xff;
350         p_buffer->p_buffer[3] = p_sys->i_sequence_number&0xff;
351         p_sys->i_sequence_number++;
352
353         p_buffer->p_buffer[4] = ( i_timestamp >> 24 )&0xff;
354         p_buffer->p_buffer[5] = ( i_timestamp >> 16 )&0xff;
355         p_buffer->p_buffer[6] = ( i_timestamp >>  8 )&0xff;
356         p_buffer->p_buffer[7] = i_timestamp&0xff;
357
358         p_buffer->p_buffer[ 8] = ( p_sys->i_ssrc >> 24 )&0xff;
359         p_buffer->p_buffer[ 9] = ( p_sys->i_ssrc >> 16 )&0xff;
360         p_buffer->p_buffer[10] = ( p_sys->i_ssrc >>  8 )&0xff;
361         p_buffer->p_buffer[11] = p_sys->i_ssrc&0xff;
362
363         p_buffer->i_size = 12;
364     }
365
366     return p_buffer;
367 }
368
369 /*****************************************************************************
370  * ThreadWrite: Write a packet on the network at the good time.
371  *****************************************************************************/
372 static void ThreadWrite( vlc_object_t *p_this )
373 {
374     sout_access_thread_t *p_thread = (sout_access_thread_t*)p_this;
375     sout_instance_t      *p_sout = p_thread->p_sout;
376     sout_buffer_t        *p_buffer;
377     mtime_t              i_date, i_pts_delay;
378
379     /* Get the i_pts_delay value */
380     i_pts_delay = config_GetInt( p_this, "udp-sout-caching" ) * 1000;
381
382     p_buffer = sout_FifoGet( p_thread->p_fifo );
383     if( p_thread->b_die ) return;
384
385     i_date = mdate() + i_pts_delay - p_buffer->i_dts;
386
387     while( 1 )
388     {
389         mtime_t i_wait;
390
391         i_wait = i_date + p_buffer->i_dts;
392
393         if( i_wait - mdate() > MAX_ERROR || i_wait - mdate() < -MAX_ERROR )
394         {
395             msg_Warn( p_sout, "resetting clock" );
396             i_date = mdate() + i_pts_delay - p_buffer->i_dts;
397         }
398         else
399         {
400             mwait( i_wait );
401         }
402
403         send( p_thread->i_handle, p_buffer->p_buffer, p_buffer->i_size, 0 );
404
405         sout_BufferDelete( p_sout, p_buffer );
406
407         p_buffer = sout_FifoGet( p_thread->p_fifo );
408         if( p_thread->b_die ) return;
409     }
410 }