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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*
* libmm-sound
*
* Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
*
* Contact: Seungbae Shin <seungbae.shin@samsung.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/**
* @file mm_sound.h
* @brief Application interface library for sound module.
* @date
* @version Release
*
* Application interface library for sound module.
*/
#ifndef __MM_SOUND_PRIVATE_H__
#define __MM_SOUND_PRIVATE_H__
#include <mm_types.h>
#include <mm_error.h>
#include <mm_sound.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
@internal
@addtogroup SOUND_PRIVATE
@{
*/
enum MMSoundGainType {
MM_SOUND_GAIN_KEYTONE = 0, /**< hw gain configuration for keytone play */
MM_SOUND_GAIN_RINGTONE, /**< hw gain configuration for ringtone play */
MM_SOUND_GAIN_ALARMTONE, /**< hw gain configuration for alarmtone play */
MM_SOUND_GAIN_CALLTONE, /**< hw gain configuration for calltone play */
MM_SOUND_GAIN_AUDIOPLAYER, /**< hw gain configuration for music play */
MM_SOUND_GAIN_VIDEOPLAYER, /**< hw gain configuration for video play */
MM_SOUND_GAIN_VOICECALL, /**< hw gain configuration for voice call */
MM_SOUND_GAIN_VIDEOCALL, /**< hw gain configuration for video call */
MM_SOUND_GAIN_FMRADIO, /**< hw gain configuration for fm radio play */
MM_SOUND_GAIN_VOICEREC, /**< hw gain configuration for voice recording */
MM_SOUND_GAIN_CAMCORDER, /**< hw gain configuration for camcording */
MM_SOUND_GAIN_CAMERA, /**< hw gain configuration for camera shutter sound */
MM_SOUND_GAIN_GAME, /**< hw gain configuration for game play */
MM_SOUND_GAIN_CNT, /**< hw gain configuration count */
MM_SOUND_GAIN_MUSIC = MM_SOUND_GAIN_AUDIOPLAYER, /**< remained for legacy application */
MM_SOUND_GAIN_VIDEO, /**< remained for legacy application */
MM_SOUND_GAIN_NONE = MM_SOUND_GAIN_KEYTONE, /**< remained for legacy application */
};
/**
* Enumerations for sound path
*/
enum MMSoundPathExType {
MM_SOUND_PATH_NONE = 0, /**< no route path */
MM_SOUND_PATH_SPK, /**< sound route to speaker */
MM_SOUND_PATH_RECV, /**< sound route to receiver */
MM_SOUND_PATH_HEADSET, /**< sound route to headset */
MM_SOUND_PATH_BTHEADSET, /**< sound route to bluetooth headset */
MM_SOUND_PATH_A2DP, /**< not used */
MM_SOUND_PATH_HANDSFREE, /**< not used */
MM_SOUND_PATH_HDMI, /**< not used */
MM_SOUND_PATH_OUTMAX, /**< output route count */
MM_SOUND_PATH_MIC = 1, /**< sound route from microphone */
MM_SOUND_PATH_HEADSETMIC, /**< sound route from headset microphone */
MM_SOUND_PATH_BTMIC, /**< sound route from bluetooth microphone */
MM_SOUND_PATH_FMINPUT, /**< sound route from FM radio module */
MM_SOUND_PATH_HANDSFREEMIC, /**< not used */
MM_SOUND_PATH_INMAX, /**< input route count */
};
/**
* Enumerations for sound path option
*/
enum MMSoundPathOptionType {
MM_SOUND_PATH_OPTION_NONE = 0x00000000, /**< no sound path option */
MM_SOUND_PATH_OPTION_AUTO_HEADSET_CONTROL = 0x00000001, /**< automatic sound path change by earphone event */
MM_SOUND_PATH_OPTION_SPEAKER_WITH_HEADSET = 0x00000002, /**< play sound via speaker and earphone (if inserted) */
MM_SOUND_PATH_OPTION_LEFT_SPEAKER_ONLY = 0x00000004, /**< not used */
MM_SOUND_PATH_OPTION_RIGHT_SPEAKER_ONLY = 0x00000008, /**< not used */
MM_SOUND_PATH_OPTION_VOICECALL_REC = 0x00000010, /**< voice call recording option */
MM_SOUND_PATH_OPTION_USE_SUB_MIC = 0x00000020, /**< use sub-mic on call and recording */
MM_SOUND_PATH_OPTION_LEGACY_MODE = 0x10000000, /**< not used */
};
/**
* Sound param
*/
enum {
MMSOUNDPARAM_FOLLOWING_ROUTE_POLICY,
MMSOUNDPARAM_SPEAKER_ONLY,
MMSOUNDPARAM_EARPHONE_AUTO,
MMSOUNDPARAM_SPEAKER_WITH_EARPHONE,
};
typedef struct {
const char *filename; /**< filename to play */
int volume; /**< relative volume level */
int loop; /**< loop count */
mm_sound_stop_callback_func callback; /**< callback function when playing is terminated */
void *data; /**< user data to callback */
void *mem_ptr; /**< memory buffer to play */
int mem_size; /**< size of memory buffer */
int bluetooth; /**< 1 for speaker only, 0 for by route policy */
int volume_table; /**< Volume Type (SW Volume table type) */
int priority; /**< 0 or 1 */
} MMSoundParamType;
/**
* This function is to play system sound with specified parameters.
*
* @param param [in] Reference pointer to MMSoundParamType structure
* @param handle [out] Handle of sound play.
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
* @remark When the stop callback is set, it will be called when system sound is
* terminated. If mm_sound_stop_sound() is called apparently before
* system sound is terminated, stop_callback will not be called.
* This function can use various sound route path with mm_sound_set_path
* @see mm_sound_stop_sound mm_sound_set_path
* @since R1, 1.0
* @limo
*/
int mm_sound_play_sound_ex(MMSoundParamType *param, int *handle);
/**
* This function is to play key sound.
*
* @param filename [in] keytone filename to play
* @param vol_type [in] Volume type
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
*
* @remark This function provide low latency sound play (such as dialer keytone)
* using fixed spec of wave file (44100Hz, mono channel)
* @see volume_type_t mm_sound_volume_set_value
*/
int mm_sound_play_keysound(const char *filename, const volume_type_t vol_type);
/**
* This function is to set sound device path.
*
* @param gain [in] sound path gain
* @param output [in] sound path out device
* @param input [in] sound path in device
* @param option [in] Sound path option
* MM_SOUND_PATH_OPTION_NONE
* MM_SOUND_PATH_OPTION_AUTO_HEADSET_CONTROL
* MM_SOUND_PATH_OPTION_SPEAKER_WITH_HEADSET
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
* @remark
* @see mm_sound_get_path
* @since 1.0
*/
int mm_sound_set_path(int gain, int output, int input, int option);
/**
* This function retreives current sound device path.
*
* @param gain [out] Sound device path
* @param output [out] Sound output device on/off
* @param input [out] Sound input device on/off
* @param option [out] Sound path option
* MM_SOUND_PATH_OPTION_NONE
* MM_SOUND_PATH_OPTION_AUTO_HEADSET_CONTROL
* MM_SOUND_PATH_OPTION_SPEAKER_WITH_HEADSET
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
* @remark
* @see mm_sound_set_path
*/
int mm_sound_get_path(int *gain, int *output, int *input, int *option);
int mm_sound_pcm_play_open_ex (MMSoundPcmHandle_t *handle, const unsigned int rate, MMSoundPcmChannel_t channel, MMSoundPcmFormat_t format, const volume_type_t vol_type, int asm_event);
/**
@}
*/
#ifdef __cplusplus
}
#endif
#endif /* __MM_SOUND_H__ */
|
