1 /*****************************************************************************
2 * waveout.c : Windows waveOut plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: waveout.c,v 1.4 2002/08/19 21:31:11 massiot Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <errno.h> /* ENOMEM */
28 #include <fcntl.h> /* open(), O_WRONLY */
29 #include <string.h> /* strerror() */
31 #include <stdlib.h> /* calloc(), malloc(), free() */
35 #include "aout_internal.h"
39 #define FRAME_SIZE 2048 /* The size is in samples, not in bytes */
41 /*****************************************************************************
43 *****************************************************************************/
44 static int Open ( vlc_object_t * );
45 static void Close ( vlc_object_t * );
47 static int SetFormat ( aout_instance_t * );
48 static void Play ( aout_instance_t * );
51 static int OpenWaveOut ( aout_instance_t *p_aout, int i_format,
52 int i_channels, int i_rate );
53 static int PlayWaveOut ( aout_instance_t *, HWAVEOUT, WAVEHDR *,
55 static void CALLBACK WaveOutCallback ( HWAVEOUT h_waveout, UINT uMsg,
57 DWORD dwParam1, DWORD dwParam2 );
59 /*****************************************************************************
61 *****************************************************************************/
63 set_description( _("Win32 waveOut extension module") );
64 set_capability( "audio output", 50 );
65 set_callbacks( Open, Close );
68 /*****************************************************************************
69 * aout_sys_t: waveOut audio output method descriptor
70 *****************************************************************************
71 * This structure is part of the audio output thread descriptor.
72 * It describes the waveOut specific properties of an audio device.
73 *****************************************************************************/
76 HWAVEOUT h_waveout; /* handle to waveout instance */
78 WAVEFORMATEX waveformat; /* audio format */
80 WAVEHDR waveheader[2];
84 byte_t *p_silence_buffer; /* buffer we use to play silence */
87 /*****************************************************************************
88 * Open: open the audio device
89 *****************************************************************************
90 * This function opens and setups Win32 waveOut
91 *****************************************************************************/
92 static int Open( vlc_object_t *p_this )
94 aout_instance_t *p_aout = (aout_instance_t *)p_this;
96 /* Allocate structure */
97 p_aout->output.p_sys = malloc( sizeof( aout_sys_t ) );
99 if( p_aout->output.p_sys == NULL )
101 msg_Err( p_aout, "out of memory" );
105 p_aout->output.pf_setformat = SetFormat;
106 p_aout->output.pf_play = Play;
108 /* calculate the frame size in bytes */
109 p_aout->output.p_sys->i_buffer_size = FRAME_SIZE * sizeof(s16)
110 * p_aout->output.p_sys->waveformat.nChannels;
111 /* Allocate silence buffer */
112 p_aout->output.p_sys->p_silence_buffer =
113 calloc( p_aout->output.p_sys->i_buffer_size, 1 );
114 if( p_aout->output.p_sys->p_silence_buffer == NULL )
116 msg_Err( p_aout, "out of memory" );
120 /* We need to open the device with default values to be sure it is
122 return OpenWaveOut( p_aout, WAVE_FORMAT_PCM, 2, 44100 );
125 /*****************************************************************************
126 * SetFormat: reset the audio device and sets its format
127 *****************************************************************************
128 * This functions set a new audio format.
129 * For this we need to close the current device and create another
130 * one with the desired format.
131 *****************************************************************************/
132 static int SetFormat( aout_instance_t *p_aout )
134 msg_Dbg( p_aout, "SetFormat" );
136 waveOutReset( p_aout->output.p_sys->h_waveout );
138 p_aout->output.output.i_format = AOUT_FMT_S16_NE;
139 p_aout->output.i_nb_samples = FRAME_SIZE;
141 /* Check if the format has changed */
142 if( (p_aout->output.p_sys->waveformat.nChannels !=
143 p_aout->output.output.i_channels) ||
144 (p_aout->output.p_sys->waveformat.nSamplesPerSec !=
145 p_aout->output.output.i_rate) )
147 if( waveOutClose( p_aout->output.p_sys->h_waveout ) !=
150 msg_Err( p_aout, "waveOutClose failed" );
153 /* calculate the frame size in bytes */
154 p_aout->output.p_sys->i_buffer_size = FRAME_SIZE * sizeof(s16)
155 * p_aout->output.output.i_channels;
157 /* take care of silence buffer */
158 free( p_aout->output.p_sys->p_silence_buffer );
159 p_aout->output.p_sys->p_silence_buffer =
160 calloc( p_aout->output.p_sys->i_buffer_size, 1 );
161 if( p_aout->output.p_sys->p_silence_buffer == NULL )
163 msg_Err( p_aout, "out of memory" );
167 if( OpenWaveOut( p_aout, WAVE_FORMAT_PCM,
168 p_aout->output.output.i_channels,
169 p_aout->output.output.i_rate ) )
173 /* We need to kick off the playback in order to have the callback properly
175 PlayWaveOut( p_aout, p_aout->output.p_sys->h_waveout,
176 &p_aout->output.p_sys->waveheader[0], NULL );
177 PlayWaveOut( p_aout, p_aout->output.p_sys->h_waveout,
178 &p_aout->output.p_sys->waveheader[1], NULL );
183 /*****************************************************************************
184 * Play: play a sound buffer
185 *****************************************************************************
186 * This doesn't actually play the buffer. This just stores the buffer so it
187 * can be played by the callback thread.
188 *****************************************************************************/
189 static void Play( aout_instance_t *p_aout )
193 /*****************************************************************************
194 * Close: close the audio device
195 *****************************************************************************/
196 static void Close( vlc_object_t *p_this )
198 aout_instance_t *p_aout = (aout_instance_t *)p_this;
200 /* Before calling waveOutClose we must reset the device */
201 waveOutReset( p_aout->output.p_sys->h_waveout );
203 /* Close the device */
204 if( waveOutClose( p_aout->output.p_sys->h_waveout ) != MMSYSERR_NOERROR )
206 msg_Err( p_aout, "waveOutClose failed" );
209 /* Free silence buffer */
210 free( p_aout->output.p_sys->p_silence_buffer );
212 if( p_aout->output.p_sys != NULL )
214 free( p_aout->output.p_sys );
215 p_aout->output.p_sys = NULL;
219 /*****************************************************************************
220 * OpenWaveOut: open the waveout sound device
221 ****************************************************************************/
222 static int OpenWaveOut( aout_instance_t *p_aout, int i_format,
223 int i_channels, int i_rate )
227 /* Set sound format */
228 p_aout->output.p_sys->waveformat.wFormatTag = i_format;
229 p_aout->output.p_sys->waveformat.nChannels = i_channels;
230 p_aout->output.p_sys->waveformat.nSamplesPerSec = i_rate;
231 p_aout->output.p_sys->waveformat.wBitsPerSample = 16;
232 p_aout->output.p_sys->waveformat.nBlockAlign =
233 p_aout->output.p_sys->waveformat.wBitsPerSample / 8 * i_channels;
234 p_aout->output.p_sys->waveformat.nAvgBytesPerSec =
235 p_aout->output.p_sys->waveformat.nSamplesPerSec *
236 p_aout->output.p_sys->waveformat.nBlockAlign;
238 /* Open the device */
239 result = waveOutOpen( &p_aout->output.p_sys->h_waveout, WAVE_MAPPER,
240 &p_aout->output.p_sys->waveformat,
241 (DWORD_PTR)WaveOutCallback, (DWORD_PTR)p_aout,
243 if( result == WAVERR_BADFORMAT )
245 msg_Err( p_aout, "waveOutOpen failed WAVERR_BADFORMAT" );
248 if( result != MMSYSERR_NOERROR )
250 msg_Err( p_aout, "waveOutOpen failed" );
257 /*****************************************************************************
258 * PlayWaveOut: play a buffer through the WaveOut device
259 *****************************************************************************/
260 static int PlayWaveOut( aout_instance_t *p_aout, HWAVEOUT h_waveout,
261 WAVEHDR *p_waveheader, aout_buffer_t *p_buffer )
265 /* Prepare the buffer */
266 if( p_buffer != NULL )
267 p_waveheader->lpData = p_buffer->p_buffer;
269 /* Use silence buffer instead */
270 p_waveheader->lpData = p_aout->output.p_sys->p_silence_buffer;
272 p_waveheader->dwUser = (DWORD_PTR)p_buffer;
273 p_waveheader->dwBufferLength = p_aout->output.p_sys->i_buffer_size;
274 p_waveheader->dwFlags = 0;
276 result = waveOutPrepareHeader( h_waveout, p_waveheader, sizeof(WAVEHDR) );
277 if( result != MMSYSERR_NOERROR )
279 msg_Err( p_aout, "waveOutPrepareHeader failed" );
283 /* Send the buffer to the waveOut queue */
284 result = waveOutWrite( h_waveout, p_waveheader, sizeof(WAVEHDR) );
285 if( result != MMSYSERR_NOERROR )
287 msg_Err( p_aout, "waveOutWrite failed" );
294 /*****************************************************************************
295 * WaveOutCallback: what to do once WaveOut has played its sound samples
296 *****************************************************************************/
297 static void CALLBACK WaveOutCallback( HWAVEOUT h_waveout, UINT uMsg,
299 DWORD dwParam1, DWORD dwParam2 )
301 aout_instance_t * p_aout = (aout_instance_t *)_p_aout;
302 WAVEHDR *p_waveheader = (WAVEHDR *)dwParam1;
303 aout_buffer_t * p_buffer;
305 if( uMsg != WOM_DONE ) return;
307 /* Unprepare and free the buffer which has just been played */
308 waveOutUnprepareHeader( h_waveout, p_waveheader, sizeof(WAVEHDR) );
309 if( p_waveheader->dwUser )
310 aout_BufferFree( (aout_buffer_t *)p_waveheader->dwUser );
312 /* FIXME : take into account WaveOut latency instead of mdate() */
313 p_buffer = aout_OutputNextBuffer( p_aout, mdate(), 0 );
315 PlayWaveOut( p_aout, h_waveout, p_waveheader, p_buffer );