pdmaudioifs.h@ 53625

Last change on this file since 53625 was 53567, checked in by vboxsync, 10 years ago
PDM/Audio: Update.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 25.8 KB

Line
1	/** @file
2	* PDM - Pluggable Device Manager, audio interfaces.
3	*/
4
5	/*
6	* Copyright (C) 2006-2014 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_vmm_pdmaudioifs_h
27	#define ___VBox_vmm_pdmaudioifs_h
28
29	#include <VBox/types.h>
30	#include <iprt/list.h>
31
32	typedef struct
33	{
34	int mute;
35	uint32_t r;
36	uint32_t l;
37	} volume_t;
38
39	#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
40	typedef uint32_t PDMAUDIODRVFLAGS;
41
42	/** No flags set. */
43	#define PDMAUDIODRVFLAG_NONE 0
44	/** Marks a primary audio driver which is critical
45	* when running the VM. */
46	#define PDMAUDIODRVFLAG_PRIMARY RT_BIT(0)
47
48	/**
49	* Audio format in signed or unsigned variants.
50	*/
51	typedef enum PDMAUDIOFMT
52	{
53	AUD_FMT_INVALID,
54	AUD_FMT_U8,
55	AUD_FMT_S8,
56	AUD_FMT_U16,
57	AUD_FMT_S16,
58	AUD_FMT_U32,
59	AUD_FMT_S32,
60	/** Hack to blow the type up to 32-bit. */
61	AUD_FMT_32BIT_HACK = 0x7fffffff
62	} PDMAUDIOFMT;
63	#endif
64
65	/**
66	* Function pointer for device emulation callback.
67	*/
68	typedef void (PDMAUDIOCALLBACK_FN) (void pvContext, uint32_t cbData);
69
70	/**
71	* Structure holding all necessary callback data to communicate
72	* with the sound device emulation, e.g. for reading or writing
73	* audio data.
74	*/
75	typedef struct PDMAUDIOCALLBACK
76	{
77	/** Callback function to use in the device emulation. */
78	PDMAUDIOCALLBACK_FN fn;
79	/** Opaque pointer to context data given on callback
80	* creation. Set by the device emulation. */
81	void *pvContext;
82	} PDMAUDIOCALLBACK, *PPDMAUDIOCALLBACK;
83
84	/**
85	* Audio configuration of a certain backend.
86	*/
87	typedef struct PDMAUDIOBACKENDCFG
88	{
89	size_t cbStreamOut;
90	size_t cbStreamIn;
91	uint32_t cMaxHstStrmsOut;
92	uint32_t cMaxHstStrmsIn;
93	} PDMAUDIOBACKENDCFG, *PPDMAUDIOBACKENDCFG;
94
95	/**
96	* An audio sample. At the moment stereo (left + right channels) only.
97	* @todo Replace this with a more generic union
98	* which then also could handle 2.1 or 5.1 sound.
99	*/
100	typedef struct PDMAUDIOSAMPLE
101	{
102	int64_t u64LSample;
103	int64_t u64RSample;
104	} PDMAUDIOSAMPLE, *PPDMAUDIOSAMPLE;
105
106	typedef enum PDMAUDIOENDIANESS
107	{
108	/** The usual invalid endian. */
109	PDMAUDIOENDIANESS_INVALID,
110	/** Little endian. */
111	PDMAUDIOENDIANESS_LITTLE,
112	/** Bit endian. */
113	PDMAUDIOENDIANESS_BIG,
114	/** Endianness doesn't have a meaning in the context. */
115	PDMAUDIOENDIANESS_NA,
116	/** The end of the valid endian values (exclusive). */
117	PDMAUDIOENDIANESS_END,
118	/** Hack to blow the type up to 32-bit. */
119	PDMAUDIOENDIANESS_32BIT_HACK = 0x7fffffff
120	} PDMAUDIOENDIANESS;
121
122	#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
123	typedef struct PDMAUDIOSTREAMCFG
124	{
125	/** Frequency in Hertz (Hz). */
126	uint32_t uHz;
127	/** Number of channels (2 for stereo). */
128	uint8_t cChannels;
129	/** Audio format. */
130	PDMAUDIOFMT enmFormat;
131	/** @todo Use RT_LE2H_? /
132	PDMAUDIOENDIANESS enmEndianness;
133	} PDMAUDIOSTREAMCFG, *PPDMAUDIOSTREAMCFG;
134	#endif
135
136	#if defined(RT_LITTLE_ENDIAN)
137	# define PDMAUDIOHOSTENDIANESS PDMAUDIOENDIANESS_LITTLE
138	#elif defined(RT_BIG_ENDIAN)
139	# define PDMAUDIOHOSTENDIANESS PDMAUDIOENDIANESS_BIG
140	#else
141	# error "Port me!"
142	#endif
143
144	typedef enum
145	{
146	PDMAUDIOMIXERCTL_UNKNOWN = 0,
147	PDMAUDIOMIXERCTL_VOLUME,
148	PDMAUDIOMIXERCTL_PCM,
149	PDMAUDIOMIXERCTL_LINE_IN,
150	/** Hack to blow the type up to 32-bit. */
151	PDMAUDIOMIXERCTL_32BIT_HACK = 0x7fffffff
152	} PDMAUDIOMIXERCTL;
153
154	typedef enum
155	{
156	PDMAUDIORECSOURCE_UNKNOWN = 0,
157	PDMAUDIORECSOURCE_MIC,
158	PDMAUDIORECSOURCE_CD,
159	PDMAUDIORECSOURCE_VIDEO,
160	PDMAUDIORECSOURCE_AUX,
161	PDMAUDIORECSOURCE_LINE_IN,
162	PDMAUDIORECSOURCE_PHONE,
163	/** Hack to blow the type up to 32-bit. */
164	PDMAUDIORECSOURCE_32BIT_HACK = 0x7fffffff
165	} PDMAUDIORECSOURCE;
166
167	/**
168	* Audio stream commands. Used in the audio connector
169	* as well as in the actual host backends.
170	*/
171	typedef enum PDMAUDIOSTREAMCMD
172	{
173	/** Unknown command, do not use. */
174	PDMAUDIOSTREAMCMD_UNKNOWN = 0,
175	/** Enables the stream. */
176	PDMAUDIOSTREAMCMD_ENABLE,
177	/** Disables the stream. */
178	PDMAUDIOSTREAMCMD_DISABLE,
179	/** Hack to blow the type up to 32-bit. */
180	PDMAUDIOSTREAMCMD_32BIT_HACK = 0x7fffffff
181	} PDMAUDIOSTREAMCMD;
182
183	/**
184	* Properties of audio streams for host/guest
185	* for in or out directions.
186	*/
187	typedef struct PDMPCMPROPS
188	{
189	/** Sample width. Bits per sample. */
190	uint8_t cBits;
191	/** Signed or unsigned sample. */
192	bool fSigned;
193	/** Shift count used for faster calculation of various
194	* values, such as the alignment, bytes to samples and so on.
195	* Depends on number of stream channels and the stream format
196	* being used.
197	*
198	** @todo Use some RTAsmXXX functions instead?
199	*/
200	uint8_t cShift;
201	/** Number of audio channels. */
202	uint8_t cChannels;
203	/** Alignment mask. */
204	uint32_t uAlign;
205	/** Sample frequency in Hertz (Hz). */
206	uint32_t uHz;
207	/** Bandwidth (bytes/s). */
208	uint32_t cbPerSec;
209	/** Whether the endianess is swapped or not. */
210	bool fSwapEndian;
211	} PDMPCMPROPS, *PPDMPCMPROPS;
212
213	/**
214	* Structure for holding rate processing information
215	* of a source + destination audio stream. This is needed
216	* because both streams can differ regarding their rates
217	* and therefore need to be treated accordingly.
218	*/
219	typedef struct PDMAUDIOSTRMRATE
220	{
221	/** Current (absolute) offset in the output
222	* (destination) stream. */
223	uint64_t dstOffset;
224	/** Increment for moving dstOffset for the
225	* destination stream. This is needed because the
226	* source <-> destination rate might be different. */
227	uint64_t dstInc;
228	/** Current (absolute) offset in the input
229	* stream. */
230	uint32_t srcOffset;
231	/** Last processed sample of the input stream.
232	* Needed for interpolation. */
233	PDMAUDIOSAMPLE srcSampleLast;
234	} PDMAUDIOSTRMRATE, *PPDMAUDIOSTRMRATE;
235
236	/**
237	* Note: All internal handling is done in samples,
238	* not in bytes!
239	*/
240	typedef uint32_t PDMAUDIOMIXBUFFMT;
241	typedef PDMAUDIOMIXBUFFMT *PPDMAUDIOMIXBUFFMT;
242
243	typedef struct PDMAUDIOMIXBUF *PPDMAUDIOMIXBUF;
244	typedef struct PDMAUDIOMIXBUF
245	{
246	RTLISTNODE Node;
247	/** Name of the buffer. */
248	char *pszName;
249	/** Sample buffer. */
250	PPDMAUDIOSAMPLE pSamples;
251	/** Size of the sample buffer (in samples). */
252	uint32_t cSamples;
253	/** The current read/write position (in samples)
254	* in the samples buffer. */
255	uint32_t offReadWrite;
256	/** Total samples already mixed down to the
257	* parent buffer (if any). Always starting at
258	* the parent's offReadWrite position.
259	* Note: Count always is specified in parent samples,
260	* as the sample count can differ between parent
261	* and child. */
262	uint32_t cMixed;
263	uint32_t cProcessed;
264	/** Pointer to parent buffer (if any). */
265	PPDMAUDIOMIXBUF pParent;
266	/** List of children mix buffers to keep
267	* in sync with (if being a parent buffer). */
268	RTLISTANCHOR lstBuffers;
269	/** Intermediate structure for buffer
270	* conversion tasks. */
271	PPDMAUDIOSTRMRATE pRate;
272	/** This buffer's audio format. */
273	PDMAUDIOMIXBUFFMT AudioFmt;
274	/**
275	* Ratio of the associated parent stream's frequency by this stream's
276	* frequency (1<<32), represented as a signed 64 bit integer.
277	*
278	* For example, if the parent stream has a frequency of 44 khZ, and this
279	* stream has a frequency of 11 kHz, the ration then would be
280	* (44/11 * (1 << 32)).
281	*
282	* Currently this does not get changed once assigned.
283	*/
284	int64_t iFreqRatio;
285	/* For quickly converting samples <-> bytes and
286	* vice versa. */
287	uint8_t cShift;
288	} PDMAUDIOMIXBUF;
289
290	/**
291	* Represents an audio input on the host of a certain
292	* backend (e.g. DirectSound, PulseAudio etc).
293	*
294	* One host audio input is assigned to exactly one parent
295	* guest input stream.
296	*/
297	struct PDMAUDIOGSTSTRMIN;
298	typedef PDMAUDIOGSTSTRMIN *PPDMAUDIOGSTSTRMIN;
299
300	typedef struct PDMAUDIOHSTSTRMIN
301	{
302	/** List node. */
303	RTLISTNODE Node;
304	/** PCM properties. */
305	PDMPCMPROPS Props;
306	/** Whether this input is enabled or not. */
307	bool fEnabled;
308	/** This stream's mixing buffer. */
309	PDMAUDIOMIXBUF MixBuf;
310	/** Pointer to (parent) guest stream. */
311	PPDMAUDIOGSTSTRMIN pGstStrmIn;
312	} PDMAUDIOHSTSTRMIN, *PPDMAUDIOHSTSTRMIN;
313
314	/*
315	* Represents an audio output on the host through a certain
316	* backend (e.g. DirectSound, PulseAudio etc).
317	*
318	* One host audio output can have multiple (1:N) guest outputs
319	* assigned.
320	*/
321	typedef struct PDMAUDIOHSTSTRMOUT
322	{
323	/** List node. */
324	RTLISTNODE Node;
325	/** Stream properites. */
326	PDMPCMPROPS Props;
327	/** Enabled or disabled flag. */
328	bool fEnabled;
329	/** Whether this stream was marked as being disabled
330	* but there are still associated guest output streams
331	* which rely on its data. */
332	bool fPendingDisable;
333	/** This stream's mixing buffer. */
334	PDMAUDIOMIXBUF MixBuf;
335	/** Associated guest output streams. */
336	RTLISTANCHOR lstGstStrmOut;
337	} PDMAUDIOHSTSTRMOUT, *PPDMAUDIOHSTSTRMOUT;
338
339	/**
340	* Guest audio stream state.
341	*/
342	typedef struct PDMAUDIOGSTSTRMSTATE
343	{
344	/** Guest audio out stream active or not. */
345	bool fActive;
346	/** Guest audio output stream has some samples or not. */
347	bool fEmpty;
348	/** Set to @c true if this stream is muted, @c false if not. */
349	bool fMuted;
350	/** Name of this stream. */
351	char *pszName;
352	/** Left channel volume. */
353	uint32_t uVolumeLeft;
354	/** Right channel volume. */
355	uint32_t uVolumeRight;
356	} PDMAUDIOGSTSTRMSTATE, *PPDMAUDIOGSTSTRMSTATE;
357
358	/**
359	* Represents an audio input from the guest (that is, from the
360	* emulated device, e.g. Intel HDA).
361	*
362	* Each guest input can have multiple host input streams.
363	*/
364	typedef struct PDMAUDIOGSTSTRMIN
365	{
366	/** Guest stream properites. */
367	PDMPCMPROPS Props;
368	/** Current stream state. */
369	PDMAUDIOGSTSTRMSTATE State;
370	/** This stream's mixing buffer. */
371	PDMAUDIOMIXBUF MixBuf;
372	/** Pointer to associated host input stream. */
373	PPDMAUDIOHSTSTRMIN pHstStrmIn;
374	/**
375	* Callback set by the device emulation on creation.
376	* This function is used to mix the guest input samples into the target
377	* host input recording buffer. */
378	PDMAUDIOCALLBACK Callback;
379	} PDMAUDIOGSTSTRMIN, *PPDMAUDIOGSTSTRMIN;
380
381	/**
382	* Represents an audio output from the guest (that is, from the
383	* emulated device, e.g. Intel HDA).
384	*
385	* Each guest output is assigned to a single host output.
386	*/
387	typedef struct PDMAUDIOGSTSTRMOUT
388	{
389	/** List node. */
390	RTLISTNODE Node;
391	/** Guest output stream properites. */
392	PDMPCMPROPS Props;
393	/** Current stream state. */
394	PDMAUDIOGSTSTRMSTATE State;
395	/** This stream's mixing buffer. */
396	PDMAUDIOMIXBUF MixBuf;
397	/** Pointer to the associated host output stream. */
398	PPDMAUDIOHSTSTRMOUT pHstStrmOut;
399	/**
400	* Callback set by the device emulation on creation.
401	* This function is used to tell the device emulation that we're ready to
402	* process new samples.
403	*/
404	PDMAUDIOCALLBACK Callback;
405	} PDMAUDIOGSTSTRMOUT, *PPDMAUDIOGSTSTRMOUT;
406
407	#ifdef VBOX_WITH_PDM_AUDIO_DRIVER
408
409	/** Pointer to a audio connector interface. */
410	typedef struct PDMIAUDIOCONNECTOR *PPDMIAUDIOCONNECTOR;
411	/**
412	* Audio connector interface (up).
413	*/
414	typedef struct PDMIAUDIOCONNECTOR
415	{
416	/**
417	* Reads PCM audio data from the host (input).
418	*
419	* @returns VBox status code.
420	* @param pInterface Pointer to the interface structure containing the called function pointer.
421	* @param pGstStrmIn Pointer to guest input stream to write to.
422	* @param pvBuf Where to store the read data.
423	* @param cbSize Number of bytes to read.
424	* @param pcbRead Bytes of audio data read. Optional.
425	*/
426	DECLR3CALLBACKMEMBER(int, pfnRead, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMIN pGstStrmIn, void pvBuf, size_t cbSize, uint32_t pcbRead));
427
428	/**
429	* Writes PCM audio data to the host (output).
430	*
431	* @returns VBox status code.
432	* @param pInterface Pointer to the interface structure containing the called function pointer.
433	* @param pGstStrmOut Pointer to guest output stream to read from.
434	* @param pvBuf Audio data to be written.
435	* @param cbSize Number of bytes to be written.
436	* @param pcbWritten Bytes of audio data written. Optional.
437	*/
438	DECLR3CALLBACKMEMBER(int, pfnWrite, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut, const void pvBuf, size_t cbSize, uint32_t pcbWritten));
439
440	/**
441	* Checks whether the specified guest input stream is in a working state.
442	*
443	* @returns True if a host voice in is available, false if not.
444	* @param pInterface Pointer to the interface structure containing the called function pointer.
445	* @param pGstStrmIn Pointer to guest input stream to check.
446	*/
447	DECLR3CALLBACKMEMBER(bool, pfnIsInputOK, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMIN pGstStrmIn));
448
449	/**
450	* Checks whether the specified guest output stream is in a working state.
451	*
452	* @returns True if a host voice out is available, false if not.
453	* @param pInterface Pointer to the interface structure containing the called function pointer.
454	* @param pGstStrmOut Pointer to guest output stream to check.
455	*/
456	DECLR3CALLBACKMEMBER(bool, pfnIsOutputOK, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut));
457
458	/**
459	* Initializes the NULL audio driver as a fallback.
460	*
461	* @returns VBox status code.
462	* @param pInterface Pointer to the interface structure containing the called function pointer.
463	*/
464	DECLR3CALLBACKMEMBER(int, pfnInitNull, (PPDMIAUDIOCONNECTOR pInterface));
465
466	/**
467	* Sets the audio volume of a specific guest output stream.
468	*
469	* @returns VBox status code.
470	* @param pInterface Pointer to the interface structure containing the called function pointer.
471	* @param pGstStrmOut Pointer to guest output stream.
472	* @param fMute Whether to mute or not.
473	* @param uVolLeft Left audio stream volume.
474	* @param uVolRight Right audio stream volume.
475	*/
476	DECLR3CALLBACKMEMBER(int, pfnIsSetOutVolume, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut,
477	bool fMute, uint8_t uVolLeft, uint8_t uVolRight));
478
479	/**
480	* Sets the overall audio volume.
481	*
482	* @returns VBox status code.
483	* @param pInterface Pointer to the interface structure containing the called function pointer.
484	* @param fMute Whether to mute or not.
485	* @param uVolLeft Left audio stream volume.
486	* @param uVolRight Right audio stream volume.
487	*/
488	DECLR3CALLBACKMEMBER(int, pfnSetVolume, (PPDMIAUDIOCONNECTOR pInterface,
489	bool fMute, uint8_t uVolLeft, uint8_t uVolRight));
490
491	/**
492	* Enables a specific guest output stream and starts the audio device.
493	*
494	* @returns VBox status code.
495	* @param pInterface Pointer to the interface structure containing the called function pointer.
496	* @param pGstStrmOut Pointer to guest output stream.
497	* @param fEnable Whether to enable or disable the specified output stream.
498	*/
499	DECLR3CALLBACKMEMBER(int, pfnEnableOut, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut, bool fEnable));
500
501	/**
502	* Enables a specific guest input stream and starts the audio device.
503	*
504	* @returns VBox status code.
505	* @param pInterface Pointer to the interface structure containing the called function pointer.
506	* @param pGstStrmIn Pointer to guest input stream.
507	* @param fEnable Whether to enable or disable the specified input stream.
508	*/
509	DECLR3CALLBACKMEMBER(int, pfnEnableIn, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMIN pGstStrmIn, bool fEnable));
510
511	/**
512	* Closes a specific guest input stream.
513	*
514	* @param pInterface Pointer to the interface structure containing the called function pointer.
515	* @param pGstStrmIn Pointer to guest input stream.
516	*/
517	DECLR3CALLBACKMEMBER(void, pfnCloseIn, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMIN pGstStrmIn));
518
519	/**
520	* Closes a specific guest output stream.
521	*
522	* @param pInterface Pointer to the interface structure containing the called function pointer.
523	* @param pGstStrmOut Pointer to guest output stream.
524	*/
525	DECLR3CALLBACKMEMBER(void, pfnCloseOut, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut));
526
527	/**
528	* Opens an input audio channel.
529	*
530	* @returns VBox status code.
531	* @param pInterface Pointer to the interface structure containing the called function pointer.
532	* @param pszName Name of the audio channel.
533	* @param enmRecSource Specifies the type of recording source to be opened.
534	* @param fnCallback Callback function to be assigned to this input stream.
535	* @param pvCallback Pointer to parameters assigned to the callback function.
536	* @param pCfg Pointer to PDMAUDIOSTREAMCFG to use.
537	* @param ppGstStrmIn Pointer where to return the guest guest input stream on success.
538	*/
539	DECLR3CALLBACKMEMBER(int, pfnOpenIn, (PPDMIAUDIOCONNECTOR pInterface, const char *pszName,
540	PDMAUDIORECSOURCE enmRecSource,
541	PDMAUDIOCALLBACK_FN fnCallback, void *pvCallback,
542	PPDMAUDIOSTREAMCFG pCfg,
543	PPDMAUDIOGSTSTRMIN *ppGstStrmIn));
544
545	/**
546	* Opens an output audio channel.
547	*
548	* @returns VBox status code.
549	* @param pInterface Pointer to the interface structure containing the called function pointer.
550	* @param pszName Name of the audio channel.
551	* @param fnCallback Callback function to be assigned to this input stream.
552	* @param pvCallback Pointer to parameters assigned to the callback function.
553	* @param pCfg Pointer to PDMAUDIOSTREAMCFG to use.
554	* @param ppGstStrmOut Pointer where to return the guest guest input stream on success.
555	*/
556	DECLR3CALLBACKMEMBER(int, pfnOpenOut, (PPDMIAUDIOCONNECTOR pInterface, const char *pszName,
557	PDMAUDIOCALLBACK_FN fnCallback, void *pvCallback,
558	PPDMAUDIOSTREAMCFG pCfg,
559	PPDMAUDIOGSTSTRMOUT *ppGstStrmOut));
560
561	/**
562	* Checks whether a specific guest input stream is active or not.
563	*
564	* @returns Whether the specified stream is active or not.
565	* @param pInterface Pointer to the interface structure containing the called function pointer.
566	* @param pGstStrmIn Pointer to guest input stream.
567	*/
568	DECLR3CALLBACKMEMBER(bool, pfnIsActiveIn, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMIN pGstStrmIn));
569
570	/**
571	* Checks whether a specific guest output stream is active or not.
572	*
573	* @returns Whether the specified stream is active or not.
574	* @param pInterface Pointer to the interface structure containing the called function pointer.
575	* @param pGstStrmOut Pointer to guest output stream.
576	*/
577	DECLR3CALLBACKMEMBER(bool, pfnIsActiveOut, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOGSTSTRMOUT pGstStrmOut));
578
579	} PDMIAUDIOCONNECTOR;
580
581	/** PDMIAUDIOCONNECTOR interface ID. */
582	#define PDMIAUDIOCONNECTOR_IID "a41ca770-ed07-4f57-a0a6-41377d9d484f"
583
584	/** Pointer to a host audio interface. */
585	typedef struct PDMIHOSTAUDIO *PPDMIHOSTAUDIO;
586	/**
587	* PDM host audio interface.
588	*/
589	typedef struct PDMIHOSTAUDIO
590	{
591	/**
592	* Initialize the host-specific audio device.
593	*
594	* @returns VBox status code.
595	* @param pInterface Pointer to the interface structure containing the called function pointer.
596	*/
597	DECLR3CALLBACKMEMBER(int, pfnInit, (PPDMIHOSTAUDIO pInterface));
598	/**
599	* Initialize the host-specific audio device for input stream.
600	*
601	* @returns VBox status code.
602	* @param pInterface Pointer to the interface structure containing the called function pointer.
603	* @param pHstStrmIn Pointer to host input stream.
604	* @param pStreamCfg Pointer to stream configuration.
605	* @param enmRecSource Specifies the type of recording source to be initialized.
606	* @param pcSamples Returns how many samples the backend can handle. Optional.
607	*/
608	DECLR3CALLBACKMEMBER(int, pfnInitIn, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMIN pHstStrmIn, PPDMAUDIOSTREAMCFG pStreamCfg, PDMAUDIORECSOURCE enmRecSource, uint32_t *pcSamples));
609
610	/**
611	* Initialize the host-specific output device for output stream.
612	*
613	* @returns VBox status code.
614	* @param pInterface Pointer to the interface structure containing the called function pointer.
615	* @param pHstStrmOut Pointer to host output stream.
616	* @param pStreamCfg Pointer to stream configuration.
617	* @param pcSamples Returns how many samples the backend can handle. Optional.
618	*/
619	DECLR3CALLBACKMEMBER(int, pfnInitOut, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMOUT pHstStrmOut, PPDMAUDIOSTREAMCFG pStreamCfg, uint32_t *pcSamples));
620
621	/**
622	* Control the host audio device for an input stream.
623	*
624	* @returns VBox status code.
625	* @param pInterface Pointer to the interface structure containing the called function pointer.
626	* @param pHstStrmOut Pointer to host output stream.
627	* @param enmStreamCmd The stream command to issue.
628	*/
629	DECLR3CALLBACKMEMBER(int, pfnControlOut, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMOUT pHstStrmOut, PDMAUDIOSTREAMCMD enmStreamCmd));
630
631	/**
632	* Control the host audio device for an output stream.
633	*
634	* @returns VBox status code.
635	* @param pInterface Pointer to the interface structure containing the called function pointer.
636	* @param pHstStrmOut Pointer to host output stream.
637	* @param enmStreamCmd The stream command to issue.
638	*/
639	DECLR3CALLBACKMEMBER(int, pfnControlIn, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMIN pHstStrmIn, PDMAUDIOSTREAMCMD enmStreamCmd));
640
641	/**
642	* End the host audio input streamm.
643	*
644	* @returns VBox status code.
645	* @param pInterface Pointer to the interface structure containing the called function pointer.
646	* @param pHstStrmIn Pointer to host input stream.
647	*/
648	DECLR3CALLBACKMEMBER(int, pfnFiniIn, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMIN pHstStrmIn));
649
650	/**
651	* End the host output stream.
652	*
653	* @returns VBox status code.
654	* @param pInterface Pointer to the interface structure containing the called function pointer.
655	* @param pHstStrmOut Pointer to host output stream.
656	*/
657	DECLR3CALLBACKMEMBER(int, pfnFiniOut, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMOUT pHstStrmOut));
658
659	/**
660	* Play audio out from stream buffer.
661	*
662	* @returns VBox status code.
663	* @param pInterface Pointer to the interface structure containing the called function pointer.
664	* @param pHstStrmOut Pointer to host output stream.
665	* @param pcSamplesPlayed Pointer to number of samples captured.
666	*/
667	DECLR3CALLBACKMEMBER(int, pfnPlayOut, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMOUT pHstStrmOut, uint32_t *pcSamplesPlayed));
668
669	/**
670	* Records audio to input stream.
671	*
672	* @returns VBox status code.
673	* @param pInterface Pointer to the interface structure containing the called function pointer.
674	* @param pHstStrmIn Pointer to host input stream.
675	* @param pcSamplesCaptured Pointer to number of samples captured.
676	*/
677	DECLR3CALLBACKMEMBER(int, pfnCaptureIn, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOHSTSTRMIN pHstStrmIn, uint32_t *pcSamplesCaptured));
678
679	/**
680	* Gets the configuration from the host audio (backend) driver.
681	*
682	* @returns VBox status code.
683	* @param pInterface Pointer to the interface structure containing the called function pointer.
684	* @param pBackendCfg Pointer where to store the backend audio configuration to.
685	*/
686	DECLR3CALLBACKMEMBER(int, pfnGetConf, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDCFG pBackendCfg));
687
688	} PDMIHOSTAUDIO;
689	#define PDMIHOSTAUDIO_IID "39feea4f-c824-4197-bcff-7d4a6ede7420"
690
691	#endif /* VBOX_WITH_PDM_AUDIO_DRIVER */
692
693	#endif /* ___VBox_vmm_pdmaudioifs_h */
694

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/vmm/pdmaudioifs.h@ 53625

Download in other formats: