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