vlc/modules/stream_filter/record.c

257 lines
7.2 KiB
C
Raw Permalink Normal View History

2008-12-09 21:06:12 +01:00
/*****************************************************************************
* record.c
*****************************************************************************
* Copyright (C) 2008 Laurent Aimar
*
* Author: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
*
LGPL Re-license almost all the playback modules to LGPLv2.1+ with authorization from their respective contributors (230+) This includes: - access, codec, packetizers, demux - audio filters, audio mixers, audio output - video filters, video chroma, video output - text renderers - XML parser - ARM NEON and SSE2 optimisations (mostly for chromas and filters) Some modules are not concerned: - BDA and DShow access modules because Manol Manolov is AWOL - Real RTSP, because it is derived from Xine - x264 and t140 because they are encoders only - DLL Loader, because it is derived from MPlayer - DTS packetizer, because Jon Lech Johansen is AWOL - Shine and WMAfixed, because they are derived from Rockbox - Real demuxer, as it is derived from MPlayer and Wang Bo is AWOL - MPC demuxer, as Yavor Doganov is AWOL - Tivo demuxer, because it is derived from an MPlayer fork - Playlist demuxer, (WPL and ZPL parts missing), because suheaven is AWOL - iOS audio output and video display, because author refuses the license change - Equalizer and compressor, because Ronald Wright is AWOL - Mono, Headphone and Dolby, because author refuses the license change - hqdn3d and yadif, because they are from MPlayer/libavfilter - remoteosd, because it derives from RealVNC code - MMX optimisations, because Ollie Lho, from SiS, is AWOL - Rotate, because it depends on GPL motion Nota Bene: - Some modules depend on GPL-only libraries, a LGPL module does not mean that the resulting binary module will be LGPL. Libraries affected would include liba52, libdvdcss, libdvdnav, libdvdread, faad2, libdca, libmad, libmpeg2, libpostproc, SRC, sid, zvbi and probably others.
2012-11-06 17:48:33 +01:00
* 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
2008-12-09 21:06:12 +01:00
* (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
LGPL Re-license almost all the playback modules to LGPLv2.1+ with authorization from their respective contributors (230+) This includes: - access, codec, packetizers, demux - audio filters, audio mixers, audio output - video filters, video chroma, video output - text renderers - XML parser - ARM NEON and SSE2 optimisations (mostly for chromas and filters) Some modules are not concerned: - BDA and DShow access modules because Manol Manolov is AWOL - Real RTSP, because it is derived from Xine - x264 and t140 because they are encoders only - DLL Loader, because it is derived from MPlayer - DTS packetizer, because Jon Lech Johansen is AWOL - Shine and WMAfixed, because they are derived from Rockbox - Real demuxer, as it is derived from MPlayer and Wang Bo is AWOL - MPC demuxer, as Yavor Doganov is AWOL - Tivo demuxer, because it is derived from an MPlayer fork - Playlist demuxer, (WPL and ZPL parts missing), because suheaven is AWOL - iOS audio output and video display, because author refuses the license change - Equalizer and compressor, because Ronald Wright is AWOL - Mono, Headphone and Dolby, because author refuses the license change - hqdn3d and yadif, because they are from MPlayer/libavfilter - remoteosd, because it derives from RealVNC code - MMX optimisations, because Ollie Lho, from SiS, is AWOL - Rotate, because it depends on GPL motion Nota Bene: - Some modules depend on GPL-only libraries, a LGPL module does not mean that the resulting binary module will be LGPL. Libraries affected would include liba52, libdvdcss, libdvdnav, libdvdread, faad2, libdca, libmad, libmpeg2, libpostproc, SRC, sid, zvbi and probably others.
2012-11-06 17:48:33 +01:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
2008-12-09 21:06:12 +01:00
*
LGPL Re-license almost all the playback modules to LGPLv2.1+ with authorization from their respective contributors (230+) This includes: - access, codec, packetizers, demux - audio filters, audio mixers, audio output - video filters, video chroma, video output - text renderers - XML parser - ARM NEON and SSE2 optimisations (mostly for chromas and filters) Some modules are not concerned: - BDA and DShow access modules because Manol Manolov is AWOL - Real RTSP, because it is derived from Xine - x264 and t140 because they are encoders only - DLL Loader, because it is derived from MPlayer - DTS packetizer, because Jon Lech Johansen is AWOL - Shine and WMAfixed, because they are derived from Rockbox - Real demuxer, as it is derived from MPlayer and Wang Bo is AWOL - MPC demuxer, as Yavor Doganov is AWOL - Tivo demuxer, because it is derived from an MPlayer fork - Playlist demuxer, (WPL and ZPL parts missing), because suheaven is AWOL - iOS audio output and video display, because author refuses the license change - Equalizer and compressor, because Ronald Wright is AWOL - Mono, Headphone and Dolby, because author refuses the license change - hqdn3d and yadif, because they are from MPlayer/libavfilter - remoteosd, because it derives from RealVNC code - MMX optimisations, because Ollie Lho, from SiS, is AWOL - Rotate, because it depends on GPL motion Nota Bene: - Some modules depend on GPL-only libraries, a LGPL module does not mean that the resulting binary module will be LGPL. Libraries affected would include liba52, libdvdcss, libdvdnav, libdvdread, faad2, libdca, libmad, libmpeg2, libpostproc, SRC, sid, zvbi and probably others.
2012-11-06 17:48:33 +01:00
* 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.
2008-12-09 21:06:12 +01:00
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <vlc_common.h>
#include <vlc_configuration.h>
2008-12-09 21:06:12 +01:00
#include <vlc_plugin.h>
#include <assert.h>
#include <vlc_stream.h>
2019-05-31 12:39:48 +02:00
#include <vlc_input_item.h>
#include <vlc_fs.h>
2008-12-09 21:06:12 +01:00
/*****************************************************************************
* Module descriptor
*****************************************************************************/
static int Open ( vlc_object_t * );
static void Close( vlc_object_t * );
vlc_module_begin()
set_subcategory( SUBCAT_INPUT_STREAM_FILTER )
set_description( N_("Internal stream record") )
set_capability( "stream_filter", 0 )
set_callbacks( Open, Close )
vlc_module_end()
/*****************************************************************************
*
*****************************************************************************/
typedef struct
2008-12-09 21:06:12 +01:00
{
FILE *f; /* TODO it could be replaced by access_output_t one day */
bool b_error;
} stream_sys_t;
2008-12-09 21:06:12 +01:00
/****************************************************************************
* Local prototypes
****************************************************************************/
static ssize_t Read( stream_t *, void *p_read, size_t i_read );
static int Seek ( stream_t *, uint64_t );
2008-12-09 21:06:12 +01:00
static int Control( stream_t *, int i_query, va_list );
static int Start ( stream_t *, const char *dir_path, const char *psz_extension );
2008-12-09 21:06:12 +01:00
static int Stop ( stream_t * );
static void Write ( stream_t *, const uint8_t *p_buffer, size_t i_buffer );
/****************************************************************************
* Open
****************************************************************************/
static int Open ( vlc_object_t *p_this )
{
stream_t *s = (stream_t*)p_this;
stream_sys_t *p_sys;
/* */
s->p_sys = p_sys = malloc( sizeof( *p_sys ) );
if( !p_sys )
return VLC_ENOMEM;
2009-07-21 18:11:22 +02:00
p_sys->f = NULL;
2008-12-09 21:06:12 +01:00
/* */
s->pf_read = Read;
s->pf_seek = Seek;
2008-12-09 21:06:12 +01:00
s->pf_control = Control;
return VLC_SUCCESS;
}
/****************************************************************************
* Close
****************************************************************************/
static void Close( vlc_object_t *p_this )
{
stream_t *s = (stream_t*)p_this;
stream_sys_t *p_sys = s->p_sys;
2009-07-21 18:11:22 +02:00
if( p_sys->f )
2008-12-09 21:06:12 +01:00
Stop( s );
free( p_sys );
}
/****************************************************************************
* Stream filters functions
****************************************************************************/
static ssize_t Read( stream_t *s, void *p_read, size_t i_read )
2008-12-09 21:06:12 +01:00
{
stream_sys_t *p_sys = s->p_sys;
void *p_record = p_read;
const ssize_t i_record = vlc_stream_Read( s->s, p_record, i_read );
2008-12-09 21:06:12 +01:00
/* Dump read data */
2009-07-21 18:11:22 +02:00
if( p_sys->f )
2008-12-09 21:06:12 +01:00
{
if( p_record && i_record > 0 )
Write( s, p_record, i_record );
}
return i_record;
}
static int Seek( stream_t *s, uint64_t offset )
{
return vlc_stream_Seek( s->s, offset );
}
2008-12-09 21:06:12 +01:00
static int Control( stream_t *s, int i_query, va_list args )
{
if( i_query != STREAM_SET_RECORD_STATE )
return vlc_stream_vaControl( s->s, i_query, args );
2008-12-09 21:06:12 +01:00
stream_sys_t *sys = s->p_sys;
2008-12-09 21:06:12 +01:00
bool b_active = (bool)va_arg( args, int );
const char *psz_extension = NULL, *dir_path = NULL;
2008-12-09 21:06:12 +01:00
if( b_active )
{
dir_path = va_arg( args, const char* );
2017-04-19 19:43:04 +02:00
psz_extension = va_arg( args, const char* );
}
2008-12-09 21:06:12 +01:00
if( !sys->f == !b_active )
2008-12-09 21:06:12 +01:00
return VLC_SUCCESS;
if( b_active )
return Start( s, dir_path, psz_extension );
2008-12-09 21:06:12 +01:00
else
return Stop( s );
}
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;
}
}
}
2008-12-09 21:06:12 +01:00
/****************************************************************************
* Helpers
****************************************************************************/
static int Start( stream_t *s, const char *dir_path, const char *psz_extension )
2008-12-09 21:06:12 +01:00
{
stream_sys_t *p_sys = s->p_sys;
char *psz_file;
FILE *f;
/* */
if( !psz_extension )
psz_extension = "dat";
/* Retrieve path */
char *psz_path = NULL;
if( dir_path == NULL )
{
psz_path = var_CreateGetNonEmptyString( s, "input-record-path" );
if( psz_path == NULL )
psz_path = config_GetUserDir( VLC_DOWNLOAD_DIR );
dir_path = psz_path;
}
2008-12-09 21:06:12 +01:00
if( dir_path == NULL )
2008-12-09 21:06:12 +01:00
return VLC_ENOMEM;
/* Create file name
* TODO allow prefix configuration */
psz_file = input_item_CreateFilename( s->p_input_item, dir_path,
2019-05-31 12:39:48 +02:00
INPUT_RECORD_PREFIX, psz_extension );
2008-12-09 21:06:12 +01:00
free( psz_path );
if( !psz_file )
return VLC_ENOMEM;
2010-02-07 14:25:29 +01:00
f = vlc_fopen( psz_file, "wb" );
2008-12-09 21:06:12 +01:00
if( !f )
{
free( psz_file );
return VLC_EGENERIC;
}
/* signal new record file */
set_record_file_var(VLC_OBJECT(s), psz_file);
2008-12-09 21:06:12 +01:00
msg_Dbg( s, "Recording into %s", psz_file );
free( psz_file );
/* */
p_sys->f = f;
p_sys->b_error = false;
return VLC_SUCCESS;
}
static int Stop( stream_t *s )
{
stream_sys_t *p_sys = s->p_sys;
2009-07-21 18:11:22 +02:00
assert( p_sys->f );
2008-12-09 21:06:12 +01:00
msg_Dbg( s, "Recording completed" );
fclose( p_sys->f );
2009-07-21 18:11:22 +02:00
p_sys->f = NULL;
2008-12-09 21:06:12 +01:00
return VLC_SUCCESS;
}
static void Write( stream_t *s, const uint8_t *p_buffer, size_t i_buffer )
{
stream_sys_t *p_sys = s->p_sys;
2009-07-21 18:11:22 +02:00
assert( p_sys->f );
2008-12-09 21:06:12 +01:00
if( i_buffer > 0 )
{
const bool b_previous_error = p_sys->b_error;
const size_t i_written = fwrite( p_buffer, 1, i_buffer, p_sys->f );
p_sys->b_error = i_written != i_buffer;
/* TODO maybe a intf_UserError or something like that ? */
if( p_sys->b_error && !b_previous_error )
msg_Err( s, "Failed to record data (begin)" );
else if( !p_sys->b_error && b_previous_error )
msg_Err( s, "Failed to record data (end)" );
}
}