qt: playlist: use item title if available
[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     char *psz_streamid = var_InheritString( p_access, SRT_PARAM_STREAMID );
72     bool streamid_needs_free = true;
73     int i_max_bandwidth_limit =
74     var_InheritInteger( p_access, SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT );
75     char *url = NULL;
76     srt_params_t params;
77     struct addrinfo hints = {
78         .ai_socktype = SOCK_DGRAM,
79     }, *res = NULL;
80
81     sout_access_out_sys_t *p_sys = p_access->p_sys;
82     bool failed = false;
83
84     i_dst_port = SRT_DEFAULT_PORT;
85     char *psz_parser = psz_dst_addr = strdup( p_access->psz_path );
86     if( !psz_dst_addr )
87     {
88         failed = true;
89         goto out;
90     }
91
92     if ( psz_parser[0] == '[' )
93         psz_parser = strchr( psz_parser, ']' );
94
95     psz_parser = strchr( psz_parser ? psz_parser : psz_dst_addr, ':' );
96     if ( psz_parser != NULL )
97     {
98         *psz_parser++ = '\0';
99         i_dst_port = atoi( psz_parser );
100     }
101
102     stat = vlc_getaddrinfo( psz_dst_addr, i_dst_port, &hints, &res );
103     if ( stat )
104     {
105         msg_Err( p_access, "Cannot resolve [%s]:%d (reason: %s)",
106                  psz_dst_addr,
107                  i_dst_port,
108                  gai_strerror( stat ) );
109
110         failed = true;
111         goto out;
112     }
113
114     /* Always start with a fresh socket */
115     if ( p_sys->sock != SRT_INVALID_SOCK )
116     {
117         srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
118         srt_close( p_sys->sock );
119     }
120
121     p_sys->sock = srt_socket( res->ai_family, SOCK_DGRAM, 0 );
122     if ( p_sys->sock == SRT_INVALID_SOCK )
123     {
124         msg_Err( p_access, "Failed to open socket." );
125         failed = true;
126         goto out;
127     }
128
129     if (psz_dst_addr) {
130         url = strdup( psz_dst_addr );
131         if (srt_parse_url( url, &params )) {
132             if (params.latency != -1)
133                 i_latency = params.latency;
134             if (params.payload_size != -1)
135                 i_payload_size = params.payload_size;
136             if (params.passphrase != NULL) {
137                 free( psz_passphrase );
138                 passphrase_needs_free = false;
139                 psz_passphrase = (char *) params.passphrase;
140             }
141             if (params.streamid != NULL) {
142                 free( psz_streamid );
143                 streamid_needs_free = false;
144                 psz_streamid = (char *) params.streamid;
145             }
146         }
147     }
148
149     /* Make SRT non-blocking */
150     srt_setsockopt( p_sys->sock, 0, SRTO_SNDSYN,
151         &(bool) { false }, sizeof( bool ) );
152     srt_setsockopt( p_sys->sock, 0, SRTO_RCVSYN,
153         &(bool) { false }, sizeof( bool ) );
154
155     /* Make sure TSBPD mode is enable (SRT mode) */
156     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDMODE,
157         &(int) { 1 }, sizeof( int ) );
158
159     /* This is an access_out so it is always a sender */
160     srt_setsockopt( p_sys->sock, 0, SRTO_SENDER,
161         &(int) { 1 }, sizeof( int ) );
162
163     /* Set latency */
164     srt_set_socket_option( access_obj, SRT_PARAM_LATENCY, p_sys->sock,
165             SRTO_LATENCY, &i_latency, sizeof(i_latency) );
166
167     /* set passphrase */
168     if (psz_passphrase != NULL && psz_passphrase[0] != '\0') {
169         int i_key_length = var_InheritInteger( access_obj, SRT_PARAM_KEY_LENGTH );
170
171         srt_set_socket_option( access_obj, SRT_PARAM_KEY_LENGTH, p_sys->sock,
172                 SRTO_PBKEYLEN, &i_key_length, sizeof(i_key_length) );
173
174         srt_set_socket_option( access_obj, SRT_PARAM_PASSPHRASE, p_sys->sock,
175                 SRTO_PASSPHRASE, psz_passphrase, strlen(psz_passphrase) );
176     }
177
178     /* set streamid */
179     if (psz_streamid != NULL && psz_streamid[0] != '\0') {
180         srt_set_socket_option( access_obj, SRT_PARAM_STREAMID, p_sys->sock,
181                 SRTO_STREAMID, psz_streamid, strlen(psz_streamid) );
182     }
183
184     /* set maximumu payload size */
185     srt_set_socket_option( access_obj, SRT_PARAM_PAYLOAD_SIZE, p_sys->sock,
186             SRTO_PAYLOADSIZE, &i_payload_size, sizeof(i_payload_size) );
187
188     /* set maximum bandwidth limit*/
189     srt_set_socket_option( access_obj, SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT,
190             p_sys->sock, SRTO_OHEADBW, &i_max_bandwidth_limit,
191             sizeof(i_max_bandwidth_limit) );
192
193     srt_setsockopt( p_sys->sock, 0, SRTO_SENDER, &(int) { 1 }, sizeof(int) );
194
195     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
196         &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT });
197
198     /* Schedule a connect */
199     msg_Dbg( p_access, "Schedule SRT connect (dest addresss: %s, port: %d).",
200         psz_dst_addr, i_dst_port );
201
202     stat = srt_connect( p_sys->sock, res->ai_addr, res->ai_addrlen );
203     if ( stat == SRT_ERROR )
204     {
205         msg_Err( p_access, "Failed to connect to server (reason: %s)",
206                  srt_getlasterror_str() );
207         failed = true;
208     }
209
210 out:
211     if (failed && p_sys->sock != SRT_INVALID_SOCK)
212     {
213         srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
214         srt_close(p_sys->sock);
215         p_sys->sock = SRT_INVALID_SOCK;
216     }
217
218     if (passphrase_needs_free)
219         free( psz_passphrase );
220     if (streamid_needs_free)
221         free( psz_streamid );
222     free( psz_dst_addr );
223     free( url );
224     freeaddrinfo( res );
225
226     return !failed;
227 }
228
229 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
230 {
231     sout_access_out_sys_t *p_sys = p_access->p_sys;
232     int i_len = 0;
233     size_t i_chunk_size = var_InheritInteger( p_access, SRT_PARAM_CHUNK_SIZE);
234     int i_poll_timeout = var_InheritInteger( p_access, SRT_PARAM_POLL_TIMEOUT );
235     bool b_interrupted = false;
236
237     vlc_interrupt_register( srt_wait_interrupted, p_access);
238
239     while( p_buffer )
240     {
241         block_t *p_next;
242
243         i_len += p_buffer->i_buffer;
244
245         while( p_buffer->i_buffer )
246         {
247             if ( vlc_killed() )
248             {
249                 /* We are told to stop. Stop. */
250                 i_len = VLC_EGENERIC;
251                 goto out;
252             }
253
254             switch( srt_getsockstate( p_sys->sock ) )
255             {
256                 case SRTS_CONNECTED:
257                     /* Good to go */
258                     break;
259                 case SRTS_BROKEN:
260                 case SRTS_NONEXIST:
261                 case SRTS_CLOSED:
262                     /* Failed. Schedule recovery. */
263                     if ( !srt_schedule_reconnect( p_access ) )
264                         msg_Err( p_access, "Failed to schedule connect");
265                     /* Fall-through */
266                 default:
267                     /* Not ready */
268                     i_len = VLC_EGENERIC;
269                     goto out;
270             }
271
272             SRTSOCKET ready[1];
273             int readycnt = 1;
274             if ( srt_epoll_wait( p_sys->i_poll_id,
275                 0, 0, &ready[0], &readycnt,
276                 i_poll_timeout, NULL, 0, NULL, 0 ) < 0)
277             {
278                 if ( vlc_killed() )
279                 {
280                     /* We are told to stop. Stop. */
281                     i_len = VLC_EGENERIC;
282                     goto out;
283                 }
284
285                 /* if 'srt_epoll_wait' is interrupted, we still need to
286                 *  finish sending current block or it may be sent only
287                 *  partially. TODO: this delay can be prevented,
288                 *  possibly with a FIFO and an additional thread.
289                 */
290                 vlc_mutex_lock( &p_sys->lock );
291                 if ( p_sys->b_interrupted )
292                 {
293                     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
294                         &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT });
295                     p_sys->b_interrupted = false;
296                     b_interrupted = true;
297                 }
298                 vlc_mutex_unlock( &p_sys->lock );
299
300                 if ( !b_interrupted )
301                 {
302                     continue;
303                 }
304                 else if ( (true) )
305                 {
306                     msg_Dbg( p_access, "srt_epoll_wait was interrupted");
307                 }
308             }
309
310             if ( readycnt > 0  && ready[0] == p_sys->sock
311                 && srt_getsockstate( p_sys->sock ) == SRTS_CONNECTED)
312             {
313                 size_t i_write = __MIN( p_buffer->i_buffer, i_chunk_size );
314                 if (srt_sendmsg2( p_sys->sock,
315                     (char *)p_buffer->p_buffer, i_write, 0 ) == SRT_ERROR )
316                 {
317                     msg_Warn( p_access, "send error: %s", srt_getlasterror_str() );
318                     i_len = VLC_EGENERIC;
319                     goto out;
320                 }
321
322                 p_buffer->p_buffer += i_write;
323                 p_buffer->i_buffer -= i_write;
324             }
325         }
326
327         p_next = p_buffer->p_next;
328         block_Release( p_buffer );
329         p_buffer = p_next;
330
331         if ( b_interrupted )
332         {
333             goto out;
334         }
335     }
336
337 out:
338     vlc_interrupt_unregister();
339
340     /* Re-add the socket to the poll if we were interrupted */
341     vlc_mutex_lock( &p_sys->lock );
342     if ( p_sys->b_interrupted )
343     {
344         srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock,
345             &(int) { SRT_EPOLL_ERR | SRT_EPOLL_OUT } );
346         p_sys->b_interrupted = false;
347     }
348     vlc_mutex_unlock( &p_sys->lock );
349
350     if ( i_len <= 0 ) block_ChainRelease( p_buffer );
351     return i_len;
352 }
353
354 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
355 {
356     VLC_UNUSED( p_access );
357
358     int i_ret = VLC_SUCCESS;
359
360     switch( i_query )
361     {
362         case ACCESS_OUT_CONTROLS_PACE:
363             *va_arg( args, bool * ) = false;
364             break;
365
366         default:
367             i_ret = VLC_EGENERIC;
368             break;
369     }
370
371     return i_ret;
372 }
373
374 static int Open( vlc_object_t *p_this )
375 {
376     sout_access_out_t       *p_access = (sout_access_out_t*)p_this;
377     sout_access_out_sys_t   *p_sys = NULL;
378
379     if (var_Create ( p_access, "dst-port", VLC_VAR_INTEGER )
380      || var_Create ( p_access, "src-port", VLC_VAR_INTEGER )
381      || var_Create ( p_access, "dst-addr", VLC_VAR_STRING )
382      || var_Create ( p_access, "src-addr", VLC_VAR_STRING ) )
383     {
384          msg_Err( p_access, "Valid network information is required." );
385         return VLC_ENOMEM;
386     }
387
388     p_sys = vlc_obj_calloc( p_this, 1, sizeof( *p_sys ) );
389     if( unlikely( p_sys == NULL ) )
390         return VLC_ENOMEM;
391
392     srt_startup();
393
394     vlc_mutex_init( &p_sys->lock );
395
396     p_access->p_sys = p_sys;
397
398     p_sys->i_poll_id = srt_epoll_create();
399     if ( p_sys->i_poll_id == -1 )
400     {
401         msg_Err( p_access, "Failed to create poll id for SRT socket (reason: %s)",
402                  srt_getlasterror_str() );
403
404         goto failed;
405     }
406
407     if ( !srt_schedule_reconnect( p_access ) )
408     {
409         msg_Err( p_access, "Failed to schedule connect");
410
411         goto failed;
412     }
413
414     p_access->pf_write = Write;
415     p_access->pf_control = Control;
416
417     return VLC_SUCCESS;
418
419 failed:
420     if ( p_sys->sock != -1 ) srt_close( p_sys->sock );
421     if ( p_sys->i_poll_id != -1 ) srt_epoll_release( p_sys->i_poll_id );
422
423     return VLC_EGENERIC;
424 }
425
426 static void Close( vlc_object_t * p_this )
427 {
428     sout_access_out_t     *p_access = (sout_access_out_t*)p_this;
429     sout_access_out_sys_t *p_sys = p_access->p_sys;
430
431     srt_epoll_remove_usock( p_sys->i_poll_id, p_sys->sock );
432     srt_close( p_sys->sock );
433     srt_epoll_release( p_sys->i_poll_id );
434
435     srt_cleanup();
436 }
437
438 /* Module descriptor */
439 vlc_module_begin()
440     set_shortname( N_( "SRT" ) )
441     set_description( N_( "SRT stream output" ) )
442     set_category( CAT_SOUT )
443     set_subcategory( SUBCAT_SOUT_ACO )
444
445     add_integer( SRT_PARAM_CHUNK_SIZE, SRT_DEFAULT_CHUNK_SIZE,
446             N_( "SRT chunk size (bytes)" ), NULL, true )
447     add_integer( SRT_PARAM_POLL_TIMEOUT, SRT_DEFAULT_POLL_TIMEOUT,
448             N_( "Return poll wait after timeout milliseconds (-1 = infinite)" ),
449             NULL, true )
450     add_integer( SRT_PARAM_LATENCY, SRT_DEFAULT_LATENCY, N_( "SRT latency (ms)" ),
451             NULL, true )
452     add_password( SRT_PARAM_PASSPHRASE, "", N_( "Password for stream encryption" ),
453             NULL )
454     add_integer( SRT_PARAM_PAYLOAD_SIZE, SRT_DEFAULT_PAYLOAD_SIZE,
455             N_( "SRT maximum payload size (bytes)" ), NULL, true )
456     add_integer( SRT_PARAM_BANDWIDTH_OVERHEAD_LIMIT,
457             SRT_DEFAULT_BANDWIDTH_OVERHEAD_LIMIT,
458             N_( "SRT maximum bandwidth ceiling (bytes)" ), NULL, true )
459     add_integer( SRT_PARAM_KEY_LENGTH, SRT_DEFAULT_KEY_LENGTH, SRT_KEY_LENGTH_TEXT,
460             SRT_KEY_LENGTH_TEXT, false )
461     change_integer_list( srt_key_lengths, srt_key_length_names )
462     add_string(SRT_PARAM_STREAMID, "",
463             N_(" SRT Stream ID"), NULL, false)
464     change_safe()
465
466     set_capability( "sout access", 0 )
467     add_shortcut( "srt" )
468
469     set_callbacks( Open, Close )
470 vlc_module_end ()