objres: restore malloc() wrapper
[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 <sys/eventfd.h>
29 #include <sys/epoll.h>
30
31 #include <vlc_common.h>
32 #include <vlc_interrupt.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_event_fd;
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_event_fd, &( bool ) { true }, sizeof( bool ) ) < 0 )
66     {
67         msg_Err( p_stream, "Failed to send data to event fd");
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     struct epoll_event event[1] = { 0 };
110
111     if ( srt_epoll_wait( p_sys->i_poll_id,
112         ready, &(int) { 2 }, 0, 0, p_sys->i_poll_timeout,
113         &(int) { p_sys->i_event_fd }, &(int) { 1 }, 0, 0 ) == -1 )
114     {
115         int srt_err = srt_getlasterror( NULL );
116
117         /* Assuming that timeout error is normal when SRT socket is connected. */
118         if ( srt_err == SRT_ETIMEOUT && srt_getsockstate( p_sys->sock ) == SRTS_CONNECTED )
119         {
120             goto skip;
121         }
122
123         msg_Err( p_stream, "released poll wait (reason : %s)", srt_getlasterror_str() );
124         goto endofstream;
125     }
126
127     if ( event[0].events & EPOLLIN ) {
128         bool cancel = 0;
129         int ret = read( event[0].data.fd, &cancel, sizeof( bool ) );
130         if ( ret < 0 )
131         {
132             goto skip;
133         }
134
135         if ( cancel )
136         {
137             msg_Dbg( p_stream, "Cancelled running" );
138             goto endofstream;
139         }
140     }
141
142     int stat = srt_recvmsg( p_sys->sock, (char *)pkt->p_buffer, p_sys->i_chunk_size );
143
144     if ( stat == SRT_ERROR )
145     {
146         msg_Err( p_stream, "failed to recevie SRT packet (reason: %s)", srt_getlasterror_str() );
147         goto endofstream;
148     }
149
150     pkt->i_buffer = stat;
151     vlc_interrupt_unregister();
152     return pkt;
153
154 endofstream:
155     msg_Dbg( p_stream, "EOS");
156    *eof = true;
157 skip:
158     block_Release(pkt);
159     srt_clearlasterror();
160     vlc_interrupt_unregister();
161
162     return NULL;
163 }
164
165 static int Open(vlc_object_t *p_this)
166 {
167     stream_t     *p_stream = (stream_t*)p_this;
168     stream_sys_t *p_sys = NULL;
169     vlc_url_t     parsed_url = { 0 };
170     struct addrinfo hints = {
171         .ai_socktype = SOCK_DGRAM,
172     }, *res = NULL;
173     int stat;
174
175     p_sys = vlc_obj_malloc( p_this, sizeof( *p_sys ) );
176     if( unlikely( p_sys == NULL ) )
177         return VLC_ENOMEM;
178
179     if ( vlc_UrlParse( &parsed_url, p_stream->psz_url ) == -1 )
180     {
181         msg_Err( p_stream, "Failed to parse a given URL (%s)", p_stream->psz_url );
182         goto failed;
183     }
184
185     p_sys->i_chunk_size = var_InheritInteger( p_stream, "chunk-size" );
186     p_sys->i_poll_timeout = var_InheritInteger( p_stream, "poll-timeout" );
187     p_sys->i_latency = var_InheritInteger( p_stream, "latency" );
188     p_sys->i_poll_id = -1;
189     p_sys->i_event_fd = -1;
190     p_stream->p_sys = p_sys;
191     p_stream->pf_block = BlockSRT;
192     p_stream->pf_control = Control;
193
194     stat = vlc_getaddrinfo( parsed_url.psz_host, parsed_url.i_port, &hints, &res );
195     if ( stat )
196     {
197         msg_Err( p_stream, "Cannot resolve [%s]:%d (reason: %s)",
198                  parsed_url.psz_host,
199                  parsed_url.i_port,
200                  gai_strerror( stat ) );
201
202         goto failed;
203     }
204
205     p_sys->sock = srt_socket( res->ai_family, SOCK_DGRAM, 0 );
206     if ( p_sys->sock == SRT_ERROR )
207     {
208         msg_Err( p_stream, "Failed to open socket." );
209         goto failed;
210     }
211
212     /* Make SRT non-blocking */
213     srt_setsockopt( p_sys->sock, 0, SRTO_SNDSYN, &(bool) { false }, sizeof( bool ) );
214
215     /* Make sure TSBPD mode is enable (SRT mode) */
216     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDMODE, &(int) { 1 }, sizeof( int ) );
217
218     /* Set latency */
219     srt_setsockopt( p_sys->sock, 0, SRTO_TSBPDDELAY, &p_sys->i_latency, sizeof( int ) );
220
221     p_sys->i_poll_id = srt_epoll_create();
222     if ( p_sys->i_poll_id == -1 )
223     {
224         msg_Err( p_stream, "Failed to create poll id for SRT socket." );
225         goto failed;
226     }
227     srt_epoll_add_usock( p_sys->i_poll_id, p_sys->sock, &(int) { SRT_EPOLL_IN } );
228
229     p_sys->i_event_fd = eventfd( 0, EFD_NONBLOCK | EFD_CLOEXEC );
230     srt_epoll_add_ssock( p_sys->i_poll_id, p_sys->i_event_fd, &(int) { EPOLLIN } );
231
232     stat = srt_connect( p_sys->sock, res->ai_addr, sizeof (struct sockaddr) );
233
234     if ( stat == SRT_ERROR )
235     {
236         msg_Err( p_stream, "Failed to connect to server." );
237         goto failed;
238     }
239
240     vlc_UrlClean( &parsed_url );
241     freeaddrinfo( res );
242
243     return VLC_SUCCESS;
244
245 failed:
246
247     if ( parsed_url.psz_host != NULL
248       && parsed_url.psz_buffer != NULL)
249     {
250         vlc_UrlClean( &parsed_url );
251     }
252
253     if ( res != NULL )
254     {
255         freeaddrinfo( res );
256     }
257
258     if ( p_sys->i_event_fd != -1 )
259     {
260         close( p_sys->i_event_fd );
261         p_sys->i_event_fd = -1;
262     }
263
264     if ( p_sys->i_poll_id != -1 )
265     {
266         srt_epoll_release( p_sys->i_poll_id );
267         p_sys->i_poll_id = -1;
268     }
269     srt_close( p_sys->sock );
270
271     return VLC_EGENERIC;
272 }
273
274 static void Close(vlc_object_t *p_this)
275 {
276     stream_t     *p_stream = (stream_t*)p_this;
277     stream_sys_t *p_sys = p_stream->p_sys;
278
279     if ( p_sys->i_poll_id != -1 )
280     {
281         srt_epoll_release( p_sys->i_poll_id );
282         p_sys->i_poll_id = -1;
283     }
284     msg_Dbg( p_stream, "closing server" );
285     srt_close( p_sys->sock );
286
287     if ( p_sys->i_event_fd != -1 )
288     {
289         close( p_sys->i_event_fd );
290         p_sys->i_event_fd = -1;
291     }
292 }
293
294 /* Module descriptor */
295 vlc_module_begin ()
296     set_shortname( N_("SRT") )
297     set_description( N_("SRT input") )
298     set_category( CAT_INPUT )
299     set_subcategory( SUBCAT_INPUT_ACCESS )
300
301     add_integer( "chunk-size", SRT_DEFAULT_CHUNK_SIZE,
302             N_("SRT chunk size (bytes)"), NULL, true )
303     add_integer( "poll-timeout", SRT_DEFAULT_POLL_TIMEOUT,
304             N_("Return poll wait after timeout miliseconds (-1 = infinite)"), NULL, true )
305     add_integer( "latency", SRT_DEFAULT_LATENCY, N_("SRT latency (ms)"), NULL, true )
306
307     set_capability( "access", 0 )
308     add_shortcut( "srt" )
309
310     set_callbacks( Open, Close )
311 vlc_module_end ()