src/sounddrv/sounddx.c

/*
 * sounddx.c - Implementation of the DirectSound sound device.
 *
 * Written by
 *  Tibor Biczo <crown@mail.matav.hu>
 *  Ettore Perazzoli <ettore@comm2000.it>
 *  Andreas Matthies <andreas.matthies@gmx.net>
 *  Marco van den Heuvel <blackystardust68@yahoo.com>
 *
 * This file is part of VICE, the Versatile Commodore Emulator.
 * See README for copyright notice.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307  USA.
 *
 */

#include "vice.h"

#ifdef USE_DXSOUND

#include <stdio.h>

#ifndef HAVE_GUIDLIB
#define INITGUID
#endif

#ifndef HAVE_DSOUND_LIB
#define _WIN32_DCOM
#endif

#include <windows.h>
#include <mmsystem.h>

#define DIRECTSOUND_VERSION 0x0500
#include <dsound.h>

#if defined(USE_SDLUI) || defined(USE_SDLUI2)
#define INCLUDE_SDL_SYSWM_H
#include "vice_sdl.h"
#endif

#include "lib.h"
#include "log.h"
#include "machine.h"
#include "sound.h"
#include "types.h"
#include "uiapi.h"

/* FIXME: each of the following should probably get moved to archdep */
#if defined(USE_SDLUI) || defined(USE_SDLUI2)

static HWND ui_get_main_hwnd(void)
{
    SDL_SysWMinfo info;

    SDL_GetWMInfo(&info);

    return info.window;
}

#elif defined(USE_NATIVE_GTK3)

#include <gtk/gtk.h>
#include <gdk/gdk.h>
#include <gdk/gdkwin32.h>
#include "ui.h"

static HWND ui_get_main_hwnd(void)
{
    GdkWindow *gdk_window = gtk_widget_get_window(ui_get_window_by_index(0));
    HWND hWnd = NULL;

    if (gdk_window) {
        if (gdk_window_ensure_native(gdk_window)) {
            hWnd = gdk_win32_window_get_impl_hwnd(gdk_window);
        }
    }

    /*
     * We could fallback to the desktop window - but we shouldn't have to!
     * DirectSound uses this window to figure out something to do with
     * how the sound device should be shared among multiple applications.
     * So I believe it's worth keeping the above in a state that works.
     * Which means better to get the bug report that the DirectSound
     * driver isn't working for someone.
     */
#if 0
    if (!hWnd) {
        hWnd = GetDesktopWindow();
    }
#endif

    return hWnd;
}

#else /* Headless UI */

static HWND ui_get_main_hwnd(void)
{
    return GetDesktopWindow();
}

#endif

/* ------------------------------------------------------------------------ */

#define DEBUG_SOUND 0

/* Debugging stuff.  */
#if DEBUG_SOUND
static void sound_debug(const char *format, ...)
{
    char tmp[1024];
    va_list args;

    va_start(args, format);
    vsprintf(tmp, format, args);
    va_end(args);
    log_debug(tmp);
}
#define SDEBUG(x) sound_debug x
#else
#define SDEBUG(x)
#endif

static char *ds_error(HRESULT result)
{
    static char tmp[0x20];
    switch (result) {
        case DSERR_ALLOCATED:
            return "Already allocated resource";
        case DSERR_CONTROLUNAVAIL:
            return "Control not available";
        case DSERR_INVALIDPARAM:
            return "Parameter not valid";
        case DSERR_INVALIDCALL:
            return "Call not valid";
        case DSERR_GENERIC:
            return "Generic error";
        case DSERR_PRIOLEVELNEEDED:
            return "Priority level needed";
        case DSERR_OUTOFMEMORY:
            return "Out of memory";
        case DSERR_BADFORMAT:
            return "Specified WAVE format not supported";
        case DSERR_UNSUPPORTED:
            return "Not supported";
        case DSERR_NODRIVER:
            return "No sound driver is available for use";
        case DSERR_ALREADYINITIALIZED:
            return "Object already initialized";
        case DSERR_NOAGGREGATION:
            return "Object does not support aggregation";
        case DSERR_BUFFERLOST:
            return "Buffer lost";
        case DSERR_OTHERAPPHASPRIO:
            return "Another app has a higher priority level";
        case DSERR_UNINITIALIZED:
            return "Object not initialized";
        case DSERR_NOINTERFACE:
            return "Requested COM interface is not available";
        default:
            break;
    }
    sprintf(tmp, "Error 0x%x", (unsigned int)result);
    return tmp;
}

/* ------------------------------------------------------------------------ */

/* DirectSound object.  */
static LPDIRECTSOUND ds = NULL;

/* Audio buffer.  */
static LPDIRECTSOUNDBUFFER buffer = NULL;
static LPDIRECTSOUNDBUFFER pbuffer = NULL;

/* Buffer offset.  */
static DWORD buffer_offset;

/* Buffer size.  */
static DWORD buffer_size;

/* Fragment size.  */
static int fragment_size;

/* Channels */
static int num_of_channels;

/* Expected buffer fill state: maximum amount. */
static int earlier_bufferspace;

/* Flag: are we in exclusive mode?  */
/* static int is_exclusive; */

#if 0
/*  DirectSoundNotify Interface, if present */
static LPDIRECTSOUNDNOTIFY notify;

typedef enum {
    STREAM_NOTIFY,
    STREAM_TIMER
} streammode_t;

/*  Flag: streaming mode */
static streammode_t streammode = STREAM_TIMER;

/*  Notify Position Array */
static DSBPOSITIONNOTIFY    *notifypositions;

/*  Notify Event */
static HANDLE notifyevent;

/*  End Event */
static HANDLE endevent;

/*  Event Table */
static HANDLE events[2];

/*  ID of Notify Thread */
static DWORD notifyThreadID;

/*  Handle of Notify Thread */
static HANDLE notifyThreadHandle;

/*  Pointer for waiting fragment */
static LPVOID fragment_pointer;
#endif

/*  Last played sample. This will be played in underflow condition */
static int16_t last_buffered_sample[2];

/*  Flag: is soundcard a 16bit or 8bit card? */
static int is16bit;

#if 0
/*  Streaming buffer */
static int16_t                *stream_buffer;

/*  Offset of first buffered sample */
static volatile int stream_buffer_first;

/*  Offset of last buffered sample */
static volatile int stream_buffer_last;

/*  Offset of first buffered sample in shadow counter */
static volatile DWORD stream_buffer_shadow_first;

/*  Offset of last buffered sample in shadow counter */
static volatile DWORD stream_buffer_shadow_last;
#endif

/*  Size of streaming buffer */
static int stream_buffer_size;

#if 0
/*  Timer callback interval */
static int timer_interval;

/*  ID of timer event */
static UINT timer_id;
#endif

/* ------------------------------------------------------------------------ */

DSBUFFERDESC desc;
PCMWAVEFORMAT pcmwf;
DSCAPS capabilities;
WAVEFORMATEX wfex;

HWND ui_get_main_hwnd(void);

static void dx_clear(void)
{
    LPVOID lpvPtr1;
    DWORD dwBytes1;
    LPVOID lpvPtr2;
    DWORD dwBytes2;
    HRESULT result;

    result = IDirectSoundBuffer_Lock(buffer, 0, buffer_size,
                                     &lpvPtr1, &dwBytes1, &lpvPtr2,
                                     &dwBytes2, 0);
    if (result == DSERR_BUFFERLOST) {
        IDirectSoundBuffer_Restore(buffer);
    } else {
        if (is16bit) {
            memset(lpvPtr1, 0, dwBytes1);
            if (lpvPtr2) {
                memset(lpvPtr2, 0, dwBytes2);
            }
        } else {
            memset(lpvPtr1, 0x80, dwBytes1);
            if (lpvPtr2) {
                memset(lpvPtr2, 0x80, dwBytes2);
            }
        }
        result = IDirectSoundBuffer_Unlock(buffer, lpvPtr1, dwBytes1,
                                           lpvPtr2, dwBytes2);
    }
}

static int dx_init(const char *param, int *speed, int *fragsize, int *fragnr,
                   int *channels)
{
    HRESULT result;

    SDEBUG(("DirectSound driver initialization: speed = %d, fragsize = %d, fragnr = %d, channels = %d\n",
           *speed, *fragsize, *fragnr, *channels));

    if (ds == NULL) {
#ifdef HAVE_DSOUND_LIB
        result = DirectSoundCreate(NULL, &ds, NULL);
#else
        result = CoCreateInstance(&CLSID_DirectSound, NULL, CLSCTX_INPROC_SERVER, &IID_IDirectSound, (PVOID*)&ds);
        if (result == S_OK) {
            result = IDirectSound_Initialize(ds, NULL);
        }
#endif
        if (result != DS_OK) {
            ui_error("Cannot initialize DirectSound:\n%s", ds_error(result));
            return -1;
        }

        if (console_mode || video_disabled_mode) {
            result = IDirectSound_SetCooperativeLevel(ds, GetForegroundWindow() ? GetForegroundWindow() : GetDesktopWindow(), DSSCL_PRIORITY);
        } else {
            result = IDirectSound_SetCooperativeLevel(ds, ui_get_main_hwnd(), DSSCL_PRIORITY);
        }

        if (result != DS_OK) {
            log_error(LOG_DEFAULT, "Cannot set cooperative level:\n%s", ds_error(result));
            return -1;
        }
    }

    memset(&capabilities, 0, sizeof(DSCAPS));
    capabilities.dwSize = sizeof(DSCAPS);

    IDirectSound_GetCaps(ds, &capabilities);
    if ((capabilities.dwFlags & DSCAPS_PRIMARY16BIT)
        || (capabilities.dwFlags & DSCAPS_SECONDARY16BIT)) {
        is16bit = 1;
    } else {
        is16bit = 0;
    }
    if (!((capabilities.dwFlags & DSCAPS_PRIMARYSTEREO) || (capabilities.dwFlags & DSCAPS_SECONDARYSTEREO))) {
        *channels = 1;
    }
    num_of_channels = *channels;

    SDEBUG(("16bit flag: %d", is16bit));
    SDEBUG(("Channels: %d", *channels));
    SDEBUG(("Capabilities %08x", capabilities.dwFlags));
    SDEBUG(("Secondary min Hz: %d", capabilities.dwMinSecondarySampleRate));
    SDEBUG(("Secondary max Hz: %d", capabilities.dwMaxSecondarySampleRate));

    memset(&pcmwf, 0, sizeof(PCMWAVEFORMAT));
    pcmwf.wf.wFormatTag = WAVE_FORMAT_PCM;
    pcmwf.wf.nChannels = *channels;
    pcmwf.wf.nSamplesPerSec = *speed;
    pcmwf.wBitsPerSample = is16bit ? 16 : 8;
/* Hack to fix if mmsystem header is bad
    ((WORD*)&pcmwf)[7] = 16;
*/
    pcmwf.wf.nBlockAlign = (is16bit ? 2 : 1) * *channels;
    pcmwf.wf.nAvgBytesPerSec = pcmwf.wf.nSamplesPerSec * pcmwf.wf.nBlockAlign;

    memset(&desc, 0, sizeof(DSBUFFERDESC));
    desc.dwSize = sizeof(DSBUFFERDESC);
    desc.dwFlags = DSBCAPS_PRIMARYBUFFER;

    fragment_size = *fragsize; /* frames */
    buffer_size = *fragsize * *fragnr * (is16bit ? 2 : 1) * *channels; /* bytes */
    stream_buffer_size = fragment_size * *fragnr * *channels; /* nr of samples */
    buffer_offset = 0; /* bytes */

    result = IDirectSound_CreateSoundBuffer(ds, &desc, &pbuffer, NULL);

    if (result != DS_OK) {
        ui_error("Cannot create Primary DirectSound bufer: %s",
                 ds_error(result));
        return -1;
    }

    memset(&desc, 0, sizeof(DSBUFFERDESC));
    desc.dwSize = sizeof(DSBUFFERDESC);
    desc.dwFlags = DSBCAPS_CTRLPOSITIONNOTIFY | DSBCAPS_GETCURRENTPOSITION2
                   | DSBCAPS_CTRLFREQUENCY | DSBCAPS_CTRLPAN
                   | DSBCAPS_CTRLVOLUME | DSBCAPS_GLOBALFOCUS;

    desc.dwBufferBytes = buffer_size;
    desc.lpwfxFormat = (LPWAVEFORMATEX)&pcmwf;

    result = IDirectSound_CreateSoundBuffer(ds, &desc, &buffer, NULL);
    if (result != DS_OK) {
        ui_error("Cannot create DirectSound buffer:\n%s", ds_error(result));
        return -1;
    }

    memset(&wfex, 0, sizeof(WAVEFORMATEX));
    wfex.wFormatTag = WAVE_FORMAT_PCM;
    wfex.nChannels = *channels;
    wfex.nSamplesPerSec = *speed;
    wfex.wBitsPerSample = is16bit ? 16 : 8;
    wfex.nBlockAlign = (is16bit ? 2 : 1) * *channels;
    wfex.nAvgBytesPerSec = wfex.nSamplesPerSec * wfex.nBlockAlign;

    result = IDirectSoundBuffer_SetFormat(pbuffer, &wfex);
    if (result != DS_OK) {
        ui_error("Cannot set Output format for primary sound buffer:\n%s",
                 ds_error(result));
        return -1;
    }

    dx_clear();
    /* Let's go...  */
    result = IDirectSoundBuffer_Play(buffer, 0, 0, DSBPLAY_LOOPING);
    if (result == DSERR_BUFFERLOST) {
        ui_error("Restoring DirectSound buffer.");
        if ((result = IDirectSoundBuffer_Restore(buffer)) != DS_OK) {
            ui_error("Cannot restore buffer:\n%s", ds_error(result));
        }
        result = IDirectSoundBuffer_Play(buffer, 0, 0, DSBPLAY_LOOPING);
    }
    if (result != DS_OK) {
        ui_error("Cannot play DirectSound buffer:\n%s", ds_error(result));
        return -1;
    }

    SDEBUG(("DirectSound initialization done succesfully.\n"));

    return 0;
}

static void dx_close(void)
{
    /*  Stop buffer play */
    if (ds == NULL) {
        return;
    }

    IDirectSoundBuffer_Stop(buffer);

    /*  Release buffer */
    IDirectSoundBuffer_Release(buffer);
    /*  Release DirectSoundObject */
    IDirectSound_Release(ds);
    buffer = NULL;
    ds = NULL;
}

static int dx_bufferspace(void)
{
    DWORD play_cursor;
    int free_samples, buffer_samples;

    IDirectSoundBuffer_GetCurrentPosition(buffer, &play_cursor, NULL);
    /* We should properly distinguish between buffer empty and buffer fill
     * case. However, it's absolutely essential that the state where play and
     * write cursors overlap is read as buffer being filled with data. */
    if (play_cursor < buffer_offset) {
        free_samples = buffer_size - (buffer_offset - play_cursor);
    } else {
        free_samples = play_cursor - buffer_offset;
    }

    SDEBUG(("play=%d, ourwrite=%d, free=%d", play_cursor, buffer_offset, free_samples));

    free_samples /= (is16bit ? 2 : 1) * num_of_channels;

    /* test for underrun condition. It generally looks like we suddenly we have
     * a filled buffer instead of nearly empty one, because the play cursor
     * stepped over the write cursor. We generally have sound core calling
     * bufferspace() with every write, so we can rely on frequent calls here.
     */
    buffer_samples = buffer_size / (is16bit ? 2 : 1) / num_of_channels;
    if (free_samples < fragment_size
        && earlier_bufferspace > buffer_samples - fragment_size) {
        /* don't trigger again */
        earlier_bufferspace = 0;
        /* report underrun */
        return buffer_samples;
    }
    earlier_bufferspace = free_samples;

    return free_samples;
}

static int dx_write(int16_t *pbuf, size_t nr)
{
    LPVOID lpvPtr1;
    DWORD dwBytes1;
    LPVOID lpvPtr2;
    DWORD dwBytes2;
    HRESULT result;
    DWORD buffer_lock_size; /* buffer_lock_end; */
    unsigned int i, count;

    count = (unsigned int)nr / fragment_size;
    buffer_lock_size = fragment_size * (is16bit ? 2 : 1);

    /* Write one fragment at a time.  FIXME: This could be faster.  */
    for (i = 0; i < count; i++) {
        /* lock buffer for writing */
        do {
            result = IDirectSoundBuffer_Lock(buffer, buffer_offset,
                                             buffer_lock_size,
                                             &lpvPtr1, &dwBytes1, &lpvPtr2,
                                             &dwBytes2, 0);

            if (result == DSERR_BUFFERLOST) {
                IDirectSoundBuffer_Restore(buffer);
                dwBytes1 = dwBytes2 = 0;
            }
        } while (dwBytes1 + dwBytes2 != buffer_lock_size);

        /* put data as-is, or convert to 8 bits first */
        if (is16bit) {
            memcpy(lpvPtr1, pbuf, dwBytes1);
            if (lpvPtr2) {
                memcpy(lpvPtr2, (BYTE *)pbuf + dwBytes1, dwBytes2);
            }
            pbuf += fragment_size;
        } else {
            for (i = 0; i < dwBytes1; i++) {
                ((BYTE *)lpvPtr1)[i] = (*(pbuf++) >> 8) + 0x80;
            }
            if (lpvPtr2 != NULL) {
                for (i = 0; i < dwBytes2; i++) {
                    ((BYTE *)lpvPtr2)[i] = (*(pbuf++) >> 8) + 0x80;
                }
            }
        }

        /* done. */
        result = IDirectSoundBuffer_Unlock(buffer, lpvPtr1, dwBytes1,
                                           lpvPtr2, dwBytes2);
        buffer_offset += buffer_lock_size;

        /* loop */
        if (buffer_offset == buffer_size) {
            buffer_offset = 0;
        }
    }

    pbuf -= num_of_channels;

    for (i = 0; i < (unsigned int)num_of_channels; i++) {
        last_buffered_sample[i] = *pbuf++;
    }

    return 0;
}

static int dx_suspend(void)
{
    int i;
    int16_t *p = lib_malloc(stream_buffer_size * sizeof(int16_t));

    if (!p) {
        return 0;
    }

    for (i = 0; i < stream_buffer_size; i++) {
        p[i] = last_buffered_sample[i % num_of_channels];
    }

    i = dx_write(p, stream_buffer_size);
    lib_free(p);

    return 0;
}


static int dx_resume(void)
{
    buffer_offset = 0;
    IDirectSoundBuffer_Play(buffer, 0, 0, DSBPLAY_LOOPING);
    return 0;
}

static sound_device_t dx_device =
{
    "dx",
    dx_init,
    dx_write,
    NULL,
    NULL,
    dx_bufferspace,
    dx_close,
    dx_suspend,
    dx_resume,
    0,
    2,           /* FIXME: should account for mono and stereo devices */
    true
};

int sound_init_dx_device(void)
{
    return sound_register_device(&dx_device);
}

#endif /*USE_DXSOUND*/