yate/modules/dsoundchan.cpp

701 lines
19 KiB
C++

/**
* dsoundchan.cpp
* This file is part of the YATE Project http://YATE.null.ro
*
* DirectSound channel driver for Windows.
*
* Yet Another Telephony Engine - a fully featured software PBX and IVR
* Copyright (C) 2004-2006 Null Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/
// define DCOM before including windows.h so advanced COM functions can be compiled
#define _WIN32_DCOM
#include <yatephone.h>
#ifndef _WINDOWS
#error This module is only for Windows
#else
#include <string.h>
// initialize the GUIDs so we don't need to link against dsound.lib
#include <initguid.h>
#include <dsound.h>
using namespace TelEngine;
namespace { // anonymous
// we should use the primary sound buffer else we will lose sound while we have no input focus
static bool s_primary = true;
// 20ms minimum chunk, 100ms buffer
#define CHUNK_SIZE 320
static unsigned int s_chunk = CHUNK_SIZE;
static unsigned int s_minsize = 2*CHUNK_SIZE;
static unsigned int s_bufsize = 4*CHUNK_SIZE;
static unsigned int s_maxsize = 5*CHUNK_SIZE;
class DSoundSource : public DataSource
{
friend class DSoundRec;
public:
DSoundSource();
~DSoundSource();
private:
DSoundRec* m_dsound;
};
class DSoundConsumer : public DataConsumer
{
friend class DSoundPlay;
public:
DSoundConsumer();
~DSoundConsumer();
virtual void Consume(const DataBlock &data, unsigned long tStamp);
private:
DSoundPlay* m_dsound;
};
// all DirectSound play related objects are created in this thread's apartment
class DSoundPlay : public Thread, public Mutex
{
public:
DSoundPlay(DSoundConsumer* owner, LPGUID device = 0);
virtual ~DSoundPlay();
virtual void run();
virtual void cleanup();
bool init();
inline void terminate()
{ m_owner = 0; }
inline LPDIRECTSOUND dsound() const
{ return m_ds; }
inline LPDIRECTSOUNDBUFFER buffer() const
{ return m_dsb; }
void put(const DataBlock& data);
private:
DSoundConsumer* m_owner;
LPGUID m_device;
LPDIRECTSOUND m_ds;
LPDIRECTSOUNDBUFFER m_dsb;
DWORD m_buffSize;
DataBlock m_buf;
u_int64_t m_start;
u_int64_t m_total;
};
// all DirectSound record related objects are created in this thread's apartment
class DSoundRec : public Thread
{
public:
DSoundRec(DSoundSource* owner, LPGUID device = 0);
virtual ~DSoundRec();
virtual void run();
virtual void cleanup();
bool init();
inline void terminate()
{ m_owner = 0; Thread::msleep(10); }
inline LPDIRECTSOUNDCAPTURE dsound() const
{ return m_ds; }
inline LPDIRECTSOUNDCAPTUREBUFFER buffer() const
{ return m_dsb; }
private:
DSoundSource* m_owner;
LPGUID m_device;
LPDIRECTSOUNDCAPTURE m_ds;
LPDIRECTSOUNDCAPTUREBUFFER m_dsb;
DWORD m_buffSize;
DWORD m_readPos;
u_int64_t m_start;
u_int64_t m_total;
};
class DSoundChan : public Channel
{
public:
DSoundChan();
virtual ~DSoundChan();
};
class AttachHandler : public MessageHandler
{
public:
AttachHandler() : MessageHandler("chan.attach")
{ }
virtual bool received(Message &msg);
};
class SoundDriver : public Driver
{
friend class DSoundPlay;
friend class DSoundRec;
public:
SoundDriver();
~SoundDriver();
virtual void initialize();
virtual bool msgExecute(Message& msg, String& dest);
private:
AttachHandler* m_handler;
};
INIT_PLUGIN(SoundDriver);
DSoundPlay::DSoundPlay(DSoundConsumer* owner, LPGUID device)
: Thread("DirectSound Play",High),
m_owner(owner), m_device(device), m_ds(0), m_dsb(0),
m_buffSize(0), m_start(0), m_total(0)
{
}
DSoundPlay::~DSoundPlay()
{
if (m_owner)
m_owner->m_dsound = 0;
if (m_start && m_total) {
unsigned int rate = (unsigned int)(m_total * 1000000 / (Time::now() - m_start));
Debug(&__plugin,DebugInfo,"DSoundPlay transferred %u bytes/s, total " FMT64U,rate,m_total);
}
}
bool DSoundPlay::init()
{
HRESULT hr;
if (FAILED(hr = ::CoInitializeEx(NULL,COINIT_MULTITHREADED))) {
Debug(DebugGoOn,"Could not initialize the COM library, code 0x%X",hr);
return false;
}
if (FAILED(hr = ::CoCreateInstance(CLSID_DirectSound, NULL, CLSCTX_INPROC_SERVER,
IID_IDirectSound, (void**)&m_ds)) || !m_ds) {
Debug(DebugGoOn,"Could not create the DirectSound object, code 0x%X",hr);
return false;
}
if (FAILED(hr = m_ds->Initialize(m_device))) {
Debug(DebugGoOn,"Could not initialize the DirectSound object, code 0x%X",hr);
return false;
}
HWND wnd = GetForegroundWindow();
if (!wnd)
wnd = GetDesktopWindow();
if (FAILED(hr = m_ds->SetCooperativeLevel(wnd,s_primary ? DSSCL_WRITEPRIMARY : DSSCL_EXCLUSIVE))) {
Debug(DebugGoOn,"Could not set the DirectSound cooperative level, code 0x%X",hr);
return false;
}
WAVEFORMATEX fmt;
fmt.wFormatTag = WAVE_FORMAT_PCM;
fmt.nChannels = 1;
fmt.nSamplesPerSec = 8000;
fmt.nAvgBytesPerSec = 16000;
fmt.nBlockAlign = 2;
fmt.wBitsPerSample = 16;
fmt.cbSize = 0;
DSBUFFERDESC bdesc;
ZeroMemory(&bdesc, sizeof(bdesc));
bdesc.dwSize = sizeof(bdesc);
if (s_primary)
bdesc.dwFlags = DSBCAPS_PRIMARYBUFFER | DSBCAPS_STICKYFOCUS;
else {
bdesc.dwFlags = DSBCAPS_GLOBALFOCUS;
// we have to set format when creating secondary buffers
bdesc.dwBufferBytes = s_bufsize;
bdesc.lpwfxFormat = &fmt;
}
if (FAILED(hr = m_ds->CreateSoundBuffer(&bdesc, &m_dsb, NULL)) || !m_dsb) {
Debug(DebugGoOn,"Could not create the DirectSound buffer, code 0x%X",hr);
return false;
}
// format can be changed only for primary buffers
if (s_primary && FAILED(hr = m_dsb->SetFormat(&fmt))) {
Debug(DebugGoOn,"Could not set the DirectSound buffer format, code 0x%X",hr);
return false;
}
if (FAILED(hr = m_dsb->GetFormat(&fmt,sizeof(fmt),0))) {
Debug(DebugGoOn,"Could not get the DirectSound buffer format, code 0x%X",hr);
return false;
}
if ((fmt.wFormatTag != WAVE_FORMAT_PCM) ||
(fmt.nChannels != 1) ||
(fmt.nSamplesPerSec != 8000) ||
(fmt.wBitsPerSample != 16)) {
Debug(DebugGoOn,"DirectSound does not support 8000Hz 16bit mono PCM format, "
"got fmt=%u, chans=%d samp=%d size=%u",
fmt.wFormatTag,fmt.nChannels,fmt.nSamplesPerSec,fmt.wBitsPerSample);
return false;
}
DSBCAPS caps;
caps.dwSize = sizeof(caps);
if (FAILED(hr = m_dsb->GetCaps(&caps))) {
Debug(DebugGoOn,"Could not get the DirectSound buffer capabilities, code 0x%X",hr);
return false;
}
m_buffSize = caps.dwBufferBytes;
Debug(&__plugin,DebugInfo,"DirectSound buffer size %u",m_buffSize);
if (FAILED(hr = m_dsb->Play(0,0,DSBPLAY_LOOPING))) {
if ((hr != DSERR_BUFFERLOST) || FAILED(hr = m_dsb->Restore())) {
Debug(DebugGoOn,"Could not play the DirectSound buffer, code 0x%X",hr);
return false;
}
m_dsb->Play(0,0,DSBPLAY_LOOPING);
}
return true;
}
void DSoundPlay::run()
{
if (!init())
return;
if (m_owner)
m_owner->m_dsound = this;
DWORD writeOffs = 0;
bool first = true;
Debug(&__plugin,DebugInfo,"DSoundPlay is initialized and running");
while (m_owner) {
msleep(1,true);
if (first) {
if (m_buf.length() < s_minsize)
continue;
first = false;
m_dsb->GetCurrentPosition(NULL,&writeOffs);
writeOffs = (s_chunk/4 + writeOffs) % m_buffSize;
Debug(&__plugin,DebugAll,"DSoundPlay has %u in buffer and starts playing at %u",
m_buf.length(),writeOffs);
m_start = Time::now();
}
while (m_dsb && (m_buf.length() >= s_chunk)) {
DWORD playPos = 0;
DWORD writePos = 0;
bool adjust = false;
// check if we slipped behind and advance our pointer if so
if (SUCCEEDED(m_dsb->GetCurrentPosition(&playPos,&writePos))) {
if (playPos < writePos)
// not wrapped - have to adjust if our pointer falls between play and write
adjust = (playPos < writeOffs) && (writeOffs < writePos);
else
// only write offset has wrapped - adjust if we are outside
adjust = (writeOffs < writePos) || (playPos <= writeOffs) ;
}
if (adjust) {
DWORD adjOffs = (s_chunk/4 + writePos) % m_buffSize;
Debug(&__plugin,DebugInfo,"Slip detected, changing write offs from %u to %u, p=%u w=%u",
writeOffs,adjOffs,playPos,writePos);
writeOffs = adjOffs;
}
void* buf = 0;
void* buf2 = 0;
DWORD len = 0;
DWORD len2 = 0;
// locking will prevent us to skip ahead and overwrite the play position
HRESULT hr = m_dsb->Lock(writeOffs,s_chunk,&buf,&len,&buf2,&len2,0);
if (FAILED(hr)) {
writeOffs = 0;
if ((hr == DSERR_BUFFERLOST) && SUCCEEDED(m_dsb->Restore())) {
m_dsb->Play(0,0,DSBPLAY_LOOPING);
m_dsb->GetCurrentPosition(NULL,&writeOffs);
writeOffs = (s_chunk/4 + writeOffs) % m_buffSize;
Debug(&__plugin,DebugAll,"DirectSound buffer lost and restored, playing at %u",
writeOffs);
}
else {
lock();
m_buf.clear();
unlock();
}
continue;
}
lock();
::memcpy(buf,m_buf.data(),len);
if (buf2)
::memcpy(buf2,((const char*)m_buf.data())+len,len2);
m_dsb->Unlock(buf,len,buf2,len2);
writeOffs += s_chunk;
if (writeOffs >= m_buffSize)
writeOffs -= m_buffSize;
m_total += s_chunk;
m_buf.cut(-(int)s_chunk);
unlock();
XDebug(&__plugin,DebugAll,"Locked %p,%d %p,%d",buf,len,buf2,len2);
}
}
}
void DSoundPlay::cleanup()
{
Debug(DebugInfo,"DSoundPlay cleaning up");
if (m_dsb) {
m_dsb->Stop();
m_dsb->Release();
m_dsb = 0;
}
if (m_ds) {
m_ds->Release();
m_ds = 0;
}
::CoUninitialize();
}
void DSoundPlay::put(const DataBlock& data)
{
if (!m_dsb)
return;
lock();
if (m_buf.length() + data.length() <= s_maxsize)
m_buf += data;
else
Debug(&__plugin,DebugMild,"DSoundPlay skipped %u bytes, buffer is full",data.length());
unlock();
}
DSoundRec::DSoundRec(DSoundSource* owner, LPGUID device)
: Thread("DirectSound Rec",High),
m_owner(owner), m_device(device), m_ds(0), m_dsb(0),
m_buffSize(0), m_readPos(0), m_start(0), m_total(0)
{
}
DSoundRec::~DSoundRec()
{
if (m_owner)
m_owner->m_dsound = 0;
if (m_start && m_total) {
unsigned int rate = (unsigned int)(m_total * 1000000 / (Time::now() - m_start));
Debug(&__plugin,DebugInfo,"DSoundRec transferred %u bytes/s, total " FMT64U,rate,m_total);
}
}
bool DSoundRec::init()
{
HRESULT hr;
if (FAILED(hr = ::CoInitializeEx(NULL,COINIT_MULTITHREADED))) {
Debug(DebugGoOn,"Could not initialize the COM library, code 0x%X",hr);
return false;
}
if (FAILED(hr = ::CoCreateInstance(CLSID_DirectSoundCapture, NULL, CLSCTX_INPROC_SERVER,
IID_IDirectSoundCapture, (void**)&m_ds)) || !m_ds) {
Debug(DebugGoOn,"Could not create the DirectSoundCapture object, code 0x%X",hr);
return false;
}
if (FAILED(hr = m_ds->Initialize(m_device))) {
Debug(DebugGoOn,"Could not initialize the DirectSoundCapture object, code 0x%X",hr);
return false;
}
WAVEFORMATEX fmt;
fmt.wFormatTag = WAVE_FORMAT_PCM;
fmt.nChannels = 1;
fmt.nSamplesPerSec = 8000;
fmt.nAvgBytesPerSec = 16000;
fmt.nBlockAlign = 2;
fmt.wBitsPerSample = 16;
fmt.cbSize = 0;
DSCBUFFERDESC bdesc;
ZeroMemory(&bdesc, sizeof(bdesc));
bdesc.dwSize = sizeof(bdesc);
bdesc.dwFlags = DSCBCAPS_WAVEMAPPED;
bdesc.dwBufferBytes = s_bufsize;
bdesc.lpwfxFormat = &fmt;
if (FAILED(hr = m_ds->CreateCaptureBuffer(&bdesc, &m_dsb, NULL)) || !m_dsb) {
Debug(DebugGoOn,"Could not create the DirectSoundCapture buffer, code 0x%X",hr);
return false;
}
if (FAILED(hr = m_dsb->GetFormat(&fmt,sizeof(fmt),0))) {
Debug(DebugGoOn,"Could not get the DirectSoundCapture buffer format, code 0x%X",hr);
return false;
}
if ((fmt.wFormatTag != WAVE_FORMAT_PCM) ||
(fmt.nChannels != 1) ||
(fmt.nSamplesPerSec != 8000) ||
(fmt.wBitsPerSample != 16)) {
Debug(DebugGoOn,"DirectSoundCapture does not support 8000Hz 16bit mono PCM format, "
"got fmt=%u, chans=%d samp=%d size=%u",
fmt.wFormatTag,fmt.nChannels,fmt.nSamplesPerSec,fmt.wBitsPerSample);
return false;
}
DSCBCAPS caps;
caps.dwSize = sizeof(caps);
if (FAILED(hr = m_dsb->GetCaps(&caps))) {
Debug(DebugGoOn,"Could not get the DirectSoundCapture buffer capabilities, code 0x%X",hr);
return false;
}
m_buffSize = caps.dwBufferBytes;
Debug(&__plugin,DebugInfo,"DirectSoundCapture buffer size %u",m_buffSize);
if (FAILED(hr = m_dsb->Start(DSCBSTART_LOOPING))) {
Debug(DebugGoOn,"Could not record to the DirectSoundCapture buffer, code 0x%X",hr);
return false;
}
return true;
}
void DSoundRec::run()
{
if (!init())
return;
if (m_owner)
m_owner->m_dsound = this;
Debug(&__plugin,DebugInfo,"DSoundRec is initialized and running");
m_start = Time::now();
while (m_owner) {
msleep(1,true);
if (m_dsb) {
DWORD pos = 0;
if (FAILED(m_dsb->GetCurrentPosition(0,&pos)))
continue;
if (pos < m_readPos)
pos += m_buffSize;
pos -= m_readPos;
if (pos < s_chunk)
continue;
void* buf = 0;
void* buf2 = 0;
DWORD len = 0;
DWORD len2 = 0;
if (FAILED(m_dsb->Lock(m_readPos,s_chunk,&buf,&len,&buf2,&len2,0)))
continue;
DataBlock data(0,len+len2);
::memcpy(data.data(),buf,len);
if (buf2)
::memcpy(((char*)data.data())+len,buf2,len2);
m_dsb->Unlock(buf,len,buf2,len2);
m_total += (len+len2);
m_readPos += (len+len2);
if (m_readPos >= m_buffSize)
m_readPos -= m_buffSize;
if (m_owner)
m_owner->Forward(data);
}
}
}
void DSoundRec::cleanup()
{
Debug(&__plugin,DebugInfo,"DSoundRec cleaning up");
if (m_dsb) {
m_dsb->Stop();
m_dsb->Release();
m_dsb = 0;
}
if (m_ds) {
m_ds->Release();
m_ds = 0;
}
::CoUninitialize();
}
DSoundSource::DSoundSource()
: m_dsound(0)
{
DSoundRec* ds = new DSoundRec(this);
ds->startup();
}
DSoundSource::~DSoundSource()
{
if (m_dsound)
m_dsound->terminate();
}
DSoundConsumer::DSoundConsumer()
: m_dsound(0)
{
DSoundPlay* ds = new DSoundPlay(this);
ds->startup();
}
DSoundConsumer::~DSoundConsumer()
{
if (m_dsound)
m_dsound->terminate();
}
void DSoundConsumer::Consume(const DataBlock &data, unsigned long tStamp)
{
if (m_dsound)
m_dsound->put(data);
}
DSoundChan::DSoundChan()
: Channel(__plugin)
{
Debug(this,DebugAll,"DSoundChan::DSoundChan() [%p]",this);
setConsumer(new DSoundConsumer);
getConsumer()->deref();
Thread::msleep(50);
setSource(new DSoundSource);
getSource()->deref();
Thread::msleep(50);
}
DSoundChan::~DSoundChan()
{
Debug(this,DebugAll,"DSoundChan::~DSoundChan() [%p]",this);
}
bool AttachHandler::received(Message &msg)
{
int more = 2;
String src(msg.getValue("source"));
if (src.null())
more--;
else if (!src.startSkip("dsound/",false))
src = "";
String cons(msg.getValue("consumer"));
if (cons.null())
more--;
else if (!cons.startSkip("dsound/",false))
cons = "";
if (src.null() && cons.null())
return false;
DataEndpoint *dd = static_cast<DataEndpoint*>(msg.userObject("DataEndpoint"));
if (!dd) {
CallEndpoint *ch = static_cast<CallEndpoint*>(msg.userObject("CallEndpoint"));
if (ch)
dd = ch->setEndpoint();
}
if (!dd) {
Debug(&__plugin,DebugWarn,"DSound attach request with no control or data channel!");
return false;
}
if (cons) {
DSoundConsumer* c = new DSoundConsumer;
dd->setConsumer(c);
c->deref();
Thread::msleep(50);
}
if (src) {
DSoundSource* s = new DSoundSource;
dd->setSource(s);
s->deref();
Thread::msleep(50);
}
// Stop dispatching if we handled all requested
return !more;
}
bool SoundDriver::msgExecute(Message& msg, String& dest)
{
CallEndpoint* ch = static_cast<CallEndpoint*>(msg.userData());
if (ch) {
DSoundChan *ds = new DSoundChan;
if (ch->connect(ds,msg.getValue("reason"))) {
msg.setParam("peerid",ds->id());
ds->deref();
}
else {
ds->destruct();
return false;
}
}
else {
Message m("call.route");
m.addParam("module",name());
String callto(msg.getValue("direct"));
if (callto.null()) {
const char *targ = msg.getValue("target");
if (!targ) {
Debug(&__plugin,DebugWarn,"DSound outgoing call with no target!");
return false;
}
callto = msg.getValue("caller");
if (callto.null())
callto << prefix() << dest;
m.addParam("called",targ);
m.addParam("caller",callto);
if (!Engine::dispatch(m)) {
Debug(&__plugin,DebugWarn,"DSound outgoing call but no route!");
return false;
}
callto = m.retValue();
m.retValue().clear();
}
m = "call.execute";
m.addParam("callto",callto);
DSoundChan *ds = new DSoundChan;
m.setParam("targetid",ds->id());
m.userData(ds);
if (Engine::dispatch(m)) {
ds->deref();
return true;
}
Debug(&__plugin,DebugWarn,"DSound outgoing call not accepted!");
ds->destruct();
return false;
}
return true;
}
SoundDriver::SoundDriver()
: Driver("dsound","misc"),
m_handler(0)
{
Output("Loaded module DirectSound");
}
SoundDriver::~SoundDriver()
{
Output("Unloading module DirectSound");
channels().clear();
}
void SoundDriver::initialize()
{
Output("Initializing module DirectSound");
setup(0,true); // no need to install notifications
Driver::initialize();
if (!m_handler) {
Configuration cfg(Engine::configFile("dsoundchan"));
s_chunk = cfg.getIntValue("general","chunk",CHUNK_SIZE);
// make sure the chunk is even sized and has some decent limits (20-50 ms)
s_chunk &= ~1;
if (s_chunk < 320)
s_chunk = 320;
if (s_chunk > 800)
s_chunk = 800;
s_minsize = cfg.getIntValue("general","minsize",2*s_chunk);
s_bufsize = cfg.getIntValue("general","bufsize",4*s_chunk);
s_maxsize = cfg.getIntValue("general","maxsize",5*s_chunk);
// the buffer MUST hold at least one chunk and about 15ms of audio - we allow 30
if (s_bufsize < s_chunk + 480)
s_bufsize = s_chunk + 480;
// also keep it under 2s and even sized
if (s_bufsize > 32000)
s_bufsize = 32000;
s_bufsize &= ~1;
// make sure playback can ever start
if (s_minsize > s_bufsize - s_chunk)
s_minsize = s_bufsize - s_chunk;
// and that we don't do stupid drops
if (s_maxsize < s_bufsize + s_chunk)
s_maxsize = s_bufsize + s_chunk;
// prefer primary buffer as we try to retain control of audio board
s_primary = cfg.getBoolValue("general","primary",true);
m_handler = new AttachHandler;
Engine::install(m_handler);
}
}
}; // anonymous namespace
#endif /* _WINDOWS */
/* vi: set ts=8 sw=4 sts=4 noet: */