git.sesse.net Git - vlc/blob - modules/access_output/livehttp.c

   1 /*****************************************************************************
   2  * livehttp.c: Live HTTP Streaming
   3  *****************************************************************************
   4  * Copyright © 2001, 2002 VLC authors and VideoLAN
   5  * Copyright © 2009-2010 by Keary Griffin
   6  *
   7  * Authors: Keary Griffin <kearygriffin at gmail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <sys/types.h>
  33 #include <time.h>
  34 #include <fcntl.h>
  35 #include <errno.h>
  36 #ifdef HAVE_UNISTD_H
  37 # include <unistd.h>
  38 #endif
  39
  40 #include <vlc_common.h>
  41 #include <vlc_plugin.h>
  42 #include <vlc_sout.h>
  43 #include <vlc_block.h>
  44 #include <vlc_fs.h>
  45 #include <vlc_strings.h>
  46 #include <vlc_charset.h>
  47
  48 #ifndef O_LARGEFILE
  49 #   define O_LARGEFILE 0
  50 #endif
  51
  52 #define STR_ENDLIST "#EXT-X-ENDLIST\n"
  53
  54 #define MAX_RENAME_RETRIES        10
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 static int  Open ( vlc_object_t * );
  60 static void Close( vlc_object_t * );
  61
  62 #define SOUT_CFG_PREFIX "sout-livehttp-"
  63 #define SEGLEN_TEXT N_("Segment length")
  64 #define SEGLEN_LONGTEXT N_("Length of TS stream segments")
  65
  66 #define SPLITANYWHERE_TEXT N_("Split segments anywhere")
  67 #define SPLITANYWHERE_LONGTEXT N_("Don't require a keyframe before splitting "\
  68                                 "a segment. Needed for audio only.")
  69
  70 #define NUMSEGS_TEXT N_("Number of segments")
  71 #define NUMSEGS_LONGTEXT N_("Number of segments to include in index")
  72
  73 #define INDEX_TEXT N_("Index file")
  74 #define INDEX_LONGTEXT N_("Path to the index file to create")
  75
  76 #define INDEXURL_TEXT N_("Full URL to put in index file")
  77 #define INDEXURL_LONGTEXT N_("Full URL to put in index file. "\
  78                           "Use #'s to represent segment number")
  79
  80 #define DELSEGS_TEXT N_("Delete segments")
  81 #define DELSEGS_LONGTEXT N_("Delete segments when they are no longer needed")
  82
  83 #define RATECONTROL_TEXT N_("Use muxers rate control mechanism")
  84
  85 vlc_module_begin ()
  86     set_description( N_("HTTP Live streaming output") )
  87     set_shortname( N_("LiveHTTP" ))
  88     add_shortcut( "livehttp" )
  89     set_capability( "sout access", 0 )
  90     set_category( CAT_SOUT )
  91     set_subcategory( SUBCAT_SOUT_ACO )
  92     add_integer( SOUT_CFG_PREFIX "seglen", 10, SEGLEN_TEXT, SEGLEN_LONGTEXT, true )
  93     add_integer( SOUT_CFG_PREFIX "numsegs", 0, NUMSEGS_TEXT, NUMSEGS_LONGTEXT, true )
  94     add_bool( SOUT_CFG_PREFIX "splitanywhere", false,
  95               SPLITANYWHERE_TEXT, SPLITANYWHERE_LONGTEXT, true )
  96     add_bool( SOUT_CFG_PREFIX "delsegs", true,
  97               DELSEGS_TEXT, DELSEGS_LONGTEXT, true )
  98     add_bool( SOUT_CFG_PREFIX "ratecontrol", false,
  99               RATECONTROL_TEXT, RATECONTROL_TEXT, true )
 100     add_string( SOUT_CFG_PREFIX "index", NULL,
 101                 INDEX_TEXT, INDEX_LONGTEXT, true )
 102     add_string( SOUT_CFG_PREFIX "index-url", NULL,
 103                 INDEXURL_TEXT, INDEXURL_LONGTEXT, true )
 104     set_callbacks( Open, Close )
 105 vlc_module_end ()
 106
 107
 108 /*****************************************************************************
 109  * Exported prototypes
 110  *****************************************************************************/
 111 static const char *const ppsz_sout_options[] = {
 112     "seglen",
 113     "splitanywhere",
 114     "numsegs",
 115     "delsegs",
 116     "index",
 117     "index-url",
 118     "ratecontrol",
 119     NULL
 120 };
 121
 122 static ssize_t Write( sout_access_out_t *, block_t * );
 123 static int Seek ( sout_access_out_t *, off_t  );
 124 static int Control( sout_access_out_t *, int, va_list );
 125
 126 struct sout_access_out_sys_t
 127 {
 128     char *psz_cursegPath;
 129     char *psz_indexPath;
 130     char *psz_indexUrl;
 131     mtime_t i_opendts;
 132     mtime_t  i_seglenm;
 133     uint32_t i_segment;
 134     size_t  i_seglen;
 135     int i_handle;
 136     unsigned i_numsegs;
 137     bool b_delsegs;
 138     bool b_ratecontrol;
 139     bool b_splitanywhere;
 140 };
 141
 142 /*****************************************************************************
 143  * Open: open the file
 144  *****************************************************************************/
 145 static int Open( vlc_object_t *p_this )
 146 {
 147     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 148     sout_access_out_sys_t *p_sys;
 149     char *psz_idx;
 150
 151     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 152
 153     if( !p_access->psz_path )
 154     {
 155         msg_Err( p_access, "no file name specified" );
 156         return VLC_EGENERIC;
 157     }
 158
 159     if( !( p_sys = malloc ( sizeof( *p_sys ) ) ) )
 160         return VLC_ENOMEM;
 161
 162     p_sys->i_seglen = var_GetInteger( p_access, SOUT_CFG_PREFIX "seglen" );
 163     /* Try to get within +-10% of asked segment length, so lower limit is 90% of segment length*/
 164     p_sys->i_seglenm = CLOCK_FREQ * p_sys->i_seglen * 0.9;
 165
 166     p_sys->i_numsegs = var_GetInteger( p_access, SOUT_CFG_PREFIX "numsegs" );
 167     p_sys->b_splitanywhere = var_GetBool( p_access, SOUT_CFG_PREFIX "splitanywhere" );
 168     p_sys->b_delsegs = var_GetBool( p_access, SOUT_CFG_PREFIX "delsegs" );
 169     p_sys->b_ratecontrol = var_GetBool( p_access, SOUT_CFG_PREFIX "ratecontrol") ;
 170
 171     p_sys->psz_indexPath = NULL;
 172     psz_idx = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index" );
 173     if ( psz_idx )
 174     {
 175         char *psz_tmp;
 176         psz_tmp = str_format_time( psz_idx );
 177         free( psz_idx );
 178         if ( !psz_tmp )
 179         {
 180             free( p_sys );
 181             return VLC_ENOMEM;
 182         }
 183         path_sanitize( psz_tmp );
 184         p_sys->psz_indexPath = psz_tmp;
 185         vlc_unlink( p_sys->psz_indexPath );
 186     }
 187
 188     p_sys->psz_indexUrl = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index-url" );
 189
 190     p_access->p_sys = p_sys;
 191     p_sys->i_handle = -1;
 192     p_sys->i_segment = 0;
 193     p_sys->psz_cursegPath = NULL;
 194
 195     p_access->pf_write = Write;
 196     p_access->pf_seek  = Seek;
 197     p_access->pf_control = Control;
 198
 199     return VLC_SUCCESS;
 200 }
 201
 202 #define SEG_NUMBER_PLACEHOLDER "#"
 203 /*****************************************************************************
 204  * formatSegmentPath: create segment path name based on seg #
 205  *****************************************************************************/
 206 static char *formatSegmentPath( char *psz_path, uint32_t i_seg, bool b_sanitize )
 207 {
 208     char *psz_result;
 209     char *psz_firstNumSign;
 210
 211     if ( ! ( psz_result  = str_format_time( psz_path ) ) )
 212         return NULL;
 213
 214     psz_firstNumSign = psz_result + strcspn( psz_result, SEG_NUMBER_PLACEHOLDER );
 215     if ( *psz_firstNumSign ) {
 216         char *psz_newResult;
 217         int i_cnt = strspn( psz_firstNumSign, SEG_NUMBER_PLACEHOLDER );
 218         int ret;
 219
 220         *psz_firstNumSign = '\0';
 221         ret = asprintf( &psz_newResult, "%s%0*d%s", psz_result, i_cnt, i_seg, psz_firstNumSign + i_cnt );
 222         free ( psz_result );
 223         if ( ret < 0 )
 224             return NULL;
 225         psz_result = psz_newResult;
 226     }
 227
 228     if ( b_sanitize )
 229         path_sanitize( psz_result );
 230
 231     return psz_result;
 232 }
 233
 234 /************************************************************************
 235  * updateIndexAndDel: If necessary, update index file & delete old segments
 236  ************************************************************************/
 237 static int updateIndexAndDel( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
 238 {
 239
 240     uint32_t i_firstseg;
 241
 242     if ( p_sys->i_numsegs == 0 || p_sys->i_segment < p_sys->i_numsegs )
 243         i_firstseg = 1;
 244     else
 245         i_firstseg = ( p_sys->i_segment - p_sys->i_numsegs ) + 1;
 246
 247     // First update index
 248     if ( p_sys->psz_indexPath )
 249     {
 250         int val;
 251         FILE *fp;
 252         char *psz_idxTmp;
 253         if ( asprintf( &psz_idxTmp, "%s.tmp", p_sys->psz_indexPath ) < 0)
 254             return -1;
 255
 256         fp = vlc_fopen( psz_idxTmp, "wt");
 257         if ( !fp )
 258         {
 259             msg_Err( p_access, "cannot open index file `%s'", psz_idxTmp );
 260             free( psz_idxTmp );
 261             return -1;
 262         }
 263
 264         if ( fprintf( fp, "#EXTM3U\n#EXT-X-TARGETDURATION:%zu\n#EXT-X-MEDIA-SEQUENCE:%"PRIu32"\n", p_sys->i_seglen, i_firstseg ) < 0 )
 265         {
 266             free( psz_idxTmp );
 267             fclose( fp );
 268             return -1;
 269         }
 270
 271         char *psz_idxFormat = p_sys->psz_indexUrl ? p_sys->psz_indexUrl : p_access->psz_path;
 272         for ( uint32_t i = i_firstseg; i <= p_sys->i_segment; i++ )
 273         {
 274             char *psz_name;
 275             if ( ! ( psz_name = formatSegmentPath( psz_idxFormat, i, false ) ) )
 276             {
 277                 free( psz_idxTmp );
 278                 fclose( fp );
 279                 return -1;
 280             }
 281             val = fprintf( fp, "#EXTINF:%zu,\n%s\n", p_sys->i_seglen, psz_name );
 282             free( psz_name );
 283             if ( val < 0 )
 284             {
 285                 free( psz_idxTmp );
 286                 fclose( fp );
 287                 return -1;
 288             }
 289         }
 290
 291         if ( b_isend )
 292         {
 293             if ( fputs ( STR_ENDLIST, fp ) < 0)
 294             {
 295                 free( psz_idxTmp );
 296                 fclose( fp ) ;
 297                 return -1;
 298             }
 299
 300         }
 301         fclose( fp );
 302
 303         val = vlc_rename ( psz_idxTmp, p_sys->psz_indexPath);
 304
 305         if ( val < 0 )
 306         {
 307             vlc_unlink( psz_idxTmp );
 308             msg_Err( p_access, "Error moving LiveHttp index file" );
 309         }
 310         else
 311             msg_Info( p_access, "LiveHttpIndexComplete: %s" , p_sys->psz_indexPath );
 312
 313         free( psz_idxTmp );
 314     }
 315
 316     // Then take care of deletion
 317     if ( p_sys->b_delsegs && i_firstseg > 1 )
 318     {
 319         char *psz_name = formatSegmentPath( p_access->psz_path, i_firstseg-1, true );
 320          if ( psz_name )
 321          {
 322              vlc_unlink( psz_name );
 323              free( psz_name );
 324          }
 325     }
 326     return 0;
 327 }
 328
 329 /*****************************************************************************
 330  * closeCurrentSegment: Close the segment file
 331  *****************************************************************************/
 332 static void closeCurrentSegment( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
 333 {
 334     if ( p_sys->i_handle >= 0 )
 335     {
 336         close( p_sys->i_handle );
 337         p_sys->i_handle = -1;
 338         if ( p_sys->psz_cursegPath )
 339         {
 340             msg_Info( p_access, "LiveHttpSegmentComplete: %s (%"PRIu32")" , p_sys->psz_cursegPath, p_sys->i_segment );
 341             free( p_sys->psz_cursegPath );
 342             p_sys->psz_cursegPath = 0;
 343             updateIndexAndDel( p_access, p_sys, b_isend );
 344         }
 345     }
 346 }
 347
 348 /*****************************************************************************
 349  * Close: close the target
 350  *****************************************************************************/
 351 static void Close( vlc_object_t * p_this )
 352 {
 353     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 354     sout_access_out_sys_t *p_sys = p_access->p_sys;
 355
 356
 357     closeCurrentSegment( p_access, p_sys, true );
 358     free( p_sys->psz_indexUrl );
 359     free( p_sys->psz_indexPath );
 360     free( p_sys );
 361
 362     msg_Dbg( p_access, "livehttp access output closed" );
 363 }
 364
 365 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 366 {
 367     sout_access_out_sys_t *p_sys = p_access->p_sys;
 368
 369     switch( i_query )
 370     {
 371         case ACCESS_OUT_CONTROLS_PACE:
 372         {
 373             bool *pb = va_arg( args, bool * );
 374             *pb = !p_sys->b_ratecontrol;
 375             //*pb = true;
 376             break;
 377         }
 378
 379         default:
 380             return VLC_EGENERIC;
 381     }
 382     return VLC_SUCCESS;
 383 }
 384
 385 /*****************************************************************************
 386  * openNextFile: Open the segment file
 387  *****************************************************************************/
 388 static ssize_t openNextFile( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys )
 389 {
 390     int fd;
 391
 392     uint32_t i_newseg = p_sys->i_segment + 1;
 393
 394     char *psz_seg = formatSegmentPath( p_access->psz_path, i_newseg, true );
 395     if ( !psz_seg )
 396         return -1;
 397
 398     fd = vlc_open( psz_seg, O_WRONLY | O_CREAT | O_LARGEFILE |
 399                      O_TRUNC, 0666 );
 400     if ( fd == -1 )
 401     {
 402         msg_Err( p_access, "cannot open `%s' (%m)", psz_seg );
 403         free( psz_seg );
 404         return -1;
 405     }
 406
 407     msg_Dbg( p_access, "Successfully opened livehttp file: %s (%"PRIu32")" , psz_seg, i_newseg );
 408
 409     //free( psz_seg );
 410     p_sys->psz_cursegPath = psz_seg;
 411     p_sys->i_handle = fd;
 412     p_sys->i_segment = i_newseg;
 413     return fd;
 414 }
 415
 416 /*****************************************************************************
 417  * Write: standard write on a file descriptor.
 418  *****************************************************************************/
 419 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 420 {
 421     size_t i_write = 0;
 422     sout_access_out_sys_t *p_sys = p_access->p_sys;
 423
 424     while( p_buffer )
 425     {
 426         if ( p_sys->i_handle >= 0 && ( p_sys->b_splitanywhere || ( p_buffer->i_flags & BLOCK_FLAG_TYPE_I ) ) && ( p_buffer->i_dts-p_sys->i_opendts ) > p_sys->i_seglenm )
 427         {
 428             closeCurrentSegment( p_access, p_sys, false );
 429         }
 430         if ( p_buffer->i_buffer > 0 && p_sys->i_handle < 0 )
 431         {
 432             p_sys->i_opendts = p_buffer->i_dts;
 433             if ( openNextFile( p_access, p_sys ) < 0 )
 434                 return -1;
 435         }
 436         ssize_t val = write ( p_sys->i_handle,
 437                              p_buffer->p_buffer, p_buffer->i_buffer );
 438         if ( val == -1 )
 439         {
 440             if ( errno == EINTR )
 441                 continue;
 442             block_ChainRelease ( p_buffer );
 443             return -1;
 444         }
 445
 446         if ( (size_t)val >= p_buffer->i_buffer )
 447         {
 448             block_t *p_next = p_buffer->p_next;
 449             block_Release (p_buffer);
 450             p_buffer = p_next;
 451         }
 452         else
 453         {
 454             p_buffer->p_buffer += val;
 455             p_buffer->i_buffer -= val;
 456         }
 457         i_write += val;
 458     }
 459     return i_write;
 460 }
 461
 462 /*****************************************************************************
 463  * Seek: seek to a specific location in a file
 464  *****************************************************************************/
 465 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 466 {
 467     (void) i_pos;
 468     msg_Err( p_access, "livehttp sout access cannot seek" );
 469     return -1;
 470 }