VirtualBox

source: vbox/trunk/src/VBox/Devices/Audio/AudioHlp.h

Last change on this file was 106061, checked in by vboxsync, 3 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.4 KB
Line 
1/* $Id: AudioHlp.h 106061 2024-09-16 14:03:52Z vboxsync $ */
2/** @file
3 * Audio helper routines.
4 */
5
6/*
7 * Copyright (C) 2006-2024 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#ifndef VBOX_INCLUDED_SRC_Audio_AudioHlp_h
29#define VBOX_INCLUDED_SRC_Audio_AudioHlp_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34#include <limits.h>
35
36#include <iprt/circbuf.h>
37#include <iprt/critsect.h>
38#include <iprt/file.h>
39#include <iprt/path.h>
40
41#include <VBox/vmm/pdmaudioifs.h>
42
43/** @name Audio calculation helper methods.
44 * @{ */
45uint32_t AudioHlpCalcBitrate(uint8_t cBits, uint32_t uHz, uint8_t cChannels);
46/** @} */
47
48/** @name Audio PCM properties helper methods.
49 * @{ */
50bool AudioHlpPcmPropsAreValidAndSupported(PCPDMAUDIOPCMPROPS pProps);
51/** @} */
52
53/** @name Audio configuration helper methods.
54 * @{ */
55bool AudioHlpStreamCfgIsValid(PCPDMAUDIOSTREAMCFG pCfg);
56/** @} */
57
58
59/** @name AUDIOHLPFILE_FLAGS_XXX
60 * @{ */
61/** No flags defined. */
62#define AUDIOHLPFILE_FLAGS_NONE UINT32_C(0)
63/** Keep the audio file even if it contains no audio data. */
64#define AUDIOHLPFILE_FLAGS_KEEP_IF_EMPTY RT_BIT_32(0)
65/** Audio file flag validation mask. */
66#define AUDIOHLPFILE_FLAGS_VALID_MASK UINT32_C(0x1)
67/** @} */
68
69/** Audio file default open flags. */
70#define AUDIOHLPFILE_DEFAULT_OPEN_FLAGS (RTFILE_O_OPEN_CREATE | RTFILE_O_APPEND | RTFILE_O_WRITE | RTFILE_O_DENY_WRITE)
71
72/**
73 * Audio file types.
74 */
75typedef enum AUDIOHLPFILETYPE
76{
77 /** The customary invalid zero value. */
78 AUDIOHLPFILETYPE_INVALID = 0,
79 /** Raw (PCM) file. */
80 AUDIOHLPFILETYPE_RAW,
81 /** Wave (.WAV) file. */
82 AUDIOHLPFILETYPE_WAV,
83 /** Hack to blow the type up to 32-bit. */
84 AUDIOHLPFILETYPE_32BIT_HACK = 0x7fffffff
85} AUDIOHLPFILETYPE;
86
87/** @name AUDIOHLPFILENAME_FLAGS_XXX
88 * @{ */
89/** No flags defined. */
90#define AUDIOHLPFILENAME_FLAGS_NONE UINT32_C(0)
91/** Adds an ISO timestamp to the file name. */
92#define AUDIOHLPFILENAME_FLAGS_TS RT_BIT_32(0)
93/** Valid flag mask. */
94#define AUDIOHLPFILENAME_FLAGS_VALID_MASK AUDIOHLPFILENAME_FLAGS_TS
95/** @} */
96
97/**
98 * Audio file handle.
99 */
100typedef struct AUDIOHLPFILE
101{
102 /** Type of the audio file. */
103 AUDIOHLPFILETYPE enmType;
104 /** Audio file flags, AUDIOHLPFILE_FLAGS_XXX. */
105 uint32_t fFlags;
106 /** Amount of wave data written. */
107 uint64_t cbWaveData;
108 /** Actual file handle. */
109 RTFILE hFile;
110 /** File name and path. */
111 RT_FLEXIBLE_ARRAY_EXTENSION
112 char szName[RT_FLEXIBLE_ARRAY];
113} AUDIOHLPFILE;
114/** Pointer to an audio file handle. */
115typedef AUDIOHLPFILE *PAUDIOHLPFILE;
116
117/** @name Audio file methods.
118 * @{ */
119int AudioHlpFileCreateAndOpen(PAUDIOHLPFILE *ppFile, const char *pszDir, const char *pszName,
120 uint32_t iInstance, PCPDMAUDIOPCMPROPS pProps);
121int AudioHlpFileCreateAndOpenEx(PAUDIOHLPFILE *ppFile, AUDIOHLPFILETYPE enmType, const char *pszDir,
122 uint32_t iInstance, uint32_t fFilename, uint32_t fCreate,
123 PCPDMAUDIOPCMPROPS pProps, uint64_t fOpen, const char *pszName, ...);
124int AudioHlpFileCreateF(PAUDIOHLPFILE *ppFile, uint32_t fFlags, AUDIOHLPFILETYPE enmType,
125 const char *pszPath, uint32_t fFilename, uint32_t uInstance, const char *pszFileFmt, ...);
126
127void AudioHlpFileDestroy(PAUDIOHLPFILE pFile);
128int AudioHlpFileOpen(PAUDIOHLPFILE pFile, uint64_t fOpen, PCPDMAUDIOPCMPROPS pProps);
129int AudioHlpFileClose(PAUDIOHLPFILE pFile);
130int AudioHlpFileDelete(PAUDIOHLPFILE pFile);
131bool AudioHlpFileIsOpen(PAUDIOHLPFILE pFile);
132int AudioHlpFileWrite(PAUDIOHLPFILE pFile, const void *pvBuf, size_t cbBuf);
133/** @} */
134
135#endif /* !VBOX_INCLUDED_SRC_Audio_AudioHlp_h */
136
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