2de24d39553868f63197f69054b5e326cc3ae719
[vlc.git] / modules / access / srt.c
1 /*****************************************************************************
2  * srt.c: SRT (Secure Reliable Transport) input module
3  *****************************************************************************
4  * Copyright (C) 2017, Collabora Ltd.
5  *
6  * Authors: Justin Kim <justin.kim@collabora.com>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 #ifdef HAVE_CONFIG_H
24 # include "config.h"
25 #endif
26
27 #include <errno.h>
28 #include <fcntl.h>
29
30 #include <vlc_common.h>
31 #include <vlc_interrupt.h>
32 #include <vlc_fs.h>
33 #include <vlc_plugin.h>
34 #include <vlc_access.h>
35
36 #include <vlc_network.h>
37 #include <vlc_url.h>
38
39 #include <srt/srt.h>
40
41 /* libsrt defines default packet size as 1316 internally
42  * so srt module takes same value. */
43 #define SRT_DEFAULT_CHUNK_SIZE 1316
44 /* The default timeout is -1 (infinite) */
45 #define SRT_DEFAULT_POLL_TIMEOUT -1
46 /* The default latency is 125
47  * which uses srt library internally */
48 #define SRT_DEFAULT_LATENCY 125
49
50 struct stream_sys_t
51 {
52     SRTSOCKET   sock;
53     int         i_poll_id;
54     int         i_poll_timeout;
55     int         i_latency;
56     size_t      i_chunk_size;
57     int         i_pipe_fds[2];
58 };
59
60 static void srt_wait_interrupted(void *p_data)
61 {
62     stream_t *p_stream = p_data;
63     stream_sys_t *p_sys = p_stream->p_sys;
64     msg_Dbg( p_stream, "Waking up srt_epoll_wait");
65     if ( write( p_sys->i_pipe_fds[1], &( bool ) { true }, sizeof( bool ) ) < 0 )
66     {
67         msg_Err( p_stream, "Failed to send data to pipe");
68     }
69 }
70
71 static int Control(stream_t *p_stream, int i_query, va_list args)
72 {
73     int i_ret = VLC_SUCCESS;
74
75     switch( i_query )
76     {
77         case STREAM_CAN_SEEK:
78         case STREAM_CAN_FASTSEEK:
79         case STREAM_CAN_PAUSE:
80         case STREAM_CAN_CONTROL_PACE:
81             *va_arg( args, bool * ) = false;
82             break;
83         case STREAM_GET_PTS_DELAY:
84             *va_arg( args, int64_t * ) = INT64_C(1000)
85                    * var_InheritInteger(p_stream, "network-caching");
86             break;
87         default:
88             i_ret = VLC_EGENERIC;
89             break;
90     }
91
92     return i_ret;
93 }
94
95 static block_t *BlockSRT(stream_t *p_stream, bool *restrict eof)
96 {
97     stream_sys_t *p_sys = p_stream->p_sys;
98
99     block_t *pkt = block_Alloc( p_sys->i_chunk_size );
100
101     if ( unlikely( pkt == NULL ) )
102     {
103         return NULL;
104     }
105
106     vlc_interrupt_register( srt_wait_interrupted, p_stream);
107
108     SRTSOCKET ready[2];
109
110     if ( srt_epoll_wait( p_sys->i_poll_id,
111         ready, &(int) { 2 }, NULL, 0, p_sys->i_poll_timeout,
112         &(int) { p_sys->i_pipe_fds[0] }, &(int) { 1 }, NULL, 0 ) == -1 )
113     {
114         int srt_err = srt_getlasterror( NULL );
115
116         /* Assuming that timeout error is normal when SRT socket is connected. */
117         if ( srt_err == SRT_ETIMEOUT && srt_getsockstate( p_sys->sock ) == SRTS_CONNECTED )
118         {
119             goto skip;
120         }
121
122         msg_Err( p_stream, "released poll wait (reason : %s)", srt_getlasterror_str() );
123         goto endofstream;
124     }
125
126     bool cancel = 0;
127     int ret = read( p_sys->i_pipe_fds[0], &cancel, sizeof( bool ) );
128     if ( ret > 0 && cancel )
129     {
130         msg_Dbg( p_stream, "Cancelled running" );
131         goto endofstream;
132     }
133
134     int stat = srt_recvmsg( p_sys->sock, (char *)pkt->p_buffer, p_sys->i_chunk_size );
135
136     if ( stat == SRT_ERROR )
137     {
138         msg_Err( p_stream, "failed to recevie SRT packet (reason: %s)", srt_getlasterror_str() );
139         goto endofstream;
140     }
141
142     pkt->i_buffer = stat;
143     vlc_interrupt_unregister();
144     return pkt;
145
146 endofstream:
147     msg_Dbg( p_stream, "EOS");
148    *eof = true;
149 skip:
150     block_Release(pkt);
151     srt_clearlasterror();
152     vlc_interrupt_unregister();
153
154     return NULL;
155 }
156
157 static int Open(vlc_object_t *p_this)
158 {
159     stream_t     *p_stream = (stream_t*)p_this;
160     stream_sys_t *p_sys = NULL;
161     vlc_url_t     parsed_url = { 0 };
162     struct addrinfo hints = {
163         .ai_socktype = SOCK_DGRAM,
164     }, *res = NULL;
165     int stat;
166
167     p_sys = vlc_obj_malloc( p_this, sizeof( *p_sys ) );
168     if( unlikely( p_sys == NULL ) )
169         return VLC_ENOMEM;
170
171     if ( vlc_UrlParse( &parsed_url, p_stream->psz_url ) == -1 )
172     {
173         msg_Err( p_stream, "Failed to parse a given URL (%s)", p_stream->psz_url );
174         goto failed;
175     }
176
177     p_sys->i_chunk_size = var_InheritInteger( p_stream, "chunk-size" );
178     p_sys->i_poll_timeout = var_InheritInteger( p_stream, "poll-timeout" );
179     p_sys->i_latency = var_InheritInteger( p_stream, "latency" );
180     p_sys->i_poll_id = -1;
181     p_stream->p_sys = p_sys;
182     p_stream->pf_block = BlockSRT;
183     p_stream->pf_control = Control;
184
185     stat = vlc_getaddrinfo( parsed_url.psz_host, parsed_url.i_port, &hints, &res );
186     if ( stat )
187     {
188         msg_Err( p_stream, "Cannot resolve [%s]:%d (reason: %s)",
189                  parsed_url.psz_host,
190                  parsed_url.i_port,
191                  gai_strerror( stat ) );
192
193         goto failed;
194     }
195
196     p_sys->sock = srt_socket( res->ai_family, SOCK_DGRAM, 0 );
197     if ( p_sys->sock == SRT_ERROR )
198     {
199         msg_Err( p_stream, "Failed to open socket." );
200         goto failed;
201     }
202
203     /* Make SRT non-blocking */
204     srt_setsockopt( p_sys->sock, 0, SRTO_SNDSYN, &(bool) { false }, sizeof( bool ) );
205
206     /* Make sure TSBPD mode is enable (SRT mode) */
207     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDMODE, &(int) { 1 }, sizeof( int ) );
208
209     /* Set latency */
210     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDDELAY, &p_sys->i_latency, sizeof( int ) );
211
212     p_sys->i_poll_id = srt_epoll_create();
213     if ( p_sys->i_poll_id == -1 )
214     {
215         msg_Err( p_stream, "Failed to create poll id for SRT socket." );
216         goto failed;
217     }
218
219     if ( vlc_pipe( p_sys->i_pipe_fds ) != 0 )
220     {
221         msg_Err( p_stream, "Failed to create pipe fds." );
222         goto failed;
223     }
224
225     fcntl( p_sys->i_pipe_fds[0], F_SETFL, O_NONBLOCK | fcntl( p_sys->i_pipe_fds[0], F_GETFL ) );
226
227     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock, &(int) { SRT_EPOLL_IN } );
228     srt_epoll_add_ssock( p_sys->i_poll_id, p_sys->i_pipe_fds[0], &(int) { SRT_EPOLL_IN } );
229
230     stat = srt_connect( p_sys->sock, res->ai_addr, sizeof (struct sockaddr) );
231
232     if ( stat == SRT_ERROR )
233     {
234         msg_Err( p_stream, "Failed to connect to server." );
235         goto failed;
236     }
237
238     vlc_UrlClean( &parsed_url );
239     freeaddrinfo( res );
240
241     return VLC_SUCCESS;
242
243 failed:
244
245     if ( parsed_url.psz_host != NULL
246       && parsed_url.psz_buffer != NULL)
247     {
248         vlc_UrlClean( &parsed_url );
249     }
250
251     if ( res != NULL )
252     {
253         freeaddrinfo( res );
254     }
255
256     vlc_close( p_sys->i_pipe_fds[0] );
257     vlc_close( p_sys->i_pipe_fds[1] );
258
259     if ( p_sys->i_poll_id != -1 )
260     {
261         srt_epoll_release( p_sys->i_poll_id );
262         p_sys->i_poll_id = -1;
263     }
264     srt_close( p_sys->sock );
265
266     return VLC_EGENERIC;
267 }
268
269 static void Close(vlc_object_t *p_this)
270 {
271     stream_t     *p_stream = (stream_t*)p_this;
272     stream_sys_t *p_sys = p_stream->p_sys;
273
274     if ( p_sys->i_poll_id != -1 )
275     {
276         srt_epoll_release( p_sys->i_poll_id );
277         p_sys->i_poll_id = -1;
278     }
279     msg_Dbg( p_stream, "closing server" );
280     srt_close( p_sys->sock );
281
282     vlc_close( p_sys->i_pipe_fds[0] );
283     vlc_close( p_sys->i_pipe_fds[1] );
284 }
285
286 /* Module descriptor */
287 vlc_module_begin ()
288     set_shortname( N_("SRT") )
289     set_description( N_("SRT input") )
290     set_category( CAT_INPUT )
291     set_subcategory( SUBCAT_INPUT_ACCESS )
292
293     add_integer( "chunk-size", SRT_DEFAULT_CHUNK_SIZE,
294             N_("SRT chunk size (bytes)"), NULL, true )
295     add_integer( "poll-timeout", SRT_DEFAULT_POLL_TIMEOUT,
296             N_("Return poll wait after timeout milliseconds (-1 = infinite)"), NULL, true )
297     add_integer( "latency", SRT_DEFAULT_LATENCY, N_("SRT latency (ms)"), NULL, true )
298
299     set_capability( "access", 0 )
300     add_shortcut( "srt" )
301
302     set_callbacks( Open, Close )
303 vlc_module_end ()