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 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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    Play        ( audio_output_t *, block_t * );
  75 static void    Flush       ( audio_output_t *, bool );
  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[] = {
  91     "u8", "s16",
  92 #ifndef WORDS_BIGENDIAN
  93     "float32",
  94 #endif
  95     "spdif",
  96 };
  97 static const int format_int[] = {
  98     VLC_CODEC_U8, VLC_CODEC_S16N,
  99 #ifndef WORDS_BIGENDIAN
 100     VLC_CODEC_FL32,
 101 #endif
 102     VLC_CODEC_SPDIFL,
 103 };
 104
 105 #define FILE_TEXT N_("Output file")
 106 #define FILE_LONGTEXT N_("File to which the audio samples will be written to. (\"-\" for stdout")
 107
 108 vlc_module_begin ()
 109     set_description( N_("File audio output") )
 110     set_shortname( N_("File") )
 111     set_category( CAT_AUDIO )
 112     set_subcategory( SUBCAT_AUDIO_AOUT )
 113
 114     add_savefile( "audiofile-file", "audiofile.wav", FILE_TEXT,
 115                   FILE_LONGTEXT, false )
 116     add_string( "audiofile-format", "s16",
 117                 FORMAT_TEXT, FORMAT_TEXT, true )
 118         change_string_list( format_list, format_list )
 119     add_integer( "audiofile-channels", 0,
 120                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
 121         change_integer_range( 0, 6 )
 122     add_bool( "audiofile-wav", true, WAV_TEXT, WAV_LONGTEXT, true )
 123
 124     set_capability( "audio output", 0 )
 125     add_shortcut( "file", "audiofile" )
 126     set_callbacks( Open, NULL )
 127 vlc_module_end ()
 128
 129 static int Start( audio_output_t *p_aout, audio_sample_format_t *restrict fmt )
 130 {
 131     char * psz_name, * psz_format;
 132     const char * const * ppsz_compare = format_list;
 133     int i_channels, i = 0;
 134
 135     psz_name = var_InheritString( p_aout, "audiofile-file" );
 136     if( !psz_name )
 137     {
 138         msg_Err( p_aout, "you need to specify an output file name" );
 139         free( psz_name );
 140         return VLC_EGENERIC;
 141     }
 142
 143     /* Allocate structure */
 144     p_aout->sys = malloc( sizeof( aout_sys_t ) );
 145     if( p_aout->sys == NULL )
 146         return VLC_ENOMEM;
 147
 148     if( !strcmp( psz_name, "-" ) )
 149         p_aout->sys->p_file = stdout;
 150     else
 151         p_aout->sys->p_file = vlc_fopen( psz_name, "wb" );
 152
 153     free( psz_name );
 154     if ( p_aout->sys->p_file == NULL )
 155     {
 156         free( p_aout->sys );
 157         return VLC_EGENERIC;
 158     }
 159
 160     p_aout->time_get = NULL;
 161     p_aout->play = Play;
 162     p_aout->pause = NULL;
 163     p_aout->flush = Flush;
 164
 165     /* Audio format */
 166     psz_format = var_InheritString( p_aout, "audiofile-format" );
 167     if ( !psz_format ) abort(); /* FIXME */
 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     fmt->i_format = format_int[i];
 191     if ( AOUT_FMT_SPDIF( fmt ) )
 192     {
 193         fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
 194         fmt->i_frame_length = A52_FRAME_NB;
 195     }
 196
 197     /* Channels number */
 198     i_channels = var_InheritInteger( p_aout, "audiofile-channels" );
 199     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
 200     {
 201         fmt->i_physical_channels = pi_channels_maps[i_channels];
 202     }
 203
 204     /* WAV header */
 205     p_aout->sys->b_add_wav_header = var_InheritBool( p_aout, "audiofile-wav" );
 206     if( p_aout->sys->b_add_wav_header )
 207     {
 208         /* Write wave header */
 209         WAVEHEADER *wh = &p_aout->sys->waveh;
 210
 211         memset( wh, 0, sizeof(*wh) );
 212
 213         switch( fmt->i_format )
 214         {
 215 #ifndef WORDS_BIGENDIAN
 216         case VLC_CODEC_FL32:
 217             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
 218             wh->BitsPerSample = sizeof(float) * 8;
 219             break;
 220 #endif
 221         case VLC_CODEC_U8:
 222             wh->Format     = WAVE_FORMAT_PCM;
 223             wh->BitsPerSample = 8;
 224             break;
 225         default:
 226             wh->Format     = WAVE_FORMAT_PCM;
 227             wh->BitsPerSample = 16;
 228             break;
 229         }
 230
 231         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 232         wh->Length = 0;                    /* temp, to be filled in as we go */
 233         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 234         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 235         wh->SubChunkLength = 16;
 236
 237         wh->Modus = aout_FormatNbChannels( fmt );
 238         wh->SampleFreq = fmt->i_rate;
 239         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
 240         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
 241
 242         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 243         wh->DataLength = 0;                /* temp, to be filled in as we go */
 244
 245         /* Header -> little endian format */
 246         SetWLE( &wh->Format, wh->Format );
 247         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
 248         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
 249         SetWLE( &wh->Modus, wh->Modus );
 250         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
 251         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
 252         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
 253
 254         if( fwrite( wh, sizeof(WAVEHEADER), 1,
 255                     p_aout->sys->p_file ) != 1 )
 256         {
 257             msg_Err( p_aout, "write error (%m)" );
 258         }
 259     }
 260
 261     return 0;
 262 }
 263
 264 /*****************************************************************************
 265  * Close: close our file
 266  *****************************************************************************/
 267 static void Stop( audio_output_t *p_aout )
 268 {
 269     msg_Dbg( p_aout, "closing audio file" );
 270
 271     if( p_aout->sys->b_add_wav_header )
 272     {
 273         /* Update Wave Header */
 274         p_aout->sys->waveh.Length =
 275             p_aout->sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
 276
 277         /* Write Wave Header */
 278         if( fseek( p_aout->sys->p_file, 0, SEEK_SET ) )
 279         {
 280             msg_Err( p_aout, "seek error (%m)" );
 281         }
 282
 283         /* Header -> little endian format */
 284         SetDWLE( &p_aout->sys->waveh.Length,
 285                  p_aout->sys->waveh.Length );
 286         SetDWLE( &p_aout->sys->waveh.DataLength,
 287                  p_aout->sys->waveh.DataLength );
 288
 289         if( fwrite( &p_aout->sys->waveh, sizeof(WAVEHEADER), 1,
 290                     p_aout->sys->p_file ) != 1 )
 291         {
 292             msg_Err( p_aout, "write error (%m)" );
 293         }
 294     }
 295
 296     if( p_aout->sys->p_file != stdout )
 297         fclose( p_aout->sys->p_file );
 298     free( p_aout->sys );
 299 }
 300
 301 /*****************************************************************************
 302  * Play: pretend to play a sound
 303  *****************************************************************************/
 304 static void Play( audio_output_t * p_aout, block_t *p_buffer )
 305 {
 306     if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
 307                 p_aout->sys->p_file ) != 1 )
 308     {
 309         msg_Err( p_aout, "write error (%m)" );
 310     }
 311
 312     if( p_aout->sys->b_add_wav_header )
 313     {
 314         /* Update Wave Header */
 315         p_aout->sys->waveh.DataLength += p_buffer->i_buffer;
 316     }
 317
 318     block_Release( p_buffer );
 319 }
 320
 321 static void Flush( audio_output_t *aout, bool wait )
 322 {
 323     if( fflush( aout->sys->p_file ) )
 324         msg_Err( aout, "flush error (%m)" );
 325     (void) wait;
 326 }
 327
 328 static int Open(vlc_object_t *obj)
 329 {
 330     audio_output_t *aout = (audio_output_t *)obj;
 331
 332     aout->start = Start;
 333     aout->stop = Stop;
 334     aout->volume_set = NULL;
 335     aout->mute_set = NULL;
 336     return VLC_SUCCESS;
 337 }