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