1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/* $Id: AudioDriver.h $ */
/** @file
* VirtualBox audio base class for Main audio drivers.
*/
/*
* Copyright (C) 2018-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* 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, in version 3 of the
* License.
*
* 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, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_AudioDriver_h
#define MAIN_INCLUDED_AudioDriver_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/com/ptr.h>
#include <VBox/com/string.h>
#include <VBox/com/AutoLock.h>
using namespace com;
/**
* Audio driver configuration for audio drivers implemented
* in Main.
*/
struct AudioDriverCfg
{
AudioDriverCfg(Utf8Str a_strDev = "", unsigned a_uInst = 0, unsigned a_uLUN = 0, Utf8Str a_strName = "",
bool a_fEnabledIn = false, bool a_fEnabledOut = false)
: strDev(a_strDev)
, uInst(a_uInst)
, uLUN(a_uLUN)
, strName(a_strName)
, fEnabledIn(a_fEnabledIn)
, fEnabledOut(a_fEnabledOut)
{ }
/** Copy assignment operator. */
AudioDriverCfg& operator=(AudioDriverCfg const &a_rThat) RT_NOEXCEPT
{
this->strDev = a_rThat.strDev;
this->uInst = a_rThat.uInst;
this->uLUN = a_rThat.uLUN;
this->strName = a_rThat.strName;
this->fEnabledIn = a_rThat.fEnabledIn;
this->fEnabledOut = a_rThat.fEnabledOut;
return *this;
}
/** The device name. */
Utf8Str strDev;
/** The device instance. */
unsigned uInst;
/** The LUN the driver is attached to.
* Set the UINT8_MAX if not attached. */
unsigned uLUN;
/** The driver name. */
Utf8Str strName;
/** Whether input is enabled. */
bool fEnabledIn;
/** Whether output is enabled. */
bool fEnabledOut;
};
class Console;
/**
* Base class for all audio drivers implemented in Main.
*/
class AudioDriver
{
public:
AudioDriver(Console *pConsole);
virtual ~AudioDriver();
/** Copy assignment operator. */
AudioDriver &operator=(AudioDriver const &a_rThat) RT_NOEXCEPT;
Console *GetParent(void) { return mpConsole; }
AudioDriverCfg *GetConfig(void) { return &mCfg; }
int InitializeConfig(AudioDriverCfg *pCfg);
/** Checks if audio is configured or not. */
bool isConfigured() const { return mCfg.strName.isNotEmpty(); }
bool IsAttached(void) { return mfAttached; }
int doAttachDriverViaEmt(PUVM pUVM, PCVMMR3VTABLE pVMM, util::AutoWriteLock *pAutoLock);
int doDetachDriverViaEmt(PUVM pUVM, PCVMMR3VTABLE pVMM, util::AutoWriteLock *pAutoLock);
protected:
static DECLCALLBACK(int) attachDriverOnEmt(AudioDriver *pThis);
static DECLCALLBACK(int) detachDriverOnEmt(AudioDriver *pThis);
int configure(unsigned uLUN, bool fAttach);
/**
* Virtual function for child specific driver configuration.
*
* This is called at the end of AudioDriver::configure().
*
* @returns VBox status code.
* @param pLunCfg CFGM configuration node of the driver.
* @param pVMM The VMM ring-3 vtable.
*/
virtual int configureDriver(PCFGMNODE pLunCfg, PCVMMR3VTABLE pVMM)
{
RT_NOREF(pLunCfg, pVMM);
return VINF_SUCCESS;
}
protected:
/** Pointer to parent. */
Console *mpConsole;
/** The driver's configuration. */
AudioDriverCfg mCfg;
/** Whether the driver is attached or not. */
bool mfAttached;
};
#endif /* !MAIN_INCLUDED_AudioDriver_h */
|
