You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

675 lines
20 KiB

/*****************************************************************************
* record.c: record stream output module
*****************************************************************************
* Copyright (C) 2008-2009 VLC authors and VideoLAN
*
* Authors: Laurent Aimar <fenrir@via.ecp.fr>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <limits.h>
#include <vlc_common.h>
#include <vlc_arrays.h>
#include <vlc_configuration.h>
#include <vlc_plugin.h>
#include <vlc_block.h>
#include <vlc_sout.h>
#include <vlc_fs.h>
#include <assert.h>
/*****************************************************************************
* Exported prototypes
*****************************************************************************/
static int Open ( vlc_object_t * );
/*****************************************************************************
* Module descriptor
*****************************************************************************/
#define DST_PREFIX_TEXT N_("Destination prefix")
#define DST_PREFIX_LONGTEXT N_( \
"Prefix of the destination file automatically generated" )
#define SOUT_CFG_PREFIX "sout-record-"
vlc_module_begin ()
set_description( N_("Record stream output") )
set_capability( "sout output", 0 )
add_shortcut( "record" )
set_shortname( N_("Record") )
set_subcategory( SUBCAT_SOUT_STREAM )
add_string( SOUT_CFG_PREFIX "dst-prefix", "", DST_PREFIX_TEXT,
DST_PREFIX_LONGTEXT )
set_callback( Open )
vlc_module_end ()
/* */
static const char *const ppsz_sout_options[] = {
"dst-prefix",
NULL
};
/* */
static void *Add( sout_stream_t *, const es_format_t *, const char * );
static void Del( sout_stream_t *, void * );
static int Send( sout_stream_t *, void *, block_t * );
typedef struct sout_stream_id_sys_t sout_stream_id_sys_t;
struct sout_stream_id_sys_t
{
es_format_t fmt;
const char *es_id;
block_t *p_first;
block_t **pp_last;
sout_stream_id_sys_t *id;
bool b_wait_key;
bool b_wait_start;
};
typedef struct
{
char *psz_prefix;
sout_stream_t *p_out;
vlc_tick_t i_date_start;
size_t i_size;
vlc_tick_t i_max_wait;
size_t i_max_size;
bool b_drop;
int i_id;
sout_stream_id_sys_t **id;
vlc_tick_t i_dts_start;
} sout_stream_sys_t;
static void OutputStart( sout_stream_t *p_stream );
static void OutputSend( sout_stream_t *p_stream, sout_stream_id_sys_t *id, block_t * );
static void Close( sout_stream_t * );
static const struct sout_stream_operations ops = {
.add = Add,
.del = Del,
.send = Send,
.close = Close,
};
/*****************************************************************************
* Open:
*****************************************************************************/
static int Open( vlc_object_t *p_this )
{
sout_stream_t *p_stream = (sout_stream_t*)p_this;
sout_stream_sys_t *p_sys;
p_stream->p_sys = p_sys = malloc( sizeof(*p_sys) );
if( !p_sys )
return VLC_ENOMEM;
config_ChainParse( p_stream, SOUT_CFG_PREFIX, ppsz_sout_options, p_stream->p_cfg );
p_sys->p_out = NULL;
p_sys->psz_prefix = var_GetNonEmptyString( p_stream, SOUT_CFG_PREFIX "dst-prefix" );
if( !p_sys->psz_prefix )
{
p_sys->psz_prefix = strdup( "sout-record-" );
if( !p_sys->psz_prefix )
{
free( p_sys );
return VLC_ENOMEM;
}
}
p_sys->i_date_start = VLC_TICK_INVALID;
p_sys->i_size = 0;
#ifdef OPTIMIZE_MEMORY
p_sys->i_max_wait = VLC_TICK_FROM_SEC(5);
p_sys->i_max_size = 1*1024*1024; /* 1 MiB */
#else
p_sys->i_max_wait = VLC_TICK_FROM_SEC(30);
p_sys->i_max_size = 20*1024*1024; /* 20 MiB */
#endif
p_sys->b_drop = false;
p_sys->i_dts_start = 0;
TAB_INIT( p_sys->i_id, p_sys->id );
p_stream->ops = &ops;
return VLC_SUCCESS;
}
/*****************************************************************************
* Close:
*****************************************************************************/
static void Close( sout_stream_t *p_stream )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
if( p_sys->p_out )
sout_StreamChainDelete( p_sys->p_out, NULL );
TAB_CLEAN( p_sys->i_id, p_sys->id );
free( p_sys->psz_prefix );
free( p_sys );
}
/*****************************************************************************
*
*****************************************************************************/
static void *
Add( sout_stream_t *p_stream, const es_format_t *p_fmt, const char *es_id )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
sout_stream_id_sys_t *id;
id = malloc( sizeof(*id) );
if( !id )
return NULL;
es_format_Copy( &id->fmt, p_fmt );
id->es_id = es_id;
id->p_first = NULL;
id->pp_last = &id->p_first;
id->id = NULL;
id->b_wait_key = true;
id->b_wait_start = true;
TAB_APPEND( p_sys->i_id, p_sys->id, id );
return id;
}
static void Del( sout_stream_t *p_stream, void *_id )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
sout_stream_id_sys_t *id = (sout_stream_id_sys_t *)_id;
if( !p_sys->p_out )
OutputStart( p_stream );
if( id->p_first )
block_ChainRelease( id->p_first );
assert( !id->id || p_sys->p_out );
if( id->id )
sout_StreamIdDel( p_sys->p_out, id->id );
es_format_Clean( &id->fmt );
TAB_REMOVE( p_sys->i_id, p_sys->id, id );
if( p_sys->i_id <= 0 )
{
if( !p_sys->p_out )
p_sys->b_drop = false;
}
free( id );
}
static int Send( sout_stream_t *p_stream, void *id, block_t *p_buffer )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
if( p_sys->i_date_start == VLC_TICK_INVALID )
p_sys->i_date_start = vlc_tick_now();
if( !p_sys->p_out &&
( vlc_tick_now() - p_sys->i_date_start > p_sys->i_max_wait ||
p_sys->i_size > p_sys->i_max_size ) )
{
msg_Dbg( p_stream, "Starting recording, waited %ds and %dbyte",
(int)SEC_FROM_VLC_TICK(vlc_tick_now() - p_sys->i_date_start), (int)p_sys->i_size );
OutputStart( p_stream );
}
OutputSend( p_stream, id, p_buffer );
return VLC_SUCCESS;
}
/*****************************************************************************
*
*****************************************************************************/
typedef struct
{
const char psz_muxer[19];
const char psz_extension[5];
int i_es_max;
vlc_fourcc_t codec[128];
} muxer_properties_t;
#define M(muxer, ext, count, ... ) { .psz_muxer = muxer, .psz_extension = ext, .i_es_max = count, .codec = { __VA_ARGS__, 0 } }
/* Table of native codec support,
* Do not do non native and non standard association !
* Muxer will be probe if no entry found */
static const muxer_properties_t p_muxers[] = {
M( "raw", "mp3", 1, VLC_CODEC_MPGA, VLC_CODEC_MP2, VLC_CODEC_MP3 ),
M( "raw", "a52", 1, VLC_CODEC_A52, VLC_CODEC_EAC3 ),
M( "raw", "dts", 1, VLC_CODEC_DTS ),
M( "raw", "mpc", 1, VLC_CODEC_MUSEPACK7, VLC_CODEC_MUSEPACK8 ),
M( "raw", "ape", 1, VLC_CODEC_APE ),
M( "wav", "wav", 1, VLC_CODEC_U8, VLC_CODEC_S16L,
VLC_CODEC_S24L, VLC_CODEC_S32L, VLC_CODEC_FL32 ),
//M( "avformat{mux=flac}", "flac", 1, VLC_CODEC_FLAC ), BROKEN
M( "ogg", "ogg", INT_MAX, VLC_CODEC_VORBIS, VLC_CODEC_SPEEX, VLC_CODEC_FLAC,
VLC_CODEC_SUBT, VLC_CODEC_THEORA,
VLC_CODEC_OPUS ),
M( "asf", "asf", 127, VLC_CODEC_WMA1, VLC_CODEC_WMA2, VLC_CODEC_WMAP, VLC_CODEC_WMAL, VLC_CODEC_WMAS,
VLC_CODEC_WMV1, VLC_CODEC_WMV2, VLC_CODEC_WMV3, VLC_CODEC_VC1 ),
M( "mp4", "mp4", INT_MAX, VLC_CODEC_MP4A, VLC_CODEC_A52, VLC_CODEC_EAC3, VLC_CODEC_DTS,
VLC_CODEC_H264, VLC_CODEC_MP4V, VLC_CODEC_HEVC, VLC_CODEC_AV1,
VLC_CODEC_SUBT, VLC_CODEC_QTXT, VLC_CODEC_TX3G ),
M( "ps", "mpg", 16/* FIXME*/, VLC_CODEC_MPGV, VLC_CODEC_MP2V, VLC_CODEC_MP1V,
VLC_CODEC_MPGA, VLC_CODEC_DVD_LPCM, VLC_CODEC_A52,
VLC_CODEC_DTS,
VLC_CODEC_SPU ),
M( "avi", "avi", 100, VLC_CODEC_A52, VLC_CODEC_MPGA,
VLC_CODEC_WMA1, VLC_CODEC_WMA2, VLC_CODEC_WMAP, VLC_CODEC_WMAL,
VLC_CODEC_U8, VLC_CODEC_S16L, VLC_CODEC_S24L,
VLC_CODEC_MP4V ),
M( "ts", "ts", 8000, VLC_CODEC_MPGV, VLC_CODEC_MP2V, VLC_CODEC_MP1V,
VLC_CODEC_H264, VLC_CODEC_HEVC,
VLC_CODEC_MPGA, VLC_CODEC_MP2, VLC_CODEC_MP3,
VLC_CODEC_DVD_LPCM, VLC_CODEC_A52, VLC_CODEC_EAC3,
VLC_CODEC_DTS, VLC_CODEC_MP4A,
VLC_CODEC_DVBS, VLC_CODEC_TELETEXT ),
M( "avformat{mux=webm}", "webm", 32,
VLC_CODEC_VP8, VLC_CODEC_VP9,
VLC_CODEC_VORBIS, VLC_CODEC_OPUS ),
M( "mkv", "mkv", 32, VLC_CODEC_H264, VLC_CODEC_HEVC, VLC_CODEC_MP4V,
VLC_CODEC_A52, VLC_CODEC_EAC3, VLC_CODEC_DTS, VLC_CODEC_MP4A,
VLC_CODEC_VORBIS, VLC_CODEC_FLAC ),
};
#undef M
static void set_record_file_var(vlc_object_t *obj, const char *file)
{
while ((obj = vlc_object_parent(obj)) != NULL)
{
if (var_Type(obj, "record-file") != 0)
{
var_SetString(obj, "record-file", file);
break;
}
}
}
static int OutputNew( sout_stream_t *p_stream,
const char *psz_muxer, const char *psz_prefix, const char *psz_extension )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
char *psz_file = NULL, *psz_tmp = NULL;
char *psz_output = NULL;
int i_count;
if( asprintf( &psz_tmp, "%s%s%s",
psz_prefix, psz_extension ? "." : "", psz_extension ? psz_extension : "" ) < 0 )
{
goto error;
}
psz_file = config_StringEscape( psz_tmp );
if( !psz_file )
{
free( psz_tmp );
goto error;
}
free( psz_tmp );
if( asprintf( &psz_output,
"std{access=file{no-append,no-format,no-overwrite},"
"mux=%s,dst='%s'}", psz_muxer, psz_file ) < 0 )
{
psz_output = NULL;
goto error;
}
/* Create the output */
msg_Dbg( p_stream, "Using record output `%s'", psz_output );
p_sys->p_out = sout_StreamChainNew( VLC_OBJECT(p_stream), psz_output,
NULL );
if( !p_sys->p_out )
goto error;
/* Add es */
i_count = 0;
for( int i = 0; i < p_sys->i_id; i++ )
{
sout_stream_id_sys_t *id = p_sys->id[i];
id->id = sout_StreamIdAdd( p_sys->p_out, &id->fmt, id->es_id );
if( id->id )
i_count++;
}
if( psz_file && psz_extension )
set_record_file_var(VLC_OBJECT(p_stream), psz_file);
free( psz_file );
free( psz_output );
return i_count;
error:
free( psz_file );
free( psz_output );
return -1;
}
static vlc_tick_t BlockTick( const block_t *p_block )
{
if( unlikely(!p_block) )
return VLC_TICK_INVALID;
else if( likely(p_block->i_dts != VLC_TICK_INVALID) )
return p_block->i_dts;
else
return p_block->i_pts;
}
static void OutputStart( sout_stream_t *p_stream )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
/* */
if( p_sys->b_drop )
return;
/* From now on drop packet that cannot be handled */
p_sys->b_drop = true;
/* Detect streams to smart select muxer */
const char *psz_muxer = NULL;
const char *psz_extension = NULL;
/* Look for preferred muxer
* TODO we could insert transcode in a few cases like
* s16l <-> s16b
*/
for( unsigned i = 0; i < sizeof(p_muxers) / sizeof(*p_muxers); i++ )
{
bool b_ok;
if( p_sys->i_id > p_muxers[i].i_es_max )
continue;
b_ok = true;
for( int j = 0; j < p_sys->i_id; j++ )
{
es_format_t *p_fmt = &p_sys->id[j]->fmt;
b_ok = false;
for( int k = 0; p_muxers[i].codec[k] != 0; k++ )
{
if( p_fmt->i_codec == p_muxers[i].codec[k] )
{
b_ok = true;
break;
}
}
if( !b_ok )
break;
}
if( !b_ok )
continue;
psz_muxer = p_muxers[i].psz_muxer;
psz_extension = p_muxers[i].psz_extension;
break;
}
/* If failed, brute force our demuxers and select the one that
* keeps most of our stream */
if( !psz_muxer || !psz_extension )
{
static const char ppsz_muxers[][2][4] = {
{ "avi", "avi" }, { "mp4", "mp4" }, { "ogg", "ogg" },
{ "asf", "asf" }, { "ts", "ts" }, { "ps", "mpg" },
{ "mkv", "mkv" },
#if 0
// XXX ffmpeg sefault really easily if you try an unsupported codec
// mov and avi at least segfault
{ "avformat{mux=avi}", "avi" },
{ "avformat{mux=mov}", "mov" },
{ "avformat{mux=mp4}", "mp4" },
{ "avformat{mux=nsv}", "nsv" },
{ "avformat{mux=flv}", "flv" },
#endif
};
int i_best = 0;
int i_best_es = 0;
msg_Warn( p_stream, "failed to find an adequate muxer, probing muxers" );
for( unsigned i = 0; i < sizeof(ppsz_muxers) / sizeof(*ppsz_muxers); i++ )
{
char *psz_file;
int i_es;
psz_file = tempnam( NULL, "vlc" );
if( !psz_file )
continue;
msg_Dbg( p_stream, "probing muxer %s", ppsz_muxers[i][0] );
i_es = OutputNew( p_stream, ppsz_muxers[i][0], psz_file, NULL );
if( i_es < 0 )
{
vlc_unlink( psz_file );
free( psz_file );
continue;
}
/* */
for( int j = 0; j < p_sys->i_id; j++ )
{
sout_stream_id_sys_t *id = p_sys->id[j];
if( id->id )
sout_StreamIdDel( p_sys->p_out, id->id );
id->id = NULL;
}
if( p_sys->p_out )
sout_StreamChainDelete( p_sys->p_out, NULL );
p_sys->p_out = NULL;
if( i_es > i_best_es )
{
i_best_es = i_es;
i_best = i;
if( i_best_es >= p_sys->i_id )
break;
}
vlc_unlink( psz_file );
free( psz_file );
}
/* */
psz_muxer = ppsz_muxers[i_best][0];
psz_extension = ppsz_muxers[i_best][1];
msg_Dbg( p_stream, "using muxer %s with extension %s (%d/%d streams accepted)",
psz_muxer, psz_extension, i_best_es, p_sys->i_id );
}
/* Create the output */
if( OutputNew( p_stream, psz_muxer, p_sys->psz_prefix, psz_extension ) < 0 )
{
msg_Err( p_stream, "failed to open output");
return;
}
/* Compute highest timestamp of first I over all streams */
p_sys->i_dts_start = 0;
vlc_tick_t i_highest_head_dts = 0;
for( int i = 0; i < p_sys->i_id; i++ )
{
sout_stream_id_sys_t *id = p_sys->id[i];
if( !id->id || !id->p_first )
continue;
const block_t *p_block = id->p_first;
vlc_tick_t i_dts = BlockTick( p_block );
if( i_dts > i_highest_head_dts &&
( id->fmt.i_cat == AUDIO_ES || id->fmt.i_cat == VIDEO_ES ) )
{
i_highest_head_dts = i_dts;
}
for( ; p_block != NULL; p_block = p_block->p_next )
{
if( p_block->i_flags & BLOCK_FLAG_TYPE_I )
{
i_dts = BlockTick( p_block );
break;
}
}
if( i_dts > p_sys->i_dts_start )
p_sys->i_dts_start = i_dts;
}
if( p_sys->i_dts_start == 0 )
p_sys->i_dts_start = i_highest_head_dts;
sout_stream_id_sys_t *p_cand;
vlc_tick_t canddts;
do
{
/* dequeue candidate */
p_cand = NULL;
canddts = VLC_TICK_INVALID;
/* Send buffered data in dts order */
for( int i = 0; i < p_sys->i_id; i++ )
{
sout_stream_id_sys_t *id = p_sys->id[i];
if( !id->id || id->p_first == NULL )
continue;
block_t *p_id_block;
vlc_tick_t id_dts = VLC_TICK_INVALID;
for( p_id_block = id->p_first; p_id_block; p_id_block = p_id_block->p_next )
{
id_dts = BlockTick( p_id_block );
if( id_dts != VLC_TICK_INVALID )
break;
}
if( id_dts == VLC_TICK_INVALID )
{
p_cand = id;
canddts = VLC_TICK_INVALID;
break;
}
if( p_cand == NULL || canddts > id_dts )
{
p_cand = id;
canddts = id_dts;
}
}
if( p_cand != NULL )
{
block_t *p_block = p_cand->p_first;
p_cand->p_first = p_block->p_next;
if( p_cand->p_first == NULL )
p_cand->pp_last = &p_cand->p_first;
p_block->p_next = NULL;
if( BlockTick( p_block ) >= p_sys->i_dts_start )
OutputSend( p_stream, p_cand, p_block );
else
block_Release( p_block );
}
} while( p_cand != NULL );
}
static void OutputSend( sout_stream_t *p_stream, sout_stream_id_sys_t *id, block_t *p_block )
{
sout_stream_sys_t *p_sys = p_stream->p_sys;
if( id->id )
{
/* We wait until the first key frame (if needed) and
* to be beyond i_dts_start (for stream without key frame) */
if( unlikely( id->b_wait_key ) )
{
if( p_block->i_flags & BLOCK_FLAG_TYPE_I )
{
id->b_wait_key = false;
id->b_wait_start = false;
}
if( ( p_block->i_flags & BLOCK_FLAG_TYPE_MASK ) == 0 )
id->b_wait_key = false;
}
if( unlikely( id->b_wait_start ) )
{
if( p_block->i_dts >=p_sys->i_dts_start )
id->b_wait_start = false;
}
if( unlikely( id->b_wait_key || id->b_wait_start ) )
block_ChainRelease( p_block );
else
sout_StreamIdSend( p_sys->p_out, id->id, p_block );
}
else if( p_sys->b_drop )
{
block_ChainRelease( p_block );
}
else
{
size_t i_size;
block_ChainProperties( p_block, NULL, &i_size, NULL );
p_sys->i_size += i_size;
block_ChainLastAppend( &id->pp_last, p_block );
}
}