git.sesse.net Git - vlc/blob - modules/stream_filter/record.c

   1 /*****************************************************************************
   2  * record.c
   3  *****************************************************************************
   4  * Copyright (C) 2008 Laurent Aimar
   5  * $Id$
   6  *
   7  * Author: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33
  34 #include <assert.h>
  35 #include <vlc_stream.h>
  36 #include <vlc_input.h>
  37 #include <vlc_fs.h>
  38
  39
  40 /*****************************************************************************
  41  * Module descriptor
  42  *****************************************************************************/
  43 static int  Open ( vlc_object_t * );
  44 static void Close( vlc_object_t * );
  45
  46 vlc_module_begin()
  47     set_category( CAT_INPUT )
  48     set_subcategory( SUBCAT_INPUT_STREAM_FILTER )
  49     set_description( N_("Internal stream record") )
  50     set_capability( "stream_filter", 0 )
  51     set_callbacks( Open, Close )
  52 vlc_module_end()
  53
  54 /*****************************************************************************
  55  *
  56  *****************************************************************************/
  57 struct stream_sys_t
  58 {
  59     FILE *f;        /* TODO it could be replaced by access_output_t one day */
  60     bool b_error;
  61 };
  62
  63
  64 /****************************************************************************
  65  * Local prototypes
  66  ****************************************************************************/
  67 static int  Read   ( stream_t *, void *p_read, unsigned int i_read );
  68 static int  Peek   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
  69 static int  Control( stream_t *, int i_query, va_list );
  70
  71 static int  Start  ( stream_t *, const char *psz_extension );
  72 static int  Stop   ( stream_t * );
  73 static void Write  ( stream_t *, const uint8_t *p_buffer, size_t i_buffer );
  74
  75 /****************************************************************************
  76  * Open
  77  ****************************************************************************/
  78 static int Open ( vlc_object_t *p_this )
  79 {
  80     stream_t *s = (stream_t*)p_this;
  81     stream_sys_t *p_sys;
  82
  83     /* */
  84     s->p_sys = p_sys = malloc( sizeof( *p_sys ) );
  85     if( !p_sys )
  86         return VLC_ENOMEM;
  87
  88     p_sys->f = NULL;
  89
  90     /* */
  91     s->pf_read = Read;
  92     s->pf_peek = Peek;
  93     s->pf_control = Control;
  94
  95     return VLC_SUCCESS;
  96 }
  97
  98 /****************************************************************************
  99  * Close
 100  ****************************************************************************/
 101 static void Close( vlc_object_t *p_this )
 102 {
 103     stream_t *s = (stream_t*)p_this;
 104     stream_sys_t *p_sys = s->p_sys;
 105
 106     if( p_sys->f )
 107         Stop( s );
 108
 109     free( p_sys );
 110 }
 111
 112 /****************************************************************************
 113  * Stream filters functions
 114  ****************************************************************************/
 115 static int Read( stream_t *s, void *p_read, unsigned int i_read )
 116 {
 117     stream_sys_t *p_sys = s->p_sys;
 118     void *p_record = p_read;
 119
 120     /* Allocate a temporary buffer for record when no p_read */
 121     if( p_sys->f && !p_record )
 122         p_record = malloc( i_read );
 123
 124     /* */
 125     const int i_record = stream_Read( s->p_source, p_record, i_read );
 126
 127     /* Dump read data */
 128     if( p_sys->f )
 129     {
 130         if( p_record && i_record > 0 )
 131             Write( s, p_record, i_record );
 132         if( !p_read )
 133             free( p_record );
 134     }
 135
 136     return i_record;
 137 }
 138
 139 static int Peek( stream_t *s, const uint8_t **pp_peek, unsigned int i_peek )
 140 {
 141     return stream_Peek( s->p_source, pp_peek, i_peek );
 142 }
 143
 144 static int Control( stream_t *s, int i_query, va_list args )
 145 {
 146     if( i_query != STREAM_SET_RECORD_STATE )
 147         return stream_vaControl( s->p_source, i_query, args );
 148
 149     bool b_active = (bool)va_arg( args, int );
 150     const char *psz_extension = NULL;
 151     if( b_active )
 152         psz_extension = (const char*)va_arg( args, const char* );
 153
 154     if( !s->p_sys->f == !b_active )
 155         return VLC_SUCCESS;
 156
 157     if( b_active )
 158         return Start( s, psz_extension );
 159     else
 160         return Stop( s );
 161 }
 162
 163 /****************************************************************************
 164  * Helpers
 165  ****************************************************************************/
 166 static int Start( stream_t *s, const char *psz_extension )
 167 {
 168     stream_sys_t *p_sys = s->p_sys;
 169
 170     char *psz_file;
 171     FILE *f;
 172
 173     /* */
 174     if( !psz_extension )
 175         psz_extension = "dat";
 176
 177     /* Retreive path */
 178     char *psz_path = var_CreateGetNonEmptyString( s, "input-record-path" );
 179     if( !psz_path )
 180         psz_path = config_GetUserDir( VLC_DOWNLOAD_DIR );
 181
 182     if( !psz_path )
 183         return VLC_ENOMEM;
 184
 185     /* Create file name
 186      * TODO allow prefix configuration */
 187     psz_file = input_CreateFilename( VLC_OBJECT(s), psz_path, INPUT_RECORD_PREFIX, psz_extension );
 188
 189     free( psz_path );
 190
 191     if( !psz_file )
 192         return VLC_ENOMEM;
 193
 194     f = vlc_fopen( psz_file, "wb" );
 195     if( !f )
 196     {
 197         free( psz_file );
 198         return VLC_EGENERIC;
 199     }
 200
 201     /* signal new record file */
 202     var_SetString( s->p_libvlc, "record-file", psz_file );
 203
 204     msg_Dbg( s, "Recording into %s", psz_file );
 205     free( psz_file );
 206
 207     /* */
 208     p_sys->f = f;
 209     p_sys->b_error = false;
 210     return VLC_SUCCESS;
 211 }
 212 static int Stop( stream_t *s )
 213 {
 214     stream_sys_t *p_sys = s->p_sys;
 215
 216     assert( p_sys->f );
 217
 218     msg_Dbg( s, "Recording completed" );
 219     fclose( p_sys->f );
 220     p_sys->f = NULL;
 221     return VLC_SUCCESS;
 222 }
 223
 224 static void Write( stream_t *s, const uint8_t *p_buffer, size_t i_buffer )
 225 {
 226     stream_sys_t *p_sys = s->p_sys;
 227
 228     assert( p_sys->f );
 229
 230     if( i_buffer > 0 )
 231     {
 232         const bool b_previous_error = p_sys->b_error;
 233         const size_t i_written = fwrite( p_buffer, 1, i_buffer, p_sys->f );
 234
 235         p_sys->b_error = i_written != i_buffer;
 236
 237         /* TODO maybe a intf_UserError or something like that ? */
 238         if( p_sys->b_error && !b_previous_error )
 239             msg_Err( s, "Failed to record data (begin)" );
 240         else if( !p_sys->b_error && b_previous_error )
 241             msg_Err( s, "Failed to record data (end)" );
 242     }
 243 }