* modules/*: sanitization of the modules description strings.
[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 VideoLAN
5  * $Id: file.c,v 1.20 2003/03/30 18:14:36 gbazin Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include <string.h>
29 #include <stdlib.h>
30 #include <errno.h>
31
32 #include <vlc/vlc.h>
33 #include <vlc/aout.h>
34
35 #include "aout_internal.h"
36 #include "codecs.h"
37
38 #define FRAME_SIZE 2048
39 #define A52_FRAME_NB 1536
40
41 typedef struct WAVEHEADER
42 {
43     uint32_t MainChunkID;                      // it will be 'RIFF'
44     uint32_t Length;
45     uint32_t ChunkTypeID;                      // it will be 'WAVE'
46     uint32_t SubChunkID;                       // it will be 'fmt '
47     uint32_t SubChunkLength;
48     uint16_t Format;
49     uint16_t Modus;
50     uint32_t SampleFreq;
51     uint32_t BytesPerSec;
52     uint16_t BytesPerSample;
53     uint16_t BitsPerSample;
54     uint32_t DataChunkID;                      // it will be 'data'
55     uint32_t DataLength;
56 } WAVEHEADER;
57
58 /*****************************************************************************
59  * aout_sys_t: audio output method descriptor
60  *****************************************************************************
61  * This structure is part of the audio output thread descriptor.
62  * It describes the direct sound specific properties of an audio device.
63  *****************************************************************************/
64 struct aout_sys_t
65 {
66     FILE     * p_file;
67     vlc_bool_t b_add_wav_header;
68
69     WAVEHEADER waveh;                      /* Wave header of the output file */
70 };
71
72 /*****************************************************************************
73  * Local prototypes.
74  *****************************************************************************/
75 static int     Open        ( vlc_object_t * );
76 static void    Close       ( vlc_object_t * );
77 static void    Play        ( aout_instance_t * );
78
79 /*****************************************************************************
80  * Module descriptor
81  *****************************************************************************/
82 #define FORMAT_TEXT N_("output format")
83 #define FORMAT_LONGTEXT N_("one of \"u8\", \"s8\", \"u16\", \"s16\", " \
84                         "\"u16_le\", \"s16_le\", \"u16_be\", " \
85                         "\"s16_be\", \"fixed32\", \"float32\" or \"spdif\"")
86 #define WAV_TEXT N_("add wave header")
87 #define WAV_LONGTEXT N_("instead of writing a raw file, you can add a wav " \
88                         "header to the file")
89
90 static char *format_list[] = { "u8", "s8", "u16", "s16", "u16_le", "s16_le",
91                                "u16_be", "s16_be", "fixed32", "float32",
92                                "spdif", NULL };
93 static int format_int[] = { VLC_FOURCC('u','8',' ',' '),
94                             VLC_FOURCC('s','8',' ',' '),
95                             AOUT_FMT_U16_NE, AOUT_FMT_S16_NE,
96                             VLC_FOURCC('u','1','6','l'),
97                             VLC_FOURCC('s','1','6','l'),
98                             VLC_FOURCC('u','1','6','b'),
99                             VLC_FOURCC('s','1','6','b'),
100                             VLC_FOURCC('f','i','3','2'),
101                             VLC_FOURCC('f','l','3','2'),
102                             VLC_FOURCC('s','p','i','f') };
103
104 #define FILE_TEXT N_("output file")
105 #define FILE_LONGTEXT N_("file to which the audio samples will be written to")
106
107 vlc_module_begin();
108     add_category_hint( N_("Audio"), NULL, VLC_FALSE );
109     add_string_from_list( "audiofile-format", "s16", format_list, NULL,
110                           FORMAT_TEXT, FORMAT_LONGTEXT, VLC_TRUE );
111     add_file( "audiofile", "audiofile.wav", NULL, FILE_TEXT,
112               FILE_LONGTEXT, VLC_FALSE );
113     add_bool( "audiofile-wav", 1, NULL, WAV_TEXT, WAV_LONGTEXT, VLC_TRUE );
114     set_description( N_("file audio output") );
115     set_capability( "audio output", 0 );
116     add_shortcut( "file" );
117     add_shortcut( "audiofile" );
118     set_callbacks( Open, Close );
119 vlc_module_end();
120
121 /*****************************************************************************
122  * Open: open a dummy audio device
123  *****************************************************************************/
124 static int Open( vlc_object_t * p_this )
125 {
126     aout_instance_t * p_aout = (aout_instance_t *)p_this;
127     char * psz_name = config_GetPsz( p_this, "audiofile-path" );
128     char * psz_format = config_GetPsz( p_aout, "audiofile-format" );
129     char ** ppsz_compare = format_list;
130     int i = 0;
131
132    /* Allocate structure */
133     p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
134     if( p_aout->output.p_sys == NULL )
135     {
136         msg_Err( p_aout, "out of memory" );
137         return VLC_EGENERIC;
138     }
139
140     p_aout->output.p_sys->p_file = fopen( psz_name, "wb" );
141     free( psz_name );
142     if ( p_aout->output.p_sys->p_file == NULL )
143     {
144         free( p_aout->output.p_sys );
145         return -1;
146     }
147
148     p_aout->output.pf_play = Play;
149
150     while ( *ppsz_compare != NULL )
151     {
152         if ( !strncmp( *ppsz_compare, psz_format, strlen(*ppsz_compare) ) )
153         {
154             break;
155         }
156         ppsz_compare++; i++;
157     }
158
159     if ( *ppsz_compare == NULL )
160     {
161         msg_Err( p_aout, "Cannot understand the format string (%s)",
162                  psz_format );
163         fclose( p_aout->output.p_sys->p_file );
164         free( p_aout->output.p_sys );
165         return -1;
166     }
167
168     p_aout->output.output.i_format = format_int[i];
169     if ( AOUT_FMT_NON_LINEAR( &p_aout->output.output ) )
170     {
171         p_aout->output.i_nb_samples = A52_FRAME_NB;
172         p_aout->output.output.i_bytes_per_frame = AOUT_SPDIF_SIZE;
173         p_aout->output.output.i_frame_length = A52_FRAME_NB;
174         aout_VolumeNoneInit( p_aout );
175     }
176     else
177     {
178         p_aout->output.i_nb_samples = FRAME_SIZE;
179         aout_VolumeSoftInit( p_aout );
180     }
181
182     p_aout->output.p_sys->b_add_wav_header =
183         config_GetInt( p_this, "audiofile-wav" );
184
185     if( p_aout->output.p_sys->b_add_wav_header )
186     {
187         /* Write wave header */
188         WAVEHEADER *wh = &p_aout->output.p_sys->waveh;
189
190         memset( wh, 0, sizeof(wh) );
191
192         switch( p_aout->output.output.i_format )
193         {
194         case VLC_FOURCC('f','l','3','2'):
195             wh->Format     = WAVE_FORMAT_IEEE_FLOAT;
196             wh->BitsPerSample = sizeof(float) * 8;
197             break;
198         case VLC_FOURCC('u','8',' ',' '):
199             wh->Format     = WAVE_FORMAT_PCM;
200             wh->BitsPerSample = 8;
201             break;
202         case VLC_FOURCC('s','1','6','l'):
203         default:
204             wh->Format     = WAVE_FORMAT_PCM;
205             wh->BitsPerSample = 16;
206             break;
207         }
208
209         wh->MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
210         wh->Length = 0;                    /* temp, to be filled in as we go */
211         wh->ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
212         wh->SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
213         wh->SubChunkLength = 16;
214
215         wh->Modus = aout_FormatNbChannels( &p_aout->output.output );
216         wh->SampleFreq = p_aout->output.output.i_rate;
217         wh->BytesPerSample = wh->Modus * ( wh->BitsPerSample / 8 );
218         wh->BytesPerSec = wh->BytesPerSample * wh->SampleFreq;
219
220         wh->DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
221         wh->DataLength = 0;                /* temp, to be filled in as we go */
222
223         if( fwrite( wh, sizeof(WAVEHEADER), 1,
224                     p_aout->output.p_sys->p_file ) != 1 )
225         {
226             msg_Err( p_aout, "write error (%s)", strerror(errno) );
227         }
228     }
229
230     return 0;
231 }
232
233 /*****************************************************************************
234  * Close: close our file
235  *****************************************************************************/
236 static void Close( vlc_object_t * p_this )
237 {
238     aout_instance_t * p_aout = (aout_instance_t *)p_this;
239
240     msg_Dbg( p_aout, "closing audio file" );
241
242     if( p_aout->output.p_sys->b_add_wav_header )
243     {
244         /* Update Wave Header */
245         p_aout->output.p_sys->waveh.Length =
246             p_aout->output.p_sys->waveh.DataLength + sizeof(WAVEHEADER) - 4;
247
248         /* Write Wave Header */
249         if( fseek( p_aout->output.p_sys->p_file, 0, SEEK_SET ) )
250         {
251             msg_Err( p_aout, "seek error (%s)", strerror(errno) );
252         }
253         if( fwrite( &p_aout->output.p_sys->waveh, sizeof(WAVEHEADER), 1,
254                     p_aout->output.p_sys->p_file ) != 1 )
255         {
256             msg_Err( p_aout, "write error (%s)", strerror(errno) );
257         }
258     }
259
260     fclose( p_aout->output.p_sys->p_file );
261     free( p_aout->output.p_sys );
262 }
263
264 /*****************************************************************************
265  * Play: pretend to play a sound
266  *****************************************************************************/
267 static void Play( aout_instance_t * p_aout )
268 {
269     aout_buffer_t * p_buffer;
270
271     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
272
273     if( fwrite( p_buffer->p_buffer, p_buffer->i_nb_bytes, 1,
274                 p_aout->output.p_sys->p_file ) != 1 )
275     {
276         msg_Err( p_aout, "write error (%s)", strerror(errno) );
277     }
278
279     if( p_aout->output.p_sys->b_add_wav_header )
280     {
281         /* Update Wave Header */
282         p_aout->output.p_sys->waveh.DataLength += p_buffer->i_nb_bytes;
283     }
284
285     aout_BufferFree( p_buffer );
286 }