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 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 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     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 int Read( stream_t *s, void *p_read, unsigned int i_read )
 117 {
 118     stream_sys_t *p_sys = s->p_sys;
 119     void *p_record = p_read;
 120
 121     /* Allocate a temporary buffer for record when no p_read */
 122     if( p_sys->f && !p_record )
 123         p_record = malloc( i_read );
 124
 125     /* */
 126     const int i_record = stream_Read( s->p_source, p_record, i_read );
 127
 128     /* Dump read data */
 129     if( p_sys->f )
 130     {
 131         if( p_record && i_record > 0 )
 132             Write( s, p_record, i_record );
 133         if( !p_read )
 134             free( p_record );
 135     }
 136
 137     return i_record;
 138 }
 139
 140 static int Peek( stream_t *s, const uint8_t **pp_peek, unsigned int i_peek )
 141 {
 142     return stream_Peek( s->p_source, pp_peek, i_peek );
 143 }
 144
 145 static int Control( stream_t *s, int i_query, va_list args )
 146 {
 147     if( i_query != STREAM_SET_RECORD_STATE )
 148         return stream_vaControl( s->p_source, i_query, args );
 149
 150     bool b_active = (bool)va_arg( args, int );
 151     const char *psz_extension = NULL;
 152     if( b_active )
 153         psz_extension = (const char*)va_arg( args, const char* );
 154
 155     if( !s->p_sys->f == !b_active )
 156         return VLC_SUCCESS;
 157
 158     if( b_active )
 159         return Start( s, psz_extension );
 160     else
 161         return Stop( s );
 162 }
 163
 164 /****************************************************************************
 165  * Helpers
 166  ****************************************************************************/
 167 static int Start( stream_t *s, const char *psz_extension )
 168 {
 169     stream_sys_t *p_sys = s->p_sys;
 170
 171     char *psz_file;
 172     FILE *f;
 173
 174     /* */
 175     if( !psz_extension )
 176         psz_extension = "dat";
 177
 178     /* Retreive path */
 179     char *psz_path = var_CreateGetNonEmptyString( s, "input-record-path" );
 180     if( !psz_path )
 181         psz_path = config_GetUserDir( VLC_DOWNLOAD_DIR );
 182
 183     if( !psz_path )
 184         return VLC_ENOMEM;
 185
 186     /* Create file name
 187      * TODO allow prefix configuration */
 188     psz_file = input_CreateFilename( s->p_input, psz_path, INPUT_RECORD_PREFIX, psz_extension );
 189
 190     free( psz_path );
 191
 192     if( !psz_file )
 193         return VLC_ENOMEM;
 194
 195     f = vlc_fopen( psz_file, "wb" );
 196     if( !f )
 197     {
 198         free( psz_file );
 199         return VLC_EGENERIC;
 200     }
 201
 202     /* signal new record file */
 203     var_SetString( s->p_libvlc, "record-file", psz_file );
 204
 205     msg_Dbg( s, "Recording into %s", psz_file );
 206     free( psz_file );
 207
 208     /* */
 209     p_sys->f = f;
 210     p_sys->b_error = false;
 211     return VLC_SUCCESS;
 212 }
 213 static int Stop( stream_t *s )
 214 {
 215     stream_sys_t *p_sys = s->p_sys;
 216
 217     assert( p_sys->f );
 218
 219     msg_Dbg( s, "Recording completed" );
 220     fclose( p_sys->f );
 221     p_sys->f = NULL;
 222     return VLC_SUCCESS;
 223 }
 224
 225 static void Write( stream_t *s, const uint8_t *p_buffer, size_t i_buffer )
 226 {
 227     stream_sys_t *p_sys = s->p_sys;
 228
 229     assert( p_sys->f );
 230
 231     if( i_buffer > 0 )
 232     {
 233         const bool b_previous_error = p_sys->b_error;
 234         const size_t i_written = fwrite( p_buffer, 1, i_buffer, p_sys->f );
 235
 236         p_sys->b_error = i_written != i_buffer;
 237
 238         /* TODO maybe a intf_UserError or something like that ? */
 239         if( p_sys->b_error && !b_previous_error )
 240             msg_Err( s, "Failed to record data (begin)" );
 241         else if( !p_sys->b_error && b_previous_error )
 242             msg_Err( s, "Failed to record data (end)" );
 243     }
 244 }