]> git.sesse.net Git - vlc/blobdiff - modules/audio_output/file.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / modules / audio_output / file.c
index 63e72093d5e2f4e3aa03ea00045dd479f6b7f94b..32f34384d86d6e6a7b1064555f4f38539f54dbb2 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * file.c : audio output which writes the samples to a file
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: file.c,v 1.22 2003/05/15 22:27:37 massiot Exp $
+ * Copyright (C) 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *          Gildas Bazin <gbazin@netcourrier.com>
@@ -11,7 +11,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 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
  *
  * 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.
+ * 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
 
-typedef struct WAVEHEADER
-{
-    uint32_t MainChunkID;                      // it will be 'RIFF'
-    uint32_t Length;
-    uint32_t ChunkTypeID;                      // it will be 'WAVE'
-    uint32_t SubChunkID;                       // it will be 'fmt '
-    uint32_t SubChunkLength;
-    uint16_t Format;
-    uint16_t Modus;
-    uint32_t SampleFreq;
-    uint32_t BytesPerSec;
-    uint16_t BytesPerSample;
-    uint16_t BitsPerSample;
-    uint32_t DataChunkID;                      // it will be 'data'
-    uint32_t DataLength;
-} WAVEHEADER;
-
 /*****************************************************************************
  * aout_sys_t: audio output method descriptor
  *****************************************************************************
@@ -64,11 +48,26 @@ typedef struct WAVEHEADER
 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 const int pi_channels_maps[CHANNELS_MAX+1] =
+{
+    0,
+    AOUT_CHAN_CENTER,
+    AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
+    AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
+    AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
+     | AOUT_CHAN_REARRIGHT,
+    AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
+     | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT,
+    AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
+     | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE
+};
+
 /*****************************************************************************
  * Local prototypes.
  *****************************************************************************/
@@ -81,42 +80,52 @@ static void    Play        ( aout_instance_t * );
  *****************************************************************************/
 #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 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", NULL };
-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') };
+    "\"u16_le\", \"s16_le\", \"u16_be\", \"s16_be\", \"fixed32\", " \
+    "\"float32\" or \"spdif\"")
+#define CHANNELS_TEXT N_("Number of output channels")
+#define CHANNELS_LONGTEXT N_("By default, 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_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
+                        "header to the file.")
+
+static const char *const format_list[] = { "u8", "s8", "u16", "s16", "u16_le",
+                                     "s16_le", "u16_be", "s16_be", "fixed32",
+                                     "float32", "spdif" };
+static const int format_int[] = { VLC_CODEC_U8,
+                                  VLC_CODEC_S8,
+                                  VLC_CODEC_U16N, VLC_CODEC_S16N,
+                                  VLC_CODEC_U16L,
+                                  VLC_CODEC_S16L,
+                                  VLC_CODEC_U16B,
+                                  VLC_CODEC_S16B,
+                                  VLC_CODEC_FI32,
+                                  VLC_CODEC_FL32,
+                                  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();
-    add_category_hint( N_("Audio"), NULL, VLC_FALSE );
-    add_string_from_list( "audiofile-format", "s16", format_list, NULL,
-                          FORMAT_TEXT, FORMAT_LONGTEXT, VLC_TRUE );
-    add_file( "audiofile", "audiofile.wav", NULL, FILE_TEXT,
-              FILE_LONGTEXT, VLC_FALSE );
-    add_bool( "audiofile-wav", 1, NULL, WAV_TEXT, WAV_LONGTEXT, VLC_TRUE );
-    set_description( N_("file audio output") );
-    set_capability( "audio output", 0 );
-    add_shortcut( "file" );
-    add_shortcut( "audiofile" );
-    set_callbacks( Open, Close );
-vlc_module_end();
+#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_string( "audiofile-format", "s16", NULL,
+                FORMAT_TEXT, FORMAT_LONGTEXT, true )
+        change_string_list( format_list, 0, 0 )
+    add_integer( "audiofile-channels", 0, NULL,
+                 CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
+    add_file( "audiofile-file", "audiofile.wav", NULL, FILE_TEXT,
+              FILE_LONGTEXT, false )
+    add_bool( "audiofile-wav", true, NULL, WAV_TEXT, WAV_LONGTEXT, true )
+
+    set_capability( "audio output", 0 )
+    add_shortcut( "file", "audiofile" )
+    set_callbacks( Open, Close )
+vlc_module_end ()
 
 /*****************************************************************************
  * Open: open a dummy audio device
@@ -124,29 +133,40 @@ vlc_module_end();
 static int Open( vlc_object_t * p_this )
 {
     aout_instance_t * p_aout = (aout_instance_t *)p_this;
-    char * psz_name = config_GetPsz( p_this, "audiofile" );
-    char * psz_format = config_GetPsz( p_aout, "audiofile-format" );
-    char ** ppsz_compare = format_list;
-    int i = 0;
+    char * psz_name, * psz_format;
+    const char * const * ppsz_compare = format_list;
+    int i_channels, i = 0;
 
-   /* Allocate structure */
-    p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
-    if( p_aout->output.p_sys == NULL )
+    psz_name = var_CreateGetString( p_this, "audiofile-file" );
+    if( !psz_name || !*psz_name )
     {
-        msg_Err( p_aout, "out of memory" );
+        msg_Err( p_aout, "you need to specify an output file name" );
+        free( psz_name );
         return VLC_EGENERIC;
     }
 
-    p_aout->output.p_sys->p_file = fopen( psz_name, "wb" );
+    /* Allocate structure */
+    p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
+    if( p_aout->output.p_sys == NULL )
+        return VLC_ENOMEM;
+
+    if( !strcmp( psz_name, "-" ) )
+        p_aout->output.p_sys->p_file = stdout;
+    else
+        p_aout->output.p_sys->p_file = vlc_fopen( psz_name, "wb" );
+
     free( psz_name );
     if ( p_aout->output.p_sys->p_file == NULL )
     {
         free( p_aout->output.p_sys );
-        return -1;
+        return VLC_EGENERIC;
     }
 
     p_aout->output.pf_play = Play;
 
+    /* Audio format */
+    psz_format = var_CreateGetString( p_this, "audiofile-format" );
+
     while ( *ppsz_compare != NULL )
     {
         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
@@ -158,12 +178,15 @@ static int Open( vlc_object_t * p_this )
 
     if ( *ppsz_compare == NULL )
     {
-        msg_Err( p_aout, "Cannot understand the format string (%s)",
+        msg_Err( p_aout, "cannot understand the format string (%s)",
                  psz_format );
-        fclose( p_aout->output.p_sys->p_file );
+        if( p_aout->output.p_sys->p_file != stdout )
+            fclose( p_aout->output.p_sys->p_file );
         free( p_aout->output.p_sys );
-        return -1;
+        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 ) )
@@ -179,27 +202,37 @@ static int Open( vlc_object_t * p_this )
         aout_VolumeSoftInit( p_aout );
     }
 
-    p_aout->output.p_sys->b_add_wav_header =
-        config_GetInt( p_this, "audiofile-wav" );
+    /* Channels number */
+    i_channels = var_CreateGetInteger( p_this, "audiofile-channels" );
+
+    if( i_channels > 0 && i_channels <= CHANNELS_MAX )
+    {
+        p_aout->output.output.i_physical_channels =
+            pi_channels_maps[i_channels];
+    }
+
+    /* WAV header */
+    p_aout->output.p_sys->b_add_wav_header = var_CreateGetBool( p_this,
+                                                        "audiofile-wav" );
 
     if( p_aout->output.p_sys->b_add_wav_header )
     {
         /* Write wave header */
         WAVEHEADER *wh = &p_aout->output.p_sys->waveh;
 
-        memset( wh, 0, sizeof(wh) );
+        memset( wh, 0, sizeof(*wh) );
 
         switch( p_aout->output.output.i_format )
         {
-        case VLC_FOURCC('f','l','3','2'):
+        case VLC_CODEC_FL32:
             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
             wh->BitsPerSample = sizeof(float) * 8;
             break;
-        case VLC_FOURCC('u','8',' ',' '):
+        case VLC_CODEC_U8:
             wh->Format     = WAVE_FORMAT_PCM;
             wh->BitsPerSample = 8;
             break;
-        case VLC_FOURCC('s','1','6','l'):
+        case VLC_CODEC_S16L:
         default:
             wh->Format     = WAVE_FORMAT_PCM;
             wh->BitsPerSample = 16;
@@ -220,10 +253,19 @@ static int Open( vlc_object_t * p_this )
         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
         wh->DataLength = 0;                /* temp, to be filled in as we go */
 
+        /* Header -> little endian format */
+        SetWLE( &wh->Format, wh->Format );
+        SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
+        SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
+        SetWLE( &wh->Modus, wh->Modus );
+        SetDWLE( &wh->SampleFreq, wh->SampleFreq );
+        SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
+        SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
+
         if( fwrite( wh, sizeof(WAVEHEADER), 1,
                     p_aout->output.p_sys->p_file ) != 1 )
         {
-            msg_Err( p_aout, "write error (%s)", strerror(errno) );
+            msg_Err( p_aout, "write error (%m)" );
         }
     }
 
@@ -248,16 +290,24 @@ static void Close( vlc_object_t * p_this )
         /* Write Wave Header */
         if( fseek( p_aout->output.p_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 );
+
         if( fwrite( &p_aout->output.p_sys->waveh, sizeof(WAVEHEADER), 1,
                     p_aout->output.p_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 );
+    if( p_aout->output.p_sys->p_file != stdout )
+        fclose( p_aout->output.p_sys->p_file );
     free( p_aout->output.p_sys );
 }
 
@@ -270,16 +320,16 @@ static void Play( aout_instance_t * p_aout )
 
     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
 
-    if( fwrite( p_buffer->p_buffer, p_buffer->i_nb_bytes, 1,
+    if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
                 p_aout->output.p_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 )
     {
         /* Update Wave Header */
-        p_aout->output.p_sys->waveh.DataLength += p_buffer->i_nb_bytes;
+        p_aout->output.p_sys->waveh.DataLength += p_buffer->i_buffer;
     }
 
     aout_BufferFree( p_buffer );