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 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 #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 ssize_t Read( stream_t *, void *p_read, size_t i_read );
  68 static int  Seek   ( stream_t *, uint64_t );
  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_seek = Seek;
  93     s->pf_control = Control;
  94     stream_FilterSetDefaultReadDir( s );
  95
  96     return VLC_SUCCESS;
  97 }
  98
  99 /****************************************************************************
 100  * Close
 101  ****************************************************************************/
 102 static void Close( vlc_object_t *p_this )
 103 {
 104     stream_t *s = (stream_t*)p_this;
 105     stream_sys_t *p_sys = s->p_sys;
 106
 107     if( p_sys->f )
 108         Stop( s );
 109
 110     free( p_sys );
 111 }
 112
 113 /****************************************************************************
 114  * Stream filters functions
 115  ****************************************************************************/
 116 static ssize_t Read( stream_t *s, void *p_read, size_t i_read )
 117 {
 118     stream_sys_t *p_sys = s->p_sys;
 119     void *p_record = p_read;
 120     const ssize_t i_record = vlc_stream_Read( s->s, p_record, i_read );
 121
 122     /* Dump read data */
 123     if( p_sys->f )
 124     {
 125         if( p_record && i_record > 0 )
 126             Write( s, p_record, i_record );
 127     }
 128
 129     return i_record;
 130 }
 131
 132 static int Seek( stream_t *s, uint64_t offset )
 133 {
 134     return vlc_stream_Seek( s->s, offset );
 135 }
 136
 137 static int Control( stream_t *s, int i_query, va_list args )
 138 {
 139     if( i_query != STREAM_SET_RECORD_STATE )
 140         return vlc_stream_vaControl( s->s, i_query, args );
 141
 142     stream_sys_t *sys = s->p_sys;
 143     bool b_active = (bool)va_arg( args, int );
 144     const char *psz_extension = NULL;
 145     if( b_active )
 146         psz_extension = va_arg( args, const char* );
 147
 148     if( !sys->f == !b_active )
 149         return VLC_SUCCESS;
 150
 151     if( b_active )
 152         return Start( s, psz_extension );
 153     else
 154         return Stop( s );
 155 }
 156
 157 /****************************************************************************
 158  * Helpers
 159  ****************************************************************************/
 160 static int Start( stream_t *s, const char *psz_extension )
 161 {
 162     stream_sys_t *p_sys = s->p_sys;
 163
 164     char *psz_file;
 165     FILE *f;
 166
 167     /* */
 168     if( !psz_extension )
 169         psz_extension = "dat";
 170
 171     /* Retreive path */
 172     char *psz_path = var_CreateGetNonEmptyString( s, "input-record-path" );
 173     if( !psz_path )
 174         psz_path = config_GetUserDir( VLC_DOWNLOAD_DIR );
 175
 176     if( !psz_path )
 177         return VLC_ENOMEM;
 178
 179     /* Create file name
 180      * TODO allow prefix configuration */
 181     psz_file = input_CreateFilename( s->p_input, psz_path, INPUT_RECORD_PREFIX, psz_extension );
 182
 183     free( psz_path );
 184
 185     if( !psz_file )
 186         return VLC_ENOMEM;
 187
 188     f = vlc_fopen( psz_file, "wb" );
 189     if( !f )
 190     {
 191         free( psz_file );
 192         return VLC_EGENERIC;
 193     }
 194
 195     /* signal new record file */
 196     var_SetString( s->obj.libvlc, "record-file", psz_file );
 197
 198     msg_Dbg( s, "Recording into %s", psz_file );
 199     free( psz_file );
 200
 201     /* */
 202     p_sys->f = f;
 203     p_sys->b_error = false;
 204     return VLC_SUCCESS;
 205 }
 206 static int Stop( stream_t *s )
 207 {
 208     stream_sys_t *p_sys = s->p_sys;
 209
 210     assert( p_sys->f );
 211
 212     msg_Dbg( s, "Recording completed" );
 213     fclose( p_sys->f );
 214     p_sys->f = NULL;
 215     return VLC_SUCCESS;
 216 }
 217
 218 static void Write( stream_t *s, const uint8_t *p_buffer, size_t i_buffer )
 219 {
 220     stream_sys_t *p_sys = s->p_sys;
 221
 222     assert( p_sys->f );
 223
 224     if( i_buffer > 0 )
 225     {
 226         const bool b_previous_error = p_sys->b_error;
 227         const size_t i_written = fwrite( p_buffer, 1, i_buffer, p_sys->f );
 228
 229         p_sys->b_error = i_written != i_buffer;
 230
 231         /* TODO maybe a intf_UserError or something like that ? */
 232         if( p_sys->b_error && !b_previous_error )
 233             msg_Err( s, "Failed to record data (begin)" );
 234         else if( !p_sys->b_error && b_previous_error )
 235             msg_Err( s, "Failed to record data (end)" );
 236     }
 237 }