VirtualBox

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

Last change on this file since 86223 was 82968, checked in by vboxsync, 5 years ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.1 KB
Line 
1/* $Id: AudioMixBuffer.h 82968 2020-02-04 10:35:17Z vboxsync $ */
2/** @file
3 * Audio Mixing bufer convert audio samples to/from different rates / formats.
4 */
5
6/*
7 * Copyright (C) 2014-2020 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 VBOX_INCLUDED_SRC_Audio_AudioMixBuffer_h
19#define VBOX_INCLUDED_SRC_Audio_AudioMixBuffer_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#include <iprt/cdefs.h>
25#include <VBox/vmm/pdmaudioifs.h>
26
27/** Constructs 32 bit value for given frequency, number of channels, bits per sample and signed bit.
28 * Note: This currently matches 1:1 the VRDE encoding -- this might change in the future, so better don't rely on this fact! */
29#define AUDMIXBUF_AUDIO_FMT_MAKE(freq, c, bps, s) ((((s) & 0x1) << 28) + (((bps) & 0xFF) << 20) + (((c) & 0xF) << 16) + ((freq) & 0xFFFF))
30
31/** Decodes frequency (Hz). */
32#define AUDMIXBUF_FMT_SAMPLE_FREQ(a) ((a) & 0xFFFF)
33/** Decodes number of channels. */
34#define AUDMIXBUF_FMT_CHANNELS(a) (((a) >> 16) & 0xF)
35/** Decodes signed bit. */
36#define AUDMIXBUF_FMT_SIGNED(a) (((a) >> 28) & 0x1)
37/** Decodes number of bits per sample. */
38#define AUDMIXBUF_FMT_BITS_PER_SAMPLE(a) (((a) >> 20) & 0xFF)
39/** Decodes number of bytes per sample. */
40#define AUDMIXBUF_FMT_BYTES_PER_SAMPLE(a) ((AUDMIXBUF_AUDIO_FMT_BITS_PER_SAMPLE(a) + 7) / 8)
41
42/** Converts frames to bytes. */
43#define AUDIOMIXBUF_F2B(pBuf, frames) ((frames) << (pBuf)->cShift)
44/** Converts frames to bytes, respecting the conversion ratio to
45 * a linked buffer. */
46#define AUDIOMIXBUF_F2B_RATIO(pBuf, frames) ((((int64_t) frames << 32) / (pBuf)->iFreqRatio) << (pBuf)->cShift)
47/** Converts bytes to frames, *not* taking the conversion ratio
48 * into account. */
49#define AUDIOMIXBUF_B2F(pBuf, cb) (cb >> (pBuf)->cShift)
50/** Converts number of frames according to the buffer's ratio. */
51#define AUDIOMIXBUF_F2F_RATIO(pBuf, frames) (((int64_t) frames << 32) / (pBuf)->iFreqRatio)
52
53
54inline uint32_t AudioMixBufBytesToSamples(PPDMAUDIOMIXBUF pMixBuf);
55void AudioMixBufClear(PPDMAUDIOMIXBUF pMixBuf);
56void AudioMixBufDestroy(PPDMAUDIOMIXBUF pMixBuf);
57void AudioMixBufFinish(PPDMAUDIOMIXBUF pMixBuf, uint32_t cFramesToClear);
58uint32_t AudioMixBufFree(PPDMAUDIOMIXBUF pMixBuf);
59uint32_t AudioMixBufFreeBytes(PPDMAUDIOMIXBUF pMixBuf);
60int AudioMixBufInit(PPDMAUDIOMIXBUF pMixBuf, const char *pszName, PPDMAUDIOPCMPROPS pProps, uint32_t cFrames);
61bool AudioMixBufIsEmpty(PPDMAUDIOMIXBUF pMixBuf);
62int AudioMixBufLinkTo(PPDMAUDIOMIXBUF pMixBuf, PPDMAUDIOMIXBUF pParent);
63uint32_t AudioMixBufLive(PPDMAUDIOMIXBUF pMixBuf);
64int AudioMixBufMixToParent(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSrcFrames, uint32_t *pcSrcMixed);
65int AudioMixBufMixToParentEx(PPDMAUDIOMIXBUF pMixBuf, uint32_t cSrcOffset, uint32_t cSrcFrames, uint32_t *pcSrcMixed);
66int AudioMixBufPeek(PPDMAUDIOMIXBUF pMixBuf, uint32_t cFramesToRead, PPDMAUDIOFRAME paSampleBuf, uint32_t cSampleBuf, uint32_t *pcFramesRead);
67int AudioMixBufPeekMutable(PPDMAUDIOMIXBUF pMixBuf, uint32_t cFramesToRead, PPDMAUDIOFRAME *ppvSamples, uint32_t *pcFramesRead);
68uint32_t AudioMixBufUsed(PPDMAUDIOMIXBUF pMixBuf);
69uint32_t AudioMixBufUsedBytes(PPDMAUDIOMIXBUF pMixBuf);
70int AudioMixBufReadAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead);
71int AudioMixBufReadAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead);
72int AudioMixBufAcquireReadBlock(PPDMAUDIOMIXBUF pMixBuf, void *pvBuf, uint32_t cbBuf, uint32_t *pcBlock);
73int AudioMixBufAcquireReadBlockEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, void *pvBuf, uint32_t cbBuf, uint32_t *pcBlock);
74void AudioMixBufReleaseReadBlock(PPDMAUDIOMIXBUF pMixBuf, uint32_t cBlock);
75uint32_t AudioMixBufReadPos(PPDMAUDIOMIXBUF pMixBuf);
76void AudioMixBufReset(PPDMAUDIOMIXBUF pMixBuf);
77void AudioMixBufSetVolume(PPDMAUDIOMIXBUF pMixBuf, PPDMAUDIOVOLUME pVol);
78uint32_t AudioMixBufSize(PPDMAUDIOMIXBUF pMixBuf);
79uint32_t AudioMixBufSizeBytes(PPDMAUDIOMIXBUF pMixBuf);
80void AudioMixBufUnlink(PPDMAUDIOMIXBUF pMixBuf);
81int AudioMixBufWriteAt(PPDMAUDIOMIXBUF pMixBuf, uint32_t offSamples, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
82int AudioMixBufWriteAtEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, uint32_t offSamples, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
83int AudioMixBufWriteCirc(PPDMAUDIOMIXBUF pMixBuf, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
84int AudioMixBufWriteCircEx(PPDMAUDIOMIXBUF pMixBuf, PDMAUDIOMIXBUFFMT enmFmt, const void *pvBuf, uint32_t cbBuf, uint32_t *pcWritten);
85uint32_t AudioMixBufWritePos(PPDMAUDIOMIXBUF pMixBuf);
86
87#ifdef DEBUG
88void AudioMixBufDbgPrint(PPDMAUDIOMIXBUF pMixBuf);
89void AudioMixBufDbgPrintChain(PPDMAUDIOMIXBUF pMixBuf);
90#endif
91
92#endif /* !VBOX_INCLUDED_SRC_Audio_AudioMixBuffer_h */
93
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