]> git.sesse.net Git - vlc/blobdiff - modules/audio_output/file.c
Use var_InheritString for --decklink-video-connection.
[vlc] / modules / audio_output / file.c
index 1dff0d785e0ba5e050269f34e7d212f25264d8e9..32f34384d86d6e6a7b1064555f4f38539f54dbb2 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * file.c : audio output which writes the samples to a file
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
+ * Copyright (C) 2002 the VideoLAN team
  * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *
  * 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
 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,
@@ -81,49 +82,50 @@ static void    Play        ( aout_instance_t * );
 #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_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_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", "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")
+#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( _("File") );
+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, VLC_TRUE );
-        change_string_list( format_list, 0, 0 );
+                FORMAT_TEXT, FORMAT_LONGTEXT, true )
+        change_string_list( format_list, 0, 0 )
     add_integer( "audiofile-channels", 0, NULL,
-                 CHANNELS_TEXT, CHANNELS_LONGTEXT, VLC_TRUE );
+                 CHANNELS_TEXT, CHANNELS_LONGTEXT, 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 );
+              FILE_LONGTEXT, false )
+    add_bool( "audiofile-wav", true, NULL, WAV_TEXT, WAV_LONGTEXT, true )
 
-    set_capability( "audio output", 0 );
-    add_shortcut( "file" );
-    add_shortcut( "audiofile" );
-    set_callbacks( Open, Close );
-vlc_module_end();
+    set_capability( "audio output", 0 )
+    add_shortcut( "file", "audiofile" )
+    set_callbacks( Open, Close )
+vlc_module_end ()
 
 /*****************************************************************************
  * Open: open a dummy audio device
@@ -132,29 +134,27 @@ static int Open( vlc_object_t * p_this )
 {
     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;
+    psz_name = var_CreateGetString( p_this, "audiofile-file" );
     if( !psz_name || !*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;
-    }
+        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" );
 
-    p_aout->output.p_sys->p_file = fopen( psz_name, "wb" );
     free( psz_name );
     if ( p_aout->output.p_sys->p_file == NULL )
     {
@@ -165,9 +165,7 @@ static int Open( vlc_object_t * p_this )
     p_aout->output.pf_play = Play;
 
     /* 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_CreateGetString( p_this, "audiofile-format" );
 
     while ( *ppsz_compare != NULL )
     {
@@ -182,10 +180,13 @@ static int Open( vlc_object_t * p_this )
     {
         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 );
+        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 ) )
@@ -202,10 +203,7 @@ static int Open( vlc_object_t * p_this )
     }
 
     /* 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_CreateGetInteger( p_this, "audiofile-channels" );
 
     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
     {
@@ -214,28 +212,27 @@ static int Open( vlc_object_t * p_this )
     }
 
     /* 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;
+    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;
@@ -268,7 +265,7 @@ static int Open( vlc_object_t * p_this )
         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)" );
         }
     }
 
@@ -293,7 +290,7 @@ 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 */
@@ -305,11 +302,12 @@ static void Close( vlc_object_t * p_this )
         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 );
 }
 
@@ -322,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 );