0ada7a49c72c3c55b2a378a0c0e5653ce6db0f50
[vlc.git] / modules / access / rtmp / access.c
1 /*****************************************************************************
2  * access.c: RTMP input.
3  *****************************************************************************
4  * Copyright (C) URJC - LADyR - Luis Lopez Fernandez
5  *
6  * Author: Miguel Angel Cabrera Moya
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 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 General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_access.h>
33
34 #include <vlc_network.h> /* DOWN: #include <network.h> */
35 #include <vlc_url.h>
36 #include <vlc_block.h>
37
38 #include "rtmp_amf_flv.h"
39
40 /*****************************************************************************
41  * Module descriptor
42  *****************************************************************************/
43 #define CACHING_TEXT N_("Caching value in ms")
44 #define CACHING_LONGTEXT N_( \
45     "Caching value for RTMP streams. This " \
46     "value should be set in milliseconds." )
47
48 static int  Open ( vlc_object_t * );
49 static void Close( vlc_object_t * );
50
51 vlc_module_begin();
52     set_description( N_("RTMP input") );
53     set_shortname( N_("RTMP") );
54     set_category( CAT_INPUT );
55     set_subcategory( SUBCAT_INPUT_ACCESS );
56
57     add_integer( "rtmp-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
58                  CACHING_LONGTEXT, true );
59
60     set_capability( "access", 0 );
61     set_callbacks( Open, Close );
62     add_shortcut( "rtmp" );
63 vlc_module_end();
64
65
66 /*****************************************************************************
67  * Local prototypes
68  *****************************************************************************/
69 static ssize_t  Read( access_t *, uint8_t *, size_t );
70 static int Seek( access_t *, int64_t );
71 static int Control( access_t *, int, va_list );
72
73 static void* ThreadControl( vlc_object_t * );
74
75 /*****************************************************************************
76  * Open: open the rtmp connection
77  *****************************************************************************/
78 static int Open( vlc_object_t *p_this )
79 {
80     access_t *p_access = (access_t *) p_this;
81     access_sys_t *p_sys;
82     char *psz, *p; 
83     int length_path, length_media_name;
84     int i;
85
86     STANDARD_READ_ACCESS_INIT
87
88     p_sys->p_thread =
89         vlc_object_create( p_access, sizeof( rtmp_control_thread_t ) );
90     if( !p_sys->p_thread )
91         return VLC_ENOMEM;
92     vlc_object_attach( p_sys->p_thread, p_access );
93
94     /* Parse URI - remove spaces */
95     p = psz = strdup( p_access->psz_path );
96     while( (p = strchr( p, ' ' )) != NULL )
97         *p = '+';
98     vlc_UrlParse( &p_sys->p_thread->url, psz, 0 );
99     free( psz );
100
101     if( p_sys->p_thread->url.psz_host == NULL
102         || *p_sys->p_thread->url.psz_host == '\0' )
103     {
104         msg_Warn( p_access, "invalid host" );
105         goto error;
106     }
107
108     if( p_sys->p_thread->url.i_port <= 0 )
109         p_sys->p_thread->url.i_port = 1935;
110
111     if( p_sys->p_thread->url.psz_path == NULL )
112     {
113         msg_Warn( p_access, "invalid path" );
114         goto error;
115     }
116
117     length_path = strlen( p_sys->p_thread->url.psz_path );
118     length_media_name = strlen( strrchr( p_sys->p_thread->url.psz_path, '/' ) ) - 1;
119
120     p_sys->p_thread->psz_application = strndup( p_sys->p_thread->url.psz_path + 1, length_path - length_media_name - 2 );
121     p_sys->p_thread->psz_media = strdup( p_sys->p_thread->url.psz_path + ( length_path - length_media_name ) );
122
123     msg_Dbg( p_access, "rtmp: host='%s' port=%d path='%s'",
124              p_sys->p_thread->url.psz_host, p_sys->p_thread->url.i_port, p_sys->p_thread->url.psz_path );
125
126     if( p_sys->p_thread->url.psz_username && *p_sys->p_thread->url.psz_username )
127     {
128         msg_Dbg( p_access, "      user='%s', pwd='%s'",
129                  p_sys->p_thread->url.psz_username, p_sys->p_thread->url.psz_password );
130     }
131
132     /* Initialize thread variables */
133     p_sys->p_thread->b_die = 0;
134     p_sys->p_thread->b_error= 0;
135     p_sys->p_thread->p_fifo_input = block_FifoNew();
136     p_sys->p_thread->p_empty_blocks = block_FifoNew();
137     p_sys->p_thread->has_audio = 0;
138     p_sys->p_thread->has_video = 0;
139     p_sys->p_thread->metadata_received = 0;
140     p_sys->p_thread->first_media_packet = 1;
141     p_sys->p_thread->flv_tag_previous_tag_size = 0x00000000; /* FLV_TAG_FIRST_PREVIOUS_TAG_SIZE */
142     p_sys->p_thread->chunk_size_recv = 128; /* RTMP_DEFAULT_CHUNK_SIZE */
143     p_sys->p_thread->chunk_size_send = 128; /* RTMP_DEFAULT_CHUNK_SIZE */
144     for(i = 0; i < 64; i++)
145     {
146         memset( &p_sys->p_thread->rtmp_headers_recv[i], 0, sizeof( rtmp_packet_t ) );
147         p_sys->p_thread->rtmp_headers_send[i].length_header = -1;
148         p_sys->p_thread->rtmp_headers_send[i].stream_index = -1;
149         p_sys->p_thread->rtmp_headers_send[i].timestamp = -1;
150         p_sys->p_thread->rtmp_headers_send[i].timestamp_relative = -1;
151         p_sys->p_thread->rtmp_headers_send[i].length_encoded = -1;
152         p_sys->p_thread->rtmp_headers_send[i].length_body = -1;
153         p_sys->p_thread->rtmp_headers_send[i].content_type = -1;
154         p_sys->p_thread->rtmp_headers_send[i].src_dst = -1;
155         p_sys->p_thread->rtmp_headers_send[i].body = NULL;
156     }
157
158     p_sys->p_thread->p_base_object = p_this;
159
160     vlc_cond_init( &p_sys->p_thread->wait );
161
162     vlc_mutex_init( &p_sys->p_thread->lock );
163
164     p_sys->p_thread->result_connect = 1;
165     p_sys->p_thread->result_play = 1;
166     p_sys->p_thread->result_stop = 0;
167
168     /* Open connection */
169     p_sys->p_thread->fd = net_ConnectTCP( p_access, p_sys->p_thread->url.psz_host, p_sys->p_thread->url.i_port );
170     if( p_sys->p_thread->fd == -1 )
171     {
172         int *p_fd_listen;
173
174         msg_Warn( p_access, "cannot connect to %s:%d", p_sys->p_thread->url.psz_host, p_sys->p_thread->url.i_port );
175         msg_Dbg( p_access, "switching to passive mode" );
176
177         p_sys->active = 0;
178
179         p_fd_listen = net_ListenTCP( p_access, p_sys->p_thread->url.psz_host, p_sys->p_thread->url.i_port );
180         if( p_fd_listen == NULL )
181         {
182             msg_Err( p_access, "cannot listen to %s port %i", p_sys->p_thread->url.psz_host, p_sys->p_thread->url.i_port );
183             goto error2;
184         }
185
186         p_sys->p_thread->fd = net_Accept( p_access, p_fd_listen, -1 );
187
188         net_ListenClose( p_fd_listen );
189
190         if( rtmp_handshake_passive( p_this, p_sys->p_thread->fd ) < 0 )
191         {
192             msg_Err( p_access, "handshake passive failed");
193             goto error2;
194         }
195
196         p_sys->p_thread->result_publish = 1;
197     }
198     else
199     {
200         p_sys->active = 1;
201
202         if( rtmp_handshake_active( p_this, p_sys->p_thread->fd ) < 0 )
203         {
204             msg_Err( p_access, "handshake active failed");
205             goto error2;
206         }
207
208         p_sys->p_thread->result_publish = 0;
209     }
210
211     if( vlc_thread_create( p_sys->p_thread, "rtmp control thread", ThreadControl,
212                            VLC_THREAD_PRIORITY_INPUT, false ) )
213     {
214         msg_Err( p_access, "cannot spawn rtmp control thread" );
215         goto error2;
216     }
217
218     if( p_sys->active )
219     {
220         if( rtmp_connect_active( p_sys->p_thread ) < 0 )
221         {
222             msg_Err( p_access, "connect active failed");
223             goto error2;
224         }
225     }
226
227     /* Set vars for reading from fifo */
228     p_access->p_sys->flv_packet = NULL;
229     p_access->p_sys->read_packet = 1;
230
231     /* Update default_pts to a suitable value for rtmp access */
232     var_Create( p_access, "rtmp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
233
234     return VLC_SUCCESS;
235
236 error2:
237     vlc_cond_destroy( &p_sys->p_thread->wait );
238     vlc_mutex_destroy( &p_sys->p_thread->lock );
239
240     free( p_sys->p_thread->psz_application );
241     free( p_sys->p_thread->psz_media );
242
243     net_Close( p_sys->p_thread->fd );
244 error:
245     vlc_UrlClean( &p_sys->p_thread->url );
246
247     vlc_object_detach( p_sys->p_thread );
248     vlc_object_release( p_sys->p_thread );
249
250     free( p_sys );
251
252     return VLC_EGENERIC;
253 }
254
255 /*****************************************************************************
256  * Close: close the rtmp connection
257  *****************************************************************************/
258 static void Close( vlc_object_t * p_this )
259 {
260     access_t     *p_access = (access_t *) p_this;
261     access_sys_t *p_sys = p_access->p_sys;
262     int i;
263
264 /*    p_sys->p_thread->b_die = true;*/
265     vlc_object_kill( p_sys->p_thread );
266     block_FifoWake( p_sys->p_thread->p_fifo_input );
267
268     vlc_thread_join( p_sys->p_thread );
269
270     vlc_cond_destroy( &p_sys->p_thread->wait );
271     vlc_mutex_destroy( &p_sys->p_thread->lock );
272
273     block_FifoRelease( p_sys->p_thread->p_fifo_input );
274     block_FifoRelease( p_sys->p_thread->p_empty_blocks );
275
276     for( i = 0; i < 64; i++ ) /* RTMP_HEADER_STREAM_INDEX_MASK */
277     {
278         if( p_sys->p_thread->rtmp_headers_recv[i].body != NULL )
279         {
280             free( p_sys->p_thread->rtmp_headers_recv[i].body->body );
281             free( p_sys->p_thread->rtmp_headers_recv[i].body );
282         }
283     }
284
285     net_Close( p_sys->p_thread->fd );
286
287     var_Destroy( p_access, "rtmp-caching" );
288
289     vlc_UrlClean( &p_sys->p_thread->url );
290     free( p_sys->p_thread->psz_application );
291     free( p_sys->p_thread->psz_media );
292
293     vlc_object_detach( p_sys->p_thread );
294     vlc_object_release( p_sys->p_thread );
295     free( p_sys );
296 }
297
298 /*****************************************************************************
299  * Read: standard read on a file descriptor.
300  *****************************************************************************/
301 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
302 {
303     access_sys_t *p_sys = p_access->p_sys;
304     rtmp_packet_t *rtmp_packet;
305     uint8_t *tmp_buffer;
306     ssize_t i_ret;
307     size_t i_len_tmp;
308
309     i_len_tmp = 0;
310
311     while( i_len_tmp < i_len )
312     {
313         if( p_sys->p_thread->result_stop || p_access->info.b_eof || !vlc_object_alive (p_access) )
314         {
315             p_access->info.b_eof = true;
316             return 0;
317         }
318
319         if( p_sys->read_packet )
320         {
321             if( !p_sys->p_thread->metadata_received )
322             {
323                 /* Wait until enough data is received for extracting metadata */
324                 if( block_FifoCount( p_sys->p_thread->p_fifo_input ) < 10 )
325                 {
326                     msleep(100000);
327                     continue;
328                 }
329
330                 p_sys->flv_packet = flv_get_metadata( p_access );
331
332                 p_sys->p_thread->metadata_received = 1;
333             }
334             else
335             {
336                 p_sys->flv_packet = block_FifoGet( p_sys->p_thread->p_fifo_input );
337                 if( p_sys->flv_packet == NULL )
338                     continue; /* Forced wake-up */
339             }
340
341             if( p_sys->p_thread->first_media_packet )
342             {
343                 p_sys->flv_packet = flv_insert_header( p_access, p_sys->flv_packet );
344
345                 p_sys->p_thread->first_media_packet = 0;
346             }
347         }
348         if( i_len - i_len_tmp >= p_sys->flv_packet->i_buffer )
349         {
350             p_sys->read_packet = 1;
351
352             memcpy( p_buffer + i_len_tmp, p_sys->flv_packet->p_buffer, p_sys->flv_packet->i_buffer );
353             block_FifoPut( p_sys->p_thread->p_empty_blocks, p_sys->flv_packet );
354
355             i_len_tmp += p_sys->flv_packet->i_buffer;
356         }
357         else
358         {
359             p_sys->read_packet = 0;
360
361             memcpy( p_buffer + i_len_tmp, p_sys->flv_packet->p_buffer, i_len - i_len_tmp);
362             p_sys->flv_packet->i_buffer -= i_len - i_len_tmp;
363             memmove( p_sys->flv_packet->p_buffer, p_sys->flv_packet->p_buffer + i_len - i_len_tmp, p_sys->flv_packet->i_buffer );
364
365             i_len_tmp += i_len - i_len_tmp;
366         }
367     }
368     if( i_len_tmp > 0 )
369     {
370         if( p_sys->p_thread->result_publish )
371         {
372             /* Send publish onStatus event only once */
373             p_sys->p_thread->result_publish = 0;
374
375             rtmp_packet = rtmp_build_publish_start( p_sys->p_thread );
376
377             tmp_buffer = rtmp_encode_packet( p_sys->p_thread, rtmp_packet );
378
379             i_ret = net_Write( p_sys->p_thread, p_sys->p_thread->fd, NULL, tmp_buffer, rtmp_packet->length_encoded );
380             if( i_ret != rtmp_packet->length_encoded )
381             {
382                 free( rtmp_packet->body->body );
383                 free( rtmp_packet->body );
384                 free( rtmp_packet );
385                 free( tmp_buffer );
386                 msg_Err( p_access, "failed send publish start" );
387                 return -1;
388             }
389             free( rtmp_packet->body->body );
390             free( rtmp_packet->body );
391             free( rtmp_packet );
392             free( tmp_buffer );
393         }
394
395         p_access->info.i_pos += i_len_tmp;
396
397         rtmp_packet = rtmp_build_bytes_read( p_sys->p_thread, p_access->info.i_pos );
398
399         tmp_buffer = rtmp_encode_packet( p_sys->p_thread, rtmp_packet );
400  
401         i_ret = net_Write( p_sys->p_thread, p_sys->p_thread->fd, NULL, tmp_buffer, rtmp_packet->length_encoded );
402         if( i_ret != rtmp_packet->length_encoded )
403         {
404             free( rtmp_packet->body->body );
405             free( rtmp_packet->body );
406             free( rtmp_packet );
407             free( tmp_buffer );
408             msg_Err( p_access, "failed send bytes read" );
409             return -1;
410         }
411         free( rtmp_packet->body->body );
412         free( rtmp_packet->body );
413         free( rtmp_packet );
414         free( tmp_buffer );
415     }
416
417     return i_len_tmp;
418 }
419
420 /*****************************************************************************
421  * Seek: seek to a specific location in a file
422  *****************************************************************************/
423 static int Seek( access_t *p_access, int64_t i_pos )
424 {
425     VLC_UNUSED( p_access );
426     VLC_UNUSED( i_pos );
427 /*msg_Warn ( p_access, "Seek to %lld", i_pos);
428     switch( rtmp_seek( p_access, i_pos ) )
429     {
430         case -1:
431             return VLC_EGENERIC;
432         case 0:
433             break;
434         default:
435             msg_Err( p_access, "You should not be here" );
436             abort();
437     }
438 */
439     return VLC_EGENERIC;
440 }
441
442 /*****************************************************************************
443  * Control:
444  *****************************************************************************/
445 static int Control( access_t *p_access, int i_query, va_list args )
446 {
447     bool    *pb_bool;
448     int     *pi_int;
449     int64_t *pi_64;
450
451     switch( i_query )
452     {
453         /* */
454         case ACCESS_CAN_SEEK:
455         case ACCESS_CAN_FASTSEEK:
456             pb_bool = (bool*) va_arg( args, bool* );
457             *pb_bool = false; /* TODO */
458             break;
459
460         case ACCESS_CAN_PAUSE:
461             pb_bool = (bool*) va_arg( args, bool* );
462             *pb_bool = false; /* TODO */
463             break;
464
465         case ACCESS_CAN_CONTROL_PACE:
466             pb_bool = (bool*) va_arg( args, bool* );
467             *pb_bool = true;
468             break;
469
470         /* */
471         case ACCESS_GET_MTU:
472             pi_int = (int*) va_arg( args, int * );
473             *pi_int = 0;
474             break;
475
476         case ACCESS_GET_PTS_DELAY:
477             pi_64 = (int64_t*) va_arg( args, int64_t * );
478             *pi_64 = var_GetInteger( p_access, "rtmp-caching" ) * INT64_C(1000);
479             break;
480
481         /* */
482         case ACCESS_SET_PAUSE_STATE:
483             /* Nothing to do */
484             break;
485
486         case ACCESS_GET_TITLE_INFO:
487         case ACCESS_SET_TITLE:
488         case ACCESS_SET_SEEKPOINT:
489         case ACCESS_SET_PRIVATE_ID_STATE:
490         case ACCESS_GET_META:
491         case ACCESS_GET_CONTENT_TYPE: /* DOWN: comment this line */
492             return VLC_EGENERIC;
493
494         default:
495             msg_Warn( p_access, "unimplemented query in control" );
496             return VLC_EGENERIC;
497     }
498
499     return VLC_SUCCESS;
500 }
501
502 /*****************************************************************************
503  * ThreadControl: manage control messages and pipe media to Read
504  *****************************************************************************/
505 static void* ThreadControl( vlc_object_t *p_this )
506 {
507     rtmp_control_thread_t *p_thread = (rtmp_control_thread_t *) p_this;
508     rtmp_packet_t *rtmp_packet;
509     int canc = vlc_savecancel ();
510
511     rtmp_init_handler( p_thread->rtmp_handler );
512
513     while( vlc_object_alive (p_thread) )
514     {
515         rtmp_packet = rtmp_read_net_packet( p_thread );
516         if( rtmp_packet != NULL )
517         {
518             if( rtmp_packet->content_type < 0x01 /* RTMP_CONTENT_TYPE_CHUNK_SIZE */
519                 || rtmp_packet->content_type > 0x14 ) /* RTMP_CONTENT_TYPE_INVOKE */
520             {
521                 free( rtmp_packet->body->body );
522                 free( rtmp_packet->body );
523                 free( rtmp_packet );
524
525                 msg_Warn( p_thread, "unknown content type received" );
526             }
527             else
528                 p_thread->rtmp_handler[rtmp_packet->content_type]( p_thread, rtmp_packet );
529         }
530         else
531         {
532             /* Sometimes server close connection too soon */
533             if( p_thread->result_connect )
534             {
535                 vlc_mutex_lock( &p_thread->lock );
536                 vlc_cond_signal( &p_thread->wait );
537                 vlc_mutex_unlock( &p_thread->lock );
538             }
539
540             p_thread->b_die = 1;
541             ((access_t *) p_thread->p_base_object)->info.b_eof = true;
542
543             block_FifoWake( p_thread->p_fifo_input );
544         }
545     }
546     vlc_restorecancel (canc);
547     return NULL;
548 }