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
  82 #define CHANNELS_TEXT N_("Number of output channels")
  83 #define CHANNELS_LONGTEXT N_("By default (0), all the channels of the incoming " \
  84     "will be saved but you can restrict the number of channels here.")
  85
  86 #define WAV_TEXT N_("Add WAVE header")
  87 #define WAV_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
  88                         "header to the file.")
  89
  90 static const char *const format_list[] = { "u8", "s8", "u16", "s16", "u16_le",
  91                                      "s16_le", "u16_be", "s16_be",
  92                                      "float32", "spdif" };
  93 static const int format_int[] = { VLC_CODEC_U8,
  94                                   VLC_CODEC_S8,
  95                                   VLC_CODEC_U16N, VLC_CODEC_S16N,
  96                                   VLC_CODEC_U16L,
  97                                   VLC_CODEC_S16L,
  98                                   VLC_CODEC_U16B,
  99                                   VLC_CODEC_S16B,
 100                                   VLC_CODEC_FL32,
 101                                   VLC_CODEC_SPDIFL };
 102
 103 #define FILE_TEXT N_("Output file")
 104 #define FILE_LONGTEXT N_("File to which the audio samples will be written to. (\"-\" for stdout")
 105
 106 vlc_module_begin ()
 107     set_description( N_("File audio output") )
 108     set_shortname( N_("File") )
 109     set_category( CAT_AUDIO )
 110     set_subcategory( SUBCAT_AUDIO_AOUT )
 111
 112     add_savefile( "audiofile-file", "audiofile.wav", FILE_TEXT,
 113                   FILE_LONGTEXT, false )
 114     add_string( "audiofile-format", "s16",
 115                 FORMAT_TEXT, FORMAT_TEXT, true )
 116         change_string_list( format_list, 0, 0 )
 117     add_integer( "audiofile-channels", 0,
 118                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
 119         change_integer_range( 0, 6 )
 120     add_bool( "audiofile-wav", true, WAV_TEXT, WAV_LONGTEXT, true )
 121
 122     set_capability( "audio output", 0 )
 123     add_shortcut( "file", "audiofile" )
 124     set_callbacks( Open, Close )
 125 vlc_module_end ()
 126
 127 /*****************************************************************************
 128  * Open: open a dummy audio device
 129  *****************************************************************************/
 130 static int Open( vlc_object_t * p_this )
 131 {
 132     audio_output_t * p_aout = (audio_output_t *)p_this;
 133     char * psz_name, * psz_format;
 134     const char * const * ppsz_compare = format_list;
 135     int i_channels, i = 0;
 136
 137     psz_name = var_CreateGetString( p_this, "audiofile-file" );
 138     if( !psz_name || !*psz_name )
 139     {
 140         msg_Err( p_aout, "you need to specify an output file name" );
 141         free( psz_name );
 142         return VLC_EGENERIC;
 143     }
 144
 145     /* Allocate structure */
 146     p_aout->sys = malloc( sizeof( aout_sys_t ) );
 147     if( p_aout->sys == NULL )
 148         return VLC_ENOMEM;
 149
 150     if( !strcmp( psz_name, "-" ) )
 151         p_aout->sys->p_file = stdout;
 152     else
 153         p_aout->sys->p_file = vlc_fopen( psz_name, "wb" );
 154
 155     free( psz_name );
 156     if ( p_aout->sys->p_file == NULL )
 157     {
 158         free( p_aout->sys );
 159         return VLC_EGENERIC;
 160     }
 161
 162     p_aout->pf_play = Play;
 163     p_aout->pf_pause = NULL;
 164     p_aout->pf_flush = NULL;
 165
 166     /* Audio format */
 167     psz_format = var_CreateGetString( p_this, "audiofile-format" );
 168
 169     while ( *ppsz_compare != NULL )
 170     {
 171         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
 172         {
 173             break;
 174         }
 175         ppsz_compare++; i++;
 176     }
 177
 178     if ( *ppsz_compare == NULL )
 179     {
 180         msg_Err( p_aout, "cannot understand the format string (%s)",
 181                  psz_format );
 182         if( p_aout->sys->p_file != stdout )
 183             fclose( p_aout->sys->p_file );
 184         free( p_aout->sys );
 185         free( psz_format );
 186         return VLC_EGENERIC;
 187     }
 188     free( psz_format );
 189
 190     p_aout->format.i_format = format_int[i];
 191     if ( AOUT_FMT_SPDIF( &p_aout->format ) )
 192     {
 193         p_aout->format.i_bytes_per_frame = AOUT_SPDIF_SIZE;
 194         p_aout->format.i_frame_length = A52_FRAME_NB;
 195     }
 196     p_aout->volume_set = NULL;
 197     p_aout->mute_set = NULL;
 198
 199     /* Channels number */
 200     i_channels = var_CreateGetInteger( p_this, "audiofile-channels" );
 201
 202     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
 203     {
 204         p_aout->format.i_physical_channels =
 205             pi_channels_maps[i_channels];
 206     }
 207
 208     /* WAV header */
 209     p_aout->sys->b_add_wav_header = var_CreateGetBool( p_this,
 210                                                         "audiofile-wav" );
 211
 212     if( p_aout->sys->b_add_wav_header )
 213     {
 214         /* Write wave header */
 215         WAVEHEADER *wh = &p_aout->sys->waveh;
 216
 217         memset( wh, 0, sizeof(*wh) );
 218
 219         switch( p_aout->format.i_format )
 220         {
 221         case VLC_CODEC_FL32:
 222             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
 223             wh->BitsPerSample = sizeof(float) * 8;
 224             break;
 225         case VLC_CODEC_U8:
 226             wh->Format     = WAVE_FORMAT_PCM;
 227             wh->BitsPerSample = 8;
 228             break;
 229         case VLC_CODEC_S16L:
 230         default:
 231             wh->Format     = WAVE_FORMAT_PCM;
 232             wh->BitsPerSample = 16;
 233             break;
 234         }
 235
 236         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 237         wh->Length = 0;                    /* temp, to be filled in as we go */
 238         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 239         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 240         wh->SubChunkLength = 16;
 241
 242         wh->Modus = aout_FormatNbChannels( &p_aout->format );
 243         wh->SampleFreq = p_aout->format.i_rate;
 244         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
 245         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
 246
 247         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 248         wh->DataLength = 0;                /* temp, to be filled in as we go */
 249
 250         /* Header -> little endian format */
 251         SetWLE( &wh->Format, wh->Format );
 252         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
 253         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
 254         SetWLE( &wh->Modus, wh->Modus );
 255         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
 256         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
 257         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
 258
 259         if( fwrite( wh, sizeof(WAVEHEADER), 1,
 260                     p_aout->sys->p_file ) != 1 )
 261         {
 262             msg_Err( p_aout, "write error (%m)" );
 263         }
 264     }
 265
 266     return 0;
 267 }
 268
 269 /*****************************************************************************
 270  * Close: close our file
 271  *****************************************************************************/
 272 static void Close( vlc_object_t * p_this )
 273 {
 274     audio_output_t * p_aout = (audio_output_t *)p_this;
 275
 276     msg_Dbg( p_aout, "closing audio file" );
 277
 278     if( p_aout->sys->b_add_wav_header )
 279     {
 280         /* Update Wave Header */
 281         p_aout->sys->waveh.Length =
 282             p_aout->sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
 283
 284         /* Write Wave Header */
 285         if( fseek( p_aout->sys->p_file, 0, SEEK_SET ) )
 286         {
 287             msg_Err( p_aout, "seek error (%m)" );
 288         }
 289
 290         /* Header -> little endian format */
 291         SetDWLE( &p_aout->sys->waveh.Length,
 292                  p_aout->sys->waveh.Length );
 293         SetDWLE( &p_aout->sys->waveh.DataLength,
 294                  p_aout->sys->waveh.DataLength );
 295
 296         if( fwrite( &p_aout->sys->waveh, sizeof(WAVEHEADER), 1,
 297                     p_aout->sys->p_file ) != 1 )
 298         {
 299             msg_Err( p_aout, "write error (%m)" );
 300         }
 301     }
 302
 303     if( p_aout->sys->p_file != stdout )
 304         fclose( p_aout->sys->p_file );
 305     free( p_aout->sys );
 306 }
 307
 308 /*****************************************************************************
 309  * Play: pretend to play a sound
 310  *****************************************************************************/
 311 static void Play( audio_output_t * p_aout, block_t *p_buffer )
 312 {
 313     if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
 314                 p_aout->sys->p_file ) != 1 )
 315     {
 316         msg_Err( p_aout, "write error (%m)" );
 317     }
 318
 319     if( p_aout->sys->b_add_wav_header )
 320     {
 321         /* Update Wave Header */
 322         p_aout->sys->waveh.DataLength += p_buffer->i_buffer;
 323     }
 324
 325     block_Release( p_buffer );
 326 }