srt: fix build issue with recent SRT library
[vlc.git] / modules / access_output / srt.c
1 /*****************************************************************************
2  * srt.c: SRT (Secure Reliable Transport) access_output module
3  *****************************************************************************
4  * Copyright (C) 2017-2018, Collabora Ltd.
5  * Copyright (C) 2018, Haivision Systems Inc.
6  *
7  * Authors: Justin Kim <justin.kim@collabora.com>
8  *          Roman Diouskine <rdiouskine@haivision.com>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #include <srt_common.h>
26
27 #include <vlc_interrupt.h>
28 #include <vlc_fs.h>
29 #include <vlc_plugin.h>
30 #include <vlc_sout.h>
31 #include <vlc_block.h>
32 #include <vlc_network.h>
33
34 typedef struct
35 {
36     SRTSOCKET     sock;
37     int           i_poll_id;
38     bool          b_interrupted;
39     vlc_mutex_t   lock;
40 } sout_access_out_sys_t;
41
42 static void srt_wait_interrupted(void *p_data)
43 {
44     sout_access_out_t *p_access = p_data;
45     sout_access_out_sys_t *p_sys = p_access->p_sys;
46
47     vlc_mutex_lock( &p_sys->lock );
48     if ( p_sys->i_poll_id >= 0 &&  p_sys->sock != SRT_INVALID_SOCK )
49     {
50         p_sys->b_interrupted = true;
51
52         msg_Dbg( p_access, "Waking up srt_epoll_wait");
53
54         /* Removing all socket descriptors from the monitoring list
55          * wakes up SRT's threads. We only have one to remove. */
56         srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
57     }
58     vlc_mutex_unlock( &p_sys->lock );
59 }
60
61 static bool srt_schedule_reconnect(sout_access_out_t *p_access)
62 {
63     vlc_object_t *access_obj = (vlc_object_t *) p_access;
64     int stat;
65     char *psz_dst_addr = NULL;
66     int i_dst_port;
67     int i_latency=var_InheritInteger( p_access, SRT_PARAM_LATENCY );
68     int i_payload_size = var_InheritInteger( p_access, SRT_PARAM_PAYLOAD_SIZE );
69     char *psz_passphrase = var_InheritString( p_access, SRT_PARAM_PASSPHRASE );
70     bool passphrase_needs_free = true;
71     int i_max_bandwidth_limit =
72     var_InheritInteger( p_access, SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT );
73     char *url = NULL;
74     srt_params_t params;
75     struct addrinfo hints = {
76         .ai_socktype = SOCK_DGRAM,
77     }, *res = NULL;
78
79     sout_access_out_sys_t *p_sys = p_access->p_sys;
80     bool failed = false;
81
82     i_dst_port = SRT_DEFAULT_PORT;
83     char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
84     if( !psz_dst_addr )
85     {
86         failed = true;
87         goto out;
88     }
89
90     if ( psz_parser[0] == '[' )
91         psz_parser = strchr( psz_parser, ']' );
92
93     psz_parser = strchr( psz_parser ? psz_parser : psz_dst_addr, ':' );
94     if ( psz_parser != NULL )
95     {
96         *psz_parser++ = '\0';
97         i_dst_port = atoi( psz_parser );
98     }
99
100     stat = vlc_getaddrinfo( psz_dst_addr, i_dst_port, &hints, &res );
101     if ( stat )
102     {
103         msg_Err( p_access, "Cannot resolve [%s]:%d (reason: %s)",
104                  psz_dst_addr,
105                  i_dst_port,
106                  gai_strerror( stat ) );
107
108         failed = true;
109         goto out;
110     }
111
112     /* Always start with a fresh socket */
113     if ( p_sys->sock != SRT_INVALID_SOCK )
114     {
115         srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
116         srt_close( p_sys->sock );
117     }
118
119     p_sys->sock = srt_socket( res->ai_family, SOCK_DGRAM, 0 );
120     if ( p_sys->sock == SRT_INVALID_SOCK )
121     {
122         msg_Err( p_access, "Failed to open socket." );
123         failed = true;
124         goto out;
125     }
126
127     if (psz_dst_addr) {
128         url = strdup( psz_dst_addr );
129         if (srt_parse_url( url, &params )) {
130             if (params.latency != -1)
131                 i_latency = params.latency;
132             if (params.payload_size != -1)
133                 i_payload_size = params.payload_size;
134             if (params.passphrase != NULL) {
135                 free( psz_passphrase );
136                 passphrase_needs_free = false;
137                 psz_passphrase = (char *) params.passphrase;
138             }
139         }
140     }
141
142     /* Make SRT non-blocking */
143     srt_setsockopt( p_sys->sock, 0, SRTO_SNDSYN,
144         &(bool) { false }, sizeof( bool ) );
145     srt_setsockopt( p_sys->sock, 0, SRTO_RCVSYN,
146         &(bool) { false }, sizeof( bool ) );
147
148     /* Make sure TSBPD mode is enable (SRT mode) */
149     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDMODE,
150         &(int) { 1 }, sizeof( int ) );
151
152     /* This is an access_out so it is always a sender */
153     srt_setsockopt( p_sys->sock, 0, SRTO_SENDER,
154         &(int) { 1 }, sizeof( int ) );
155
156     /* Set latency */
157     srt_set_socket_option( access_obj, SRT_PARAM_LATENCY, p_sys->sock,
158             SRTO_TSBPDDELAY, &i_latency, sizeof(i_latency) );
159
160     /* set passphrase */
161     if (psz_passphrase != NULL && psz_passphrase[0] != '\0') {
162         int i_key_length = var_InheritInteger( access_obj, SRT_PARAM_KEY_LENGTH );
163
164         srt_set_socket_option( access_obj, SRT_PARAM_KEY_LENGTH, p_sys->sock,
165                 SRTO_PBKEYLEN, &i_key_length, sizeof(i_key_length) );
166
167         srt_set_socket_option( access_obj, SRT_PARAM_PASSPHRASE, p_sys->sock,
168                 SRTO_PASSPHRASE, psz_passphrase, strlen(psz_passphrase) );
169     }
170
171     /* set maximumu payload size */
172     srt_set_socket_option( access_obj, SRT_PARAM_PAYLOAD_SIZE, p_sys->sock,
173             SRTO_PAYLOADSIZE, &i_payload_size, sizeof(i_payload_size) );
174
175     /* set maximum bandwidth limit*/
176     srt_set_socket_option( access_obj, SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT,
177             p_sys->sock, SRTO_OHEADBW, &i_max_bandwidth_limit,
178             sizeof(i_max_bandwidth_limit) );
179
180     srt_setsockopt( p_sys->sock, 0, SRTO_SENDER, &(int) { 1 }, sizeof(int) );
181
182     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
183         &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT });
184
185     /* Schedule a connect */
186     msg_Dbg( p_access, "Schedule SRT connect (dest addresss: %s, port: %d).",
187         psz_dst_addr, i_dst_port );
188
189     stat = srt_connect( p_sys->sock, res->ai_addr, res->ai_addrlen );
190     if ( stat == SRT_ERROR )
191     {
192         msg_Err( p_access, "Failed to connect to server (reason: %s)",
193                  srt_getlasterror_str() );
194         failed = true;
195     }
196
197 out:
198     if (failed && p_sys->sock != SRT_INVALID_SOCK)
199     {
200         srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
201         srt_close(p_sys->sock);
202         p_sys->sock = SRT_INVALID_SOCK;
203     }
204
205     if (passphrase_needs_free)
206         free( psz_passphrase );
207     free( psz_dst_addr );
208     free( url );
209     freeaddrinfo( res );
210
211     return !failed;
212 }
213
214 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
215 {
216     sout_access_out_sys_t *p_sys = p_access->p_sys;
217     int i_len = 0;
218     size_t i_chunk_size = var_InheritInteger( p_access, SRT_PARAM_CHUNK_SIZE);
219     int i_poll_timeout = var_InheritInteger( p_access, SRT_PARAM_POLL_TIMEOUT );
220     bool b_interrupted = false;
221
222     vlc_interrupt_register( srt_wait_interrupted, p_access);
223
224     while( p_buffer )
225     {
226         block_t *p_next;
227
228         i_len += p_buffer->i_buffer;
229
230         while( p_buffer->i_buffer )
231         {
232             if ( vlc_killed() )
233             {
234                 /* We are told to stop. Stop. */
235                 i_len = VLC_EGENERIC;
236                 goto out;
237             }
238
239             switch( srt_getsockstate( p_sys->sock ) )
240             {
241                 case SRTS_CONNECTED:
242                     /* Good to go */
243                     break;
244                 case SRTS_BROKEN:
245                 case SRTS_NONEXIST:
246                 case SRTS_CLOSED:
247                     /* Failed. Schedule recovery. */
248                     if ( !srt_schedule_reconnect( p_access ) )
249                         msg_Err( p_access, "Failed to schedule connect");
250                     /* Fall-through */
251                 default:
252                     /* Not ready */
253                     i_len = VLC_EGENERIC;
254                     goto out;
255             }
256
257             SRTSOCKET ready[1];
258             int readycnt = 1;
259             if ( srt_epoll_wait( p_sys->i_poll_id,
260                 0, 0, &ready[0], &readycnt,
261                 i_poll_timeout, NULL, 0, NULL, 0 ) < 0)
262             {
263                 if ( vlc_killed() )
264                 {
265                     /* We are told to stop. Stop. */
266                     i_len = VLC_EGENERIC;
267                     goto out;
268                 }
269
270                 /* if 'srt_epoll_wait' is interrupted, we still need to
271                 *  finish sending current block or it may be sent only
272                 *  partially. TODO: this delay can be prevented,
273                 *  possibly with a FIFO and an additional thread.
274                 */
275                 vlc_mutex_lock( &p_sys->lock );
276                 if ( p_sys->b_interrupted )
277                 {
278                     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
279                         &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT });
280                     p_sys->b_interrupted = false;
281                     b_interrupted = true;
282                 }
283                 vlc_mutex_unlock( &p_sys->lock );
284
285                 if ( !b_interrupted )
286                 {
287                     continue;
288                 }
289                 else if ( (true) )
290                 {
291                     msg_Dbg( p_access, "srt_epoll_wait was interrupted");
292                 }
293             }
294
295             if ( readycnt > 0  && ready[0] == p_sys->sock
296                 && srt_getsockstate( p_sys->sock ) == SRTS_CONNECTED)
297             {
298                 size_t i_write = __MIN( p_buffer->i_buffer, i_chunk_size );
299                 if (srt_sendmsg2( p_sys->sock,
300                     (char *)p_buffer->p_buffer, i_write, 0 ) == SRT_ERROR )
301                 {
302                     msg_Warn( p_access, "send error: %s", srt_getlasterror_str() );
303                     i_len = VLC_EGENERIC;
304                     goto out;
305                 }
306
307                 p_buffer->p_buffer += i_write;
308                 p_buffer->i_buffer -= i_write;
309             }
310         }
311
312         p_next = p_buffer->p_next;
313         block_Release( p_buffer );
314         p_buffer = p_next;
315
316         if ( b_interrupted )
317         {
318             goto out;
319         }
320     }
321
322 out:
323     vlc_interrupt_unregister();
324
325     /* Re-add the socket to the poll if we were interrupted */
326     vlc_mutex_lock( &p_sys->lock );
327     if ( p_sys->b_interrupted )
328     {
329         srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
330             &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT } );
331         p_sys->b_interrupted = false;
332     }
333     vlc_mutex_unlock( &p_sys->lock );
334
335     if ( i_len <= 0 ) block_ChainRelease( p_buffer );
336     return i_len;
337 }
338
339 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
340 {
341     VLC_UNUSED( p_access );
342
343     int i_ret = VLC_SUCCESS;
344
345     switch( i_query )
346     {
347         case ACCESS_OUT_CONTROLS_PACE:
348             *va_arg( args, bool * ) = false;
349             break;
350
351         default:
352             i_ret = VLC_EGENERIC;
353             break;
354     }
355
356     return i_ret;
357 }
358
359 static int Open( vlc_object_t *p_this )
360 {
361     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
362     sout_access_out_sys_t   *p_sys = NULL;
363
364     if (var_Create ( p_access, "dst-port", VLC_VAR_INTEGER )
365      || var_Create ( p_access, "src-port", VLC_VAR_INTEGER )
366      || var_Create ( p_access, "dst-addr", VLC_VAR_STRING )
367      || var_Create ( p_access, "src-addr", VLC_VAR_STRING ) )
368     {
369          msg_Err( p_access, "Valid network information is required." );
370         return VLC_ENOMEM;
371     }
372
373     p_sys = vlc_obj_calloc( p_this, 1, sizeof( *p_sys ) );
374     if( unlikely( p_sys == NULL ) )
375         return VLC_ENOMEM;
376
377     srt_startup();
378
379     vlc_mutex_init( &p_sys->lock );
380
381     p_access->p_sys = p_sys;
382
383     p_sys->i_poll_id = srt_epoll_create();
384     if ( p_sys->i_poll_id == -1 )
385     {
386         msg_Err( p_access, "Failed to create poll id for SRT socket (reason: %s)",
387                  srt_getlasterror_str() );
388
389         goto failed;
390     }
391
392     if ( !srt_schedule_reconnect( p_access ) )
393     {
394         msg_Err( p_access, "Failed to schedule connect");
395
396         goto failed;
397     }
398
399     p_access->pf_write = Write;
400     p_access->pf_control = Control;
401
402     return VLC_SUCCESS;
403
404 failed:
405     if ( p_sys->sock != -1 ) srt_close( p_sys->sock );
406     if ( p_sys->i_poll_id != -1 ) srt_epoll_release( p_sys->i_poll_id );
407
408     return VLC_EGENERIC;
409 }
410
411 static void Close( vlc_object_t * p_this )
412 {
413     sout_access_out_t     *p_access = (sout_access_out_t*)p_this;
414     sout_access_out_sys_t *p_sys = p_access->p_sys;
415
416     srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
417     srt_close( p_sys->sock );
418     srt_epoll_release( p_sys->i_poll_id );
419
420     srt_cleanup();
421 }
422
423 /* Module descriptor */
424 vlc_module_begin()
425     set_shortname( N_( "SRT" ) )
426     set_description( N_( "SRT stream output" ) )
427     set_category( CAT_SOUT )
428     set_subcategory( SUBCAT_SOUT_ACO )
429
430     add_integer( SRT_PARAM_CHUNK_SIZE, SRT_DEFAULT_CHUNK_SIZE,
431             N_( "SRT chunk size (bytes)" ), NULL, true )
432     add_integer( SRT_PARAM_POLL_TIMEOUT, SRT_DEFAULT_POLL_TIMEOUT,
433             N_( "Return poll wait after timeout milliseconds (-1 = infinite)" ),
434             NULL, true )
435     add_integer( SRT_PARAM_LATENCY, SRT_DEFAULT_LATENCY, N_( "SRT latency (ms)" ),
436             NULL, true )
437     add_password( SRT_PARAM_PASSPHRASE, "", N_( "Password for stream encryption" ),
438             NULL )
439     add_integer( SRT_PARAM_PAYLOAD_SIZE, SRT_DEFAULT_PAYLOAD_SIZE,
440             N_( "SRT maximum payload size (bytes)" ), NULL, true )
441     add_integer( SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT,
442             SRT_DEFAULT_BANDWIDTH_OVERHEAD_LIMIT,
443             N_( "SRT maximum bandwidth ceiling (bytes)" ), NULL, true )
444     add_integer( SRT_PARAM_KEY_LENGTH, SRT_DEFAULT_KEY_LENGTH, SRT_KEY_LENGTH_TEXT,
445             SRT_KEY_LENGTH_TEXT, false )
446     change_integer_list( srt_key_lengths, srt_key_length_names )
447
448     set_capability( "sout access", 0 )
449     add_shortcut( "srt" )
450
451     set_callbacks( Open, Close )
452 vlc_module_end ()