[wxWidgets.git] / src / unix / sound.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        sound.cpp
// Purpose:     wxSound
// Author:      Marcel Rasche, Vaclav Slavik
// Modified by:
// Created:     25/10/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart, Open Source Applications Foundation
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "sound.h"
#pragma implementation "soundbase.h"
#endif

// for compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"

#include "wx/setup.h"

#if defined(__BORLANDC__)
#pragma hdrstop
#endif

#if wxUSE_SOUND

#include <stdio.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/ioctl.h>

#ifdef HAVE_SYS_SOUNDCARD_H
#include <sys/soundcard.h>
#endif

#ifndef WX_PRECOMP
    #include "wx/event.h"
    #include "wx/intl.h"
    #include "wx/log.h"
#endif

#include "wx/thread.h"
#include "wx/file.h"
#include "wx/module.h"
#include "wx/sound.h"
#include "wx/dynlib.h"


#if wxUSE_THREADS
// mutex for all wxSound's synchronization
static wxMutex gs_soundMutex;
#endif

// ----------------------------------------------------------------------------
// wxSoundData
// ----------------------------------------------------------------------------

void wxSoundData::IncRef()
{
#if wxUSE_THREADS
    wxMutexLocker locker(gs_soundMutex);
#endif
    m_refCnt++;
}

void wxSoundData::DecRef()
{
#if wxUSE_THREADS
    wxMutexLocker locker(gs_soundMutex);
#endif
    if (--m_refCnt == 0)
        delete this;
}

wxSoundData::~wxSoundData()
{
    delete[] m_dataWithHeader;
}


// ----------------------------------------------------------------------------
// wxSoundBackendNull, used in absence of audio API or card
// ----------------------------------------------------------------------------

class wxSoundBackendNull : public wxSoundBackend
{
public:
    wxString GetName() const { return _("No sound"); }
    int GetPriority() const { return 0; }
    bool IsAvailable() const { return true; }
    bool HasNativeAsyncPlayback() const { return true; }
    bool Play(wxSoundData *WXUNUSED(data), unsigned WXUNUSED(flags),
              volatile wxSoundPlaybackStatus *WXUNUSED(status))
        { return true; }
    void Stop() {}
    bool IsPlaying() const { return false; }
};


// ----------------------------------------------------------------------------
// wxSoundBackendOSS, for Linux
// ----------------------------------------------------------------------------

#ifdef HAVE_SYS_SOUNDCARD_H

#ifndef AUDIODEV
#define AUDIODEV   "/dev/dsp"    // Default path for audio device
#endif

class wxSoundBackendOSS : public wxSoundBackend
{
public:
    wxString GetName() const { return _T("Open Sound System"); }
    int GetPriority() const { return 10; }
    bool IsAvailable() const;
    bool HasNativeAsyncPlayback() const { return false; }
    bool Play(wxSoundData *data, unsigned flags,
              volatile wxSoundPlaybackStatus *status);
    void Stop() {}
    bool IsPlaying() const { return false; }

private:
    int OpenDSP(const wxSoundData *data);
    bool InitDSP(int dev, const wxSoundData *data);

    int m_DSPblkSize;        // Size of the DSP buffer
    bool m_needConversion;
};

bool wxSoundBackendOSS::IsAvailable() const
{
    int fd;
    fd = open(AUDIODEV, O_WRONLY | O_NONBLOCK);
    if (fd < 0)
        return false;
    close(fd);
    return true;
}

bool wxSoundBackendOSS::Play(wxSoundData *data, unsigned flags,
                             volatile wxSoundPlaybackStatus *status)
{
    int dev = OpenDSP(data);

    if (dev < 0)
        return false;

    ioctl(dev, SNDCTL_DSP_SYNC, 0);

    do
    {
        bool play = true;
        int i;
        unsigned l = 0;
        size_t datasize = data->m_dataBytes;

        do
        {
            if (status->m_stopRequested)
            {
                wxLogTrace(_T("sound"), _T("playback stopped"));
                close(dev);
                return true;
            }

            i= (int)((l + m_DSPblkSize) < datasize ?
                     m_DSPblkSize : (datasize - l));
            if (write(dev, &data->m_data[l], i) != i)
            {
                play = false;
            }
            l += i;
        } while (play && l < datasize);
    } while (flags & wxSOUND_LOOP);

    close(dev);
    return true;
}

int wxSoundBackendOSS::OpenDSP(const wxSoundData *data)
{
    int dev = -1;

    if ((dev = open(AUDIODEV, O_WRONLY, 0)) <0)
        return -1;

    if (!InitDSP(dev, data) || m_needConversion)
    {
        close(dev);
        return -1;
    }

    return dev;
}


bool wxSoundBackendOSS::InitDSP(int dev, const wxSoundData *data)
{
    unsigned tmp;

    // Reset the dsp
    if (ioctl(dev, SNDCTL_DSP_RESET, 0) < 0)
    {
        wxLogTrace(_T("sound"), _T("unable to reset dsp"));
        return false;
    }

    m_needConversion = false;

    tmp = data->m_bitsPerSample;
    if (ioctl(dev, SNDCTL_DSP_SAMPLESIZE, &tmp) < 0)
    {
        wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SAMPLESIZE)"));
        return false;
    }
    if (tmp != data->m_bitsPerSample)
    {
        wxLogTrace(_T("sound"),
                   _T("Unable to set DSP sample size to %d (wants %d)"),
                   data->m_bitsPerSample, tmp);
        m_needConversion = true;
    }

    unsigned stereo = data->m_channels == 1 ? 0 : 1;
    tmp = stereo;
    if (ioctl(dev, SNDCTL_DSP_STEREO, &tmp) < 0)
    {
        wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_STEREO)"));
        return false;
    }
    if (tmp != stereo)
    {
        wxLogTrace(_T("sound"), _T("Unable to set DSP to %s."), stereo?  _T("stereo"):_T("mono"));
        m_needConversion = true;
    }

    tmp = data->m_samplingRate;
    if (ioctl(dev, SNDCTL_DSP_SPEED, &tmp) < 0)
    {
        wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SPEED)"));
       return false;
    }
    if (tmp != data->m_samplingRate)
    {
        // If the rate the sound card is using is not within 1% of what the
        // data specified then override the data setting.  The only reason not
        // to always override this is because of clock-rounding
        // problems. Sound cards will sometimes use things like 44101 when you
        // ask for 44100.  No need overriding this and having strange output
        // file rates for something that we can't hear anyways.
        if (data->m_samplingRate - tmp > (tmp * .01) ||
            tmp - data->m_samplingRate > (tmp * .01)) {
            wxLogTrace(_T("sound"),
                       _T("Unable to set DSP sampling rate to %d (wants %d)"),
                       data->m_samplingRate, tmp);
            m_needConversion = true;
        }
    }

    // Do this last because some drivers can adjust the buffer sized based on
    // the sampling rate, etc.
    if (ioctl(dev, SNDCTL_DSP_GETBLKSIZE, &m_DSPblkSize) < 0)
    {
        wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_GETBLKSIZE)"));
        return false;
    }
    return true;
}

#endif // HAVE_SYS_SOUNDCARD_H

// ----------------------------------------------------------------------------
// wxSoundSyncOnlyAdaptor
// ----------------------------------------------------------------------------

#if wxUSE_THREADS

class wxSoundSyncOnlyAdaptor;

// this class manages asynchronous playback of audio if the backend doesn't
// support it natively (e.g. OSS backend)
class wxSoundAsyncPlaybackThread : public wxThread
{
public:
    wxSoundAsyncPlaybackThread(wxSoundSyncOnlyAdaptor *adaptor,
                              wxSoundData *data, unsigned flags)
        : wxThread(), m_adapt(adaptor), m_data(data), m_flags(flags) {}
    virtual ExitCode Entry();

protected:
    wxSoundSyncOnlyAdaptor *m_adapt;
    wxSoundData *m_data;
    unsigned m_flags;
};

#endif // wxUSE_THREADS

// This class turns wxSoundBackend that doesn't support asynchronous playback
// into one that does
class wxSoundSyncOnlyAdaptor : public wxSoundBackend
{
public:
    wxSoundSyncOnlyAdaptor(wxSoundBackend *backend)
        : m_backend(backend), m_playing(false) {}
    ~wxSoundSyncOnlyAdaptor()
    {
        delete m_backend;
    }
    wxString GetName() const
    {
        return m_backend->GetName();
    }
    int GetPriority() const
    {
        return m_backend->GetPriority();
    }
    bool IsAvailable() const
    {
        return m_backend->IsAvailable();
    }
    bool HasNativeAsyncPlayback() const
    {
        return true;
    }
    bool Play(wxSoundData *data, unsigned flags,
              volatile wxSoundPlaybackStatus *status);
    void Stop();
    bool IsPlaying() const;

private:
    friend class wxSoundAsyncPlaybackThread;

    wxSoundBackend *m_backend;
    bool m_playing;
#if wxUSE_THREADS
    // player thread holds this mutex and releases it after it finishes
    // playing, so that the main thread knows when it can play sound
    wxMutex m_mutexRightToPlay;
    wxSoundPlaybackStatus m_status;
#endif
};


#if wxUSE_THREADS
wxThread::ExitCode wxSoundAsyncPlaybackThread::Entry()
{
    m_adapt->m_backend->Play(m_data, m_flags & ~wxSOUND_ASYNC,
                             &m_adapt->m_status);

    m_data->DecRef();
    m_adapt->m_playing = false;
    m_adapt->m_mutexRightToPlay.Unlock();
    wxLogTrace(_T("sound"), _T("terminated async playback thread"));
    return 0;
}
#endif

bool wxSoundSyncOnlyAdaptor::Play(wxSoundData *data, unsigned flags,
                                  volatile wxSoundPlaybackStatus *status)
{
    Stop();
    if (flags & wxSOUND_ASYNC)
    {
#if wxUSE_THREADS
        m_mutexRightToPlay.Lock();
        m_status.m_playing = true;
        m_status.m_stopRequested = false;
        data->IncRef();
        wxThread *th = new wxSoundAsyncPlaybackThread(this, data, flags);
        th->Create();
        th->Run();
        wxLogTrace(_T("sound"), _T("launched async playback thread"));
        return true;
#else
        wxLogError(_("Unable to play sound asynchronously."));
        return false;
#endif
    }
    else
    {
#if wxUSE_THREADS
        m_mutexRightToPlay.Lock();
#endif
        bool rv = m_backend->Play(data, flags, status);
#if wxUSE_THREADS
        m_mutexRightToPlay.Unlock();
#endif
        return rv;
    }
}

void wxSoundSyncOnlyAdaptor::Stop()
{
    wxLogTrace(_T("sound"), _T("asking audio to stop"));

#if wxUSE_THREADS
    // tell the player thread (if running) to stop playback ASAP:
    m_status.m_stopRequested = true;

    // acquire the mutex to be sure no sound is being played, then
    // release it because we don't need it for anything (the effect of this
    // is that calling thread will wait until playback thread reacts to
    // our request to interrupt playback):
    m_mutexRightToPlay.Lock();
    m_mutexRightToPlay.Unlock();
    wxLogTrace(_T("sound"), _T("audio was stopped"));
#endif
}

bool wxSoundSyncOnlyAdaptor::IsPlaying() const
{
#if wxUSE_THREADS
    return m_status.m_playing;
#else
    return false;
#endif
}


// ----------------------------------------------------------------------------
// wxSound
// ----------------------------------------------------------------------------

wxSoundBackend *wxSound::ms_backend = NULL;

// FIXME - temporary, until we have plugins architecture
#if wxUSE_LIBSDL
    #if wxUSE_PLUGINS
        wxDynamicLibrary *wxSound::ms_backendSDL = NULL;
    #else
        extern "C" wxSoundBackend *wxCreateSoundBackendSDL();
    #endif
#endif

wxSound::wxSound() : m_data(NULL)
{
}

wxSound::wxSound(const wxString& sFileName, bool isResource) : m_data(NULL)
{
    Create(sFileName, isResource);
}

wxSound::wxSound(int size, const wxByte* data) : m_data(NULL)
{
    Create(size, data);
}

wxSound::~wxSound()
{
    Free();
}

bool wxSound::Create(const wxString& fileName, bool isResource)
{
    wxASSERT_MSG( !isResource,
             _T("Loading sound from resources is only supported on Windows") );

    Free();

    wxFile fileWave;
    if (!fileWave.Open(fileName, wxFile::read))
    {
        return false;
    }

    wxFileOffset len = fileWave.Length();
    wxUint8 *data = new wxUint8[len];
    if (fileWave.Read(data, len) != len)
    {
        wxLogError(_("Couldn't load sound data from '%s'."), fileName.c_str());
        return false;
    }

    if (!LoadWAV(data, len, false))
    {
        wxLogError(_("Sound file '%s' is in unsupported format."),
                   fileName.c_str());
        return false;
    }

    return true;
}

bool wxSound::Create(int size, const wxByte* data)
{
    wxASSERT( data != NULL );

    Free();
    if (!LoadWAV(data, size, true))
    {
        wxLogError(_("Sound data are in unsupported format."));
        return false;
    }
    return true;
}

/*static*/ void wxSound::EnsureBackend()
{
    if (!ms_backend)
    {
        // FIXME -- make this fully dynamic when plugins architecture is in
        // place
#if wxUSE_LIBSDL
        //if (!ms_backend)
        {
#if !wxUSE_PLUGINS
            ms_backend = wxCreateSoundBackendSDL();
#else
            wxString dllname;
            dllname.Printf(_T("%s/%s"),
                wxDynamicLibrary::GetPluginsDirectory().c_str(),
                wxDynamicLibrary::CanonicalizePluginName(
                    _T("sound_sdl"), wxDL_PLUGIN_BASE).c_str());
            wxLogTrace(_T("sound"),
                       _T("trying to load SDL plugin from '%s'..."),
                       dllname.c_str());
            wxLogNull null;
            ms_backendSDL = new wxDynamicLibrary(dllname, wxDL_NOW);
            if (!ms_backendSDL->IsLoaded())
            {
                wxDELETE(ms_backendSDL);
            }
            else
            {
                typedef wxSoundBackend *(*wxCreateSoundBackend_t)();
                wxDYNLIB_FUNCTION(wxCreateSoundBackend_t,
                                  wxCreateSoundBackendSDL, *ms_backendSDL);
                if (pfnwxCreateSoundBackendSDL)
                {
                    ms_backend = (*pfnwxCreateSoundBackendSDL)();
                }
            }
#endif
            if (ms_backend && !ms_backend->IsAvailable())
            {
                wxDELETE(ms_backend);
            }
        }
#endif

#ifdef HAVE_SYS_SOUNDCARD_H
        if (!ms_backend)
        {
            ms_backend = new wxSoundBackendOSS();
            if (!ms_backend->IsAvailable())
            {
                wxDELETE(ms_backend);
            }
        }
#endif

        if (!ms_backend)
            ms_backend = new wxSoundBackendNull();

        if (!ms_backend->HasNativeAsyncPlayback())
            ms_backend = new wxSoundSyncOnlyAdaptor(ms_backend);

        wxLogTrace(_T("sound"),
                   _T("using backend '%s'"), ms_backend->GetName().c_str());
    }
}

/*static*/ void wxSound::UnloadBackend()
{
    if (ms_backend)
    {
        wxLogTrace(_T("sound"), _T("unloading backend"));

        Stop();

        delete ms_backend;
        ms_backend = NULL;
#if wxUSE_LIBSDL && wxUSE_PLUGINS
        delete ms_backendSDL;
#endif
    }
}

bool wxSound::DoPlay(unsigned flags) const
{
    wxCHECK_MSG( IsOk(), false, _T("Attempt to play invalid wave data") );

    EnsureBackend();
    wxSoundPlaybackStatus status;
    status.m_playing = true;
    status.m_stopRequested = false;
    return ms_backend->Play(m_data, flags, &status);
}

/*static*/ void wxSound::Stop()
{
    if (ms_backend)
        ms_backend->Stop();
}

/*static*/ bool wxSound::IsPlaying()
{
    if (ms_backend)
        return ms_backend->IsPlaying();
    else
        return false;
}

void wxSound::Free()
{
    if (m_data)
        m_data->DecRef();
}

typedef struct
{
    wxUint32      uiSize;
    wxUint16      uiFormatTag;
    wxUint16      uiChannels;
    wxUint32      ulSamplesPerSec;
    wxUint32      ulAvgBytesPerSec;
    wxUint16      uiBlockAlign;
    wxUint16      uiBitsPerSample;
} WAVEFORMAT;

#define WAVE_FORMAT_PCM  1
#define WAVE_INDEX       8
#define FMT_INDEX       12

bool wxSound::LoadWAV(const wxUint8 *data, size_t length, bool copyData)
{
    WAVEFORMAT waveformat;
    wxUint32 ul;

    if (length < 32 + sizeof(WAVEFORMAT))
        return false;

    memcpy(&waveformat, &data[FMT_INDEX + 4], sizeof(WAVEFORMAT));
    waveformat.uiSize = wxUINT32_SWAP_ON_BE(waveformat.uiSize);
    waveformat.uiFormatTag = wxUINT16_SWAP_ON_BE(waveformat.uiFormatTag);
    waveformat.uiChannels = wxUINT16_SWAP_ON_BE(waveformat.uiChannels);
    waveformat.ulSamplesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulSamplesPerSec);
    waveformat.ulAvgBytesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulAvgBytesPerSec);
    waveformat.uiBlockAlign = wxUINT16_SWAP_ON_BE(waveformat.uiBlockAlign);
    waveformat.uiBitsPerSample = wxUINT16_SWAP_ON_BE(waveformat.uiBitsPerSample);

    if (memcmp(data, "RIFF", 4) != 0)
        return false;
    if (memcmp(&data[WAVE_INDEX], "WAVE", 4) != 0)
        return false;
    if (memcmp(&data[FMT_INDEX], "fmt ", 4) != 0)
        return false;
    if (memcmp(&data[FMT_INDEX + waveformat.uiSize + 8], "data", 4) != 0)
        return false;
    memcpy(&ul,&data[FMT_INDEX + waveformat.uiSize + 12], 4);
    ul = wxUINT32_SWAP_ON_BE(ul);

    //WAS: if (ul + FMT_INDEX + waveformat.uiSize + 16 != length)
    if (ul + FMT_INDEX + waveformat.uiSize + 16 > length)
        return false;

    if (waveformat.uiFormatTag != WAVE_FORMAT_PCM)
        return false;

    if (waveformat.ulSamplesPerSec !=
        waveformat.ulAvgBytesPerSec / waveformat.uiBlockAlign)
        return false;

    m_data = new wxSoundData;
    m_data->m_channels = waveformat.uiChannels;
    m_data->m_samplingRate = waveformat.ulSamplesPerSec;
    m_data->m_bitsPerSample = waveformat.uiBitsPerSample;
    m_data->m_samples = ul / (m_data->m_channels * m_data->m_bitsPerSample / 8);
    m_data->m_dataBytes = ul;

    if (copyData)
    {
        m_data->m_dataWithHeader = new wxUint8[length];
        memcpy(m_data->m_dataWithHeader, data, length);
    }
    else
        m_data->m_dataWithHeader = (wxUint8*)data;

    m_data->m_data =
        (&m_data->m_dataWithHeader[FMT_INDEX + waveformat.uiSize + 8]);

    return true;
}


// ----------------------------------------------------------------------------
// wxSoundCleanupModule
// ----------------------------------------------------------------------------

class wxSoundCleanupModule: public wxModule
{
public:
    bool OnInit() { return true; }
    void OnExit() { wxSound::UnloadBackend(); }
    DECLARE_DYNAMIC_CLASS(wxSoundCleanupModule)
};

IMPLEMENT_DYNAMIC_CLASS(wxSoundCleanupModule, wxModule)

#endif
Commit	Line	Data
9be32e8f VS	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: sound.cpp
	3	// Purpose: wxSound
	4	// Author: Marcel Rasche, Vaclav Slavik
	5	// Modified by:
	6	// Created: 25/10/98
	7	// RCS-ID: $Id$
f156e20c	8	// Copyright: (c) Julian Smart, Open Source Applications Foundation
f8a586e0	9	// Licence: wxWindows licence
9be32e8f VS	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
	13	#pragma implementation "sound.h"
	14	#pragma implementation "soundbase.h"
	15	#endif
	16
	17	// for compilers that support precompilation, includes "wx.h".
	18	#include "wx/wxprec.h"
	19
	20	#include "wx/setup.h"
	21
	22	#if defined(__BORLANDC__)
	23	#pragma hdrstop
	24	#endif
	25
f156e20c	26	#if wxUSE_SOUND
9be32e8f VS	27
	28	#include <stdio.h>
	29	#include <unistd.h>
	30	#include <fcntl.h>
	31	#include <sys/ioctl.h>
	32
83f7f12d	33	#ifdef HAVE_SYS_SOUNDCARD_H
9be32e8f VS	34	#include <sys/soundcard.h>
	35	#endif
	36
	37	#ifndef WX_PRECOMP
	38	#include "wx/event.h"
	39	#include "wx/intl.h"
	40	#include "wx/log.h"
	41	#endif
	42
	43	#include "wx/thread.h"
	44	#include "wx/file.h"
	45	#include "wx/module.h"
	46	#include "wx/sound.h"
	47	#include "wx/dynlib.h"
	48
83f7f12d VS	49
	50	#if wxUSE_THREADS
	51	// mutex for all wxSound's synchronization
	52	static wxMutex gs_soundMutex;
	53	#endif
	54
	55	// ----------------------------------------------------------------------------
	56	// wxSoundData
	57	// ----------------------------------------------------------------------------
f8a586e0	58
83f7f12d VS	59	void wxSoundData::IncRef()
	60	{
	61	#if wxUSE_THREADS
	62	wxMutexLocker locker(gs_soundMutex);
	63	#endif
	64	m_refCnt++;
	65	}
	66
	67	void wxSoundData::DecRef()
	68	{
	69	#if wxUSE_THREADS
	70	wxMutexLocker locker(gs_soundMutex);
	71	#endif
	72	if (--m_refCnt == 0)
	73	delete this;
	74	}
	75
	76	wxSoundData::~wxSoundData()
	77	{
	78	delete[] m_dataWithHeader;
	79	}
	80
	81
9be32e8f VS	82	// ----------------------------------------------------------------------------
	83	// wxSoundBackendNull, used in absence of audio API or card
	84	// ----------------------------------------------------------------------------
	85
	86	class wxSoundBackendNull : public wxSoundBackend
	87	{
	88	public:
	89	wxString GetName() const { return _("No sound"); }
	90	int GetPriority() const { return 0; }
	91	bool IsAvailable() const { return true; }
	92	bool HasNativeAsyncPlayback() const { return true; }
83f7f12d VS	93	bool Play(wxSoundData *WXUNUSED(data), unsigned WXUNUSED(flags),
83f7f12d VS	94	volatile wxSoundPlaybackStatus *WXUNUSED(status))
9be32e8f	95	{ return true; }
83f7f12d VS	96	void Stop() {}
83f7f12d VS	97	bool IsPlaying() const { return false; }
9be32e8f VS	98	};
	99
	100
	101	// ----------------------------------------------------------------------------
	102	// wxSoundBackendOSS, for Linux
	103	// ----------------------------------------------------------------------------
	104
	105	#ifdef HAVE_SYS_SOUNDCARD_H
	106
	107	#ifndef AUDIODEV
	108	#define AUDIODEV "/dev/dsp" // Default path for audio device
	109	#endif
	110
	111	class wxSoundBackendOSS : public wxSoundBackend
	112	{
	113	public:
	114	wxString GetName() const { return _T("Open Sound System"); }
	115	int GetPriority() const { return 10; }
	116	bool IsAvailable() const;
	117	bool HasNativeAsyncPlayback() const { return false; }
83f7f12d VS	118	bool Play(wxSoundData *data, unsigned flags,
	119	volatile wxSoundPlaybackStatus *status);
	120	void Stop() {}
	121	bool IsPlaying() const { return false; }
9be32e8f VS	122
	123	private:
	124	int OpenDSP(const wxSoundData *data);
544c4a3b	125	bool InitDSP(int dev, const wxSoundData *data);
f8a586e0	126
9be32e8f	127	int m_DSPblkSize; // Size of the DSP buffer
544c4a3b	128	bool m_needConversion;
9be32e8f VS	129	};
	130
	131	bool wxSoundBackendOSS::IsAvailable() const
	132	{
	133	int fd;
	134	fd = open(AUDIODEV, O_WRONLY \| O_NONBLOCK);
	135	if (fd < 0)
	136	return false;
	137	close(fd);
	138	return true;
	139	}
	140
83f7f12d VS	141	bool wxSoundBackendOSS::Play(wxSoundData *data, unsigned flags,
83f7f12d VS	142	volatile wxSoundPlaybackStatus *status)
9be32e8f VS	143	{
9be32e8f VS	144	int dev = OpenDSP(data);
f8a586e0	145
9be32e8f VS	146	if (dev < 0)
	147	return false;
	148
	149	ioctl(dev, SNDCTL_DSP_SYNC, 0);
544c4a3b	150
9be32e8f VS	151	do
	152	{
	153	bool play = true;
	154	int i;
	155	unsigned l = 0;
	156	size_t datasize = data->m_dataBytes;
	157
	158	do
	159	{
83f7f12d VS	160	if (status->m_stopRequested)
	161	{
	162	wxLogTrace(_T("sound"), _T("playback stopped"));
	163	close(dev);
	164	return true;
	165	}
	166
9be32e8f	167	i= (int)((l + m_DSPblkSize) < datasize ?
544c4a3b	168	m_DSPblkSize : (datasize - l));
9be32e8f VS	169	if (write(dev, &data->m_data[l], i) != i)
	170	{
	171	play = false;
	172	}
	173	l += i;
	174	} while (play && l < datasize);
	175	} while (flags & wxSOUND_LOOP);
f8a586e0	176
544c4a3b	177	close(dev);
9be32e8f VS	178	return true;
	179	}
	180
	181	int wxSoundBackendOSS::OpenDSP(const wxSoundData *data)
	182	{
	183	int dev = -1;
f8a586e0	184
9be32e8f VS	185	if ((dev = open(AUDIODEV, O_WRONLY, 0)) <0)
9be32e8f VS	186	return -1;
f8a586e0	187
544c4a3b	188	if (!InitDSP(dev, data) \|\| m_needConversion)
9be32e8f VS	189	{
	190	close(dev);
	191	return -1;
	192	}
	193
	194	return dev;
	195	}
	196
544c4a3b RD	197
544c4a3b RD	198	bool wxSoundBackendOSS::InitDSP(int dev, const wxSoundData *data)
9be32e8f	199	{
544c4a3b RD	200	unsigned tmp;
	201
	202	// Reset the dsp
	203	if (ioctl(dev, SNDCTL_DSP_RESET, 0) < 0)
	204	{
	205	wxLogTrace(_T("sound"), _T("unable to reset dsp"));
9be32e8f	206	return false;
544c4a3b RD	207	}
	208
	209	m_needConversion = false;
f8a586e0	210
544c4a3b RD	211	tmp = data->m_bitsPerSample;
	212	if (ioctl(dev, SNDCTL_DSP_SAMPLESIZE, &tmp) < 0)
	213	{
	214	wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SAMPLESIZE)"));
9be32e8f	215	return false;
544c4a3b RD	216	}
	217	if (tmp != data->m_bitsPerSample)
	218	{
	219	wxLogTrace(_T("sound"),
	220	_T("Unable to set DSP sample size to %d (wants %d)"),
	221	data->m_bitsPerSample, tmp);
	222	m_needConversion = true;
f8a586e0 RL	223	}
f8a586e0 RL	224
544c4a3b RD	225	unsigned stereo = data->m_channels == 1 ? 0 : 1;
	226	tmp = stereo;
	227	if (ioctl(dev, SNDCTL_DSP_STEREO, &tmp) < 0)
	228	{
	229	wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_STEREO)"));
9be32e8f	230	return false;
544c4a3b RD	231	}
	232	if (tmp != stereo)
	233	{
f8a586e0	234	wxLogTrace(_T("sound"), _T("Unable to set DSP to %s."), stereo? _T("stereo"):_T("mono"));
544c4a3b RD	235	m_needConversion = true;
	236	}
	237
	238	tmp = data->m_samplingRate;
	239	if (ioctl(dev, SNDCTL_DSP_SPEED, &tmp) < 0)
	240	{
	241	wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_SPEED)"));
	242	return false;
	243	}
	244	if (tmp != data->m_samplingRate)
	245	{
	246	// If the rate the sound card is using is not within 1% of what the
	247	// data specified then override the data setting. The only reason not
	248	// to always override this is because of clock-rounding
	249	// problems. Sound cards will sometimes use things like 44101 when you
	250	// ask for 44100. No need overriding this and having strange output
	251	// file rates for something that we can't hear anyways.
f8a586e0 RL	252	if (data->m_samplingRate - tmp > (tmp * .01) \|\|
	253	tmp - data->m_samplingRate > (tmp * .01)) {
	254	wxLogTrace(_T("sound"),
544c4a3b RD	255	_T("Unable to set DSP sampling rate to %d (wants %d)"),
	256	data->m_samplingRate, tmp);
	257	m_needConversion = true;
f8a586e0	258	}
544c4a3b RD	259	}
	260
	261	// Do this last because some drivers can adjust the buffer sized based on
	262	// the sampling rate, etc.
	263	if (ioctl(dev, SNDCTL_DSP_GETBLKSIZE, &m_DSPblkSize) < 0)
	264	{
	265	wxLogTrace(_T("sound"), _T("IOCTL failure (SNDCTL_DSP_GETBLKSIZE)"));
9be32e8f	266	return false;
544c4a3b	267	}
9be32e8f VS	268	return true;
9be32e8f VS	269	}
f8a586e0	270
9be32e8f VS	271	#endif // HAVE_SYS_SOUNDCARD_H
9be32e8f VS	272
9be32e8f	273	// ----------------------------------------------------------------------------
83f7f12d	274	// wxSoundSyncOnlyAdaptor
9be32e8f VS	275	// ----------------------------------------------------------------------------
	276
	277	#if wxUSE_THREADS
	278
83f7f12d	279	class wxSoundSyncOnlyAdaptor;
9be32e8f VS	280
	281	// this class manages asynchronous playback of audio if the backend doesn't
	282	// support it natively (e.g. OSS backend)
	283	class wxSoundAsyncPlaybackThread : public wxThread
	284	{
	285	public:
83f7f12d	286	wxSoundAsyncPlaybackThread(wxSoundSyncOnlyAdaptor *adaptor,
9be32e8f	287	wxSoundData *data, unsigned flags)
83f7f12d VS	288	: wxThread(), m_adapt(adaptor), m_data(data), m_flags(flags) {}
83f7f12d VS	289	virtual ExitCode Entry();
f8a586e0	290
9be32e8f	291	protected:
83f7f12d	292	wxSoundSyncOnlyAdaptor *m_adapt;
9be32e8f VS	293	wxSoundData *m_data;
	294	unsigned m_flags;
	295	};
	296
	297	#endif // wxUSE_THREADS
	298
83f7f12d VS	299	// This class turns wxSoundBackend that doesn't support asynchronous playback
	300	// into one that does
	301	class wxSoundSyncOnlyAdaptor : public wxSoundBackend
	302	{
	303	public:
	304	wxSoundSyncOnlyAdaptor(wxSoundBackend *backend)
	305	: m_backend(backend), m_playing(false) {}
	306	~wxSoundSyncOnlyAdaptor()
	307	{
	308	delete m_backend;
	309	}
	310	wxString GetName() const
	311	{
	312	return m_backend->GetName();
	313	}
	314	int GetPriority() const
	315	{
	316	return m_backend->GetPriority();
	317	}
	318	bool IsAvailable() const
	319	{
	320	return m_backend->IsAvailable();
	321	}
	322	bool HasNativeAsyncPlayback() const
	323	{
	324	return true;
	325	}
	326	bool Play(wxSoundData *data, unsigned flags,
	327	volatile wxSoundPlaybackStatus *status);
	328	void Stop();
	329	bool IsPlaying() const;
	330
	331	private:
	332	friend class wxSoundAsyncPlaybackThread;
	333
	334	wxSoundBackend *m_backend;
	335	bool m_playing;
	336	#if wxUSE_THREADS
	337	// player thread holds this mutex and releases it after it finishes
	338	// playing, so that the main thread knows when it can play sound
	339	wxMutex m_mutexRightToPlay;
	340	wxSoundPlaybackStatus m_status;
	341	#endif
	342	};
	343
	344
	345	#if wxUSE_THREADS
	346	wxThread::ExitCode wxSoundAsyncPlaybackThread::Entry()
	347	{
	348	m_adapt->m_backend->Play(m_data, m_flags & ~wxSOUND_ASYNC,
	349	&m_adapt->m_status);
	350
	351	m_data->DecRef();
	352	m_adapt->m_playing = false;
	353	m_adapt->m_mutexRightToPlay.Unlock();
	354	wxLogTrace(_T("sound"), _T("terminated async playback thread"));
	355	return 0;
	356	}
	357	#endif
	358
	359	bool wxSoundSyncOnlyAdaptor::Play(wxSoundData *data, unsigned flags,
	360	volatile wxSoundPlaybackStatus *status)
	361	{
	362	Stop();
363	if (flags & wxSOUND_ASYNC)
364	{
365	#if wxUSE_THREADS
366	m_mutexRightToPlay.Lock();
367	m_status.m_playing = true;
368	m_status.m_stopRequested = false;
369	data->IncRef();
370	wxThread *th = new wxSoundAsyncPlaybackThread(this, data, flags);
371	th->Create();
372	th->Run();
373	wxLogTrace(_T("sound"), _T("launched async playback thread"));
374	return true;
375	#else
376	wxLogError(_("Unable to play sound asynchronously."));
377	return false;
378	#endif
379	}
380	else
381	{
382	#if wxUSE_THREADS
383	m_mutexRightToPlay.Lock();
384	#endif
385	bool rv = m_backend->Play(data, flags, status);
386	#if wxUSE_THREADS
387	m_mutexRightToPlay.Unlock();
388	#endif
389	return rv;
390	}
391	}
392
393	void wxSoundSyncOnlyAdaptor::Stop()
394	{
395	wxLogTrace(_T("sound"), _T("asking audio to stop"));
f8a586e0	396
a333f34d	397	#if wxUSE_THREADS
83f7f12d VS	398	// tell the player thread (if running) to stop playback ASAP:
83f7f12d VS	399	m_status.m_stopRequested = true;
f8a586e0	400
83f7f12d VS	401	// acquire the mutex to be sure no sound is being played, then
	402	// release it because we don't need it for anything (the effect of this
	403	// is that calling thread will wait until playback thread reacts to
	404	// our request to interrupt playback):
	405	m_mutexRightToPlay.Lock();
	406	m_mutexRightToPlay.Unlock();
	407	wxLogTrace(_T("sound"), _T("audio was stopped"));
a333f34d	408	#endif
83f7f12d VS	409	}
	410
	411	bool wxSoundSyncOnlyAdaptor::IsPlaying() const
	412	{
a333f34d	413	#if wxUSE_THREADS
83f7f12d	414	return m_status.m_playing;
a333f34d	415	#else
8fbe65e9	416	return false;
a333f34d	417	#endif
83f7f12d VS	418	}
	419
	420
9be32e8f	421	// ----------------------------------------------------------------------------
f8a586e0	422	// wxSound
9be32e8f VS	423	// ----------------------------------------------------------------------------
	424
	425	wxSoundBackend *wxSound::ms_backend = NULL;
	426
	427	// FIXME - temporary, until we have plugins architecture
	428	#if wxUSE_LIBSDL
	429	#if wxUSE_PLUGINS
	430	wxDynamicLibrary *wxSound::ms_backendSDL = NULL;
	431	#else
	432	extern "C" wxSoundBackend *wxCreateSoundBackendSDL();
	433	#endif
	434	#endif
	435
	436	wxSound::wxSound() : m_data(NULL)
	437	{
	438	}
	439
	440	wxSound::wxSound(const wxString& sFileName, bool isResource) : m_data(NULL)
	441	{
	442	Create(sFileName, isResource);
	443	}
	444
	445	wxSound::wxSound(int size, const wxByte* data) : m_data(NULL)
	446	{
	447	Create(size, data);
	448	}
	449
	450	wxSound::~wxSound()
	451	{
	452	Free();
	453	}
	454
	455	bool wxSound::Create(const wxString& fileName, bool isResource)
	456	{
	457	wxASSERT_MSG( !isResource,
	458	_T("Loading sound from resources is only supported on Windows") );
f8a586e0	459
9be32e8f	460	Free();
f8a586e0	461
9be32e8f VS	462	wxFile fileWave;
9be32e8f VS	463	if (!fileWave.Open(fileName, wxFile::read))
f8a586e0 RL	464	{
	465	return false;
	466	}
9be32e8f	467
f8a586e0	468	wxFileOffset len = fileWave.Length();
9be32e8f VS	469	wxUint8 *data = new wxUint8[len];
	470	if (fileWave.Read(data, len) != len)
	471	{
	472	wxLogError(_("Couldn't load sound data from '%s'."), fileName.c_str());
	473	return false;
	474	}
	475
	476	if (!LoadWAV(data, len, false))
	477	{
	478	wxLogError(_("Sound file '%s' is in unsupported format."),
	479	fileName.c_str());
	480	return false;
	481	}
f8a586e0	482
9be32e8f VS	483	return true;
	484	}
	485
	486	bool wxSound::Create(int size, const wxByte* data)
	487	{
	488	wxASSERT( data != NULL );
	489
	490	Free();
	491	if (!LoadWAV(data, size, true))
	492	{
	493	wxLogError(_("Sound data are in unsupported format."));
	494	return false;
	495	}
	496	return true;
	497	}
	498
	499	/static/ void wxSound::EnsureBackend()
	500	{
	501	if (!ms_backend)
	502	{
	503	// FIXME -- make this fully dynamic when plugins architecture is in
	504	// place
9be32e8f	505	#if wxUSE_LIBSDL
3209f765	506	//if (!ms_backend)
9be32e8f VS	507	{
	508	#if !wxUSE_PLUGINS
	509	ms_backend = wxCreateSoundBackendSDL();
	510	#else
	511	wxString dllname;
	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'..."),
	518	dllname.c_str());
	519	wxLogNull null;
	520	ms_backendSDL = new wxDynamicLibrary(dllname, wxDL_NOW);
	521	if (!ms_backendSDL->IsLoaded())
	522	{
	523	wxDELETE(ms_backendSDL);
	524	}
	525	else
	526	{
	527	typedef wxSoundBackend (wxCreateSoundBackend_t)();
	528	wxDYNLIB_FUNCTION(wxCreateSoundBackend_t,
	529	wxCreateSoundBackendSDL, *ms_backendSDL);
	530	if (pfnwxCreateSoundBackendSDL)
	531	{
	532	ms_backend = (*pfnwxCreateSoundBackendSDL)();
	533	}
	534	}
	535	#endif
	536	if (ms_backend && !ms_backend->IsAvailable())
	537	{
	538	wxDELETE(ms_backend);
	539	}
	540	}
	541	#endif
	542
3209f765 VS	543	#ifdef HAVE_SYS_SOUNDCARD_H
	544	if (!ms_backend)
	545	{
	546	ms_backend = new wxSoundBackendOSS();
	547	if (!ms_backend->IsAvailable())
	548	{
	549	wxDELETE(ms_backend);
	550	}
	551	}
	552	#endif
	553
9be32e8f VS	554	if (!ms_backend)
	555	ms_backend = new wxSoundBackendNull();
	556
83f7f12d VS	557	if (!ms_backend->HasNativeAsyncPlayback())
	558	ms_backend = new wxSoundSyncOnlyAdaptor(ms_backend);
	559
9be32e8f VS	560	wxLogTrace(_T("sound"),
	561	_T("using backend '%s'"), ms_backend->GetName().c_str());
	562	}
	563	}
	564
	565	/static/ void wxSound::UnloadBackend()
	566	{
	567	if (ms_backend)
	568	{
	569	wxLogTrace(_T("sound"), _T("unloading backend"));
83f7f12d VS	570
83f7f12d VS	571	Stop();
f8a586e0	572
9be32e8f VS	573	delete ms_backend;
	574	ms_backend = NULL;
	575	#if wxUSE_LIBSDL && wxUSE_PLUGINS
	576	delete ms_backendSDL;
	577	#endif
	578	}
	579	}
	580
f156e20c	581	bool wxSound::DoPlay(unsigned flags) const
9be32e8f VS	582	{
	583	wxCHECK_MSG( IsOk(), false, _T("Attempt to play invalid wave data") );
	584
	585	EnsureBackend();
83f7f12d VS	586	wxSoundPlaybackStatus status;
	587	status.m_playing = true;
	588	status.m_stopRequested = false;
	589	return ms_backend->Play(m_data, flags, &status);
	590	}
9be32e8f	591
83f7f12d VS	592	/static/ void wxSound::Stop()
	593	{
	594	if (ms_backend)
	595	ms_backend->Stop();
	596	}
	597
	598	/static/ bool wxSound::IsPlaying()
	599	{
	600	if (ms_backend)
	601	return ms_backend->IsPlaying();
9be32e8f	602	else
83f7f12d	603	return false;
9be32e8f VS	604	}
	605
	606	void wxSound::Free()
	607	{
9be32e8f VS	608	if (m_data)
	609	m_data->DecRef();
	610	}
	611
	612	typedef struct
f8a586e0	613	{
9be32e8f VS	614	wxUint32 uiSize;
	615	wxUint16 uiFormatTag;
	616	wxUint16 uiChannels;
	617	wxUint32 ulSamplesPerSec;
	618	wxUint32 ulAvgBytesPerSec;
	619	wxUint16 uiBlockAlign;
	620	wxUint16 uiBitsPerSample;
83f7f12d	621	} WAVEFORMAT;
9be32e8f	622
9be32e8f VS	623	#define WAVE_FORMAT_PCM 1
	624	#define WAVE_INDEX 8
	625	#define FMT_INDEX 12
	626
	627	bool wxSound::LoadWAV(const wxUint8 *data, size_t length, bool copyData)
	628	{
	629	WAVEFORMAT waveformat;
	630	wxUint32 ul;
	631
	632	if (length < 32 + sizeof(WAVEFORMAT))
	633	return false;
	634
	635	memcpy(&waveformat, &data[FMT_INDEX + 4], sizeof(WAVEFORMAT));
	636	waveformat.uiSize = wxUINT32_SWAP_ON_BE(waveformat.uiSize);
	637	waveformat.uiFormatTag = wxUINT16_SWAP_ON_BE(waveformat.uiFormatTag);
	638	waveformat.uiChannels = wxUINT16_SWAP_ON_BE(waveformat.uiChannels);
	639	waveformat.ulSamplesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulSamplesPerSec);
	640	waveformat.ulAvgBytesPerSec = wxUINT32_SWAP_ON_BE(waveformat.ulAvgBytesPerSec);
	641	waveformat.uiBlockAlign = wxUINT16_SWAP_ON_BE(waveformat.uiBlockAlign);
	642	waveformat.uiBitsPerSample = wxUINT16_SWAP_ON_BE(waveformat.uiBitsPerSample);
	643
	644	if (memcmp(data, "RIFF", 4) != 0)
	645	return false;
	646	if (memcmp(&data[WAVE_INDEX], "WAVE", 4) != 0)
	647	return false;
	648	if (memcmp(&data[FMT_INDEX], "fmt ", 4) != 0)
	649	return false;
	650	if (memcmp(&data[FMT_INDEX + waveformat.uiSize + 8], "data", 4) != 0)
	651	return false;
	652	memcpy(&ul,&data[FMT_INDEX + waveformat.uiSize + 12], 4);
	653	ul = wxUINT32_SWAP_ON_BE(ul);
f8a586e0	654
9be32e8f VS	655	//WAS: if (ul + FMT_INDEX + waveformat.uiSize + 16 != length)
	656	if (ul + FMT_INDEX + waveformat.uiSize + 16 > length)
	657	return false;
f8a586e0	658
9be32e8f VS	659	if (waveformat.uiFormatTag != WAVE_FORMAT_PCM)
9be32e8f VS	660	return false;
f8a586e0 RL	661
f8a586e0 RL	662	if (waveformat.ulSamplesPerSec !=
9be32e8f VS	663	waveformat.ulAvgBytesPerSec / waveformat.uiBlockAlign)
9be32e8f VS	664	return false;
f8a586e0	665
9be32e8f VS	666	m_data = new wxSoundData;
	667	m_data->m_channels = waveformat.uiChannels;
	668	m_data->m_samplingRate = waveformat.ulSamplesPerSec;
	669	m_data->m_bitsPerSample = waveformat.uiBitsPerSample;
	670	m_data->m_samples = ul / (m_data->m_channels * m_data->m_bitsPerSample / 8);
	671	m_data->m_dataBytes = ul;
	672
	673	if (copyData)
	674	{
	675	m_data->m_dataWithHeader = new wxUint8[length];
	676	memcpy(m_data->m_dataWithHeader, data, length);
	677	}
	678	else
	679	m_data->m_dataWithHeader = (wxUint8*)data;
	680
f8a586e0	681	m_data->m_data =
9be32e8f VS	682	(&m_data->m_dataWithHeader[FMT_INDEX + waveformat.uiSize + 8]);
	683
	684	return true;
	685	}
	686
	687
	688	// ----------------------------------------------------------------------------
	689	// wxSoundCleanupModule
	690	// ----------------------------------------------------------------------------
	691
	692	class wxSoundCleanupModule: public wxModule
	693	{
	694	public:
	695	bool OnInit() { return true; }
	696	void OnExit() { wxSound::UnloadBackend(); }
	697	DECLARE_DYNAMIC_CLASS(wxSoundCleanupModule)
	698	};
	699
	700	IMPLEMENT_DYNAMIC_CLASS(wxSoundCleanupModule, wxModule)
	701
	702	#endif