modules/audio_output/file.c

   1 /*****************************************************************************
   2  * file.c : audio output which writes the samples to a file
   3  *****************************************************************************
   4  * Copyright (C) 2002 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_aout.h>
  36 #include <vlc_codecs.h> /* WAVEHEADER */
  37 #include <vlc_fs.h>
  38
  39 #define FRAME_SIZE 2048
  40 #define A52_FRAME_NB 1536
  41
  42 /*****************************************************************************
  43  * aout_sys_t: audio output method descriptor
  44  *****************************************************************************
  45  * This structure is part of the audio output thread descriptor.
  46  * It describes the direct sound specific properties of an audio device.
  47  *****************************************************************************/
  48 struct aout_sys_t
  49 {
  50     FILE     * p_file;
  51     bool b_add_wav_header;
  52
  53     WAVEHEADER waveh;                      /* Wave header of the output file */
  54 };
  55
  56 #define CHANNELS_MAX 6
  57 static const int pi_channels_maps[CHANNELS_MAX+1] =
  58 {
  59     0,
  60     AOUT_CHAN_CENTER,
  61     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  62     AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  63     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
  64      | AOUT_CHAN_REARRIGHT,
  65     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
  66      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT,
  67     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
  68      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE
  69 };
  70
  71 /*****************************************************************************
  72  * Local prototypes.
  73  *****************************************************************************/
  74 static int     Open        ( vlc_object_t * );
  75 static void    Close       ( vlc_object_t * );
  76 static void    Play        ( aout_instance_t * );
  77
  78 /*****************************************************************************
  79  * Module descriptor
  80  *****************************************************************************/
  81 #define FORMAT_TEXT N_("Output format")
  82 #define FORMAT_LONGTEXT N_("One of \"u8\", \"s8\", \"u16\", \"s16\", " \
  83     "\"u16_le\", \"s16_le\", \"u16_be\", \"s16_be\", \"fixed32\", " \
  84     "\"float32\" or \"spdif\"")
  85 #define CHANNELS_TEXT N_("Number of output channels")
  86 #define CHANNELS_LONGTEXT N_("By default, all the channels of the incoming " \
  87     "will be saved but you can restrict the number of channels here.")
  88
  89 #define WAV_TEXT N_("Add WAVE header")
  90 #define WAV_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
  91                         "header to the file.")
  92
  93 static const char *const format_list[] = { "u8", "s8", "u16", "s16", "u16_le",
  94                                      "s16_le", "u16_be", "s16_be", "fixed32",
  95                                      "float32", "spdif" };
  96 static const int format_int[] = { VLC_CODEC_U8,
  97                                   VLC_CODEC_S8,
  98                                   VLC_CODEC_U16N, VLC_CODEC_S16N,
  99                                   VLC_CODEC_U16L,
 100                                   VLC_CODEC_S16L,
 101                                   VLC_CODEC_U16B,
 102                                   VLC_CODEC_S16B,
 103                                   VLC_CODEC_FI32,
 104                                   VLC_CODEC_FL32,
 105                                   VLC_CODEC_SPDIFL };
 106
 107 #define FILE_TEXT N_("Output file")
 108 #define FILE_LONGTEXT N_("File to which the audio samples will be written to. (\"-\" for stdout")
 109
 110 vlc_module_begin ()
 111     set_description( N_("File audio output") )
 112     set_shortname( N_("File") )
 113     set_category( CAT_AUDIO )
 114     set_subcategory( SUBCAT_AUDIO_AOUT )
 115
 116     add_string( "audiofile-format", "s16", NULL,
 117                 FORMAT_TEXT, FORMAT_LONGTEXT, true )
 118         change_string_list( format_list, 0, 0 )
 119     add_integer( "audiofile-channels", 0, NULL,
 120                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
 121     add_file( "audiofile-file", "audiofile.wav", NULL, FILE_TEXT,
 122               FILE_LONGTEXT, false )
 123     add_bool( "audiofile-wav", true, NULL, WAV_TEXT, WAV_LONGTEXT, true )
 124
 125     set_capability( "audio output", 0 )
 126     add_shortcut( "file" )
 127     add_shortcut( "audiofile" )
 128     set_callbacks( Open, Close )
 129 vlc_module_end ()
 130
 131 /*****************************************************************************
 132  * Open: open a dummy audio device
 133  *****************************************************************************/
 134 static int Open( vlc_object_t * p_this )
 135 {
 136     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 137     char * psz_name, * psz_format;
 138     const char * const * ppsz_compare = format_list;
 139     int i_channels, i = 0;
 140
 141     psz_name = var_CreateGetString( p_this, "audiofile-file" );
 142     if( !psz_name || !*psz_name )
 143     {
 144         msg_Err( p_aout, "you need to specify an output file name" );
 145         free( psz_name );
 146         return VLC_EGENERIC;
 147     }
 148
 149     /* Allocate structure */
 150     p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
 151     if( p_aout->output.p_sys == NULL )
 152         return VLC_ENOMEM;
 153
 154     if( !strcmp( psz_name, "-" ) )
 155         p_aout->output.p_sys->p_file = stdout;
 156     else
 157         p_aout->output.p_sys->p_file = vlc_fopen( psz_name, "wb" );
 158
 159     free( psz_name );
 160     if ( p_aout->output.p_sys->p_file == NULL )
 161     {
 162         free( p_aout->output.p_sys );
 163         return VLC_EGENERIC;
 164     }
 165
 166     p_aout->output.pf_play = Play;
 167
 168     /* Audio format */
 169     psz_format = var_CreateGetString( p_this, "audiofile-format" );
 170
 171     while ( *ppsz_compare != NULL )
 172     {
 173         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
 174         {
 175             break;
 176         }
 177         ppsz_compare++; i++;
 178     }
 179
 180     if ( *ppsz_compare == NULL )
 181     {
 182         msg_Err( p_aout, "cannot understand the format string (%s)",
 183                  psz_format );
 184         if( p_aout->output.p_sys->p_file != stdout )
 185             fclose( p_aout->output.p_sys->p_file );
 186         free( p_aout->output.p_sys );
 187         free( psz_format );
 188         return VLC_EGENERIC;
 189     }
 190     free( psz_format );
 191
 192     p_aout->output.output.i_format = format_int[i];
 193     if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
 194     {
 195         p_aout->output.i_nb_samples = A52_FRAME_NB;
 196         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
 197         p_aout->output.output.i_frame_length = A52_FRAME_NB;
 198         aout_VolumeNoneInit( p_aout );
 199     }
 200     else
 201     {
 202         p_aout->output.i_nb_samples = FRAME_SIZE;
 203         aout_VolumeSoftInit( p_aout );
 204     }
 205
 206     /* Channels number */
 207     i_channels = var_CreateGetInteger( p_this, "audiofile-channels" );
 208
 209     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
 210     {
 211         p_aout->output.output.i_physical_channels =
 212             pi_channels_maps[i_channels];
 213     }
 214
 215     /* WAV header */
 216     p_aout->output.p_sys->b_add_wav_header = var_CreateGetBool( p_this,
 217                                                         "audiofile-wav" );
 218
 219     if( p_aout->output.p_sys->b_add_wav_header )
 220     {
 221         /* Write wave header */
 222         WAVEHEADER *wh = &p_aout->output.p_sys->waveh;
 223
 224         memset( wh, 0, sizeof(*wh) );
 225
 226         switch( p_aout->output.output.i_format )
 227         {
 228         case VLC_CODEC_FL32:
 229             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
 230             wh->BitsPerSample = sizeof(float) * 8;
 231             break;
 232         case VLC_CODEC_U8:
 233             wh->Format     = WAVE_FORMAT_PCM;
 234             wh->BitsPerSample = 8;
 235             break;
 236         case VLC_CODEC_S16L:
 237         default:
 238             wh->Format     = WAVE_FORMAT_PCM;
 239             wh->BitsPerSample = 16;
 240             break;
 241         }
 242
 243         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 244         wh->Length = 0;                    /* temp, to be filled in as we go */
 245         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 246         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 247         wh->SubChunkLength = 16;
 248
 249         wh->Modus = aout_FormatNbChannels( &p_aout->output.output );
 250         wh->SampleFreq = p_aout->output.output.i_rate;
 251         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
 252         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
 253
 254         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 255         wh->DataLength = 0;                /* temp, to be filled in as we go */
 256
 257         /* Header -> little endian format */
 258         SetWLE( &wh->Format, wh->Format );
 259         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
 260         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
 261         SetWLE( &wh->Modus, wh->Modus );
 262         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
 263         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
 264         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
 265
 266         if( fwrite( wh, sizeof(WAVEHEADER), 1,
 267                     p_aout->output.p_sys->p_file ) != 1 )
 268         {
 269             msg_Err( p_aout, "write error (%m)" );
 270         }
 271     }
 272
 273     return 0;
 274 }
 275
 276 /*****************************************************************************
 277  * Close: close our file
 278  *****************************************************************************/
 279 static void Close( vlc_object_t * p_this )
 280 {
 281     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 282
 283     msg_Dbg( p_aout, "closing audio file" );
 284
 285     if( p_aout->output.p_sys->b_add_wav_header )
 286     {
 287         /* Update Wave Header */
 288         p_aout->output.p_sys->waveh.Length =
 289             p_aout->output.p_sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
 290
 291         /* Write Wave Header */
 292         if( fseek( p_aout->output.p_sys->p_file, 0, SEEK_SET ) )
 293         {
 294             msg_Err( p_aout, "seek error (%m)" );
 295         }
 296
 297         /* Header -> little endian format */
 298         SetDWLE( &p_aout->output.p_sys->waveh.Length,
 299                  p_aout->output.p_sys->waveh.Length );
 300         SetDWLE( &p_aout->output.p_sys->waveh.DataLength,
 301                  p_aout->output.p_sys->waveh.DataLength );
 302
 303         if( fwrite( &p_aout->output.p_sys->waveh, sizeof(WAVEHEADER), 1,
 304                     p_aout->output.p_sys->p_file ) != 1 )
 305         {
 306             msg_Err( p_aout, "write error (%m)" );
 307         }
 308     }
 309
 310     if( p_aout->output.p_sys->p_file != stdout )
 311         fclose( p_aout->output.p_sys->p_file );
 312     free( p_aout->output.p_sys );
 313 }
 314
 315 /*****************************************************************************
 316  * Play: pretend to play a sound
 317  *****************************************************************************/
 318 static void Play( aout_instance_t * p_aout )
 319 {
 320     aout_buffer_t * p_buffer;
 321
 322     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
 323
 324     if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
 325                 p_aout->output.p_sys->p_file ) != 1 )
 326     {
 327         msg_Err( p_aout, "write error (%m)" );
 328     }
 329
 330     if( p_aout->output.p_sys->b_add_wav_header )
 331     {
 332         /* Update Wave Header */
 333         p_aout->output.p_sys->waveh.DataLength += p_buffer->i_buffer;
 334     }
 335
 336     aout_BufferFree( p_buffer );
 337 }