1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/unix/sound.cpp
4 // Author: Marcel Rasche, Vaclav Slavik
8 // Copyright: (c) Julian Smart, Open Source Applications Foundation
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // for compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
15 #if defined(__BORLANDC__)
24 #include <sys/ioctl.h>
26 #ifdef HAVE_SYS_SOUNDCARD_H
27 #include <sys/soundcard.h>
36 #include "wx/thread.h"
38 #include "wx/module.h"
40 #include "wx/dynlib.h"
44 // mutex for all wxSound's synchronization
45 static wxMutex gs_soundMutex;
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 void wxSoundData::IncRef()
55 wxMutexLocker locker(gs_soundMutex);
60 void wxSoundData::DecRef()
63 wxMutexLocker locker(gs_soundMutex);
69 wxSoundData::~wxSoundData()
71 delete[] m_dataWithHeader;
75 // ----------------------------------------------------------------------------
76 // wxSoundBackendNull, used in absence of audio API or card
77 // ----------------------------------------------------------------------------
79 class wxSoundBackendNull : public wxSoundBackend
82 wxString GetName() const { return _("No sound"); }
83 int GetPriority() const { return 0; }
84 bool IsAvailable() const { return true; }
85 bool HasNativeAsyncPlayback() const { return true; }
86 bool Play(wxSoundData *WXUNUSED(data), unsigned WXUNUSED(flags),
87 volatile wxSoundPlaybackStatus *WXUNUSED(status))
90 bool IsPlaying() const { return false; }
94 // ----------------------------------------------------------------------------
95 // wxSoundBackendOSS, for Linux
96 // ----------------------------------------------------------------------------
98 #ifdef HAVE_SYS_SOUNDCARD_H
101 #define AUDIODEV "/dev/dsp" // Default path for audio device
104 class wxSoundBackendOSS : public wxSoundBackend
107 wxString GetName() const { return _T("Open Sound System"); }
108 int GetPriority() const { return 10; }
109 bool IsAvailable() const;
110 bool HasNativeAsyncPlayback() const { return false; }
111 bool Play(wxSoundData *data, unsigned flags,
112 volatile wxSoundPlaybackStatus *status);
114 bool IsPlaying() const { return false; }
117 int OpenDSP(const wxSoundData *data);
118 bool InitDSP(int dev, const wxSoundData *data);
120 int m_DSPblkSize; // Size of the DSP buffer
121 bool m_needConversion;
124 bool wxSoundBackendOSS::IsAvailable() const
127 fd = open(AUDIODEV, O_WRONLY | O_NONBLOCK);
134 bool wxSoundBackendOSS::Play(wxSoundData *data, unsigned flags,
135 volatile wxSoundPlaybackStatus *status)
137 int dev = OpenDSP(data);
142 ioctl(dev, SNDCTL_DSP_SYNC, 0);
149 size_t datasize = data->m_dataBytes;
153 if (status->m_stopRequested)
155 wxLogTrace(_T("sound"), _T("playback stopped"));
160 i= (int)((l + m_DSPblkSize) < datasize ?
161 m_DSPblkSize : (datasize - l));
162 if (write(dev, &data->m_data[l], i) != i)
167 } while (play && l < datasize);
168 } while (flags & wxSOUND_LOOP);
174 int wxSoundBackendOSS::OpenDSP(const wxSoundData *data)
178 if ((dev = open(AUDIODEV, O_WRONLY, 0)) <0)
181 if (!InitDSP(dev, data) || m_needConversion)
191 bool wxSoundBackendOSS::InitDSP(int dev, const wxSoundData *data)
196 if (ioctl(dev, SNDCTL_DSP_RESET, 0) < 0)
198 wxLogTrace(_T("sound"), _T("unable to reset dsp"));
202 m_needConversion = false;
204 tmp = data->m_bitsPerSample;
205 if (ioctl(dev, SNDCTL_DSP_SAMPLESIZE, &tmp) < 0)
207 wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SAMPLESIZE)"));
210 if (tmp != data->m_bitsPerSample)
212 wxLogTrace(_T("sound"),
213 _T("Unable to set DSP sample size to %d (wants %d)"),
214 data->m_bitsPerSample, tmp);
215 m_needConversion = true;
218 unsigned stereo = data->m_channels == 1 ? 0 : 1;
220 if (ioctl(dev, SNDCTL_DSP_STEREO, &tmp) < 0)
222 wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_STEREO)"));
227 wxLogTrace(_T("sound"), _T("Unable to set DSP to %s."), stereo? _T("stereo"):_T("mono"));
228 m_needConversion = true;
231 tmp = data->m_samplingRate;
232 if (ioctl(dev, SNDCTL_DSP_SPEED, &tmp) < 0)
234 wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SPEED)"));
237 if (tmp != data->m_samplingRate)
239 // If the rate the sound card is using is not within 1% of what the
240 // data specified then override the data setting. The only reason not
241 // to always override this is because of clock-rounding
242 // problems. Sound cards will sometimes use things like 44101 when you
243 // ask for 44100. No need overriding this and having strange output
244 // file rates for something that we can't hear anyways.
245 if (data->m_samplingRate - tmp > (tmp * .01) ||
246 tmp - data->m_samplingRate > (tmp * .01)) {
247 wxLogTrace(_T("sound"),
248 _T("Unable to set DSP sampling rate to %d (wants %d)"),
249 data->m_samplingRate, tmp);
250 m_needConversion = true;
254 // Do this last because some drivers can adjust the buffer sized based on
255 // the sampling rate, etc.
256 if (ioctl(dev, SNDCTL_DSP_GETBLKSIZE, &m_DSPblkSize) < 0)
258 wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_GETBLKSIZE)"));
264 #endif // HAVE_SYS_SOUNDCARD_H
266 // ----------------------------------------------------------------------------
267 // wxSoundSyncOnlyAdaptor
268 // ----------------------------------------------------------------------------
272 class wxSoundSyncOnlyAdaptor;
274 // this class manages asynchronous playback of audio if the backend doesn't
275 // support it natively (e.g. OSS backend)
276 class wxSoundAsyncPlaybackThread : public wxThread
279 wxSoundAsyncPlaybackThread(wxSoundSyncOnlyAdaptor *adaptor,
280 wxSoundData *data, unsigned flags)
281 : wxThread(), m_adapt(adaptor), m_data(data), m_flags(flags) {}
282 virtual ExitCode Entry();
285 wxSoundSyncOnlyAdaptor *m_adapt;
290 #endif // wxUSE_THREADS
292 // This class turns wxSoundBackend that doesn't support asynchronous playback
293 // into one that does
294 class wxSoundSyncOnlyAdaptor : public wxSoundBackend
297 wxSoundSyncOnlyAdaptor(wxSoundBackend *backend)
298 : m_backend(backend), m_playing(false) {}
299 ~wxSoundSyncOnlyAdaptor()
303 wxString GetName() const
305 return m_backend->GetName();
307 int GetPriority() const
309 return m_backend->GetPriority();
311 bool IsAvailable() const
313 return m_backend->IsAvailable();
315 bool HasNativeAsyncPlayback() const
319 bool Play(wxSoundData *data, unsigned flags,
320 volatile wxSoundPlaybackStatus *status);
322 bool IsPlaying() const;
325 friend class wxSoundAsyncPlaybackThread;
327 wxSoundBackend *m_backend;
330 // player thread holds this mutex and releases it after it finishes
331 // playing, so that the main thread knows when it can play sound
332 wxMutex m_mutexRightToPlay;
333 wxSoundPlaybackStatus m_status;
339 wxThread::ExitCode wxSoundAsyncPlaybackThread::Entry()
341 m_adapt->m_backend->Play(m_data, m_flags & ~wxSOUND_ASYNC,
345 m_adapt->m_playing = false;
346 m_adapt->m_mutexRightToPlay.Unlock();
347 wxLogTrace(_T("sound"), _T("terminated async playback thread"));
352 bool wxSoundSyncOnlyAdaptor::Play(wxSoundData *data, unsigned flags,
353 volatile wxSoundPlaybackStatus *status)
356 if (flags & wxSOUND_ASYNC)
359 m_mutexRightToPlay.Lock();
360 m_status.m_playing = true;
361 m_status.m_stopRequested = false;
363 wxThread *th = new wxSoundAsyncPlaybackThread(this, data, flags);
366 wxLogTrace(_T("sound"), _T("launched async playback thread"));
369 wxLogError(_("Unable to play sound asynchronously."));
376 m_mutexRightToPlay.Lock();
378 bool rv = m_backend->Play(data, flags, status);
380 m_mutexRightToPlay.Unlock();
386 void wxSoundSyncOnlyAdaptor::Stop()
388 wxLogTrace(_T("sound"), _T("asking audio to stop"));
391 // tell the player thread (if running) to stop playback ASAP:
392 m_status.m_stopRequested = true;
394 // acquire the mutex to be sure no sound is being played, then
395 // release it because we don't need it for anything (the effect of this
396 // is that calling thread will wait until playback thread reacts to
397 // our request to interrupt playback):
398 m_mutexRightToPlay.Lock();
399 m_mutexRightToPlay.Unlock();
400 wxLogTrace(_T("sound"), _T("audio was stopped"));
404 bool wxSoundSyncOnlyAdaptor::IsPlaying() const
407 return m_status.m_playing;
414 // ----------------------------------------------------------------------------
416 // ----------------------------------------------------------------------------
418 wxSoundBackend *wxSound::ms_backend = NULL;
420 // FIXME - temporary, until we have plugins architecture
423 wxDynamicLibrary *wxSound::ms_backendSDL = NULL;
425 extern "C" wxSoundBackend *wxCreateSoundBackendSDL();
429 wxSound::wxSound() : m_data(NULL)
433 wxSound::wxSound(const wxString& sFileName, bool isResource) : m_data(NULL)
435 Create(sFileName, isResource);
438 wxSound::wxSound(int size, const wxByte* data) : m_data(NULL)
448 bool wxSound::Create(const wxString& fileName,
449 bool WXUNUSED_UNLESS_DEBUG(isResource))
451 wxASSERT_MSG( !isResource,
452 _T("Loading sound from resources is only supported on Windows") );
457 if (!fileWave.Open(fileName, wxFile::read))
462 wxFileOffset lenOrig = fileWave.Length();
463 if ( lenOrig == wxInvalidOffset )
466 size_t len = wx_truncate_cast(size_t, lenOrig);
467 wxUint8 *data = new wxUint8[len];
468 if ( fileWave.Read(data, len) != lenOrig )
471 wxLogError(_("Couldn't load sound data from '%s'."), fileName.c_str());
475 if (!LoadWAV(data, len, false))
478 wxLogError(_("Sound file '%s' is in unsupported format."),
486 bool wxSound::Create(int size, const wxByte* data)
488 wxASSERT( data != NULL );
491 if (!LoadWAV(data, size, true))
493 wxLogError(_("Sound data are in unsupported format."));
499 /*static*/ void wxSound::EnsureBackend()
503 // FIXME -- make this fully dynamic when plugins architecture is in
509 ms_backend = wxCreateSoundBackendSDL();
512 dllname.Printf(_T("%s/%s"),
513 wxDynamicLibrary::GetPluginsDirectory().c_str(),
514 wxDynamicLibrary::CanonicalizePluginName(
515 _T("sound_sdl"), wxDL_PLUGIN_BASE).c_str());
516 wxLogTrace(_T("sound"),
517 _T("trying to load SDL plugin from '%s'..."),
520 ms_backendSDL = new wxDynamicLibrary(dllname, wxDL_NOW);
521 if (!ms_backendSDL->IsLoaded())
523 wxDELETE(ms_backendSDL);
527 typedef wxSoundBackend *(*wxCreateSoundBackend_t)();
528 wxDYNLIB_FUNCTION(wxCreateSoundBackend_t,
529 wxCreateSoundBackendSDL, *ms_backendSDL);
530 if (pfnwxCreateSoundBackendSDL)
532 ms_backend = (*pfnwxCreateSoundBackendSDL)();
536 if (ms_backend && !ms_backend->IsAvailable())
538 wxDELETE(ms_backend);
543 #ifdef HAVE_SYS_SOUNDCARD_H
546 ms_backend = new wxSoundBackendOSS();
547 if (!ms_backend->IsAvailable())
549 wxDELETE(ms_backend);
555 ms_backend = new wxSoundBackendNull();
557 if (!ms_backend->HasNativeAsyncPlayback())
558 ms_backend = new wxSoundSyncOnlyAdaptor(ms_backend);
560 wxLogTrace(_T("sound"),
561 _T("using backend '%s'"), ms_backend->GetName().c_str());
565 /*static*/ void wxSound::UnloadBackend()
569 wxLogTrace(_T("sound"), _T("unloading backend"));
575 #if wxUSE_LIBSDL && wxUSE_PLUGINS
576 delete ms_backendSDL;
581 bool wxSound::DoPlay(unsigned flags) const
583 wxCHECK_MSG( IsOk(), false, _T("Attempt to play invalid wave data") );
586 wxSoundPlaybackStatus status;
587 status.m_playing = true;
588 status.m_stopRequested = false;
589 return ms_backend->Play(m_data, flags, &status);
592 /*static*/ void wxSound::Stop()
598 /*static*/ bool wxSound::IsPlaying()
601 return ms_backend->IsPlaying();
615 wxUint16 uiFormatTag;
617 wxUint32 ulSamplesPerSec;
618 wxUint32 ulAvgBytesPerSec;
619 wxUint16 uiBlockAlign;
620 wxUint16 uiBitsPerSample;
623 #define WAVE_FORMAT_PCM 1
627 bool wxSound::LoadWAV(const wxUint8 *data, size_t length, bool copyData)
629 // the simplest wave file header consists of 44 bytes:
638 // 22 number of channels |
639 // 24 sample rate | WAVEFORMAT
640 // 28 average bytes per second |
641 // 32 bytes per frame |
642 // 34 bits per sample |
645 // 40 number of data bytes
646 // 44 (wave signal) data
648 // so check that we have at least as much
652 WAVEFORMAT waveformat;
653 memcpy(&waveformat, &data[FMT_INDEX + 4], sizeof(WAVEFORMAT));
654 waveformat.uiSize = wxUINT32_SWAP_ON_BE(waveformat.uiSize);
655 waveformat.uiFormatTag = wxUINT16_SWAP_ON_BE(waveformat.uiFormatTag);
656 waveformat.uiChannels = wxUINT16_SWAP_ON_BE(waveformat.uiChannels);
657 waveformat.ulSamplesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulSamplesPerSec);
658 waveformat.ulAvgBytesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulAvgBytesPerSec);
659 waveformat.uiBlockAlign = wxUINT16_SWAP_ON_BE(waveformat.uiBlockAlign);
660 waveformat.uiBitsPerSample = wxUINT16_SWAP_ON_BE(waveformat.uiBitsPerSample);
662 // get the sound data size
664 memcpy(&ul, &data[FMT_INDEX + waveformat.uiSize + 12], 4);
665 ul = wxUINT32_SWAP_ON_BE(ul);
667 if ( length < ul + FMT_INDEX + waveformat.uiSize + 16 )
670 if (memcmp(data, "RIFF", 4) != 0)
672 if (memcmp(&data[WAVE_INDEX], "WAVE", 4) != 0)
674 if (memcmp(&data[FMT_INDEX], "fmt ", 4) != 0)
676 if (memcmp(&data[FMT_INDEX + waveformat.uiSize + 8], "data", 4) != 0)
679 if (waveformat.uiFormatTag != WAVE_FORMAT_PCM)
682 if (waveformat.ulSamplesPerSec !=
683 waveformat.ulAvgBytesPerSec / waveformat.uiBlockAlign)
686 m_data = new wxSoundData;
687 m_data->m_channels = waveformat.uiChannels;
688 m_data->m_samplingRate = waveformat.ulSamplesPerSec;
689 m_data->m_bitsPerSample = waveformat.uiBitsPerSample;
690 m_data->m_samples = ul / (m_data->m_channels * m_data->m_bitsPerSample / 8);
691 m_data->m_dataBytes = ul;
695 m_data->m_dataWithHeader = new wxUint8[length];
696 memcpy(m_data->m_dataWithHeader, data, length);
699 m_data->m_dataWithHeader = (wxUint8*)data;
702 (&m_data->m_dataWithHeader[FMT_INDEX + waveformat.uiSize + 8]);
708 // ----------------------------------------------------------------------------
709 // wxSoundCleanupModule
710 // ----------------------------------------------------------------------------
712 class wxSoundCleanupModule: public wxModule
715 bool OnInit() { return true; }
716 void OnExit() { wxSound::UnloadBackend(); }
717 DECLARE_DYNAMIC_CLASS(wxSoundCleanupModule)
720 IMPLEMENT_DYNAMIC_CLASS(wxSoundCleanupModule, wxModule)