blob: 0cee7de576f807bb98df6119ec3dd8a91e00a00f (
plain)
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
|
/*
This file is part of GNUnet
Copyright (C) 2013 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Simon Dieterle
* @author Andreas Fuchs
* @author Christian Grothoff
*
* @file
* API to access an audio speaker; provides access to hardware speakers
*
* @defgroup speaker Speaker service
* Access hardware audio speakers.
* @{
*/
#ifndef GNUNET_SPEAKER_SERVICE_H
#define GNUNET_SPEAKER_SERVICE_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_util_lib.h"
/**
* Function that enables a speaker.
*
* @param cls closure
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
typedef int (*GNUNET_SPEAKER_EnableCallback)(void *cls);
/**
* Function that disables a speaker.
*
* @param cls closure
*/
typedef void (*GNUNET_SPEAKER_DisableCallback)(void *cls);
/**
* Function to destroy a speaker.
*
* @param cls closure
*/
typedef void (*GNUNET_SPEAKER_DestroyCallback)(void *cls);
/**
* Function to cause a speaker to play audio data.
*
* @param cls closure
* @param data_size number of bytes in @a data
* @param data audio data to play, format is
* opaque to the API but should be OPUS.
*/
typedef void (*GNUNET_SPEAKER_PlayCallback)(void *cls,
size_t data_size,
const void *data);
/**
* A speaker is a device that can play or record audio data.
*/
struct GNUNET_SPEAKER_Handle
{
/**
* Turn on the speaker.
*/
GNUNET_SPEAKER_EnableCallback enable_speaker;
/**
* Play audio.
*/
GNUNET_SPEAKER_PlayCallback play;
/**
* Turn the speaker off.
*/
GNUNET_SPEAKER_DisableCallback disable_speaker;
/**
* Destroy the speaker. Called by #GNUNET_SPEAKER_destroy.
*/
GNUNET_SPEAKER_DestroyCallback destroy_speaker;
/**
* Closure for the callbacks.
*/
void *cls;
};
/**
* Create a speaker that corresponds to the speaker hardware
* of our system.
*
* @param cfg configuration to use
* @return NULL on error
*/
struct GNUNET_SPEAKER_Handle *
GNUNET_SPEAKER_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Destroy a speaker.
*
* @param speaker speaker to destroy
*/
void
GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
/* end of gnunet_speaker_lib.h */
|
