git.sesse.net Git - vlc/blob - modules/demux/demuxdump.c

   1 /*****************************************************************************
   2  * demuxdump.c : Pseudo demux module for vlc (dump raw stream)
   3  *****************************************************************************
   4  * Copyright (C) 2001-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <errno.h>
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_demux.h>
  37 #include <vlc_charset.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 #define FILE_TEXT N_("Dump filename")
  43 #define FILE_LONGTEXT N_( \
  44     "Name of the file to which the raw stream will be dumped." )
  45 #define APPEND_TEXT N_("Append to existing file")
  46 #define APPEND_LONGTEXT N_( \
  47     "If the file already exists, it will not be overwritten." )
  48
  49 static int  Open( vlc_object_t * );
  50 static void Close ( vlc_object_t * );
  51
  52 vlc_module_begin ()
  53     set_shortname("Dump")
  54     set_category( CAT_INPUT )
  55     set_subcategory( SUBCAT_INPUT_DEMUX )
  56     set_description( N_("File dumper") )
  57     set_capability( "demux", 0 )
  58     add_file( "demuxdump-file", "stream-demux.dump", NULL, FILE_TEXT,
  59               FILE_LONGTEXT, false )
  60     add_bool( "demuxdump-append", false, NULL, APPEND_TEXT, APPEND_LONGTEXT,
  61               false )
  62     set_callbacks( Open, Close )
  63     add_shortcut( "dump" )
  64 vlc_module_end ()
  65
  66
  67 /*****************************************************************************
  68  * Local prototypes
  69  *****************************************************************************/
  70 static int Demux( demux_t * );
  71 static int Control( demux_t *, int,va_list );
  72
  73 #define DUMP_BLOCKSIZE  16384
  74
  75 struct demux_sys_t
  76 {
  77     char        *psz_file;
  78     FILE        *p_file;
  79     uint64_t    i_write;
  80 };
  81
  82 /*
  83  * Data reading functions
  84  */
  85
  86 /*****************************************************************************
  87  * Open: initializes dump structures
  88  *****************************************************************************/
  89 static int Open( vlc_object_t * p_this )
  90 {
  91     demux_t     *p_demux = (demux_t*)p_this;
  92     demux_sys_t *p_sys;
  93     const char  *psz_mode;
  94     vlc_value_t val;
  95     bool  b_append;
  96
  97     /* Accept only if forced */
  98     if( !p_demux->b_force )
  99         return VLC_EGENERIC;
 100
 101     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 102     if( !p_sys )
 103         return VLC_ENOMEM;
 104
 105     var_Create( p_demux, "demuxdump-append", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
 106     var_Get( p_demux, "demuxdump-append", &val );
 107     b_append = val.b_bool;
 108     if ( b_append )
 109         psz_mode = "ab";
 110     else
 111         psz_mode = "wb";
 112
 113     p_demux->pf_demux = Demux;
 114     p_demux->pf_control = Control;
 115
 116     p_sys->i_write = 0;
 117     p_sys->p_file = NULL;
 118     p_sys->psz_file = var_CreateGetString( p_demux, "demuxdump-file" );
 119     if( *p_sys->psz_file == '\0' )
 120     {
 121         msg_Warn( p_demux, "no dump file name given" );
 122         free( p_sys->psz_file );
 123         free( p_sys );
 124         return VLC_EGENERIC;
 125     }
 126
 127     if( !strcmp( p_sys->psz_file, "-" ) )
 128     {
 129         msg_Info( p_demux, "dumping raw stream to standard output" );
 130         p_sys->p_file = stdout;
 131     }
 132     else if( ( p_sys->p_file = utf8_fopen( p_sys->psz_file, psz_mode ) ) == NULL )
 133     {
 134         msg_Err( p_demux, "cannot create `%s' for writing", p_sys->psz_file );
 135         free( p_sys->psz_file );
 136         free( p_sys );
 137         return VLC_EGENERIC;
 138     }
 139     msg_Info( p_demux, "%s raw stream to file `%s'",
 140               b_append ? "appending" : "dumping", p_sys->psz_file );
 141
 142     return VLC_SUCCESS;
 143 }
 144
 145 /*****************************************************************************
 146  * Close:
 147  *****************************************************************************/
 148 static void Close( vlc_object_t *p_this )
 149 {
 150
 151     demux_t     *p_demux = (demux_t*)p_this;
 152     demux_sys_t *p_sys = p_demux->p_sys;
 153
 154     msg_Info( p_demux ,"closing %s (%"PRId64" Kbytes dumped)", p_sys->psz_file,
 155               p_sys->i_write / 1024 );
 156
 157     if( p_sys->p_file != stdout )
 158     {
 159         fclose( p_sys->p_file );
 160     }
 161     free( p_sys->psz_file );
 162     free( p_sys );
 163 }
 164
 165 /*****************************************************************************
 166  * Demux: reads and demuxes data packets
 167  *****************************************************************************
 168  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 169  *****************************************************************************/
 170 static int Demux( demux_t *p_demux )
 171 {
 172     demux_sys_t *p_sys = p_demux->p_sys;
 173
 174     const uint8_t *p_peek;
 175     int i_data;
 176
 177     i_data = stream_Peek( p_demux->s, &p_peek, DUMP_BLOCKSIZE );
 178     if ( i_data <= 0 )
 179         return i_data;
 180
 181     i_data = fwrite( p_peek, 1, i_data, p_sys->p_file );
 182
 183     if( i_data == 0 )
 184     {
 185         msg_Err( p_demux, "failed to write data" );
 186         return -1;
 187     }
 188 #if 0
 189     msg_Dbg( p_demux, "dumped %d bytes", i_data );
 190 #endif
 191
 192     stream_Read( p_demux->s, NULL, i_data );
 193     p_sys->i_write += i_data;
 194
 195     return 1;
 196 }
 197
 198 /*****************************************************************************
 199  * Demux: reads and demuxes data packets
 200  *****************************************************************************/
 201 static int Control( demux_t *p_demux, int i_query, va_list args )
 202 {
 203     return demux_vaControlHelper( p_demux->s, 0, -1, 0, 1, i_query, args );
 204 }
 205