root/modules/audio_output/file.c

Revision 6e41ca0135153181e3a922f0347154c4b83bac0e, 12.3 kB (checked in by Antoine Cellerier <dionoea@videolan.org>, 2 months ago)

Remove change_unsafe() no-op.

  • Property mode set to 100644
Line 
1 /*****************************************************************************
2  * file.c : audio output which writes the samples to a file
3  *****************************************************************************
4  * Copyright (C) 2002 the VideoLAN team
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
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, 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 <errno.h>
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_aout.h>
38 #include <vlc_codecs.h> /* WAVEHEADER */
39 #include <vlc_charset.h>
40
41 #define FRAME_SIZE 2048
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 struct aout_sys_t
51 {
52     FILE     * p_file;
53     bool b_add_wav_header;
54
55     WAVEHEADER waveh;                      /* Wave header of the output file */
56 };
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    Close       ( vlc_object_t * );
78 static void    Play        ( aout_instance_t * );
79
80 /*****************************************************************************
81  * Module descriptor
82  *****************************************************************************/
83 #define FORMAT_TEXT N_("Output format")
84 #define FORMAT_LONGTEXT N_("One of \"u8\", \"s8\", \"u16\", \"s16\", " \
85     "\"u16_le\", \"s16_le\", \"u16_be\", \"s16_be\", \"fixed32\", " \
86     "\"float32\" or \"spdif\"")
87 #define CHANNELS_TEXT N_("Number of output channels")
88 #define CHANNELS_LONGTEXT N_("By default, all the channels of the incoming " \
89     "will be saved but you can restrict the number of channels here.")
90
91 #define WAV_TEXT N_("Add WAVE header")
92 #define WAV_LONGTEXT N_("Instead of writing a raw file, you can add a WAV " \
93                         "header to the file.")
94
95 static const char *const format_list[] = { "u8", "s8", "u16", "s16", "u16_le",
96                                      "s16_le", "u16_be", "s16_be", "fixed32",
97                                      "float32", "spdif" };
98 static const int format_int[] = { VLC_FOURCC('u','8',' ',' '),
99                                   VLC_FOURCC('s','8',' ',' '),
100                                   AOUT_FMT_U16_NE, AOUT_FMT_S16_NE,
101                                   VLC_FOURCC('u','1','6','l'),
102                                   VLC_FOURCC('s','1','6','l'),
103                                   VLC_FOURCC('u','1','6','b'),
104                                   VLC_FOURCC('s','1','6','b'),
105                                   VLC_FOURCC('f','i','3','2'),
106                                   VLC_FOURCC('f','l','3','2'),
107                                   VLC_FOURCC('s','p','i','f') };
108
109 #define FILE_TEXT N_("Output file")
110 #define FILE_LONGTEXT N_("File to which the audio samples will be written to. (\"-\" for stdout")
111
112 vlc_module_begin();
113     set_description( N_("File audio output") );
114     set_shortname( N_("File") );
115     set_category( CAT_AUDIO );
116     set_subcategory( SUBCAT_AUDIO_AOUT );
117
118     add_string( "audiofile-format", "s16", NULL,
119                 FORMAT_TEXT, FORMAT_LONGTEXT, true );
120         change_string_list( format_list, 0, 0 );
121     add_integer( "audiofile-channels", 0, NULL,
122                  CHANNELS_TEXT, CHANNELS_LONGTEXT, true );
123     add_file( "audiofile-file", "audiofile.wav", NULL, FILE_TEXT,
124               FILE_LONGTEXT, false );
125     add_bool( "audiofile-wav", 1, NULL, WAV_TEXT, WAV_LONGTEXT, true );
126
127     set_capability( "audio output", 0 );
128     add_shortcut( "file" );
129     add_shortcut( "audiofile" );
130     set_callbacks( Open, Close );
131 vlc_module_end();
132
133 /*****************************************************************************
134  * Open: open a dummy audio device
135  *****************************************************************************/
136 static int Open( vlc_object_t * p_this )
137 {
138     aout_instance_t * p_aout = (aout_instance_t *)p_this;
139     char * psz_name, * psz_format;
140     const char * const * ppsz_compare = format_list;
141     vlc_value_t val;
142     int i_channels, i = 0;
143
144     var_Create( p_this, "audiofile-file", VLC_VAR_STRING|VLC_VAR_DOINHERIT );
145     var_Get( p_this, "audiofile-file", &val );
146     psz_name = val.psz_string;
147     if( !psz_name || !*psz_name )
148     {
149         msg_Err( p_aout, "you need to specify an output file name" );
150         free( psz_name );
151         return VLC_EGENERIC;
152     }
153
154     /* Allocate structure */
155     p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
156     if( p_aout->output.p_sys == NULL )
157         return VLC_ENOMEM;
158
159     if( !strcmp( psz_name, "-" ) )
160         p_aout->output.p_sys->p_file = stdout;
161     else
162         p_aout->output.p_sys->p_file = utf8_fopen( psz_name, "wb" );
163
164     free( psz_name );
165     if ( p_aout->output.p_sys->p_file == NULL )
166     {
167         free( p_aout->output.p_sys );
168         return VLC_EGENERIC;
169     }
170
171     p_aout->output.pf_play = Play;
172
173     /* Audio format */
174     var_Create( p_this, "audiofile-format", VLC_VAR_STRING|VLC_VAR_DOINHERIT );
175     var_Get( p_this, "audiofile-format", &val );
176     psz_format = val.psz_string;
177
178     while ( *ppsz_compare != NULL )
179     {
180         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
181         {
182             break;
183         }
184         ppsz_compare++; i++;
185     }
186
187     if ( *ppsz_compare == NULL )
188     {
189         msg_Err( p_aout, "cannot understand the format string (%s)",
190                  psz_format );
191         if( p_aout->output.p_sys->p_file != stdout )
192             fclose( p_aout->output.p_sys->p_file );
193         free( p_aout->output.p_sys );
194         free( psz_format );
195         return VLC_EGENERIC;
196     }
197     free( psz_format );
198
199     p_aout->output.output.i_format = format_int[i];
200     if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
201     {
202         p_aout->output.i_nb_samples = A52_FRAME_NB;
203         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
204         p_aout->output.output.i_frame_length = A52_FRAME_NB;
205         aout_VolumeNoneInit( p_aout );
206     }
207     else
208     {
209         p_aout->output.i_nb_samples = FRAME_SIZE;
210         aout_VolumeSoftInit( p_aout );
211     }
212
213     /* Channels number */
214     var_Create( p_this, "audiofile-channels",
215                 VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
216     var_Get( p_this, "audiofile-channels", &val );
217     i_channels = val.i_int;
218
219     if( i_channels > 0 && i_channels <= CHANNELS_MAX )
220     {
221         p_aout->output.output.i_physical_channels =
222             pi_channels_maps[i_channels];
223     }
224
225     /* WAV header */
226     var_Create( p_this, "audiofile-wav", VLC_VAR_BOOL|VLC_VAR_DOINHERIT );
227     var_Get( p_this, "audiofile-wav", &val );
228     p_aout->output.p_sys->b_add_wav_header = val.b_bool;
229
230     if( p_aout->output.p_sys->b_add_wav_header )
231     {
232         /* Write wave header */
233         WAVEHEADER *wh = &p_aout->output.p_sys->waveh;
234
235         memset( wh, 0, sizeof(wh) );
236
237         switch( p_aout->output.output.i_format )
238         {
239         case VLC_FOURCC('f','l','3','2'):
240             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
241             wh->BitsPerSample = sizeof(float) * 8;
242             break;
243         case VLC_FOURCC('u','8',' ',' '):
244             wh->Format     = WAVE_FORMAT_PCM;
245             wh->BitsPerSample = 8;
246             break;
247         case VLC_FOURCC('s','1','6','l'):
248         default:
249             wh->Format     = WAVE_FORMAT_PCM;
250             wh->BitsPerSample = 16;
251             break;
252         }
253
254         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
255         wh->Length = 0;                    /* temp, to be filled in as we go */
256         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
257         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
258         wh->SubChunkLength = 16;
259
260         wh->Modus = aout_FormatNbChannels( &p_aout->output.output );
261         wh->SampleFreq = p_aout->output.output.i_rate;
262         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
263         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
264
265         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
266         wh->DataLength = 0;                /* temp, to be filled in as we go */
267
268         /* Header -> little endian format */
269         SetWLE( &wh->Format, wh->Format );
270         SetWLE( &wh->BitsPerSample, wh->BitsPerSample );
271         SetDWLE( &wh->SubChunkLength, wh->SubChunkLength );
272         SetWLE( &wh->Modus, wh->Modus );
273         SetDWLE( &wh->SampleFreq, wh->SampleFreq );
274         SetWLE( &wh->BytesPerSample, wh->BytesPerSample );
275         SetDWLE( &wh->BytesPerSec, wh->BytesPerSec );
276
277         if( fwrite( wh, sizeof(WAVEHEADER), 1,
278                     p_aout->output.p_sys->p_file ) != 1 )
279         {
280             msg_Err( p_aout, "write error (%m)" );
281         }
282     }
283
284     return 0;
285 }
286
287 /*****************************************************************************
288  * Close: close our file
289  *****************************************************************************/
290 static void Close( vlc_object_t * p_this )
291 {
292     aout_instance_t * p_aout = (aout_instance_t *)p_this;
293
294     msg_Dbg( p_aout, "closing audio file" );
295
296     if( p_aout->output.p_sys->b_add_wav_header )
297     {
298         /* Update Wave Header */
299         p_aout->output.p_sys->waveh.Length =
300             p_aout->output.p_sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
301
302         /* Write Wave Header */
303         if( fseek( p_aout->output.p_sys->p_file, 0, SEEK_SET ) )
304         {
305             msg_Err( p_aout, "seek error (%m)" );
306         }
307
308         /* Header -> little endian format */
309         SetDWLE( &p_aout->output.p_sys->waveh.Length,
310                  p_aout->output.p_sys->waveh.Length );
311         SetDWLE( &p_aout->output.p_sys->waveh.DataLength,
312                  p_aout->output.p_sys->waveh.DataLength );
313
314         if( fwrite( &p_aout->output.p_sys->waveh, sizeof(WAVEHEADER), 1,
315                     p_aout->output.p_sys->p_file ) != 1 )
316         {
317             msg_Err( p_aout, "write error (%m)" );
318         }
319     }
320
321     if( p_aout->output.p_sys->p_file != stdout )
322         fclose( p_aout->output.p_sys->p_file );
323     free( p_aout->output.p_sys );
324 }
325
326 /*****************************************************************************
327  * Play: pretend to play a sound
328  *****************************************************************************/
329 static void Play( aout_instance_t * p_aout )
330 {
331     aout_buffer_t * p_buffer;
332
333     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
334
335     if( fwrite( p_buffer->p_buffer, p_buffer->i_nb_bytes, 1,
336                 p_aout->output.p_sys->p_file ) != 1 )
337     {
338         msg_Err( p_aout, "write error (%m)" );
339     }
340
341     if( p_aout->output.p_sys->b_add_wav_header )
342     {
343         /* Update Wave Header */
344         p_aout->output.p_sys->waveh.DataLength += p_buffer->i_nb_bytes;
345     }
346
347     aout_BufferFree( p_buffer );
348 }
Note: See TracBrowser for help on using the browser.