demuxdump.c 6.14 KB
Newer Older
1 2 3
/*****************************************************************************
 * demuxdump.c : Pseudo demux module for vlc (dump raw stream)
 *****************************************************************************
4
 * Copyright (C) 2001-2004 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
13
 *
14 15 16 17 18 19 20
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
34
#include <vlc_demux.h>
35
#include <vlc_fs.h>
36 37 38 39

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
40
#define FILE_TEXT N_("Dump filename")
Gildas Bazin's avatar
 
Gildas Bazin committed
41
#define FILE_LONGTEXT N_( \
Clément Stenac's avatar
Clément Stenac committed
42 43
    "Name of the file to which the raw stream will be dumped." )
#define APPEND_TEXT N_("Append to existing file")
44
#define APPEND_LONGTEXT N_( \
Clément Stenac's avatar
Clément Stenac committed
45
    "If the file already exists, it will not be overwritten." )
Gildas Bazin's avatar
 
Gildas Bazin committed
46

47 48 49
static int  Open( vlc_object_t * );
static void Close ( vlc_object_t * );

50 51 52 53 54 55
vlc_module_begin ()
    set_shortname("Dump")
    set_category( CAT_INPUT )
    set_subcategory( SUBCAT_INPUT_DEMUX )
    set_description( N_("File dumper") )
    set_capability( "demux", 0 )
56
    add_file( "demuxdump-file", "stream-demux.dump", NULL, FILE_TEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
57
              FILE_LONGTEXT, false )
Rémi Duraffort's avatar
Rémi Duraffort committed
58
    add_bool( "demuxdump-append", false, NULL, APPEND_TEXT, APPEND_LONGTEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
59
              false )
60 61 62
    set_callbacks( Open, Close )
    add_shortcut( "dump" )
vlc_module_end ()
63

64 65 66 67 68 69 70 71 72

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int Demux( demux_t * );
static int Control( demux_t *, int,va_list );

#define DUMP_BLOCKSIZE  16384

73 74
struct demux_sys_t
{
75
    char        *psz_file;
76 77
    FILE        *p_file;
    uint64_t    i_write;
78 79

    uint8_t     buffer[DUMP_BLOCKSIZE];
80 81 82 83 84 85 86
};

/*
 * Data reading functions
 */

/*****************************************************************************
87
 * Open: initializes dump structures
88
 *****************************************************************************/
89
static int Open( vlc_object_t * p_this )
90
{
91 92
    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
93
    const char  *psz_mode;
94
    bool  b_append;
95

96
    /* Accept only if forced */
97
    if( !p_demux->b_force )
Gildas Bazin's avatar
 
Gildas Bazin committed
98
        return VLC_EGENERIC;
99

100 101 102 103
    p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
    if( !p_sys )
        return VLC_ENOMEM;

104
    b_append = var_CreateGetBool( p_demux, "demuxdump-append" );
105 106 107 108 109
    if ( b_append )
        psz_mode = "ab";
    else
        psz_mode = "wb";

110 111
    p_demux->pf_demux = Demux;
    p_demux->pf_control = Control;
112

113 114 115 116
    p_sys->i_write = 0;
    p_sys->p_file = NULL;
    p_sys->psz_file = var_CreateGetString( p_demux, "demuxdump-file" );
    if( *p_sys->psz_file == '\0' )
117
    {
118
        msg_Warn( p_demux, "no dump file name given" );
119 120
        free( p_sys->psz_file );
        free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
121
        return VLC_EGENERIC;
122
    }
123

124
    if( !strcmp( p_sys->psz_file, "-" ) )
125
    {
126 127
        msg_Info( p_demux, "dumping raw stream to standard output" );
        p_sys->p_file = stdout;
128
    }
129
    else if( ( p_sys->p_file = utf8_fopen( p_sys->psz_file, psz_mode ) ) == NULL )
130
    {
131
        msg_Err( p_demux, "cannot create `%s' for writing", p_sys->psz_file );
132
        free( p_sys->psz_file );
133 134
        free( p_sys );
        return VLC_EGENERIC;
135
    }
136 137
    msg_Info( p_demux, "%s raw stream to file `%s'",
              b_append ? "appending" : "dumping", p_sys->psz_file );
138

Gildas Bazin's avatar
 
Gildas Bazin committed
139
    return VLC_SUCCESS;
140 141 142
}

/*****************************************************************************
143
 * Close:
144
 *****************************************************************************/
145
static void Close( vlc_object_t *p_this )
146
{
147

148 149
    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys = p_demux->p_sys;
150

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
151
    msg_Info( p_demux ,"closing %s (%"PRId64" Kbytes dumped)", p_sys->psz_file,
152 153 154
              p_sys->i_write / 1024 );

    if( p_sys->p_file != stdout )
155
    {
156
        fclose( p_sys->p_file );
157
    }
158 159
    free( p_sys->psz_file );
    free( p_sys );
160 161 162 163 164 165 166
}

/*****************************************************************************
 * Demux: reads and demuxes data packets
 *****************************************************************************
 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 *****************************************************************************/
167
static int Demux( demux_t *p_demux )
168
{
169
    demux_sys_t *p_sys = p_demux->p_sys;
170

171
    int i_data;
172

173
    i_data = stream_Read( p_demux->s, p_sys->buffer, DUMP_BLOCKSIZE );
174 175
    if ( i_data <= 0 )
        return i_data;
176

177
    i_data = fwrite( p_sys->buffer, 1, i_data, p_sys->p_file );
178

179
    if( i_data == 0 )
180
    {
181 182
        msg_Err( p_demux, "failed to write data" );
        return -1;
183
    }
184
#if 0
185
    msg_Dbg( p_demux, "dumped %d bytes", i_data );
186
#endif
187

188
    p_sys->i_write += i_data;
189

190 191
    return 1;
}
192

193 194 195 196 197
/*****************************************************************************
 * Demux: reads and demuxes data packets
 *****************************************************************************/
static int Control( demux_t *p_demux, int i_query, va_list args )
{
198
    return demux_vaControlHelper( p_demux->s, 0, -1, 0, 1, i_query, args );
199
}
200