xref: /freebsd/usr.sbin/bhyve/audio.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2016 Alex Teaca <iateaca@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _AUDIO_EMUL_H_
30 #define _AUDIO_EMUL_H_
31 
32 #include <sys/types.h>
33 #include <sys/soundcard.h>
34 
35 /*
36  * Audio Player data structures
37  */
38 
39 struct audio;
40 
41 struct audio_params {
42 	int channels;
43 	int format;
44 	int rate;
45 };
46 
47 /*
48  * Audio Player API
49  */
50 
51 /*
52  * audio_init - initialize an instance of audio player
53  * @dev_name - the backend sound device used to play / capture
54  * @dir - dir = 1 for write mode, dir = 0 for read mode
55  * Returns NULL on error and the address of the audio player instance
56  */
57 struct audio *audio_init(const char *dev_name, uint8_t dir);
58 
59 /*
60  * audio_set_params - reset the sound device and set the audio params
61  * @aud - the audio player to be configured
62  * @params - the audio parameters to be set
63  * Returns -1 on error and 0 on success
64  */
65 int audio_set_params(struct audio *aud, struct audio_params *params);
66 
67 /*
68  * audio_playback - plays samples to the sound device using blocking operations
69  * @aud - the audio player used to play the samples
70  * @buf - the buffer containing the samples
71  * @count - the number of bytes in buffer
72  * Returns -1 on error and 0 on success
73  */
74 int audio_playback(struct audio *aud, const uint8_t *buf, size_t count);
75 
76 /*
77  * audio_record - records samples from the sound device using blocking
78  * operations.
79  * @aud - the audio player used to capture the samples
80  * @buf - the buffer to receive the samples
81  * @count - the number of bytes to capture in buffer
82  * Returns -1 on error and 0 on success
83  */
84 int audio_record(struct audio *aud, uint8_t *buf, size_t count);
85 
86 #endif  /* _AUDIO_EMUL_H_ */
87