b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/* $Id$ */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** @file
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * VBox audio: TODO
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/*
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * Copyright (C) 2014-2015 Oracle Corporation
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin *
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * This file is part of VirtualBox Open Source Edition (OSE), as
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * available from http://www.virtualbox.org. This file is free software;
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * you can redistribute it and/or modify it under the terms of the GNU
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * General Public License (GPL) as published by the Free Software
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * Foundation, in version 2 as it comes in the "COPYING" file of the
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#ifndef AUDIO_MIXBUF_H
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDIO_MIXBUF_H
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#include <iprt/cdefs.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <VBox/vmm/pdmaudioifs.h>
4445fffbbb1ea25fd0e9ea68b9380dd7a6709025Matthew Ahrens
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Constructs 32 bit value for given frequency, number of channels, bits per sample and signed bit.
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * Note: This currently matches 1:1 the VRDE encoding -- this might change in the future, so better don't rely on this fact! */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDMIXBUF_AUDIO_FMT_MAKE(freq, c, bps, s) ((((s) & 0x1) << 28) + (((bps) & 0xFF) << 20) + (((c) & 0xF) << 16) + ((freq) & 0xFFFF))
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Decodes frequency (Hz). */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDMIXBUF_FMT_SAMPLE_FREQ(a) ((a) & 0xFFFF)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Decodes number of channels. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDMIXBUF_FMT_CHANNELS(a) (((a) >> 16) & 0xF)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Decodes signed bit. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDMIXBUF_FMT_SIGNED(a) (((a) >> 28) & 0x1)
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley/** Decodes number of bits per sample. */
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley#define AUDMIXBUF_FMT_BITS_PER_SAMPLE(a) (((a) >> 20) & 0xFF)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Decodes number of bytes per sample. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDMIXBUF_FMT_BYTES_PER_SAMPLE(a) ((AUDMIXBUF_AUDIO_FMT_BITS_PER_SAMPLE(a) + 7) / 8)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Converts samples to bytes. */
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley#define AUDIOMIXBUF_S2B(pBuf, samples) ((samples) << (pBuf)->cShift)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Converts samples to bytes, respecting the conversion ratio to
0a586cea3ceec7e5e50e7e54c745082a7a333ac2Mark Shellenbaum * a linked buffer. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDIOMIXBUF_S2B_RATIO(pBuf, samples) ((((int64_t) samples << 32) / (pBuf)->iFreqRatio) << (pBuf)->cShift)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Converts bytes to samples, *not* taking the conversion ratio
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin * into account. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDIOMIXBUF_B2S(pBuf, cb) (cb >> (pBuf)->cShift)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin/** Converts number of samples according to the buffer's ratio. */
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin#define AUDIOMIXBUF_S2S_RATIO(pBuf, samples) (((int64_t) samples << 32) / (pBuf)->iFreqRatio)
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrin
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufAcquire(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamplesToRead, PPDMAUDIOSAMPLE *ppvSamples, uint32_t *pcSamplesRead);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrininline uint32_t audioMixBufBytesToSamples(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinvoid audioMixBufDestroy(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinvoid audioMixBufFinish(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamplesToClear);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinuint32_t audioMixBufFree(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinuint32_t audioMixBufFreeBytes(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufInit(PPDMAUDIOMIXBUF pMixBuf, const char *pszName, PPDMPCMPROPS pProps, uint32_t cSamples);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinbool audioMixBufIsEmpty(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufLinkTo(PPDMAUDIOMIXBUF pMixBuf, PPDMAUDIOMIXBUF pParent);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinuint32_t audioMixBufMixed(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufMixToChildren(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamples, uint32_t *pcProcessed);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufMixToParent(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamples, uint32_t *pcProcessed);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinuint32_t audioMixBufProcessed(PPDMAUDIOMIXBUF pMixBuf);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufReadAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufReadAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufReadCirc(PPDMAUDIOMIXBUF pMixBuf, void *pvBuf, uint32_t cbBuf, uint32_t *pcRead);
b7b97454b9b1f6625e7e655e9651e744a8dee09dperrinint audioMixBufReadCircEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, void *pvBuf, uint32_t cbBuf, uint32_t *pcRead);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyvoid audioMixBufReset(PPDMAUDIOMIXBUF pMixBuf);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyvoid audioMixBufSetVolume(PPDMAUDIOMIXBUF pMixBuf, PPDMAUDIOVOLUME pVol);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyuint32_t audioMixBufSize(PPDMAUDIOMIXBUF pMixBuf);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyuint32_t audioMixBufSizeBytes(PPDMAUDIOMIXBUF pMixBuf);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyvoid audioMixBufUnlink(PPDMAUDIOMIXBUF pMixBuf);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyint audioMixBufWriteAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyint audioMixBufWriteAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyint audioMixBufWriteCirc(PPDMAUDIOMIXBUF pMixBuf, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haleyint audioMixBufWriteCircEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley#endif /* AUDIO_MIXBUF_H */
c8ee1847e300c992c76cf25d6c165e6ccf64a113Victor Latushkin
468c413a79615e77179e8d98f22a7e513a8135bdTim Haley