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     p_sys->i_seglenm = CLOCK_FREQ * p_sys->i_seglen;
 164
 165     p_sys->i_numsegs = var_GetInteger( p_access, SOUT_CFG_PREFIX "numsegs" );
 166     p_sys->b_splitanywhere = var_GetBool( p_access, SOUT_CFG_PREFIX "splitanywhere" );
 167     p_sys->b_delsegs = var_GetBool( p_access, SOUT_CFG_PREFIX "delsegs" );
 168     p_sys->b_ratecontrol = var_GetBool( p_access, SOUT_CFG_PREFIX "ratecontrol") ;
 169
 170     p_sys->psz_indexPath = NULL;
 171     psz_idx = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index" );
 172     if ( psz_idx )
 173     {
 174         char *psz_tmp;
 175         psz_tmp = str_format( p_access, psz_idx );
 176         free( psz_idx );
 177         if ( !psz_tmp )
 178         {
 179             free( p_sys );
 180             return VLC_ENOMEM;
 181         }
 182         path_sanitize( psz_tmp );
 183         p_sys->psz_indexPath = psz_tmp;
 184         vlc_unlink( p_sys->psz_indexPath );
 185     }
 186
 187     p_sys->psz_indexUrl = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index-url" );
 188
 189     p_access->p_sys = p_sys;
 190     p_sys->i_handle = -1;
 191     p_sys->i_segment = 0;
 192     p_sys->psz_cursegPath = NULL;
 193
 194     p_access->pf_write = Write;
 195     p_access->pf_seek  = Seek;
 196     p_access->pf_control = Control;
 197
 198     return VLC_SUCCESS;
 199 }
 200
 201 #define SEG_NUMBER_PLACEHOLDER "#"
 202 /*****************************************************************************
 203  * formatSegmentPath: create segment path name based on seg #
 204  *****************************************************************************/
 205 static char *formatSegmentPath( sout_access_out_t *p_access, char *psz_path, uint32_t i_seg, bool b_sanitize )
 206 {
 207     char *psz_result;
 208     char *psz_firstNumSign;
 209
 210     if ( ! ( psz_result  = str_format( p_access, psz_path ) ) )
 211         return NULL;
 212
 213     psz_firstNumSign = psz_result + strcspn( psz_result, SEG_NUMBER_PLACEHOLDER );
 214     if ( *psz_firstNumSign ) {
 215         char *psz_newResult;
 216         int i_cnt = strspn( psz_firstNumSign, SEG_NUMBER_PLACEHOLDER );
 217         int ret;
 218
 219         *psz_firstNumSign = '\0';
 220         ret = asprintf( &psz_newResult, "%s%0*d%s", psz_result, i_cnt, i_seg, psz_firstNumSign + i_cnt );
 221         free ( psz_result );
 222         if ( ret < 0 )
 223             return NULL;
 224         psz_result = psz_newResult;
 225     }
 226
 227     if ( b_sanitize )
 228         path_sanitize( psz_result );
 229
 230     return psz_result;
 231 }
 232
 233 /************************************************************************
 234  * updateIndexAndDel: If necessary, update index file & delete old segments
 235  ************************************************************************/
 236 static int updateIndexAndDel( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
 237 {
 238
 239     uint32_t i_firstseg;
 240
 241     if ( p_sys->i_numsegs == 0 || p_sys->i_segment < p_sys->i_numsegs )
 242         i_firstseg = 1;
 243     else
 244         i_firstseg = ( p_sys->i_segment - p_sys->i_numsegs ) + 1;
 245
 246     // First update index
 247     if ( p_sys->psz_indexPath )
 248     {
 249         int val;
 250         FILE *fp;
 251         char *psz_idxTmp;
 252         if ( asprintf( &psz_idxTmp, "%s.tmp", p_sys->psz_indexPath ) < 0)
 253             return -1;
 254
 255         fp = vlc_fopen( psz_idxTmp, "wt");
 256         if ( !fp )
 257         {
 258             msg_Err( p_access, "cannot open index file `%s'", psz_idxTmp );
 259             free( psz_idxTmp );
 260             return -1;
 261         }
 262
 263         if ( fprintf( fp, "#EXTM3U\n#EXT-X-TARGETDURATION:%zu\n#EXT-X-MEDIA-SEQUENCE:%"PRIu32"\n", p_sys->i_seglen, i_firstseg ) < 0 )
 264         {
 265             free( psz_idxTmp );
 266             fclose( fp );
 267             return -1;
 268         }
 269
 270         char *psz_idxFormat = p_sys->psz_indexUrl ? p_sys->psz_indexUrl : p_access->psz_path;
 271         for ( uint32_t i = i_firstseg; i <= p_sys->i_segment; i++ )
 272         {
 273             char *psz_name;
 274             if ( ! ( psz_name = formatSegmentPath( p_access, psz_idxFormat, i, false ) ) )
 275             {
 276                 free( psz_idxTmp );
 277                 fclose( fp );
 278                 return -1;
 279             }
 280             val = fprintf( fp, "#EXTINF:%zu,\n%s\n", p_sys->i_seglen, psz_name );
 281             free( psz_name );
 282             if ( val < 0 )
 283             {
 284                 free( psz_idxTmp );
 285                 fclose( fp );
 286                 return -1;
 287             }
 288         }
 289
 290         if ( b_isend )
 291         {
 292             if ( fputs ( STR_ENDLIST, fp ) < 0)
 293             {
 294                 free( psz_idxTmp );
 295                 fclose( fp ) ;
 296                 return -1;
 297             }
 298
 299         }
 300         fclose( fp );
 301
 302         val = vlc_rename ( psz_idxTmp, p_sys->psz_indexPath);
 303
 304         if ( val < 0 )
 305         {
 306             vlc_unlink( psz_idxTmp );
 307             msg_Err( p_access, "Error moving LiveHttp index file" );
 308         }
 309         else
 310             msg_Info( p_access, "LiveHttpIndexComplete: %s" , p_sys->psz_indexPath );
 311
 312         free( psz_idxTmp );
 313     }
 314
 315     // Then take care of deletion
 316     if ( p_sys->b_delsegs && i_firstseg > 1 )
 317     {
 318         char *psz_name = formatSegmentPath( p_access, p_access->psz_path, i_firstseg-1, true );
 319          if ( psz_name )
 320          {
 321              vlc_unlink( psz_name );
 322              free( psz_name );
 323          }
 324     }
 325     return 0;
 326 }
 327
 328 /*****************************************************************************
 329  * closeCurrentSegment: Close the segment file
 330  *****************************************************************************/
 331 static void closeCurrentSegment( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
 332 {
 333     if ( p_sys->i_handle >= 0 )
 334     {
 335         close( p_sys->i_handle );
 336         p_sys->i_handle = -1;
 337         if ( p_sys->psz_cursegPath )
 338         {
 339             msg_Info( p_access, "LiveHttpSegmentComplete: %s (%"PRIu32")" , p_sys->psz_cursegPath, p_sys->i_segment );
 340             free( p_sys->psz_cursegPath );
 341             p_sys->psz_cursegPath = 0;
 342             updateIndexAndDel( p_access, p_sys, b_isend );
 343         }
 344     }
 345 }
 346
 347 /*****************************************************************************
 348  * Close: close the target
 349  *****************************************************************************/
 350 static void Close( vlc_object_t * p_this )
 351 {
 352     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 353     sout_access_out_sys_t *p_sys = p_access->p_sys;
 354
 355
 356     closeCurrentSegment( p_access, p_sys, true );
 357     free( p_sys->psz_indexUrl );
 358     free( p_sys->psz_indexPath );
 359     free( p_sys );
 360
 361     msg_Dbg( p_access, "livehttp access output closed" );
 362 }
 363
 364 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 365 {
 366     sout_access_out_sys_t *p_sys = p_access->p_sys;
 367
 368     switch( i_query )
 369     {
 370         case ACCESS_OUT_CONTROLS_PACE:
 371         {
 372             bool *pb = va_arg( args, bool * );
 373             *pb = !p_sys->b_ratecontrol;
 374             //*pb = true;
 375             break;
 376         }
 377
 378         default:
 379             return VLC_EGENERIC;
 380     }
 381     return VLC_SUCCESS;
 382 }
 383
 384 /*****************************************************************************
 385  * openNextFile: Open the segment file
 386  *****************************************************************************/
 387 static ssize_t openNextFile( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys )
 388 {
 389     int fd;
 390
 391     uint32_t i_newseg = p_sys->i_segment + 1;
 392
 393     char *psz_seg = formatSegmentPath( p_access, p_access->psz_path, i_newseg, true );
 394     if ( !psz_seg )
 395         return -1;
 396
 397     fd = vlc_open( psz_seg, O_WRONLY | O_CREAT | O_LARGEFILE |
 398                      O_TRUNC, 0666 );
 399     if ( fd == -1 )
 400     {
 401         msg_Err( p_access, "cannot open `%s' (%m)", psz_seg );
 402         free( psz_seg );
 403         return -1;
 404     }
 405
 406     msg_Dbg( p_access, "Successfully opened livehttp file: %s (%"PRIu32")" , psz_seg, i_newseg );
 407
 408     //free( psz_seg );
 409     p_sys->psz_cursegPath = psz_seg;
 410     p_sys->i_handle = fd;
 411     p_sys->i_segment = i_newseg;
 412     return fd;
 413 }
 414
 415 /*****************************************************************************
 416  * Write: standard write on a file descriptor.
 417  *****************************************************************************/
 418 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 419 {
 420     size_t i_write = 0;
 421     sout_access_out_sys_t *p_sys = p_access->p_sys;
 422
 423     while( p_buffer )
 424     {
 425         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 )
 426         {
 427             closeCurrentSegment( p_access, p_sys, false );
 428         }
 429         if ( p_buffer->i_buffer > 0 && p_sys->i_handle < 0 )
 430         {
 431             p_sys->i_opendts = p_buffer->i_dts;
 432             if ( openNextFile( p_access, p_sys ) < 0 )
 433                 return -1;
 434         }
 435         ssize_t val = write ( p_sys->i_handle,
 436                              p_buffer->p_buffer, p_buffer->i_buffer );
 437         if ( val == -1 )
 438         {
 439             if ( errno == EINTR )
 440                 continue;
 441             block_ChainRelease ( p_buffer );
 442             return -1;
 443         }
 444
 445         if ( (size_t)val >= p_buffer->i_buffer )
 446         {
 447             block_t *p_next = p_buffer->p_next;
 448             block_Release (p_buffer);
 449             p_buffer = p_next;
 450         }
 451         else
 452         {
 453             p_buffer->p_buffer += val;
 454             p_buffer->i_buffer -= val;
 455         }
 456         i_write += val;
 457     }
 458     return i_write;
 459 }
 460
 461 /*****************************************************************************
 462  * Seek: seek to a specific location in a file
 463  *****************************************************************************/
 464 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 465 {
 466     (void) i_pos;
 467     msg_Err( p_access, "livehttp sout access cannot seek" );
 468     return -1;
 469 }