/*****************************************************************************
* file.c : audio output which writes the samples to a file
*****************************************************************************
- * Copyright (C) 2002 VideoLAN
+ * Copyright (C) 2002 VLC authors and VideoLAN
* $Id$
*
* Authors: Christophe Massiot <massiot@via.ecp.fr>
* Gildas Bazin <gbazin@netcourrier.com>
*
- * 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
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* 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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser 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
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <string.h>
-#include <stdlib.h>
-#include <errno.h>
-#include <vlc/vlc.h>
-#include <vlc/aout.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "aout_internal.h"
-#include "codecs.h"
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_aout.h>
+#include <vlc_codecs.h> /* WAVEHEADER */
+#include <vlc_fs.h>
-#define FRAME_SIZE 2048
#define A52_FRAME_NB 1536
/*****************************************************************************
struct aout_sys_t
{
FILE * p_file;
- vlc_bool_t b_add_wav_header;
+ bool b_add_wav_header;
WAVEHEADER waveh; /* Wave header of the output file */
};
#define CHANNELS_MAX 6
-static int pi_channels_maps[CHANNELS_MAX+1] =
+static const int pi_channels_maps[CHANNELS_MAX+1] =
{
0,
AOUT_CHAN_CENTER,
* Local prototypes.
*****************************************************************************/
static int Open ( vlc_object_t * );
-static void Close ( vlc_object_t * );
-static void Play ( aout_instance_t * );
+static void Play ( audio_output_t *, block_t * );
+static void Flush ( audio_output_t *, bool );
/*****************************************************************************
* Module descriptor
*****************************************************************************/
#define FORMAT_TEXT N_("Output format")
-#define FORMAT_LONGTEXT N_("One of \"u8\", \"s8\", \"u16\", \"s16\", " \
- "\"u16_le\", \"s16_le\", \"u16_be\", \"s16_be\", \"fixed32\", " \
- "\"float32\" or \"spdif\"")
-#define CHANNELS_TEXT N_("Output channels number")
-#define CHANNELS_LONGTEXT N_("By default, all the channels of the incoming " \
+
+#define CHANNELS_TEXT N_("Number of output channels")
+#define CHANNELS_LONGTEXT N_("By default (0), all the channels of the incoming " \
"will be saved but you can restrict the number of channels here.")
-#define WAV_TEXT N_("Add wave header")
+#define WAV_TEXT N_("Add WAVE header")
#define WAV_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
- "header to the file")
-
-static char *format_list[] = { "u8", "s8", "u16", "s16", "u16_le", "s16_le",
- "u16_be", "s16_be", "fixed32", "float32",
- "spdif" };
-static int format_int[] = { VLC_FOURCC('u','8',' ',' '),
- VLC_FOURCC('s','8',' ',' '),
- AOUT_FMT_U16_NE, AOUT_FMT_S16_NE,
- VLC_FOURCC('u','1','6','l'),
- VLC_FOURCC('s','1','6','l'),
- VLC_FOURCC('u','1','6','b'),
- VLC_FOURCC('s','1','6','b'),
- VLC_FOURCC('f','i','3','2'),
- VLC_FOURCC('f','l','3','2'),
- VLC_FOURCC('s','p','i','f') };
+ "header to the file.")
+
+static const char *const format_list[] = {
+ "u8", "s16",
+#ifndef WORDS_BIGENDIAN
+ "float32",
+#endif
+ "spdif",
+};
+static const int format_int[] = {
+ VLC_CODEC_U8, VLC_CODEC_S16N,
+#ifndef WORDS_BIGENDIAN
+ VLC_CODEC_FL32,
+#endif
+ VLC_CODEC_SPDIFL,
+};
#define FILE_TEXT N_("Output file")
-#define FILE_LONGTEXT N_("File to which the audio samples will be written to")
-
-vlc_module_begin();
- set_description( N_("File audio output") );
-
- add_string( "audiofile-format", "s16", NULL,
- FORMAT_TEXT, FORMAT_LONGTEXT, VLC_TRUE );
- change_string_list( format_list, 0, 0 );
- add_integer( "audiofile-channels", 0, NULL,
- CHANNELS_TEXT, CHANNELS_LONGTEXT, VLC_TRUE );
- add_file( "audiofile-file", "audiofile.wav", NULL, FILE_TEXT,
- FILE_LONGTEXT, VLC_FALSE );
- add_bool( "audiofile-wav", 1, NULL, WAV_TEXT, WAV_LONGTEXT, VLC_TRUE );
-
- set_capability( "audio output", 0 );
- add_shortcut( "file" );
- add_shortcut( "audiofile" );
- set_callbacks( Open, Close );
-vlc_module_end();
-
-/*****************************************************************************
- * Open: open a dummy audio device
- *****************************************************************************/
-static int Open( vlc_object_t * p_this )
+#define FILE_LONGTEXT N_("File to which the audio samples will be written to. (\"-\" for stdout")
+
+vlc_module_begin ()
+ set_description( N_("File audio output") )
+ set_shortname( N_("File") )
+ set_category( CAT_AUDIO )
+ set_subcategory( SUBCAT_AUDIO_AOUT )
+
+ add_savefile( "audiofile-file", "audiofile.wav", FILE_TEXT,
+ FILE_LONGTEXT, false )
+ add_string( "audiofile-format", "s16",
+ FORMAT_TEXT, FORMAT_TEXT, true )
+ change_string_list( format_list, format_list )
+ add_integer( "audiofile-channels", 0,
+ CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
+ change_integer_range( 0, 6 )
+ add_bool( "audiofile-wav", true, WAV_TEXT, WAV_LONGTEXT, true )
+
+ set_capability( "audio output", 0 )
+ add_shortcut( "file", "audiofile" )
+ set_callbacks( Open, NULL )
+vlc_module_end ()
+
+static int Start( audio_output_t *p_aout, audio_sample_format_t *restrict fmt )
{
- aout_instance_t * p_aout = (aout_instance_t *)p_this;
char * psz_name, * psz_format;
- char ** ppsz_compare = format_list;
- vlc_value_t val;
+ const char * const * ppsz_compare = format_list;
int i_channels, i = 0;
- var_Create( p_this, "audiofile-file", VLC_VAR_STRING|VLC_VAR_DOINHERIT );
- var_Get( p_this, "audiofile-file", &val );
- psz_name = val.psz_string;
- if( !psz_name || !*psz_name )
+ psz_name = var_InheritString( p_aout, "audiofile-file" );
+ if( !psz_name )
{
msg_Err( p_aout, "you need to specify an output file name" );
- if( psz_name ) free( psz_name );
+ free( psz_name );
return VLC_EGENERIC;
}
/* Allocate structure */
- p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
- if( p_aout->output.p_sys == NULL )
- {
- msg_Err( p_aout, "out of memory" );
- return VLC_EGENERIC;
- }
+ p_aout->sys = malloc( sizeof( aout_sys_t ) );
+ if( p_aout->sys == NULL )
+ return VLC_ENOMEM;
+
+ if( !strcmp( psz_name, "-" ) )
+ p_aout->sys->p_file = stdout;
+ else
+ p_aout->sys->p_file = vlc_fopen( psz_name, "wb" );
- p_aout->output.p_sys->p_file = fopen( psz_name, "wb" );
free( psz_name );
- if ( p_aout->output.p_sys->p_file == NULL )
+ if ( p_aout->sys->p_file == NULL )
{
- free( p_aout->output.p_sys );
+ free( p_aout->sys );
return VLC_EGENERIC;
}
- p_aout->output.pf_play = Play;
+ p_aout->time_get = NULL;
+ p_aout->play = Play;
+ p_aout->pause = NULL;
+ p_aout->flush = Flush;
/* Audio format */
- var_Create( p_this, "audiofile-format", VLC_VAR_STRING|VLC_VAR_DOINHERIT );
- var_Get( p_this, "audiofile-format", &val );
- psz_format = val.psz_string;
+ psz_format = var_InheritString( p_aout, "audiofile-format" );
+ if ( !psz_format ) abort(); /* FIXME */
while ( *ppsz_compare != NULL )
{
{
msg_Err( p_aout, "cannot understand the format string (%s)",
psz_format );
- fclose( p_aout->output.p_sys->p_file );
- free( p_aout->output.p_sys );
+ if( p_aout->sys->p_file != stdout )
+ fclose( p_aout->sys->p_file );
+ free( p_aout->sys );
+ free( psz_format );
return VLC_EGENERIC;
}
+ free( psz_format );
- p_aout->output.output.i_format = format_int[i];
- if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
- {
- p_aout->output.i_nb_samples = A52_FRAME_NB;
- p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
- p_aout->output.output.i_frame_length = A52_FRAME_NB;
- aout_VolumeNoneInit( p_aout );
- }
- else
+ fmt->i_format = format_int[i];
+ if ( AOUT_FMT_SPDIF( fmt ) )
{
- p_aout->output.i_nb_samples = FRAME_SIZE;
- aout_VolumeSoftInit( p_aout );
+ fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
+ fmt->i_frame_length = A52_FRAME_NB;
}
/* Channels number */
- var_Create( p_this, "audiofile-channels",
- VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
- var_Get( p_this, "audiofile-channels", &val );
- i_channels = val.i_int;
-
+ i_channels = var_InheritInteger( p_aout, "audiofile-channels" );
if( i_channels > 0 && i_channels <= CHANNELS_MAX )
{
- p_aout->output.output.i_physical_channels =
- pi_channels_maps[i_channels];
+ fmt->i_physical_channels = pi_channels_maps[i_channels];
}
/* WAV header */
- var_Create( p_this, "audiofile-wav", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
- var_Get( p_this, "audiofile-wav", &val );
- p_aout->output.p_sys->b_add_wav_header = val.b_bool;
-
- if( p_aout->output.p_sys->b_add_wav_header )
+ p_aout->sys->b_add_wav_header = var_InheritBool( p_aout, "audiofile-wav" );
+ if( p_aout->sys->b_add_wav_header )
{
/* Write wave header */
- WAVEHEADER *wh = &p_aout->output.p_sys->waveh;
+ WAVEHEADER *wh = &p_aout->sys->waveh;
- memset( wh, 0, sizeof(wh) );
+ memset( wh, 0, sizeof(*wh) );
- switch( p_aout->output.output.i_format )
+ switch( fmt->i_format )
{
- case VLC_FOURCC('f','l','3','2'):
+#ifndef WORDS_BIGENDIAN
+ case VLC_CODEC_FL32:
wh->Format = WAVE_FORMAT_IEEE_FLOAT;
wh->BitsPerSample = sizeof(float) * 8;
break;
- case VLC_FOURCC('u','8',' ',' '):
+#endif
+ case VLC_CODEC_U8:
wh->Format = WAVE_FORMAT_PCM;
wh->BitsPerSample = 8;
break;
- case VLC_FOURCC('s','1','6','l'):
default:
wh->Format = WAVE_FORMAT_PCM;
wh->BitsPerSample = 16;
wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
wh->SubChunkLength = 16;
- wh->Modus = aout_FormatNbChannels( &p_aout->output.output );
- wh->SampleFreq = p_aout->output.output.i_rate;
+ wh->Modus = aout_FormatNbChannels( fmt );
+ wh->SampleFreq = fmt->i_rate;
wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
if( fwrite( wh, sizeof(WAVEHEADER), 1,
- p_aout->output.p_sys->p_file ) != 1 )
+ p_aout->sys->p_file ) != 1 )
{
- msg_Err( p_aout, "write error (%s)", strerror(errno) );
+ msg_Err( p_aout, "write error (%m)" );
}
}
/*****************************************************************************
* Close: close our file
*****************************************************************************/
-static void Close( vlc_object_t * p_this )
+static void Stop( audio_output_t *p_aout )
{
- aout_instance_t * p_aout = (aout_instance_t *)p_this;
-
msg_Dbg( p_aout, "closing audio file" );
- if( p_aout->output.p_sys->b_add_wav_header )
+ if( p_aout->sys->b_add_wav_header )
{
/* Update Wave Header */
- p_aout->output.p_sys->waveh.Length =
- p_aout->output.p_sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
+ p_aout->sys->waveh.Length =
+ p_aout->sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
/* Write Wave Header */
- if( fseek( p_aout->output.p_sys->p_file, 0, SEEK_SET ) )
+ if( fseek( p_aout->sys->p_file, 0, SEEK_SET ) )
{
- msg_Err( p_aout, "seek error (%s)", strerror(errno) );
+ msg_Err( p_aout, "seek error (%m)" );
}
/* Header -> little endian format */
- SetDWLE( &p_aout->output.p_sys->waveh.Length,
- p_aout->output.p_sys->waveh.Length );
- SetDWLE( &p_aout->output.p_sys->waveh.DataLength,
- p_aout->output.p_sys->waveh.DataLength );
+ SetDWLE( &p_aout->sys->waveh.Length,
+ p_aout->sys->waveh.Length );
+ SetDWLE( &p_aout->sys->waveh.DataLength,
+ p_aout->sys->waveh.DataLength );
- if( fwrite( &p_aout->output.p_sys->waveh, sizeof(WAVEHEADER), 1,
- p_aout->output.p_sys->p_file ) != 1 )
+ if( fwrite( &p_aout->sys->waveh, sizeof(WAVEHEADER), 1,
+ p_aout->sys->p_file ) != 1 )
{
- msg_Err( p_aout, "write error (%s)", strerror(errno) );
+ msg_Err( p_aout, "write error (%m)" );
}
}
- fclose( p_aout->output.p_sys->p_file );
- free( p_aout->output.p_sys );
+ if( p_aout->sys->p_file != stdout )
+ fclose( p_aout->sys->p_file );
+ free( p_aout->sys );
}
/*****************************************************************************
* Play: pretend to play a sound
*****************************************************************************/
-static void Play( aout_instance_t * p_aout )
+static void Play( audio_output_t * p_aout, block_t *p_buffer )
{
- aout_buffer_t * p_buffer;
-
- p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
-
- if( fwrite( p_buffer->p_buffer, p_buffer->i_nb_bytes, 1,
- p_aout->output.p_sys->p_file ) != 1 )
+ if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
+ p_aout->sys->p_file ) != 1 )
{
- msg_Err( p_aout, "write error (%s)", strerror(errno) );
+ msg_Err( p_aout, "write error (%m)" );
}
- if( p_aout->output.p_sys->b_add_wav_header )
+ if( p_aout->sys->b_add_wav_header )
{
/* Update Wave Header */
- p_aout->output.p_sys->waveh.DataLength += p_buffer->i_nb_bytes;
+ p_aout->sys->waveh.DataLength += p_buffer->i_buffer;
}
- aout_BufferFree( p_buffer );
+ block_Release( p_buffer );
+}
+
+static void Flush( audio_output_t *aout, bool wait )
+{
+ if( fflush( aout->sys->p_file ) )
+ msg_Err( aout, "flush error (%m)" );
+ (void) wait;
+}
+
+static int Open(vlc_object_t *obj)
+{
+ audio_output_t *aout = (audio_output_t *)obj;
+
+ aout->start = Start;
+ aout->stop = Stop;
+ aout->volume_set = NULL;
+ aout->mute_set = NULL;
+ return VLC_SUCCESS;
}