1 /*****************************************************************************
2 * livehttp.c: Live HTTP Streaming
3 *****************************************************************************
4 * Copyright © 2001, 2002 VLC authors and VideoLAN
5 * Copyright © 2009-2010 by Keary Griffin
7 * Authors: Keary Griffin <kearygriffin at gmail.com>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <sys/types.h>
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
43 #include <vlc_block.h>
45 #include <vlc_strings.h>
46 #include <vlc_charset.h>
49 # define O_LARGEFILE 0
52 #define STR_ENDLIST "#EXT-X-ENDLIST\n"
54 #define MAX_RENAME_RETRIES 10
56 /*****************************************************************************
58 *****************************************************************************/
59 static int Open ( vlc_object_t * );
60 static void Close( vlc_object_t * );
62 #define SOUT_CFG_PREFIX "sout-livehttp-"
63 #define SEGLEN_TEXT N_("Segment length")
64 #define SEGLEN_LONGTEXT N_("Length of TS stream segments")
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.")
70 #define NUMSEGS_TEXT N_("Number of segments")
71 #define NUMSEGS_LONGTEXT N_("Number of segments to include in index")
73 #define INDEX_TEXT N_("Index file")
74 #define INDEX_LONGTEXT N_("Path to the index file to create")
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")
80 #define DELSEGS_TEXT N_("Delete segments")
81 #define DELSEGS_LONGTEXT N_("Delete segments when they are no longer needed")
83 #define RATECONTROL_TEXT N_("Use muxers rate control mechanism")
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 )
108 /*****************************************************************************
109 * Exported prototypes
110 *****************************************************************************/
111 static const char *const ppsz_sout_options[] = {
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 );
126 struct sout_access_out_sys_t
128 char *psz_cursegPath;
136 block_t *block_buffer;
142 bool b_splitanywhere;
145 /*****************************************************************************
146 * Open: open the file
147 *****************************************************************************/
148 static int Open( vlc_object_t *p_this )
150 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
151 sout_access_out_sys_t *p_sys;
154 config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
156 if( !p_access->psz_path )
158 msg_Err( p_access, "no file name specified" );
162 if( unlikely( !( p_sys = malloc ( sizeof( *p_sys ) ) ) ) )
165 p_sys->i_seglen = var_GetInteger( p_access, SOUT_CFG_PREFIX "seglen" );
166 /* Try to get within +-10% of asked segment length, so limit is +10% of segment length*/
167 p_sys->i_seglenm = CLOCK_FREQ * p_sys->i_seglen * 1.10;
168 p_sys->block_buffer = NULL;
170 p_sys->i_numsegs = var_GetInteger( p_access, SOUT_CFG_PREFIX "numsegs" );
171 p_sys->b_splitanywhere = var_GetBool( p_access, SOUT_CFG_PREFIX "splitanywhere" );
172 p_sys->b_delsegs = var_GetBool( p_access, SOUT_CFG_PREFIX "delsegs" );
173 p_sys->b_ratecontrol = var_GetBool( p_access, SOUT_CFG_PREFIX "ratecontrol") ;
176 /* 5 elements is from harrison-stetson algorithm to start from some number
177 * if we don't have numsegs defined
179 p_sys->i_seglens = 5;
180 if( p_sys->i_numsegs )
181 p_sys->i_seglens = p_sys->i_numsegs+1;
182 p_sys->p_seglens = malloc( sizeof(float) * p_sys->i_seglens );
183 if( unlikely( !p_sys->p_seglens ) )
189 p_sys->psz_indexPath = NULL;
190 psz_idx = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index" );
194 psz_tmp = str_format_time( psz_idx );
201 path_sanitize( psz_tmp );
202 p_sys->psz_indexPath = psz_tmp;
203 vlc_unlink( p_sys->psz_indexPath );
206 p_sys->psz_indexUrl = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "index-url" );
208 p_access->p_sys = p_sys;
209 p_sys->i_handle = -1;
210 p_sys->i_segment = 0;
211 p_sys->psz_cursegPath = NULL;
213 p_access->pf_write = Write;
214 p_access->pf_seek = Seek;
215 p_access->pf_control = Control;
220 #define SEG_NUMBER_PLACEHOLDER "#"
221 /*****************************************************************************
222 * formatSegmentPath: create segment path name based on seg #
223 *****************************************************************************/
224 static char *formatSegmentPath( char *psz_path, uint32_t i_seg, bool b_sanitize )
227 char *psz_firstNumSign;
229 if ( ! ( psz_result = str_format_time( psz_path ) ) )
232 psz_firstNumSign = psz_result + strcspn( psz_result, SEG_NUMBER_PLACEHOLDER );
233 if ( *psz_firstNumSign ) {
235 int i_cnt = strspn( psz_firstNumSign, SEG_NUMBER_PLACEHOLDER );
238 *psz_firstNumSign = '\0';
239 ret = asprintf( &psz_newResult, "%s%0*d%s", psz_result, i_cnt, i_seg, psz_firstNumSign + i_cnt );
243 psz_result = psz_newResult;
247 path_sanitize( psz_result );
252 /************************************************************************
253 * updateIndexAndDel: If necessary, update index file & delete old segments
254 ************************************************************************/
255 static int updateIndexAndDel( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
260 if ( p_sys->i_numsegs == 0 || p_sys->i_segment < p_sys->i_numsegs )
264 if( p_sys->i_segment >= (p_sys->i_seglens-1) )
266 p_sys->i_seglens <<= 1;
267 msg_Dbg( p_access, "Segment amount %u", p_sys->i_seglens );
268 p_sys->p_seglens = realloc( p_sys->p_seglens, sizeof(float) * p_sys->i_seglens );
269 if( unlikely( !p_sys->p_seglens ) )
274 i_firstseg = ( p_sys->i_segment - p_sys->i_numsegs ) + 1;
276 // First update index
277 if ( p_sys->psz_indexPath )
282 if ( asprintf( &psz_idxTmp, "%s.tmp", p_sys->psz_indexPath ) < 0)
285 fp = vlc_fopen( psz_idxTmp, "wt");
288 msg_Err( p_access, "cannot open index file `%s'", psz_idxTmp );
293 if ( fprintf( fp, "#EXTM3U\n#EXT-X-TARGETDURATION:%zu\n#EXT-X-VERSION:3\n#EXT-X-MEDIA-SEQUENCE:%"PRIu32"\n", p_sys->i_seglen, i_firstseg ) < 0 )
300 char *psz_idxFormat = p_sys->psz_indexUrl ? p_sys->psz_indexUrl : p_access->psz_path;
301 for ( uint32_t i = i_firstseg; i <= p_sys->i_segment; i++ )
304 char *psz_duration = NULL;
305 if ( ! ( psz_name = formatSegmentPath( psz_idxFormat, i, false ) ) )
311 if( ! ( us_asprintf( &psz_duration, "%.2f", p_sys->p_seglens[i % p_sys->i_seglens ], psz_name ) ) )
317 val = fprintf( fp, "#EXTINF:%s,\n%s\n", psz_duration, psz_name );
318 free( psz_duration );
330 if ( fputs ( STR_ENDLIST, fp ) < 0)
340 val = vlc_rename ( psz_idxTmp, p_sys->psz_indexPath);
344 vlc_unlink( psz_idxTmp );
345 msg_Err( p_access, "Error moving LiveHttp index file" );
348 msg_Info( p_access, "LiveHttpIndexComplete: %s" , p_sys->psz_indexPath );
353 // Then take care of deletion
354 if ( p_sys->b_delsegs && i_firstseg > 1 )
356 char *psz_name = formatSegmentPath( p_access->psz_path, i_firstseg-1, true );
359 vlc_unlink( psz_name );
366 /*****************************************************************************
367 * closeCurrentSegment: Close the segment file
368 *****************************************************************************/
369 static void closeCurrentSegment( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys, bool b_isend )
371 if ( p_sys->i_handle >= 0 )
373 close( p_sys->i_handle );
374 p_sys->i_handle = -1;
375 if ( p_sys->psz_cursegPath )
377 msg_Info( p_access, "LiveHttpSegmentComplete: %s (%"PRIu32")" , p_sys->psz_cursegPath, p_sys->i_segment );
378 free( p_sys->psz_cursegPath );
379 p_sys->psz_cursegPath = 0;
380 updateIndexAndDel( p_access, p_sys, b_isend );
385 /*****************************************************************************
386 * Close: close the target
387 *****************************************************************************/
388 static void Close( vlc_object_t * p_this )
390 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
391 sout_access_out_sys_t *p_sys = p_access->p_sys;
393 msg_Dbg( p_access, "Flushing buffer to last file");
394 while( p_sys->block_buffer )
396 ssize_t val = write( p_sys->i_handle, p_sys->block_buffer->p_buffer, p_sys->block_buffer->i_buffer );
399 if ( errno == EINTR )
401 block_ChainRelease ( p_sys->block_buffer);
404 if( !p_sys->block_buffer->p_next )
406 p_sys->p_seglens[p_sys->i_segment % p_sys->i_seglens ] =
407 (float)( p_sys->block_buffer->i_length / (1000000)) +
408 (float)(p_sys->block_buffer->i_dts - p_sys->i_opendts) / CLOCK_FREQ;
411 if ( (size_t)val >= p_sys->block_buffer->i_buffer )
413 block_t *p_next = p_sys->block_buffer->p_next;
414 block_Release (p_sys->block_buffer);
415 p_sys->block_buffer = p_next;
419 p_sys->block_buffer->p_buffer += val;
420 p_sys->block_buffer->i_buffer -= val;
424 closeCurrentSegment( p_access, p_sys, true );
425 free( p_sys->psz_indexUrl );
426 free( p_sys->psz_indexPath );
427 free( p_sys->p_seglens );
430 msg_Dbg( p_access, "livehttp access output closed" );
433 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
435 sout_access_out_sys_t *p_sys = p_access->p_sys;
439 case ACCESS_OUT_CONTROLS_PACE:
441 bool *pb = va_arg( args, bool * );
442 *pb = !p_sys->b_ratecontrol;
453 /*****************************************************************************
454 * openNextFile: Open the segment file
455 *****************************************************************************/
456 static ssize_t openNextFile( sout_access_out_t *p_access, sout_access_out_sys_t *p_sys )
460 uint32_t i_newseg = p_sys->i_segment + 1;
462 char *psz_seg = formatSegmentPath( p_access->psz_path, i_newseg, true );
466 fd = vlc_open( psz_seg, O_WRONLY | O_CREAT | O_LARGEFILE |
470 msg_Err( p_access, "cannot open `%s' (%m)", psz_seg );
475 msg_Dbg( p_access, "Successfully opened livehttp file: %s (%"PRIu32")" , psz_seg, i_newseg );
478 p_sys->psz_cursegPath = psz_seg;
479 p_sys->i_handle = fd;
480 p_sys->i_segment = i_newseg;
484 /*****************************************************************************
485 * Write: standard write on a file descriptor.
486 *****************************************************************************/
487 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
490 sout_access_out_sys_t *p_sys = p_access->p_sys;
495 if ( ( p_sys->b_splitanywhere || ( p_buffer->i_flags & BLOCK_FLAG_HEADER ) ) )
497 block_t *output = p_sys->block_buffer;
498 p_sys->block_buffer = NULL;
501 if( p_sys->i_handle > 0 &&
502 ( p_buffer->i_dts - p_sys->i_opendts +
503 p_buffer->i_length * CLOCK_FREQ / INT64_C(1000000)
504 ) >= p_sys->i_seglenm )
505 closeCurrentSegment( p_access, p_sys, false );
507 if ( p_sys->i_handle < 0 )
509 p_sys->i_opendts = output ? output->i_dts : p_buffer->i_dts;
510 if ( openNextFile( p_access, p_sys ) < 0 )
516 ssize_t val = write( p_sys->i_handle, output->p_buffer, output->i_buffer );
519 if ( errno == EINTR )
521 block_ChainRelease ( p_buffer );
524 p_sys->p_seglens[p_sys->i_segment % p_sys->i_seglens ] =
525 (float)output->i_length / INT64_C(1000000) +
526 (float)(output->i_dts - p_sys->i_opendts) / CLOCK_FREQ;
528 if ( (size_t)val >= output->i_buffer )
530 block_t *p_next = output->p_next;
531 block_Release (output);
536 output->p_buffer += val;
537 output->i_buffer -= val;
543 p_temp = p_buffer->p_next;
544 p_buffer->p_next = NULL;
545 block_ChainAppend( &p_sys->block_buffer, p_buffer );
552 /*****************************************************************************
553 * Seek: seek to a specific location in a file
554 *****************************************************************************/
555 static int Seek( sout_access_out_t *p_access, off_t i_pos )
558 msg_Err( p_access, "livehttp sout access cannot seek" );