demuxdump.c 6.29 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 33
#include <errno.h>

34
#include <vlc_common.h>
35
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
36 37
#include <vlc_demux.h>
#include <vlc_charset.h>
38 39 40 41

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

49 50 51
static int  Open( vlc_object_t * );
static void Close ( vlc_object_t * );

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

66 67 68 69 70 71 72 73 74

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

#define DUMP_BLOCKSIZE  16384

75 76
struct demux_sys_t
{
77
    char        *psz_file;
78 79 80 81 82 83 84 85 86
    FILE        *p_file;
    uint64_t    i_write;
};

/*
 * 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
    vlc_value_t val;
95
    bool  b_append;
96

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

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

105 106 107 108 109 110 111 112
    var_Create( p_demux, "demuxdump-append", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
    var_Get( p_demux, "demuxdump-append", &val );
    b_append = val.b_bool;
    if ( b_append )
        psz_mode = "ab";
    else
        psz_mode = "wb";

113 114
    p_demux->pf_demux = Demux;
    p_demux->pf_control = Control;
115

116 117 118 119
    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' )
120
    {
121
        msg_Warn( p_demux, "no dump file name given" );
122 123
        free( p_sys->psz_file );
        free( p_sys );
Gildas Bazin's avatar
 
Gildas Bazin committed
124
        return VLC_EGENERIC;
125
    }
126

127
    if( !strcmp( p_sys->psz_file, "-" ) )
128
    {
129 130
        msg_Info( p_demux, "dumping raw stream to standard output" );
        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 137
        free( p_sys );
        return VLC_EGENERIC;
138
    }
139 140
    msg_Info( p_demux, "%s raw stream to file `%s'",
              b_append ? "appending" : "dumping", p_sys->psz_file );
141

Gildas Bazin's avatar
 
Gildas Bazin committed
142
    return VLC_SUCCESS;
143 144 145
}

/*****************************************************************************
146
 * Close:
147
 *****************************************************************************/
148
static void Close( vlc_object_t *p_this )
149
{
150

151 152
    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys = p_demux->p_sys;
153

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

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

/*****************************************************************************
 * Demux: reads and demuxes data packets
 *****************************************************************************
 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 *****************************************************************************/
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 179
    if ( i_data <= 0 )
        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 186
        msg_Err( p_demux, "failed to write data" );
        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 196
    return 1;
}
197

198 199 200 201 202
/*****************************************************************************
 * Demux: reads and demuxes data packets
 *****************************************************************************/
static int Control( demux_t *p_demux, int i_query, va_list args )
{
203
    return demux_vaControlHelper( p_demux->s, 0, -1, 0, 1, i_query, args );
204
}
205