git.sesse.net Git - vlc/blob - 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 A52_FRAME_NB 1536
  40
  41 /*****************************************************************************
  42  * aout_sys_t: audio output method descriptor
  43  *****************************************************************************
  44  * This structure is part of the audio output thread descriptor.
  45  * It describes the direct sound specific properties of an audio device.
  46  *****************************************************************************/
  47 struct aout_sys_t
  48 {
  49     FILE     * p_file;
  50     bool b_add_wav_header;
  51
  52     WAVEHEADER waveh;                      /* Wave header of the output file */
  53 };
  54
  55 #define CHANNELS_MAX 6
  56 static const int pi_channels_maps[CHANNELS_MAX+1] =
  57 {
  58     0,
  59     AOUT_CHAN_CENTER,
  60     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  61     AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  62     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
  63      | AOUT_CHAN_REARRIGHT,
  64     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
  65      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT,
  66     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
  67      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE
  68 };
  69
  70 /*****************************************************************************
  71  * Local prototypes.
  72  *****************************************************************************/
  73 static int     Open        ( vlc_object_t * );
  74 static void    Close       ( vlc_object_t * );
  75 static void    Play        ( audio_output_t *, block_t * );
  76
  77 /*****************************************************************************
  78  * Module descriptor
  79  *****************************************************************************/
  80 #define FORMAT_TEXT N_("Output format")
  81 #define FORMAT_LONGTEXT N_("One of \"u8\", \"s8\", \"u16\", \"s16\", " \
  82     "\"u16_le\", \"s16_le\", \"u16_be\", \"s16_be\", \"fixed32\", " \
  83     "\"float32\" or \"spdif\"")
  84
  85 #define CHANNELS_TEXT N_("Number of output channels")
  86 #define CHANNELS_LONGTEXT N_("By default (0), 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_savefile( "audiofile-file", "audiofile.wav", FILE_TEXT,
 117                   FILE_LONGTEXT, false )
 118     add_string( "audiofile-format", "s16",
 119                 FORMAT_TEXT, FORMAT_LONGTEXT, true )
 120         change_string_list( format_list, 0, 0 )
 121     add_integer( "audiofile-channels", 0,
 122                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
 123         change_integer_range( 0, 6 )
 124     add_bool( "audiofile-wav", true, WAV_TEXT, WAV_LONGTEXT, true )
 125
 126     set_capability( "audio output", 0 )
 127     add_shortcut( "file", "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     audio_output_t * p_aout = (audio_output_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->sys = malloc( sizeof( aout_sys_t ) );
 151     if( p_aout->sys == NULL )
 152         return VLC_ENOMEM;
 153
 154     if( !strcmp( psz_name, "-" ) )
 155         p_aout->sys->p_file = stdout;
 156     else
 157         p_aout->sys->p_file = vlc_fopen( psz_name, "wb" );
 158
 159     free( psz_name );
 160     if ( p_aout->sys->p_file == NULL )
 161     {
 162         free( p_aout->sys );
 163         return VLC_EGENERIC;
 164     }
 165
 166     p_aout->pf_play = Play;
 167     p_aout->pf_pause = NULL;
 168     p_aout->pf_flush = NULL;
 169
 170     /* Audio format */
 171     psz_format = var_CreateGetString( p_this, "audiofile-format" );
 172
 173     while ( *ppsz_compare != NULL )
 174     {
 175         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
 176         {
 177             break;
 178         }
 179         ppsz_compare++; i++;
 180     }
 181
 182     if ( *ppsz_compare == NULL )
 183     {
 184         msg_Err( p_aout, "cannot understand the format string (%s)",
 185                  psz_format );
 186         if( p_aout->sys->p_file != stdout )
 187             fclose( p_aout->sys->p_file );
 188         free( p_aout->sys );
 189         free( psz_format );
 190         return VLC_EGENERIC;
 191     }
 192     free( psz_format );
 193
 194     p_aout->format.i_format = format_int[i];
 195     if ( AOUT_FMT_SPDIF( &p_aout->format ) )
 196     {
 197         p_aout->format.i_bytes_per_frame = AOUT_SPDIF_SIZE;
 198         p_aout->format.i_frame_length = A52_FRAME_NB;
 199         aout_VolumeNoneInit( p_aout );
 200     }
 201     else
 202         aout_VolumeSoftInit( p_aout );
 203
 204     /* Channels number */
 205     i_channels = var_CreateGetInteger( p_this, "audiofile-channels" );
 206
 207     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
 208     {
 209         p_aout->format.i_physical_channels =
 210             pi_channels_maps[i_channels];
 211     }
 212
 213     /* WAV header */
 214     p_aout->sys->b_add_wav_header = var_CreateGetBool( p_this,
 215                                                         "audiofile-wav" );
 216
 217     if( p_aout->sys->b_add_wav_header )
 218     {
 219         /* Write wave header */
 220         WAVEHEADER *wh = &p_aout->sys->waveh;
 221
 222         memset( wh, 0, sizeof(*wh) );
 223
 224         switch( p_aout->format.i_format )
 225         {
 226         case VLC_CODEC_FL32:
 227             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
 228             wh->BitsPerSample = sizeof(float) * 8;
 229             break;
 230         case VLC_CODEC_U8:
 231             wh->Format     = WAVE_FORMAT_PCM;
 232             wh->BitsPerSample = 8;
 233             break;
 234         case VLC_CODEC_S16L:
 235         default:
 236             wh->Format     = WAVE_FORMAT_PCM;
 237             wh->BitsPerSample = 16;
 238             break;
 239         }
 240
 241         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 242         wh->Length = 0;                    /* temp, to be filled in as we go */
 243         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 244         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 245         wh->SubChunkLength = 16;
 246
 247         wh->Modus = aout_FormatNbChannels( &p_aout->format );
 248         wh->SampleFreq = p_aout->format.i_rate;
 249         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
 250         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
 251
 252         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 253         wh->DataLength = 0;                /* temp, to be filled in as we go */
 254
 255         /* Header -> little endian format */
 256         SetWLE( &wh->Format, wh->Format );
 257         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
 258         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
 259         SetWLE( &wh->Modus, wh->Modus );
 260         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
 261         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
 262         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
 263
 264         if( fwrite( wh, sizeof(WAVEHEADER), 1,
 265                     p_aout->sys->p_file ) != 1 )
 266         {
 267             msg_Err( p_aout, "write error (%m)" );
 268         }
 269     }
 270
 271     return 0;
 272 }
 273
 274 /*****************************************************************************
 275  * Close: close our file
 276  *****************************************************************************/
 277 static void Close( vlc_object_t * p_this )
 278 {
 279     audio_output_t * p_aout = (audio_output_t *)p_this;
 280
 281     msg_Dbg( p_aout, "closing audio file" );
 282
 283     if( p_aout->sys->b_add_wav_header )
 284     {
 285         /* Update Wave Header */
 286         p_aout->sys->waveh.Length =
 287             p_aout->sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
 288
 289         /* Write Wave Header */
 290         if( fseek( p_aout->sys->p_file, 0, SEEK_SET ) )
 291         {
 292             msg_Err( p_aout, "seek error (%m)" );
 293         }
 294
 295         /* Header -> little endian format */
 296         SetDWLE( &p_aout->sys->waveh.Length,
 297                  p_aout->sys->waveh.Length );
 298         SetDWLE( &p_aout->sys->waveh.DataLength,
 299                  p_aout->sys->waveh.DataLength );
 300
 301         if( fwrite( &p_aout->sys->waveh, sizeof(WAVEHEADER), 1,
 302                     p_aout->sys->p_file ) != 1 )
 303         {
 304             msg_Err( p_aout, "write error (%m)" );
 305         }
 306     }
 307
 308     if( p_aout->sys->p_file != stdout )
 309         fclose( p_aout->sys->p_file );
 310     free( p_aout->sys );
 311 }
 312
 313 /*****************************************************************************
 314  * Play: pretend to play a sound
 315  *****************************************************************************/
 316 static void Play( audio_output_t * p_aout, block_t *p_buffer )
 317 {
 318     if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
 319                 p_aout->sys->p_file ) != 1 )
 320     {
 321         msg_Err( p_aout, "write error (%m)" );
 322     }
 323
 324     if( p_aout->sys->b_add_wav_header )
 325     {
 326         /* Update Wave Header */
 327         p_aout->sys->waveh.DataLength += p_buffer->i_buffer;
 328     }
 329
 330     aout_BufferFree( p_buffer );
 331 }