aout: always provide time_get
[vlc.git] / 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 <stdio.h>
34 #include <errno.h>
35
36 #include <vlc_common.h>
37 #include <vlc_plugin.h>
38 #include <vlc_aout.h>
39 #include <vlc_codecs.h> /* WAVEHEADER */
40 #include <vlc_fs.h>
41
42 #define A52_FRAME_NB 1536
43
44 /*****************************************************************************
45  * aout_sys_t: audio output method descriptor
46  *****************************************************************************
47  * This structure is part of the audio output thread descriptor.
48  * It describes the direct sound specific properties of an audio device.
49  *****************************************************************************/
50 typedef struct
51 {
52     FILE     * p_file;
53     bool b_add_wav_header;
54
55     WAVEHEADER waveh;                      /* Wave header of the output file */
56 } aout_sys_t;
57
58 #define CHANNELS_MAX 6
59 static const int pi_channels_maps[CHANNELS_MAX+1] =
60 {
61     0,
62     AOUT_CHAN_CENTER,
63     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
64     AOUT_CHAN_CENTER | AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
65     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
66      | AOUT_CHAN_REARRIGHT,
67     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
68      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT,
69     AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
70      | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE
71 };
72
73 /*****************************************************************************
74  * Local prototypes.
75  *****************************************************************************/
76 static int     Open        ( vlc_object_t * );
77 static void    Play        ( audio_output_t *, block_t *, mtime_t );
78 static void    Flush       ( audio_output_t *, bool );
79
80 /*****************************************************************************
81  * Module descriptor
82  *****************************************************************************/
83 #define FORMAT_TEXT N_("Output format")
84
85 #define CHANNELS_TEXT N_("Number of output channels")
86 #define CHANNELS_LONGTEXT N_("By default (0), all the channels of the incoming " \
87     "will be saved but you can restrict the number of channels here.")
88
89 #define WAV_TEXT N_("Add WAVE header")
90 #define WAV_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
91                         "header to the file.")
92
93 static const char *const format_list[] = {
94     "u8", "s16",
95 #ifndef WORDS_BIGENDIAN
96     "float32",
97 #endif
98     "spdif",
99 };
100 static const int format_int[] = {
101     VLC_CODEC_U8, VLC_CODEC_S16N,
102 #ifndef WORDS_BIGENDIAN
103     VLC_CODEC_FL32,
104 #endif
105     VLC_CODEC_SPDIFL,
106 };
107
108 #define FILE_TEXT N_("Output file")
109 #define FILE_LONGTEXT N_("File to which the audio samples will be written to (\"-\" for stdout).")
110
111 vlc_module_begin ()
112     set_description( N_("File audio output") )
113     set_shortname( N_("File") )
114     set_category( CAT_AUDIO )
115     set_subcategory( SUBCAT_AUDIO_AOUT )
116
117     add_savefile("audiofile-file", "audiofile.wav", FILE_TEXT, FILE_LONGTEXT)
118     add_string( "audiofile-format", "s16",
119                 FORMAT_TEXT, FORMAT_TEXT, true )
120         change_string_list( format_list, format_list )
121     add_integer( "audiofile-channels", 0,
122                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true )
123         change_integer_range( 0, 6 )
124     add_bool( "audiofile-wav", true, WAV_TEXT, WAV_LONGTEXT, true )
125
126     set_capability( "audio output", 0 )
127     add_shortcut( "file", "audiofile" )
128     set_callbacks( Open, NULL )
129 vlc_module_end ()
130
131 static int Start( audio_output_t *p_aout, audio_sample_format_t *restrict fmt )
132 {
133     char * psz_name, * psz_format;
134     const char * const * ppsz_compare = format_list;
135     int i_channels, i = 0;
136
137     if( aout_FormatNbChannels( fmt ) == 0 )
138         return VLC_EGENERIC;
139
140     psz_name = var_InheritString( p_aout, "audiofile-file" );
141     if( !psz_name )
142     {
143         msg_Err( p_aout, "you need to specify an output file name" );
144         free( psz_name );
145         return VLC_EGENERIC;
146     }
147
148     /* Allocate structure */
149     aout_sys_t *p_sys = malloc( sizeof( aout_sys_t ) );
150     if( p_sys == NULL )
151         return VLC_ENOMEM;
152     p_aout->sys = p_sys;
153
154     if( !strcmp( psz_name, "-" ) )
155         p_sys->p_file = stdout;
156     else
157         p_sys->p_file = vlc_fopen( psz_name, "wb" );
158
159     free( psz_name );
160     if ( p_sys->p_file == NULL )
161     {
162         free( p_sys );
163         return VLC_EGENERIC;
164     }
165
166     p_aout->time_get = aout_TimeGetDefault;
167     p_aout->play = Play;
168     p_aout->pause = NULL;
169     p_aout->flush = Flush;
170
171     /* Audio format */
172     psz_format = var_InheritString( p_aout, "audiofile-format" );
173     if ( !psz_format ) /* FIXME */
174     {
175         if( p_sys->p_file != stdout )
176             fclose( p_sys->p_file );
177         free( p_sys );
178         return VLC_EGENERIC;
179     }
180
181     while ( *ppsz_compare != NULL )
182     {
183         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
184         {
185             break;
186         }
187         ppsz_compare++; i++;
188     }
189
190     if ( *ppsz_compare == NULL )
191     {
192         msg_Err( p_aout, "cannot understand the format string (%s)",
193                  psz_format );
194         if( p_sys->p_file != stdout )
195             fclose( p_sys->p_file );
196         free( p_sys );
197         free( psz_format );
198         return VLC_EGENERIC;
199     }
200     free( psz_format );
201
202     fmt->i_format = format_int[i];
203     if ( AOUT_FMT_SPDIF( fmt ) )
204     {
205         fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
206         fmt->i_frame_length = A52_FRAME_NB;
207     }
208
209     /* Channels number */
210     i_channels = var_InheritInteger( p_aout, "audiofile-channels" );
211     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
212     {
213         fmt->i_physical_channels = pi_channels_maps[i_channels];
214     }
215     fmt->channel_type = AUDIO_CHANNEL_TYPE_BITMAP;
216
217     /* WAV header */
218     p_sys->b_add_wav_header = var_InheritBool( p_aout, "audiofile-wav" );
219     if( p_sys->b_add_wav_header )
220     {
221         /* Write wave header */
222         WAVEHEADER *wh = &p_sys->waveh;
223
224         memset( wh, 0, sizeof(*wh) );
225
226         switch( fmt->i_format )
227         {
228 #ifndef WORDS_BIGENDIAN
229         case VLC_CODEC_FL32:
230             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
231             wh->BitsPerSample = sizeof(float) * 8;
232             break;
233 #endif
234         case VLC_CODEC_U8:
235             wh->Format     = WAVE_FORMAT_PCM;
236             wh->BitsPerSample = 8;
237             break;
238         default:
239             wh->Format     = WAVE_FORMAT_PCM;
240             wh->BitsPerSample = 16;
241             break;
242         }
243
244         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
245         wh->Length = 0;                    /* temp, to be filled in as we go */
246         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
247         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
248         wh->SubChunkLength = 16;
249
250         wh->Modus = aout_FormatNbChannels( fmt );
251         wh->SampleFreq = fmt->i_rate;
252         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
253         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
254
255         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
256         wh->DataLength = 0;                /* temp, to be filled in as we go */
257
258         /* Header -> little endian format */
259         SetWLE( &wh->Format, wh->Format );
260         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
261         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
262         SetWLE( &wh->Modus, wh->Modus );
263         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
264         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
265         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
266
267         if( fwrite( wh, sizeof(WAVEHEADER), 1,
268                     p_sys->p_file ) != 1 )
269         {
270             msg_Err( p_aout, "write error: %s", vlc_strerror_c(errno) );
271         }
272     }
273
274     return 0;
275 }
276
277 /*****************************************************************************
278  * Close: close our file
279  *****************************************************************************/
280 static void Stop( audio_output_t *p_aout )
281 {
282     msg_Dbg( p_aout, "closing audio file" );
283     aout_sys_t *p_sys = p_aout->sys;
284
285     if( p_sys->b_add_wav_header )
286     {
287         /* Update Wave Header */
288         p_sys->waveh.Length =
289             p_sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
290
291         /* Write Wave Header */
292         if( fseek( p_sys->p_file, 0, SEEK_SET ) )
293         {
294             msg_Err( p_aout, "seek error: %s", vlc_strerror_c(errno) );
295         }
296
297         /* Header -> little endian format */
298         SetDWLE( &p_sys->waveh.Length,
299                  p_sys->waveh.Length );
300         SetDWLE( &p_sys->waveh.DataLength,
301                  p_sys->waveh.DataLength );
302
303         if( fwrite( &p_sys->waveh, sizeof(WAVEHEADER), 1,
304                     p_sys->p_file ) != 1 )
305         {
306             msg_Err( p_aout, "write error: %s", vlc_strerror_c(errno) );
307         }
308     }
309
310     if( p_sys->p_file != stdout )
311         fclose( p_sys->p_file );
312     free( p_sys );
313 }
314
315 /*****************************************************************************
316  * Play: pretend to play a sound
317  *****************************************************************************/
318 static void Play( audio_output_t * p_aout, block_t *p_buffer, mtime_t date )
319 {
320     aout_sys_t *p_sys = p_aout->sys;
321     if( fwrite( p_buffer->p_buffer, p_buffer->i_buffer, 1,
322                 p_sys->p_file ) != 1 )
323     {
324         msg_Err( p_aout, "write error: %s", vlc_strerror_c(errno) );
325     }
326
327     if( p_sys->b_add_wav_header )
328     {
329         /* Update Wave Header */
330         p_sys->waveh.DataLength += p_buffer->i_buffer;
331     }
332
333     block_Release( p_buffer );
334     (void) date;
335 }
336
337 static void Flush( audio_output_t *aout, bool wait )
338 {
339     aout_sys_t *p_sys = aout->sys;
340     if( fflush( p_sys->p_file ) )
341         msg_Err( aout, "flush error: %s", vlc_strerror_c(errno) );
342     (void) wait;
343 }
344
345 static int Open(vlc_object_t *obj)
346 {
347     audio_output_t *aout = (audio_output_t *)obj;
348
349     aout->start = Start;
350     aout->stop = Stop;
351     aout->volume_set = NULL;
352     aout->mute_set = NULL;
353     return VLC_SUCCESS;
354 }