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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* $Header: /pjproject/pjmedia/src/pjmedia/sound.h 8 8/24/05 10:30a Bennylp $ */
#ifndef __PJMEDIA_SOUND_H__
#define __PJMEDIA_SOUND_H__
/**
* @file sound.h
* @brief Sound player and recorder device framework.
*/
#include <pj/pool.h>
PJ_BEGIN_DECL
/**
* @defgroup PJMED_SND Sound device abstraction.
* @ingroup PJMEDIA
* @{
*/
/** Opaque data type for audio stream. */
typedef struct pj_snd_stream pj_snd_stream;
/**
* Device information structure returned by #pj_snd_get_dev_info.
*/
typedef struct pj_snd_dev_info
{
char name[64]; /**< Device name. */
unsigned input_count; /**< Max number of input channels. */
unsigned output_count; /**< Max number of output channels. */
unsigned default_samples_per_sec;/**< Default sampling rate. */
} pj_snd_dev_info;
/**
* Sound device parameter, to be specified when calling #pj_snd_open_recorder
* or #pj_snd_open_player.
*/
typedef struct pj_snd_stream_info
{
unsigned samples_per_sec; /* Sampling rate. */
unsigned bits_per_sample; /* No of bits per sample. */
unsigned samples_per_frame; /* No of samples per frame. */
unsigned bytes_per_frame; /* No of bytes per frame. */
unsigned frames_per_packet; /* No of frames per packet. */
} pj_snd_stream_info;
/**
* This callback is called by player stream when it needs additional data
* to be played by the device. Application must fill in the whole of output
* buffer with sound samples.
*
* @param user_data User data associated with the stream.
* @param timestamp Timestamp, in samples.
* @param output Buffer to be filled out by application.
* @param size The size requested in bytes, which will be equal to
* the size of one whole packet.
*
* @return Non-zero to stop the stream.
*/
typedef pj_status_t (*pj_snd_play_cb)(/* in */ void *user_data,
/* in */ pj_uint32_t timestamp,
/* out */ void *output,
/* out */ unsigned size);
/**
* This callback is called by recorder stream when it has captured the whole
* packet worth of audio samples.
*
* @param user_data User data associated with the stream.
* @param timestamp Timestamp, in samples.
* @param output Buffer containing the captured audio samples.
* @param size The size of the data in the buffer, in bytes.
*
* @return Non-zero to stop the stream.
*/
typedef pj_status_t (*pj_snd_rec_cb)(/* in */ void *user_data,
/* in */ pj_uint32_t timestamp,
/* in */ const void *input,
/* in*/ unsigned size);
/**
* Init the sound library.
*
* @param factory The sound factory.
*
* @return Zero on success.
*/
PJ_DECL(pj_status_t) pj_snd_init(pj_pool_factory *factory);
/**
* Get the number of devices detected by the library.
*
* @return Number of devices.
*/
PJ_DECL(int) pj_snd_get_dev_count(void);
/**
* Get device info.
*
* @param index The index of the device, which should be in the range
* from zero to #pj_snd_get_dev_count - 1.
*/
PJ_DECL(const pj_snd_dev_info*) pj_snd_get_dev_info(unsigned index);
/**
* Create a new audio stream for audio capture purpose.
*
* @param index Device index, or -1 to let the library choose the first
* available device, or -2 to use NULL device.
* @param param Stream parameters.
* @param rec_cb Callback to handle captured audio samples.
* @param user_data User data to be associated with the stream.
*
* @return Audio stream, or NULL if failed.
*/
PJ_DECL(pj_snd_stream*) pj_snd_open_recorder(int index,
const pj_snd_stream_info *param,
pj_snd_rec_cb rec_cb,
void *user_data);
/**
* Create a new audio stream for playing audio samples.
*
* @param index Device index, or -1 to let the library choose the first
* available device, or -2 to use NULL device.
* @param param Stream parameters.
* @param play_cb Callback to supply audio samples.
* @param user_data User data to be associated with the stream.
*
* @return Audio stream, or NULL if failed.
*/
PJ_DECL(pj_snd_stream*) pj_snd_open_player(int index,
const pj_snd_stream_info *param,
pj_snd_play_cb play_cb,
void *user_data);
/**
* Start the stream.
*
* @param stream The recorder or player stream.
*
* @return Zero on success.
*/
PJ_DECL(pj_status_t) pj_snd_stream_start(pj_snd_stream *stream);
/**
* Stop the stream.
*
* @param stream The recorder or player stream.
*
* @return Zero on success.
*/
PJ_DECL(pj_status_t) pj_snd_stream_stop(pj_snd_stream *stream);
/**
* Destroy the stream.
*
* @param stream The recorder of player stream.
*
* @return Zero on success.
*/
PJ_DECL(pj_status_t) pj_snd_stream_close(pj_snd_stream *stream);
/**
* Deinitialize sound library.
*
* @return Zero on success.
*/
PJ_DECL(pj_status_t) pj_snd_deinit(void);
/**
* @}
*/
PJ_END_DECL
#endif /* __PJMEDIA_SOUND_H__ */
|
