[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
/////////////////////////////////////////////////////////////////////////////

// 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 lenOrig = fileWave.Length();
    if ( lenOrig == wxInvalidOffset )
        return false;

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