VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/AudioMixBuffer.h@ 54153

Last change on this file since 54153 was 53830, checked in by vboxsync, 10 years ago

PDM/Audio: Unified timer work, minor cleanup.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.2 KB
Line 
1/* $Id: AudioMixBuffer.h 53830 2015-01-15 15:44:12Z vboxsync $ */
2/** @file
3 * VBox audio: TODO
4 */
5
6/*
7 * Copyright (C) 2014 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef AUDIO_MIXBUF_H
19#define AUDIO_MIXBUF_H
20
21#include <iprt/cdefs.h>
22#include <VBox/vmm/pdmaudioifs.h>
23
24/** Constructs 32 bit value for given frequency, number of channels, bits per sample and signed bit.
25 * Note: This currently matches 1:1 the VRDE encoding. */
26#define AUDMIXBUF_AUDIO_FMT_MAKE(freq, c, bps, s) ((((s) & 0x1) << 28) + (((bps) & 0xFF) << 20) + (((c) & 0xF) << 16) + ((freq) & 0xFFFF))
27
28/** Decodes frequency (Hz). */
29#define AUDMIXBUF_FMT_SAMPLE_FREQ(a) ((a) & 0xFFFF)
30/** Decodes number of channels. */
31#define AUDMIXBUF_FMT_CHANNELS(a) (((a) >> 16) & 0xF)
32/** Decodes signed bit. */
33#define AUDMIXBUF_FMT_SIGNED(a) (((a) >> 28) & 0x1)
34/** Decodes number of bits per sample. */
35#define AUDMIXBUF_FMT_BITS_PER_SAMPLE(a) (((a) >> 20) & 0xFF)
36/** Decodes number of bytes per sample. */
37#define AUDMIXBUF_FMT_BYTES_PER_SAMPLE(a) ((AUDMIXBUF_AUDIO_FMT_BITS_PER_SAMPLE(a) + 7) / 8)
38
39/** Converts samples to bytes. */
40#define AUDIOMIXBUF_S2B(pBuf, samples) ((samples) << (pBuf)->cShift)
41/** Converts samples to bytes, respecting the conversion ratio to
42 * a linked buffer. */
43#define AUDIOMIXBUF_S2B_RATIO(pBuf, samples) ((((int64_t) samples << 32) / (pBuf)->iFreqRatio) << (pBuf)->cShift)
44/** Converts bytes to samples, *not* taking the conversion ratio
45 * into account. */
46#define AUDIOMIXBUF_B2S(pBuf, cb) (cb >> (pBuf)->cShift)
47/** Converts number of samples according to the buffer's ratio. */
48#define AUDIOMIXBUF_S2S_RATIO(pBuf, samples) (((int64_t) samples << 32) / (pBuf)->iFreqRatio)
49
50
51int audioMixBufAcquire(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamplesToRead, PPDMAUDIOSAMPLE *ppvSamples, uint32_t *pcSamplesRead);
52inline uint32_t audioMixBufBytesToSamples(PPDMAUDIOMIXBUF pMixBuf);
53void audioMixBufDestroy(PPDMAUDIOMIXBUF pMixBuf);
54void audioMixBufFinish(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamplesToClear);
55uint32_t audioMixBufFree(PPDMAUDIOMIXBUF pMixBuf);
56size_t audioMixBufFreeBytes(PPDMAUDIOMIXBUF pMixBuf);
57int audioMixBufInit(PPDMAUDIOMIXBUF pMixBuf, const char *pszName, PPDMPCMPROPS pProps, uint32_t cSamples);
58bool audioMixBufIsEmpty(PPDMAUDIOMIXBUF pMixBuf);
59int audioMixBufLinkTo(PPDMAUDIOMIXBUF pMixBuf, PPDMAUDIOMIXBUF pParent);
60uint32_t audioMixBufMixed(PPDMAUDIOMIXBUF pMixBuf);
61int audioMixBufMixToChildren(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamples, uint32_t *pcProcessed);
62int audioMixBufMixToParent(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSamples, uint32_t *pcProcessed);
63uint32_t audioMixBufProcessed(PPDMAUDIOMIXBUF pMixBuf);
64int audioMixBufReadAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, void *pvBuf, size_t cbBuf, uint32_t *pcbRead);
65int audioMixBufReadAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, void *pvBuf, size_t cbBuf, uint32_t *pcbRead);
66int audioMixBufReadCirc(PPDMAUDIOMIXBUF pMixBuf, void *pvBuf, size_t cbBuf, uint32_t *pcRead);
67int audioMixBufReadCircEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, void *pvBuf, size_t cbBuf, uint32_t *pcRead);
68void audioMixBufReset(PPDMAUDIOMIXBUF pMixBuf);
69uint32_t audioMixBufSize(PPDMAUDIOMIXBUF pMixBuf);
70size_t audioMixBufSizeBytes(PPDMAUDIOMIXBUF pMixBuf);
71void audioMixBufUnlink(PPDMAUDIOMIXBUF pMixBuf);
72int audioMixBufWriteAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, const void *pvBuf, size_t cbBuf, uint32_t *pcWritten);
73int audioMixBufWriteAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, const void *pvBuf, size_t cbBuf, uint32_t *pcWritten);
74int audioMixBufWriteCirc(PPDMAUDIOMIXBUF pMixBuf, const void *pvBuf, size_t cbBuf, uint32_t *pcWritten);
75int audioMixBufWriteCircEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, const void *pvBuf, size_t cbBuf, uint32_t *pcWritten);
76
77#endif /* AUDIO_MIXBUF_H */
78
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette