VOLUME_TYPE_MEDIA, /**< Media volume type */
VOLUME_TYPE_CALL, /**< Call volume type */
VOLUME_TYPE_VOIP, /**< VOIP volume type */
+ VOLUME_TYPE_VOICE, /**< VOICE volume type */
VOLUME_TYPE_FIXED, /**< Volume type for fixed acoustic level */
- VOLUME_TYPE_EXT_JAVA, /**< External system volume for Java */
VOLUME_TYPE_MAX, /**< Volume type count */
- VOLUME_TYPE_EXT_ANDROID = VOLUME_TYPE_FIXED, /**< External system volume for Android */
+ VOLUME_TYPE_UNKNOWN = -1, /**< volume type is not determined */
} volume_type_t;
typedef enum {
VOLUME_GAIN_MIDI = 7<<8,
VOLUME_GAIN_BOOTING = 8<<8,
VOLUME_GAIN_VIDEO = 9<<8,
- VOLUME_GAIN_VIDEO_HDMI = 10<<8,
+ VOLUME_GAIN_TTS = 10<<8,
} volume_gain_t;
/**
- * Volume change callback function type.
- *
- * @param user_data [in] Argument passed when callback has called
- *
- * @return No return value
- * @remark None.
- * @see mm_sound_volume_add_callback mm_sound_volume_remove_callback
+ * @brief Enumerations of supporting source_type
*/
-typedef void (*volume_callback_fn)(void* user_data);
+typedef enum {
+ SUPPORT_SOURCE_TYPE_DEFAULT,
+ SUPPORT_SOURCE_TYPE_MIRRORING,
+ SUPPORT_SOURCE_TYPE_VOICECONTROL,
+ SUPPORT_SOURCE_TYPE_SVR,
+ SUPPORT_SOURCE_TYPE_VIDEOCALL,
+ SUPPORT_SOURCE_TYPE_VOICERECORDING,
+ SUPPORT_SOURCE_TYPE_VOIP, /* Supporting VoIP source*/
+ SUPPORT_SOURCE_TYPE_CALL_FORWARDING,
+ SUPPORT_SOURCE_TYPE_FMRADIO,
+ SUPPORT_SOURCE_TYPE_LOOPBACK,
+} mm_sound_source_type_e;
/**
- * This function is to retrieve number of volume level.
+ * Active volume change callback function type.
*
- * @param type [in] volume type to query
- * @param step [out] number of volume steps
+ * @param type [in] The sound type of changed volume
+ * @param volume [in] The new volume value
+ * @param user_data [in] Argument passed when callback has called
*
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark step means number of steps. so actual volume step can be 0 ~ step-1
- * @see volume_type_t
- * @pre None.
- * @post None.
- * @par Example
- * @code
-int step = 0;
-int ret = 0;
-int max = 0;
-
-ret = mm_sound_volume_get_step(VOLUME_TYPE_SYSTEM, &step);
-if(ret < 0)
-{
- printf("Can not get volume step\n");
-}
-else
-{
- max = step - 1;
- //set system volume to max value
- mm_sound_volume_set_value(VOLUME_TYPE_SYSTEM, max);
-}
- * @endcode
+ * @return No return value
+ * @remark None.
+ * @see mm_sound_add_volume_changed_callback mm_sound_remove_volume_changed_callback
*/
-int mm_sound_volume_get_step(volume_type_t type, int *step);
-
-
-/**
- * This function is to add volume changed callback.
- *
- * @param type [in] volume type to set change callback function
- * @param func [in] callback function pointer
- * @param user_data [in] user data passing to callback function
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark Only one callback function per volume type will be registered.
- * if you want to change callback function for certain volume type,
- * remove callback first via mm_sound_volume_remove_callback().
- * @see volume_type_t volume_callback_fn
- * @pre There should be not be pre-registered callback fuction to given volume type.
- * @post Callback function will be registered to given volume type
- * @par Example
- * @code
-volume_type_t g_vol_type = VOLUME_TYPE_MEDIA;
-
-void _volume_callback(void *data)
-{
- unsigned int value = 0;
- int result = 0;
- volume_type_t *type = (volume_type_t*)data;
-
- result = mm_sound_volume_get_value(*type, &value);
- if(result == MM_ERROR_NONE)
- {
- printf("Current volume value is %d\n", value);
- }
- else
- {
- printf("Can not get volume\n");
- }
-}
+typedef void (*mm_sound_volume_changed_cb) (volume_type_t type, unsigned int volume, void *user_data);
-int volume_control()
-{
- int ret = 0;
- ret = mm_sound_volume_add_callback(g_vol_type, _volume_callback, (void*)&g_vol_type);
- if ( MM_ERROR_NONE != ret)
- {
- printf("Can not add callback\n");
- }
- else
- {
- printf("Add callback success\n");
- }
- return 0;
-}
- * @endcode
- */
-int mm_sound_volume_add_callback(volume_type_t type, volume_callback_fn func, void* user_data);
+int mm_sound_add_volume_changed_callback(mm_sound_volume_changed_cb func, void* user_data, unsigned int *id);
/**
*/
int mm_sound_volume_remove_callback(volume_type_t type);
+/**
+ * This function is to remove volume change callback.
+ *
+ * @return This function returns MM_ERROR_NONE on success, or negative value
+ * with error code.
+ **/
+int mm_sound_remove_volume_changed_callback(unsigned int id);
/**
* This function is to set volume level of certain volume type.
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark value should be 0 ~ mm_sound_volume_get_step() -1
- * @see mm_sound_volume_get_step, mm_sound_volume_get_value volume_type_t
+ * @remark value should be 0 ~ MAX
+ * @see mm_sound_volume_get_value volume_type_t
* @pre None.
* @post Volume value will be changed to given value for given volume type.
* @par Example
- * @code
-int step = 0;
-int ret = 0;
-int max = 0;
-
-ret = mm_sound_volume_get_step(VOLUME_TYPE_SYSTEM, &step);
-if(ret < 0)
-{
- printf("Can not get volume step\n");
-}
-else
-{
- max = step - 1;
- //set system volume to max value
- ret = mm_sound_volume_set_value(VOLUME_TYPE_SYSTEM, max);
- if(ret < 0)
- {
- printf("Can not set volume value\n");
- }
-}
- * @endcode
*/
-int mm_sound_volume_set_value(volume_type_t type, const unsigned int value);
-
+int mm_sound_volume_set_value(volume_type_t type, const unsigned int volume_level);
/**
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
* @remark Application should use this function during foreground.
- * Application should clear primary volume type by mm_sound_volume_primary_type_clear() when it goes background.
* @pre None.
* @post Volume app. will be update given volume type when H/W volume control key pressed.
- * @see mm_sound_volume_primary_type_clear volume_type_t
+ * @see volume_type_t
* @par Example
* @code
static int _resume(void *data)
{
int ret = 0;
- ret = mm_sound_volume_primary_type_clear();
+ ret = mm_sound_volume_primary_type_set(VOLUME_TYPE_UNKNOWN);
if(ret < 0)
{
printf("Can not clear primary volume type\n");
* @endcode
*/
int mm_sound_volume_primary_type_set(volume_type_t type);
-
-
+int mm_sound_volume_primary_type_get(volume_type_t *type);
/**
- * This function is to clear primary volume type.
+ * This function is to set sound filter and apply to selected stream type.
*
+ * @param stream_type [in] stream type to apply
+ * @param filter_name [in] name of filter module to apply
+ * @param filter_parameters [in] extra filter parameters(optional)
+ * @param filter_group [in] extra filter group(optional)
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark mm_sound_volume_primary_type_set() and mm_sound_volume_primary_type_clear() should be used as pair
- * @see mm_sound_volume_primary_type_set
- * @pre primary volume should be set at same process.
- * @post primary volume will be cleared.
- * @par Example
- * @code
-static int _resume(void *data)
-{
- int ret = 0;
-
- ret = mm_sound_volume_primary_type_set(VOLUME_TYPE_MEDIA);
- if(ret < 0)
- {
- printf("Can not set primary volume type\n");
- }
- ...
-}
-
-static int _pause(void* data)
-{
- int ret = 0;
-
- ret = mm_sound_volume_primary_type_clear();
- if(ret < 0)
- {
- printf("Can not clear primary volume type\n");
- }
- ...
-}
-
-int main()
-{
- ...
- struct appcore_ops ops = {
- .create = _create,
- .terminate = _terminate,
- .pause = _pause,
- .resume = _resume,
- .reset = _reset,
- };
- ...
- return appcore_efl_main(PACKAGE, ..., &ops);
-}
- * @endcode
+ * @remark None
+ * @pre None
+ * @post None
+ * @see None
*/
-int mm_sound_volume_primary_type_clear();
-
-
+int mm_sound_set_filter(const char *stream_type, const char *filter_name, const char *filter_parameters, const char *filter_group);
/**
- * This function is to get current playing volume type
+ * This function is to unset sound filter and remove from selected stream type.
*
- * @param type [out] current playing volume type
+ * @param stream_type [in] stream type to remove
*
- * @return This function returns MM_ERROR_NONE on success,
- * or MM_ERROR_SOUND_VOLUME_NO_INSTANCE when there is no existing playing instance,
- * or MM_ERROR_SOUND_VOLUME_CAPTURE_ONLY when only capture audio instances are exist.
- * or negative value with error code for other errors.
- * @remark None.
- * @pre None.
- * @post None.
- * @see mm_sound_volume_get_value, mm_sound_volume_set_value
- * @par Example
- * @code
-int ret=0;
-volume_type_t type = 0;
-
-ret = mm_sound_volume_get_current_playing_type(&type);
-switch(ret)
-{
-case MM_ERROR_NONE:
- printf("Current playing is %d\n", type);
- break;
-case MM_ERROR_SOUND_VOLUME_NO_INSTANCE:
- printf("No sound instance\n");
- break;
-case MM_ERROR_SOUND_VOLUME_CAPTURE_ONLY:
- printf("Only sound capture instances are exist\n");
- break;
-default:
- printf("Error\n");
- break;
-}
-
- * @endcode
- */
-int mm_sound_volume_get_current_playing_type(volume_type_t *type);
-
-
-/*
- * MMSound PCM APIs
+ * @return This function returns MM_ERROR_NONE on success, or negative value
+ * with error code.
+ * @remark None
+ * @pre None
+ * @post None
+ * @see None
*/
-typedef void* MMSoundPcmHandle_t; /**< MMsound PCM handle type */
+int mm_sound_unset_filter(const char *stream_type);
/**
- * Enumerations of Format used in MMSoundPcm operation.
+ * This function is to control filter configurations to selected stream type.
+ *
+ * @param stream_type [in] stream type to apply
+ * @param filter_name [in] specify filter module to apply
+ * @param filter_controls [in] filter control parameters(e.g, "0.0, 0.1, 3.0")
+ *
+ * @return This function returns MM_ERROR_NONE on success, or negative value
+ * with error code.
+ * @remark None
+ * @pre None
+ * @post None
+ * @see None
*/
-typedef enum {
- MMSOUND_PCM_U8 = 0x70, /**< unsigned 8bit audio */
- MMSOUND_PCM_S16_LE, /**< signed 16bit audio */
-} MMSoundPcmFormat_t;
+int mm_sound_control_filter(const char *stream_type, const char *filter_name, const char *filter_controls);
/**
- * Enumerations of Channel count used in MMSoundPcm operation.
+ * Terminate callback function type.
+ *
+ * @param data [in] Argument passed when callback was set
+ * @param id [in] handle which has completed playing
+ *
+ * @return No return value
+ * @remark It is not allowed to call MMSound API recursively or do time-consuming
+ * task in this callback because this callback is called synchronously.
+ * @see mm_sound_play_sound
*/
-typedef enum {
- MMSOUND_PCM_MONO = 0x80, /**< Mono channel */
- MMSOUND_PCM_STEREO, /**< Stereo channel */
-}MMSoundPcmChannel_t;
+typedef void (*mm_sound_stop_callback_func) (void *data, int id);
+/*
+ * MMSound Play APIs
+ */
/**
- * This function is to create handle for PCM playback.
+ * This function is to play system sound.
*
- * @param handle [out] handle to play pcm data
- * @param rate [in] sample rate (8000Hz ~ 44100Hz)
- * @param channel [in] number of channels (mono or stereo)
- * @param format [in] S8 or S16LE
- * @param volume [in] volume type
+ * @param filename [in] Sound filename to play
+ * @param volume config [in] Volume type & volume gain
+ * @param callback [in] Callback function pointer when playing is terminated.
+ * @param data [in] Pointer to user data when callback is called.
+ * @param handle [out] Handle of sound play.
*
- * @return This function returns suggested buffer size (in bytes) on success, or negative value
+ * @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark use mm_sound_volume_set_value() function to change volume
- * @see mm_sound_pcm_play_write, mm_sound_pcm_play_close, mm_sound_volume_set_value, MMSoundPcmFormat_t, MMSoundPcmChannel_t volume_type_t
+ * @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.
+ * @see mm_sound_stop_sound mm_sound_stop_callback_func volume_type_t volume_gain_t
* @pre None.
- * @post PCM play handle will be created.
+ * @post Sound will be generated with given filename.
* @par Example
* @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
+int g_stop=0;
+void _stop_callback(void* data)
+{
+ printf("Stop callback\n");
+ g_stop = 1;
+}
-int main(int argc, char* argv[])
+int play_file()
{
- FILE *fp = NULL;
- char *buffer = NULL;
+ char filename[] ="testfile.wav";
+ volume_type_t volume = VOLUME_TYPE_SYSTEM;
int ret = 0;
- int size = 0;
- int readed = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
+ int handle = -1;
- fp = fopen(filename,"r");
- if(fp ==NULL)
+ ret = mm_sound_play_sound(filename, volume, _stop_callback, NULL, &handle);
+ if(ret < 0)
{
- printf("Can not open file %s\n", filename);
- return -1;
+ printf("play file failed\n");
}
-
- size = mm_sound_pcm_play_open(&handle, 44100, MMSOUND_PCM_STEREO, MMSOUND_PCM_S16_LE, VOLUME_TYPE_SYSTEM);
- if(size < 0)
+ else
{
- printf("Can not open playback handle\n");
- return -2;
+ printf("play file success\n");
}
-
- buffer = alloca(size);
- while((readed = fread(buffer, size, sizeof(char), fp)) > 0 )
+ while(g_stop == 0)
{
- ret = mm_sound_pcm_play_write(handle, (void*)buffer, readed);
- if(ret < 0)
- {
- printf("write fail\n");
- break;
- }
- memset(buffer, '\0', sizeof(buffer));
+ sleep(1);
}
-
- fclose(fp);
- mm_sound_pcm_play_close(handle);
+ printf("play stopped\n");
return 0;
}
* @endcode
*/
-int mm_sound_pcm_play_open(MMSoundPcmHandle_t *handle, const unsigned int rate, MMSoundPcmChannel_t channel, MMSoundPcmFormat_t format, const volume_type_t volume);
-
-/**
- * This function start pcm playback
- *
- * @param handle [in] handle to start playback
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark
- * @see
- * @pre PCM playback handle should be allocated.
- * @post PCM playback is ready to write.
- */
-int mm_sound_pcm_play_start(MMSoundPcmHandle_t handle);
+int mm_sound_play_sound(const char *filename, int volume_config, mm_sound_stop_callback_func callback, void *data, int *handle);
/**
- * This function stop pcm playback
+ * This function is to play system sound. And other audio stream will be mute during playing time
*
- * @param handle [in] handle to stop playback
+ * @param filename [in] Sound filename to play
+ * @param volume config [in] Volume type & volume gain
+ * @param callback [in] Callback function pointer when playing is terminated.
+ * @param data [in] Pointer to user data when callback is called.
+ * @param handle [out] Handle of sound play.
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark
- * @see
- * @pre PCM playback handle should be allocated.
- * @post PCM playback data will not be buffered.
- */
-int mm_sound_pcm_play_stop(MMSoundPcmHandle_t handle);
-
-/**
- * This function is to play PCM memory buffer.
- *
- * @param handle [in] handle to play pcm data
- * @param ptr [in] pcm buffer address
- * @param length_byte [in] size of pcm buffer (in bytes)
- *
- * @return This function returns written data size on success, or negative value
- * with error code.
- * @remark Make pcm buffer size with returned value of mm_sound_pcm_play_open()
- * @see mm_sound_pcm_play_open, mm_sound_pcm_play_close
- * @pre PCM play handle should be created.
- * @post Sound will be generated with given PCM buffer data.
+ * @remark This function is almost same with mm_sound_play_sound,
+ * but this make other audio playback stream to mute during playing time.
+ * @see mm_sound_stop_sound mm_sound_stop_callback_func volume_type_t volume_gain_t
+ * @pre None.
+ * @post Sound will be generated with given filename.
* @par Example
* @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
+int g_stop=0;
+void _stop_callback(void* data)
+{
+ printf("Stop callback\n");
+ g_stop = 1;
+}
-int main(int argc, char* argv[])
+int play_file()
{
- FILE *fp = NULL;
- char *buffer = NULL;
+ char filename[] ="testfile.wav";
+ volume_type_t volume = VOLUME_TYPE_SYSTEM;
int ret = 0;
- int size = 0;
- int readed = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
+ int handle = -1;
- fp = fopen(filename,"r");
- if(fp ==NULL)
+ ret = mm_sound_play_loud_solo_sound(filename, volume, _stop_callback, NULL, &handle);
+ if(ret < 0)
{
- printf("Can not open file %s\n", filename);
- return -1;
+ printf("play file failed\n");
}
-
- size = mm_sound_pcm_play_open(&handle, 44100, MMSOUND_PCM_STEREO, MMSOUND_PCM_S16_LE, VOLUME_TYPE_SYSTEM);
- if(size < 0)
+ else
{
- printf("Can not open playback handle\n");
- return -2;
+ printf("play file success\n");
}
-
- buffer = alloca(size);
- while((readed = fread(buffer, size, sizeof(char), fp)) > 0 )
+ while(g_stop == 0)
{
- ret = mm_sound_pcm_play_write(handle, (void*)buffer, readed);
- if(ret < 0)
- {
- printf("write fail\n");
- break;
- }
- memset(buffer, '\0', sizeof(buffer));
+ sleep(1);
}
-
- fclose(fp);
- mm_sound_pcm_play_close(handle);
+ printf("play stopped\n");
return 0;
}
* @endcode
*/
-int mm_sound_pcm_play_write(MMSoundPcmHandle_t handle, void* ptr, unsigned int length_byte);
-
-
+int mm_sound_play_loud_solo_sound(const char *filename, int volume_config, mm_sound_stop_callback_func callback, void *data, int *handle);
/**
- * This function is to close PCM memory playback handle
+ * This function is to stop playing system sound.
*
- * @param handle [in] handle to play pcm data
+ * @param handle [in] Handle of mm_sound_play_sound
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark None
- * @see mm_sound_pcm_play_open, mm_sound_pcm_play_write
- * @pre PCM play handle should be created
- * @post PCM play handle will be terminated.
+ *
+ * @remark When system sound is terminated with this function call, it does not
+ * call stop callback which was set when start playing system sound.
+ * @see mm_sound_play_sound
+ * @pre An sound play handle should be valid.
+ * @post Playing sound file will be stopped.
* @par Example
* @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
+int g_stop=0;
+void _stop_callback(void* data)
+{
+ printf("Stop callback\n");
+ g_stop = 1;
+}
-int main(int argc, char* argv[])
+int play_file_one_second()
{
- FILE *fp = NULL;
- char *buffer = NULL;
- int ret = 0;
- int size = 0;
- int readed = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
-
- fp = fopen(filename,"r");
- if(fp ==NULL)
- {
- printf("Can not open file %s\n", filename);
- return -1;
- }
-
- size = mm_sound_pcm_play_open(&handle, 44100, MMSOUND_PCM_STEREO, MMSOUND_PCM_S16_LE, VOLUME_TYPE_SYSTEM);
- if(size < 0)
- {
- printf("Can not open playback handle\n");
- return -2;
- }
-
- buffer = alloca(size);
- while((readed = fread(buffer, size, sizeof(char), fp)) > 0 )
- {
- ret = mm_sound_pcm_play_write(handle, (void*)buffer, readed);
- if(ret < 0)
- {
- printf("write fail\n");
- break;
- }
- memset(buffer, '\0', sizeof(buffer));
- }
-
- fclose(fp);
- mm_sound_pcm_play_close(handle);
- return 0;
-}
- * @endcode
- */
-int mm_sound_pcm_play_close(MMSoundPcmHandle_t handle);
-
-
-
-/**
- * This function is to create handle for PCM capture.
- *
- * @param handle [out] handle to capture pcm data
- * @param rate [in] sample rate (8000Hz ~ 44100Hz)
- * @param channel [in] number of channels (mono or stereo)
- * @param format [in] S8 or S16LE
- *
- * @return This function returns suggested buffer size (in bytes) on success, or negative value
- * with error code.
- * @remark only mono channel is valid for now.
- * @see mm_sound_pcm_capture_read, mm_sound_pcm_capture_close, MMSoundPcmFormat_t, MMSoundPcmChannel_t
- * @pre None.
- * @post PCM capture handle will be allocated.
- * @par Example
- * @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
-
-int main(int argc, char* argv[])
-{
- FILE *fp = NULL;
- char *buffer = NULL;
- int ret = 0;
- int size = 0;
- int count = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
-
- fp = fopen(filename,"w");
- if(fp ==NULL)
- {
- printf("Can not open file %s\n", filename);
- return -1;
- }
-
- size = mm_sound_pcm_capture_open(&handle, 44100, MMSOUND_PCM_MONO, MMSOUND_PCM_S16_LE);
- if(size < 0)
- {
- printf("Can not open capture handle\n");
- return -2;
- }
-
- buffer = alloca(size);
- while(1)
- {
- ret = mm_sound_pcm_capture_read(handle, (void*)buffer, size);
- if(ret < 0)
- {
- printf("read fail\n");
- break;
- }
- fwrite(buffer, ret, sizeof(char), fp);
- if(count++ > 20) {
- break;
- }
- }
-
- fclose(fp);
- mm_sound_pcm_capture_close(handle);
- return 0;
-}
-
- * @endcode
- */
-int mm_sound_pcm_capture_open(MMSoundPcmHandle_t *handle, const unsigned int rate, MMSoundPcmChannel_t channel, MMSoundPcmFormat_t format);
-
-/**
- * This function start pcm capture
- *
- * @param handle [in] handle to start capture
- *
- * @return This function returns read data size on success, or negative value
- * with error code.
- * @remark
- * @see
- * @pre PCM capture handle should be allocated.
- * @post PCM capture data will be buffered.
- */
-int mm_sound_pcm_capture_start(MMSoundPcmHandle_t handle);
-
-/**
- * This function stop pcm capture
- *
- * @param handle [in] handle to stop capture
- *
- * @return This function returns read data size on success, or negative value
- * with error code.
- * @remark
- * @see
- * @pre PCM capture handle should be allocated.
- * @post PCM capture data will not be buffered.
- */
-int mm_sound_pcm_capture_stop(MMSoundPcmHandle_t handle);
-
-/**
- * This function captures PCM to memory buffer. (Samsung extension)
- *
- * @param handle [in] handle to play pcm data
- * @param buffer [in] pcm buffer address
- * @param length [in] size of pcm buffer (in bytes)
- *
- * @return This function returns read data size on success, or negative value
- * with error code.
- * @remark Make pcm buffer size with returned value of mm_sound_pcm_capture_open()
- * @see mm_sound_pcm_capture_open, mm_sound_pcm_capture_close
- * @pre PCM capture handle should be allcated.
- * @post PCM data will be filled to given memory pointer.
- * @par Example
- * @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
-
-int main(int argc, char* argv[])
-{
- FILE *fp = NULL;
- char *buffer = NULL;
- int ret = 0;
- int size = 0;
- int count = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
-
- fp = fopen(filename,"w");
- if(fp ==NULL)
- {
- printf("Can not open file %s\n", filename);
- return -1;
- }
-
- size = mm_sound_pcm_capture_open(&handle, 44100, MMSOUND_PCM_MONO, MMSOUND_PCM_S16_LE);
- if(size < 0)
- {
- printf("Can not open capture handle\n");
- return -2;
- }
-
- buffer = alloca(size);
- while(1)
- {
- ret = mm_sound_pcm_capture_read(handle, (void*)buffer, size);
- if(ret < 0)
- {
- printf("read fail\n");
- break;
- }
- fwrite(buffer, ret, sizeof(char), fp);
- if(count++ > 20) {
- break;
- }
- }
-
- fclose(fp);
- mm_sound_pcm_capture_close(handle);
- return 0;
-}
-
- * @endcode
- */
-int mm_sound_pcm_capture_read(MMSoundPcmHandle_t handle, void *buffer, const unsigned int length );
-
-/**
- * This function captures PCM memory to memory buffer (Samsung extension)
- *
- * @param handle [in] handle to capture pcm data
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @see mm_sound_pcm_capture_open, mm_sound_pcm_capture_read
- * @pre PCM capture handle should be opend.
- * @post PCM capture handle will be freed.
- * @par Example
- * @code
-#include <mm_sound.h>
-#include <stdio.h>
-#include <alloca.h>
-
-int main(int argc, char* argv[])
-{
- FILE *fp = NULL;
- char *buffer = NULL;
- int ret = 0;
- int size = 0;
- int count = 0;
- MMSoundPcmHandle_t handle;
- char *filename = NULL;
-
- if(argc !=2 )
- {
- printf("Usage) %s filename\n", argv[0]);
- return -1;
- }
- filename = argv[1];
-
- fp = fopen(filename,"w");
- if(fp ==NULL)
- {
- printf("Can not open file %s\n", filename);
- return -1;
- }
-
- size = mm_sound_pcm_capture_open(&handle, 44100, MMSOUND_PCM_MONO, MMSOUND_PCM_S16_LE);
- if(size < 0)
- {
- printf("Can not open capture handle\n");
- return -2;
- }
-
- buffer = alloca(size);
- while(1)
- {
- ret = mm_sound_pcm_capture_read(handle, (void*)buffer, size);
- if(ret < 0)
- {
- printf("read fail\n");
- break;
- }
- fwrite(buffer, ret, sizeof(char), fp);
- if(count++ > 20) {
- break;
- }
- }
-
- fclose(fp);
- mm_sound_pcm_capture_close(handle);
- return 0;
-}
-
- * @endcode
- */
-int mm_sound_pcm_capture_close(MMSoundPcmHandle_t handle);
-
-/**
- * This function sets callback function for receiving messages from pcm API.
- *
- * @param handle [in] Handle of pcm.
- * @param callback [in] Message callback function.
- * @param user_param [in] User parameter which is passed to callback function.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value with error code.
- * @see MMMessageCallback
- * @remark None
- * @par Example
- * @code
-int msg_callback(int message, MMMessageParamType *param, void *user_param)
-{
- switch (message)
- {
- case MM_MESSAGE_SOUND_PCM_CAPTURE_RESTRICTED:
- //do something
- break;
-
- case MM_MESSAGE_SOUND_PCM_INTERRUPTED:
- //do something
- break;
-
- default:
- break;
- }
- return TRUE;
-}
-
-mm_sound_pcm_set_message_callback(pcmHandle, msg_callback, (void *)pcmHandle);
- * @endcode
- */
-int mm_sound_pcm_set_message_callback (MMSoundPcmHandle_t handle, MMMessageCallback callback, void *user_param);
-
-/**
- * Terminate callback function type.
- *
- * @param param [in] Argument passed when callback was set
- *
- * @return No return value
- * @remark It is not allowed to call MMSound API recursively or do time-consuming
- * task in this callback because this callback is called synchronously.
- * @see mm_sound_play_sound
- */
-typedef void (*mm_sound_stop_callback_func) (void *data);
-
-/*
- * MMSound Play APIs
- */
-
-/**
- * This function is to play system sound.
- *
- * @param filename [in] Sound filename to play
- * @param volume config [in] Volume type & volume gain
- * @param callback [in] Callback function pointer when playing is terminated.
- * @param data [in] Pointer to user data when callback is called.
- * @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.
- * @see mm_sound_stop_sound mm_sound_stop_callback_func volume_type_t volume_gain_t
- * @pre None.
- * @post Sound will be generated with given filename.
- * @par Example
- * @code
-int g_stop=0;
-void _stop_callback(void* data)
-{
- printf("Stop callback\n");
- g_stop = 1;
-}
-
-int play_file()
-{
- char filename[] ="/opt/media/Sound/testfile.wav";
- volume_type_t volume = VOLUME_TYPE_SYSTEM;
- int ret = 0;
- int handle = -1;
-
- ret = mm_sound_play_sound(filename, volume, _stop_callback, NULL, &handle);
- if(ret < 0)
- {
- printf("play file failed\n");
- }
- else
- {
- printf("play file success\n");
- }
- while(g_stop == 0)
- {
- sleep(1);
- }
- printf("play stopped\n");
- return 0;
-}
- * @endcode
- */
-int mm_sound_play_sound(const char *filename, int volume_config, mm_sound_stop_callback_func callback, void *data, int *handle);
-
-/**
- * This function is to play system sound. And other audio stream will be mute during playing time
- *
- * @param filename [in] Sound filename to play
- * @param volume config [in] Volume type & volume gain
- * @param callback [in] Callback function pointer when playing is terminated.
- * @param data [in] Pointer to user data when callback is called.
- * @param handle [out] Handle of sound play.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark This function is almost same with mm_sound_play_sound,
- * but this make other audio playback stream to mute during playing time.
- * @see mm_sound_stop_sound mm_sound_stop_callback_func volume_type_t volume_gain_t
- * @pre None.
- * @post Sound will be generated with given filename.
- * @par Example
- * @code
-int g_stop=0;
-void _stop_callback(void* data)
-{
- printf("Stop callback\n");
- g_stop = 1;
-}
-
-int play_file()
-{
- char filename[] ="/opt/media/Sound/testfile.wav";
- volume_type_t volume = VOLUME_TYPE_SYSTEM;
- int ret = 0;
- int handle = -1;
-
- ret = mm_sound_play_loud_solo_sound(filename, volume, _stop_callback, NULL, &handle);
- if(ret < 0)
- {
- printf("play file failed\n");
- }
- else
- {
- printf("play file success\n");
- }
- while(g_stop == 0)
- {
- sleep(1);
- }
- printf("play stopped\n");
- return 0;
-}
- * @endcode
- */
-int mm_sound_play_loud_solo_sound(const char *filename, int volume_config, mm_sound_stop_callback_func callback, void *data, int *handle);
-
-int mm_sound_play_loud_solo_sound_no_restore(const char *filename, int volume_config, mm_sound_stop_callback_func callback, void *data, int *handle);
-
-/**
- * This function is to stop playing system sound.
- *
- * @param handle [in] Handle of mm_sound_play_sound
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- *
- * @remark When system sound is terminated with this function call, it does not
- * call stop callback which was set when start playing system sound.
- * @see mm_sound_play_sound
- * @pre An sound play handle should be valid.
- * @post Playing sound file will be stopped.
- * @par Example
- * @code
-int g_stop=0;
-void _stop_callback(void* data)
-{
- printf("Stop callback\n");
- g_stop = 1;
-}
-
-int play_file_one_second()
-{
- char filename[] ="/opt/media/Sound/testfile.wav";
- volume_type_t volume = VOLUME_TYPE_SYSTEM;
+ char filename[] ="testfile.wav";
+ volume_type_t volume = VOLUME_TYPE_SYSTEM;
int ret = 0;
int handle = -1;
MM_SOUND_TONE_CDMA_HIGH_SSL, /**CDMA HIGH SSL tone: {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
MM_SOUND_TONE_CDMA_MED_SSL, /**CDMA MED SSL tone: {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
MM_SOUND_TONE_CDMA_LOW_SSL, /**CDMA LOW SSL tone: {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
- MM_SOUND_TONE_CDMA_HIGH_SS_2, /**CDMA HIGH SS2 tone: {3700Hz 25ms, 4000Hz 25ms} 20 times, 1000ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 3000ms OFF, repeat .... */
- MM_SOUND_TONE_CDMA_MED_SS_2, /**CDMA MED SS2 tone: {2600Hz 25ms, 2900Hz 25ms} 20 times, 1000ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 3000ms OFF, repeat .... */
- MM_SOUND_TONE_CDMA_LOW_SS_2, /**CDMA LOW SS2 tone: {1300Hz 25ms, 1450Hz 25ms} 20 times, 1000ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 3000ms OFF, repeat .... */
- MM_SOUND_TONE_CDMA_HIGH_SLS, /**CDMA HIGH SLS tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 3000ms OFF, REPEAT */
- MM_SOUND_TONE_CDMA_MED_SLS, /**CDMA MED SLS tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 3000ms OFF, REPEAT */
- MM_SOUND_TONE_CDMA_LOW_SLS, /**CDMA LOW SLS tone: {1300Hz 25ms, 1450Hz 25ms} 10 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 10 times, 3000ms OFF, REPEAT */
- MM_SOUND_TONE_CDMA_HIGH_S_X4, /**CDMA HIGH S X4 tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_MED_S_X4, /**CDMA MED S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_LOW_S_X4, /**CDMA LOW S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT....*/
- MM_SOUND_TONE_CDMA_HIGH_PBX_L, /**CDMA HIGH PBX L: {3700Hz 25ms, 4000Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_MED_PBX_L, /**CDMA MED PBX L: {2600Hz 25ms, 2900Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_LOW_PBX_L, /**CDMA LOW PBX L: {1300Hz 25ms,1450Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_HIGH_PBX_SS, /**CDMA HIGH PBX SS tone: {3700Hz 25ms, 4000Hz 25ms} 8 times 200 ms OFF, {3700Hz 25ms 4000Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_MED_PBX_SS, /**CDMA MED PBX SS tone: {2600Hz 25ms, 2900Hz 25ms} 8 times 200 ms OFF, {2600Hz 25ms 2900Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_LOW_PBX_SS, /**CDMA LOW PBX SS tone: {1300Hz 25ms, 1450Hz 25ms} 8 times 200 ms OFF, {1300Hz 25ms 1450Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_HIGH_PBX_SSL, /**CDMA HIGH PBX SSL tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_MED_PBX_SSL, /**CDMA MED PBX SSL tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_LOW_PBX_SSL, /**CDMA LOW PBX SSL tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_HIGH_PBX_SLS, /**CDMA HIGH PBX SLS tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_MED_PBX_SLS, /**CDMA MED PBX SLS tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_LOW_PBX_SLS, /**CDMA LOW PBX SLS tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
- MM_SOUND_TONE_CDMA_HIGH_PBX_S_X4, /**CDMA HIGH PBX X S4 tone: {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 800ms OFF, REPEAT... */
- MM_SOUND_TONE_CDMA_MED_PBX_S_X4, /**CDMA MED PBX X S4 tone: {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 800ms OFF, REPEAT... */
- MM_SOUND_TONE_CDMA_LOW_PBX_S_X4, /**CDMA LOW PBX X S4 tone: {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 800ms OFF, REPEAT... */
- MM_SOUND_TONE_CDMA_ALERT_NETWORK_LITE, /**CDMA Alert Network Lite tone: 1109Hz 62ms ON, 784Hz 62ms ON, 740Hz 62ms ON 622Hz 62ms ON, 1109Hz 62ms ON */
- MM_SOUND_TONE_CDMA_ALERT_AUTOREDIAL_LITE, /**CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON */
- MM_SOUND_TONE_CDMA_ONE_MIN_BEEP, /**CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON */
- MM_SOUND_TONE_CDMA_KEYPAD_VOLUME_KEY_LITE, /**CDMA KEYPAD Volume key lite tone: 941Hz+1477Hz 120ms ON */
- MM_SOUND_TONE_CDMA_PRESSHOLDKEY_LITE, /**CDMA PRESSHOLDKEY LITE tone: 587Hz 375ms ON, 1175Hz 125ms ON */
- MM_SOUND_TONE_CDMA_ALERT_INCALL_LITE, /**CDMA ALERT INCALL LITE tone: 587Hz 62ms, 784 62ms, 831Hz 62ms, 784Hz 62ms, 1109 62ms, 784Hz 62ms, 831Hz 62ms, 784Hz 62ms*/
- MM_SOUND_TONE_CDMA_EMERGENCY_RINGBACK, /**CDMA EMERGENCY RINGBACK tone: {941Hz 125ms ON, 10ms OFF} 3times 4990ms OFF, REPEAT... */
- MM_SOUND_TONE_CDMA_ALERT_CALL_GUARD, /**CDMA ALERT CALL GUARD tone: {1319Hz 125ms ON, 125ms OFF} 3 times */
- MM_SOUND_TONE_CDMA_SOFT_ERROR_LITE, /**CDMA SOFT ERROR LITE tone: 1047Hz 125ms ON, 370Hz 125ms */
- MM_SOUND_TONE_CDMA_CALLDROP_LITE, /**CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms */
- MM_SOUND_TONE_CDMA_NETWORK_BUSY_ONE_SHOT, /**CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. */
- MM_SOUND_TONE_CDMA_ABBR_ALERT, /**CDMA_ABBR_ALERT tone: 1150Hz+770Hz 400ms ON */
- MM_SOUND_TONE_CDMA_SIGNAL_OFF, /**CDMA_SIGNAL_OFF - silent tone */
- MM_SOUND_TONE_NUM,
-}MMSoundTone_t;
-
-typedef unsigned long sound_time_msec_t; /**< millisecond unit */
-
-/**
- * This function is to play tone sound.
- *
- * @param num [in] predefined tone type (MMSoundTone_t)
- * volume config [in] volume type & volume gain
- * volume [in] volume ratio (0.0 ~1.0)
- * duration [in] millisecond (-1 for infinite)
- * handle [in] Handle of mm_sound_play_tone
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- *
- * @remark It doesn't provide stop
- * @see volume_type_t volume_gain_t MMSoundTone_t
- * @pre None.
- * @post TONE sound will be played.
- * @par Example
- * @code
-int ret = 0;
-
-ret = mm_sound_play_tone(MM_SOUND_TONE_DTMF_9, VOLUME_TYPE_SYSTEM, 1.0, 1000, &handle); //play 1 second with volume ratio 1.0
-if(ret < 0)
-{
- printf("play tone failed\n");
-}
-else
-{
- printf("play tone success\n");
-}
- * @endcode
- */
-int mm_sound_play_tone (MMSoundTone_t num, int volume_config, const double volume, const int duration, int *handle);
-
-/*
- * Enumerations of System audio route policy
- */
-typedef enum {
- SYSTEM_AUDIO_ROUTE_POLICY_DEFAULT, /**< Play via a2dp headset if connected. or play via headset if connected. or play via speaker.
- And capture via 4pole headset-mic if connected. or capture via mic */
- SYSTEM_AUDIO_ROUTE_POLICY_IGNORE_A2DP, /**< Play via headset if connected. or play via speaker
- And capture via 4pole headset-mic if connected. or capture via mic */
- SYSTEM_AUDIO_ROUTE_POLICY_HANDSET_ONLY, /**< Play via speaker. and capture via mic */
- SYSTEM_AUDIO_ROUTE_POLICY_MAX
-}system_audio_route_t;
-
-typedef enum {
- SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_NONE, /**< Abnormal case */
- SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_HANDSET, /**< Speaker or Headset or Earpiece */
- SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_BLUETOOTH, /**< Bluetooth */
- SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_EARPHONE, /**< Earphone */
- SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_MAX,
-}system_audio_route_device_t;
-
-typedef enum {
- SYSTEM_AUDIO_CAPTURE_NONE, /**< Capture device is not in use */
- SYSTEM_AUDIO_CAPTURE_ACTIVE, /**< Capture device is in use */
- SYSTEM_AUDIO_CAPTURE_MAX,
-}system_audio_capture_status_t;
-
-
-/**
- * This function set system route policy.
- *
- * @param route [in] audio route type
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark If bluetooth has disconnected during SYSTEM_AUDIO_ROUTE_POLICY_IGNORE_A2DP policy,
- * The audio route policy will be changed to SYSTEM_AUDIO_ROUTE_POLICY_DEFAULT.
- * @see mm_sound_route_get_system_policy system_audio_route_t mm_sound_route_is_a2dp_on
- * @pre None.
- * @post Audio routing policy will be changed with given type. And route change callback function will be called if registered.
- * @par Example
- * @code
-int g_stop = 0;
-void _stop_callback()
-{
- g_stop = 1;
-}
-
-int play_file_via_speaker()
-{
- int ret = 0;
- system_audio_route_t route, original_route;
-
- //get backup current policy
- ret = mm_sound_route_get_system_policy(&original_route);
- if(ret < 0)
- {
- printf("Can not get system audio route policy\n");
- }
- else
- {
- //set route policy to ignore a2dp
- route = SYSTEM_AUDIO_ROUTE_POLICY_IGNORE_A2DP;
- ret = mm_sound_route_set_system_policy(route);
- if(ret < 0)
- {
- printf("Ca not set route policy\n");
- }
- else
- {
- int handle;
- //play wav file
- ret = mm_sound_play_sound("/opt/media/Sound/alert.wav", VOLUME_TYPE_SYSTEM, NULL, NULL, &handle);
- if(ret < 0)
- {
- printf("Can not play wav file\n");
- }
- else
- {
- while(g_stop == 0)
- {
- sleep(1);
- }
- //restore original policy
- mm_sound_route_set_system_policy(original_route);
- }
- }
- }
- return 0;
-}
- * @endcode
- */
-int mm_sound_route_set_system_policy (system_audio_route_t route);
-
-/**
- * This function get sysytem route policy.
- *
- * @param route [out] audio route type
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @see mm_sound_route_set_system_policy system_audio_route_t mm_sound_route_is_a2dp_on
- * @pre None.
- * @post None.
- * @par Example
- * @code
-int g_stop = 0;
-void _stop_callback()
-{
- g_stop = 1;
-}
-
-int play_file_via_speaker()
-{
- int ret = 0;
- system_audio_route_t route, original_route;
-
- //get backup current policy
- ret = mm_sound_route_get_system_policy(&original_route);
- if(ret < 0)
- {
- printf("Can not get system audio route policy\n");
- }
- else
- {
- //set route policy to ignore a2dp
- route = SYSTEM_AUDIO_ROUTE_POLICY_IGNORE_A2DP;
- ret = mm_sound_route_set_system_policy(route);
- if(ret < 0)
- {
- printf("Can not set route policy\n");
- }
- else
- {
- int handle;
- //play wav file
- ret = mm_sound_play_sound("/opt/media/Sound/alert.wav", VOLUME_TYPE_SYSTEM, NULL, NULL, &handle);
- if(ret < 0)
- {
- printf("Can not play wav file\n");
- }
- else
- {
- while(g_stop == 0)
- {
- sleep(1);
- }
- //restore original policy
- mm_sound_route_set_system_policy(original_route);
- }
- }
- }
- return 0;
-}
- * @endcode
- */
-int mm_sound_route_get_system_policy (system_audio_route_t *route);
-
-
-
-/**
- * This function get a2dp activation information.
- *
- * @param connected [out] is Bluetooth A2DP connected (1:connected, 0:not connected)
- * bt_name [out] Bluetooth A2DP connected device name (allocated by internal when connected=1 otherwise set to null)
- *
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark This function allocation memory to given bt_name pointer internally.
- * So application should free given memory pointer later after use.
- * bt_name will be null if there's no a2dp device is connected (connected is 0)
- * @see mm_sound_route_set_system_policy mm_sound_route_get_system_policy
- * @pre None.
- * @post memory buffer will be allocated and fill with bluetooth device name.
- * @par Example
- * @code
-int ret;
-int connected = 0;
-char* bt_name = NULL;
-ret = mm_sound_route_get_a2dp_status (&connected, &bt_name);
-
-if (ret == MM_ERROR_NONE) {
- g_print ("### Is Bluetooth A2DP On Success : connected=[%d] name=[%s]\n", connected, bt_name);
- if (bt_name)
- free (bt_name);
-} else {
- g_print ("### Is Bluetooth A2DP On Error : errno [%d]\n", ret);
-
- * @endcode
- */
-int mm_sound_route_get_a2dp_status (bool* connected, char** bt_name);
+ MM_SOUND_TONE_CDMA_HIGH_SS_2, /**CDMA HIGH SS2 tone: {3700Hz 25ms, 4000Hz 25ms} 20 times, 1000ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 3000ms OFF, repeat .... */
+ MM_SOUND_TONE_CDMA_MED_SS_2, /**CDMA MED SS2 tone: {2600Hz 25ms, 2900Hz 25ms} 20 times, 1000ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 3000ms OFF, repeat .... */
+ MM_SOUND_TONE_CDMA_LOW_SS_2, /**CDMA LOW SS2 tone: {1300Hz 25ms, 1450Hz 25ms} 20 times, 1000ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 3000ms OFF, repeat .... */
+ MM_SOUND_TONE_CDMA_HIGH_SLS, /**CDMA HIGH SLS tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 3000ms OFF, REPEAT */
+ MM_SOUND_TONE_CDMA_MED_SLS, /**CDMA MED SLS tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 3000ms OFF, REPEAT */
+ MM_SOUND_TONE_CDMA_LOW_SLS, /**CDMA LOW SLS tone: {1300Hz 25ms, 1450Hz 25ms} 10 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 10 times, 3000ms OFF, REPEAT */
+ MM_SOUND_TONE_CDMA_HIGH_S_X4, /**CDMA HIGH S X4 tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_MED_S_X4, /**CDMA MED S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_LOW_S_X4, /**CDMA LOW S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT....*/
+ MM_SOUND_TONE_CDMA_HIGH_PBX_L, /**CDMA HIGH PBX L: {3700Hz 25ms, 4000Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_MED_PBX_L, /**CDMA MED PBX L: {2600Hz 25ms, 2900Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_LOW_PBX_L, /**CDMA LOW PBX L: {1300Hz 25ms,1450Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_HIGH_PBX_SS, /**CDMA HIGH PBX SS tone: {3700Hz 25ms, 4000Hz 25ms} 8 times 200 ms OFF, {3700Hz 25ms 4000Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_MED_PBX_SS, /**CDMA MED PBX SS tone: {2600Hz 25ms, 2900Hz 25ms} 8 times 200 ms OFF, {2600Hz 25ms 2900Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_LOW_PBX_SS, /**CDMA LOW PBX SS tone: {1300Hz 25ms, 1450Hz 25ms} 8 times 200 ms OFF, {1300Hz 25ms 1450Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_HIGH_PBX_SSL, /**CDMA HIGH PBX SSL tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_MED_PBX_SSL, /**CDMA MED PBX SSL tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_LOW_PBX_SSL, /**CDMA LOW PBX SSL tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_HIGH_PBX_SLS, /**CDMA HIGH PBX SLS tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_MED_PBX_SLS, /**CDMA MED PBX SLS tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_LOW_PBX_SLS, /**CDMA LOW PBX SLS tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
+ MM_SOUND_TONE_CDMA_HIGH_PBX_S_X4, /**CDMA HIGH PBX X S4 tone: {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 800ms OFF, REPEAT... */
+ MM_SOUND_TONE_CDMA_MED_PBX_S_X4, /**CDMA MED PBX X S4 tone: {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 800ms OFF, REPEAT... */
+ MM_SOUND_TONE_CDMA_LOW_PBX_S_X4, /**CDMA LOW PBX X S4 tone: {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 800ms OFF, REPEAT... */
+ MM_SOUND_TONE_CDMA_ALERT_NETWORK_LITE, /**CDMA Alert Network Lite tone: 1109Hz 62ms ON, 784Hz 62ms ON, 740Hz 62ms ON 622Hz 62ms ON, 1109Hz 62ms ON */
+ MM_SOUND_TONE_CDMA_ALERT_AUTOREDIAL_LITE, /**CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON */
+ MM_SOUND_TONE_CDMA_ONE_MIN_BEEP, /**CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON */
+ MM_SOUND_TONE_CDMA_KEYPAD_VOLUME_KEY_LITE, /**CDMA KEYPAD Volume key lite tone: 941Hz+1477Hz 120ms ON */
+ MM_SOUND_TONE_CDMA_PRESSHOLDKEY_LITE, /**CDMA PRESSHOLDKEY LITE tone: 587Hz 375ms ON, 1175Hz 125ms ON */
+ MM_SOUND_TONE_CDMA_ALERT_INCALL_LITE, /**CDMA ALERT INCALL LITE tone: 587Hz 62ms, 784 62ms, 831Hz 62ms, 784Hz 62ms, 1109 62ms, 784Hz 62ms, 831Hz 62ms, 784Hz 62ms*/
+ MM_SOUND_TONE_CDMA_EMERGENCY_RINGBACK, /**CDMA EMERGENCY RINGBACK tone: {941Hz 125ms ON, 10ms OFF} 3times 4990ms OFF, REPEAT... */
+ MM_SOUND_TONE_CDMA_ALERT_CALL_GUARD, /**CDMA ALERT CALL GUARD tone: {1319Hz 125ms ON, 125ms OFF} 3 times */
+ MM_SOUND_TONE_CDMA_SOFT_ERROR_LITE, /**CDMA SOFT ERROR LITE tone: 1047Hz 125ms ON, 370Hz 125ms */
+ MM_SOUND_TONE_CDMA_CALLDROP_LITE, /**CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms */
+ MM_SOUND_TONE_CDMA_NETWORK_BUSY_ONE_SHOT, /**CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. */
+ MM_SOUND_TONE_CDMA_ABBR_ALERT, /**CDMA_ABBR_ALERT tone: 1150Hz+770Hz 400ms ON */
+ MM_SOUND_TONE_CDMA_SIGNAL_OFF, /**CDMA_SIGNAL_OFF - silent tone */
+ MM_SOUND_TONE_LOW_FRE, /**100Hz continuous */
+ MM_SOUND_TONE_MED_FRE, /**200Hz continuous */
+ MM_SOUND_TONE_HIGH_FRE, /**300Hz continuous */
+ MM_SOUND_TONE_NUM,
+}MMSoundTone_t;
+typedef unsigned long sound_time_msec_t; /**< millisecond unit */
/**
- * This function get current playing device.
+ * This function is to play tone sound.
*
- * @param dev [out] current playing device information
+ * @param num [in] predefined tone type (MMSoundTone_t)
+ * volume config [in] volume type & volume gain
+ * volume [in] volume ratio (0.0 ~1.0)
+ * duration [in] millisecond (-1 for infinite)
+ * handle [in] Handle of mm_sound_play_tone
+ * enable_session [in] set enable/unable session
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark if there is no running instance in system,
- * output parameter dev can be SYSTEM_AUDIO_ROUTE_PLAYING_DEVICE_NONE.
*
- * @see system_audio_route_device_t
+ * @remark It doesn't provide stop
+ * @see volume_type_t volume_gain_t MMSoundTone_t
* @pre None.
- * @post None.
+ * @post TONE sound will be played.
* @par Example
* @code
int ret = 0;
-system_audio_route_device_t dev;
-ret = mm_sound_route_get_playing_device (&dev);
-if(ret == MM_ERROR_NONE)
+ret = mm_sound_play_tone_ex(MM_SOUND_TONE_DTMF_9, VOLUME_TYPE_SYSTEM, 1.0, 1000, &handle, TRUE); //play 1 second with volume ratio 1.0
+if(ret < 0)
{
- switch(dev)
- {
- case SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_HANDSET:
- printf("Handset is playing\n");
- break;
- case SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_BLUETOOTH:
- printf("Bluetooth is playing\n");
- break;
- case SYSTEM_AUDIO_ROUTE_PLAYBACK_DEVICE_NONE:
- default:
- printf("Unexptected\n");
- break;
- }
+ printf("play tone failed\n");
}
else
{
- printf ("Can not get current running device\n");
+ printf("play tone success\n");
}
-
* @endcode
*/
-int mm_sound_route_get_playing_device(system_audio_route_device_t *dev);
-
-
-/**
- * Audio route policy change callback function type.
- *
- * @param user_data [in] Argument passed when callback has called
- * @param policy [in] changed policy type
- *
- * @return No return value
- * @remark
- * @see mm_sound_volume_add_callback mm_sound_volume_remove_callback
- */
-typedef void (*audio_route_policy_changed_callback_fn)(void* user_data, system_audio_route_t policy);
+int mm_sound_play_tone_ex (MMSoundTone_t num, int volume_config, const double volume, const int duration, int *handle, bool enable_session);
/**
- * This function set system audio policy changed callback function.
+ * This function is to play tone sound.
*
- * @param func [in] callback function pointer
- * @param user_data [in] user data will be called with func
+ * @param num [in] predefined tone type (MMSoundTone_t)
+ * volume config [in] volume type & volume gain
+ * volume [in] volume ratio (0.0 ~1.0)
+ * duration [in] millisecond (-1 for infinite)
+ * handle [in] Handle of mm_sound_play_tone
*
* @return This function returns MM_ERROR_NONE on success, or negative value
* with error code.
- * @remark None.
- * @see mm_sound_route_remove_change_callback mm_sound_route_set_system_policy mm_sound_route_get_system_policy system_audio_route_t
+ *
+ * @remark It doesn't provide stop
+ * @see volume_type_t volume_gain_t MMSoundTone_t
* @pre None.
- * @post None.
+ * @post TONE sound will be played.
* @par Example
* @code
-void audio_route_policy_changed_callback(void* data, system_audio_route_t policy)
-{
- int value = (int) data;
- system_audio_route_t lv_policy;
- char *str_route[SYSTEM_AUDIO_ROUTE_POLICY_MAX] = {
- "DEFAULT","IGN_A2DP","HANDSET"
- };
- printf("Audio Route Policy has changed to [%s]\n", str_route[policy]);
- printf("user data : %d\n", value);
- if(0 > mm_sound_route_get_system_policy(&lv_policy)) {
- printf("Can not get policy...in callback function\n");
- }
- else {
- printf("readed policy [%s]\n", str_route[lv_policy]);
- }
-}
-int make_callback()
-{
- int ret = 0;
- ret = mm_sound_route_add_change_callback(audio_route_policy_changed_callback, (void*)111);
- if(ret < 0)
- {
- printf("Can not add callback\n");
- }
- return 0;
-}
- * @endcode
- */
-int mm_sound_route_add_change_callback(audio_route_policy_changed_callback_fn func, void* user_data);
+int ret = 0;
-/**
- * This function remove system audio policy changed callback function.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @see mm_sound_route_add_change_callback mm_sound_route_set_system_policy mm_sound_route_get_system_policy system_audio_route_t
- * @pre Sound route change callback should be registered.
- * @post Sound route change callback deregistered and does not be called anymore.
- * @par Example
- * @code
-void audio_route_policy_changed_callback(void* data, system_audio_route_t policy)
+ret = mm_sound_play_tone(MM_SOUND_TONE_DTMF_9, VOLUME_TYPE_SYSTEM, 1.0, 1000, &handle); //play 1 second with volume ratio 1.0
+if(ret < 0)
{
- int value = (int) data;
- system_audio_route_t lv_policy;
- char *str_route[SYSTEM_AUDIO_ROUTE_POLICY_MAX] = {
- "DEFAULT","IGN_A2DP","HANDSET"
- };
- printf("Audio Route Policy has changed to [%s]\n", str_route[policy]);
- printf("user data : %d\n", value);
- if(0 > mm_sound_route_get_system_policy(&lv_policy)) {
- printf("Can not get policy...in callback function\n");
- }
- else {
- printf("readed policy [%s]\n", str_route[lv_policy]);
- }
+ printf("play tone failed\n");
}
-int make_callback()
+else
{
- int ret = 0;
- ret = mm_sound_route_add_change_callback(audio_route_policy_changed_callback, (void*)111);
- if(ret < 0)
- {
- printf("Can not add callback\n");
- }
- else
- {
- ret = mm_sound_route_remove_change_callback();
- if(ret < 0)
- {
- printf("Can not remove callback\n");
- }
- }
- return 0;
+ printf("play tone success\n");
}
* @endcode
*/
-int mm_sound_route_remove_change_callback(void);
+int mm_sound_play_tone (MMSoundTone_t num, int volume_config, const double volume, const int duration, int *handle);
+
+int mm_sound_play_tone_with_stream_info(MMSoundTone_t tone, char *stream_type, int stream_id, const double volume, const int duration, int *handle);
/*
* Enumerations of device & route
*/
typedef enum{
+ MM_SOUND_DIRECTION_NONE,
+ MM_SOUND_DIRECTION_IN, /**< Capture */
+ MM_SOUND_DIRECTION_OUT, /**< Playback */
+} mm_sound_direction;
+
+typedef enum{
MM_SOUND_DEVICE_IN_NONE = 0x00,
MM_SOUND_DEVICE_IN_MIC = 0x01, /**< Device builtin mic. */
MM_SOUND_DEVICE_IN_WIRED_ACCESSORY = 0x02, /**< Wired input devices */
- MM_SOUND_DEVICE_IN_BT_SCO = 0x04, /**< Bluetooth SCO device */
+ MM_SOUND_DEVICE_IN_BT_SCO = 0x08, /**< Bluetooth SCO device */
} mm_sound_device_in;
typedef enum{
MM_SOUND_DEVICE_OUT_NONE = 0x000,
- MM_SOUND_DEVICE_OUT_SPEAKER = 0x001<<8, /**< Device builtin speaker */
+ MM_SOUND_DEVICE_OUT_SPEAKER = 0x001<<8, /**< Device builtin speaker */
MM_SOUND_DEVICE_OUT_RECEIVER = 0x002<<8, /**< Device builtin receiver */
MM_SOUND_DEVICE_OUT_WIRED_ACCESSORY = 0x004<<8, /**< Wired output devices such as headphone, headset, and so on. */
MM_SOUND_DEVICE_OUT_BT_SCO = 0x008<<8, /**< Bluetooth SCO device */
- MM_SOUND_DEVICE_OUT_BT_A2DP = 0x010<<8, /**< Bluetooth A2DP device */
+ MM_SOUND_DEVICE_OUT_BT_A2DP = 0x010<<8, /**< Bluetooth A2DP device */
MM_SOUND_DEVICE_OUT_DOCK = 0x020<<8, /**< DOCK device */
MM_SOUND_DEVICE_OUT_HDMI = 0x040<<8, /**< HDMI device */
- MM_SOUND_DEVICE_OUT_WFD = 0x080<<8, /**< WFD device */
+ MM_SOUND_DEVICE_OUT_MIRRORING = 0x080<<8, /**< MIRRORING device */
MM_SOUND_DEVICE_OUT_USB_AUDIO = 0x100<<8, /**< USB Audio device */
+ MM_SOUND_DEVICE_OUT_MULTIMEDIA_DOCK = 0x200<<8, /**< Multimedia DOCK device */
} mm_sound_device_out;
-#define MM_SOUND_ROUTE_NUM 14
-
-typedef enum{
- MM_SOUND_ROUTE_OUT_SPEAKER = MM_SOUND_DEVICE_OUT_SPEAKER, /**< Routing audio output to builtin device such as internal speaker. */
- MM_SOUND_ROUTE_OUT_WIRED_ACCESSORY = MM_SOUND_DEVICE_OUT_WIRED_ACCESSORY,/**< Routing audio output to wired accessory such as headphone, headset, and so on. */
- MM_SOUND_ROUTE_OUT_BLUETOOTH = MM_SOUND_DEVICE_OUT_BT_A2DP, /**< Routing audio output to bluetooth A2DP. */
- MM_SOUND_ROUTE_OUT_DOCK = MM_SOUND_DEVICE_OUT_DOCK, /**< Routing audio output to DOCK */
- MM_SOUND_ROUTE_OUT_HDMI = MM_SOUND_DEVICE_OUT_HDMI, /**< Routing audio output to HDMI */
- MM_SOUND_ROUTE_OUT_WFD = MM_SOUND_DEVICE_OUT_WFD, /**< Routing audio output to WFD */
- MM_SOUND_ROUTE_OUT_USB_AUDIO = MM_SOUND_DEVICE_OUT_USB_AUDIO, /**< Routing audio output to USB Audio */
- MM_SOUND_ROUTE_IN_MIC = MM_SOUND_DEVICE_IN_MIC, /**< Routing audio input to device builtin mic. */
- MM_SOUND_ROUTE_IN_WIRED_ACCESSORY = MM_SOUND_DEVICE_IN_WIRED_ACCESSORY, /**< Routing audio input to wired accessory. */
- MM_SOUND_ROUTE_IN_MIC_OUT_RECEIVER = MM_SOUND_DEVICE_IN_MIC | MM_SOUND_DEVICE_OUT_RECEIVER, /**< Routing audio input to device builtin mic and routing audio output to builtin receiver*/
- MM_SOUND_ROUTE_IN_MIC_OUT_SPEAKER = MM_SOUND_DEVICE_IN_MIC | MM_SOUND_DEVICE_OUT_SPEAKER , /**< Routing audio input to device builtin mic and routing audio output to builtin speaker */
- MM_SOUND_ROUTE_IN_MIC_OUT_HEADPHONE = MM_SOUND_DEVICE_IN_MIC | MM_SOUND_DEVICE_OUT_WIRED_ACCESSORY,/**< Routing audio input to device builtin mic and routing audio output to headphone */
- MM_SOUND_ROUTE_INOUT_HEADSET = MM_SOUND_DEVICE_IN_WIRED_ACCESSORY | MM_SOUND_DEVICE_OUT_WIRED_ACCESSORY, /**< Routing audio input and output to headset*/
- MM_SOUND_ROUTE_INOUT_BLUETOOTH = MM_SOUND_DEVICE_IN_BT_SCO | MM_SOUND_DEVICE_OUT_BT_SCO /**< Routing audio input and output to bluetooth SCO */
-} mm_sound_route;
-
-typedef int (*mm_sound_available_route_cb)(mm_sound_route route, void *user_data);
-
-int mm_sound_is_route_available(mm_sound_route route, bool *is_available);
-
-int mm_sound_foreach_available_route_cb(mm_sound_available_route_cb, void *user_data);
-
-int mm_sound_set_active_route(mm_sound_route route);
-
-/**
- * This function is to get active playback device and capture device.
- *
- * @param playback_device [out] playback device.
- * @param capture_device [out] capture device.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @pre None.
- * @post None.
- * @see mm_sound_set_active_route mm_sound_device_in mm_sound_device_out
- */
-int mm_sound_get_active_device(mm_sound_device_in *device_in, mm_sound_device_out *device_out);
+typedef enum {
+ MM_SOUND_VOLUME_DEVICE_OUT_SPEAKER, /**< Device builtin speaker */
+ MM_SOUND_VOLUME_DEVICE_OUT_RECEIVER, /**< Device builtin receiver */
+ MM_SOUND_VOLUME_DEVICE_OUT_WIRED_ACCESSORY, /**< Wired output devices such as headphone, headset, and so on. */
+ MM_SOUND_VOLUME_DEVICE_OUT_BT_SCO, /**< Bluetooth SCO device */
+ MM_SOUND_VOLUME_DEVICE_OUT_BT_A2DP, /**< Bluetooth A2DP device */
+ MM_SOUND_VOLUME_DEVICE_OUT_DOCK, /**< DOCK device */
+ MM_SOUND_VOLUME_DEVICE_OUT_HDMI, /**< HDMI device */
+ MM_SOUND_VOLUME_DEVICE_OUT_MIRRORING, /**< MIRRORING device */
+ MM_SOUND_VOLUME_DEVICE_OUT_USB_AUDIO, /**< USB Audio device */
+ MM_SOUND_VOLUME_DEVICE_OUT_MULTIMEDIA_DOCK, /**< Multimedia DOCK device */
+} mm_sound_volume_device_out_t;
+
+#define MM_SOUND_ROUTE_NUM 16
+#define MM_SOUND_NAME_NUM 32
-/**
- * Active device changed callback function type.
- *
- * @param user_data [in] Argument passed when callback has called
- *
- * @return No return value
- * @remark None.
- * @see mm_sound_add_active_device_changed_callback mm_sound_remove_active_device_changed_callback
+/*
+ * MMSound Device APIs
*/
-typedef void (*mm_sound_active_device_changed_cb) (mm_sound_device_in device_in, mm_sound_device_out device_out, void *user_data);
-
-/**
- * This function is to add active device callback.
- *
- * @param func [in] callback function pointer
- * @param user_data [in] user data passing to callback function
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @see mm_sound_remove_active_device_changed_callback mm_sound_active_device_changed_cb
- * @pre None.
- * @post None.
- * @par Example
- * @code
-
-void __active_device_callback(void *user_data)
-{
- printf("Callback function\n");
-}
-
-int active_device_control()
-{
- int ret = 0;
-
- ret = mm_sound_add_active_device_changed_callback(__active_device_callback, NULL);
- if ( MM_ERROR_NONE != ret)
- {
- printf("Can not add callback\n");
- }
- else
- {
- printf("Add callback success\n");
- }
- return ret;
-}
+typedef enum {
+ MM_SOUND_DEVICE_IO_DIRECTION_IN_FLAG = 0x0001, /**< Flag for input devices */
+ MM_SOUND_DEVICE_IO_DIRECTION_OUT_FLAG = 0x0002, /**< Flag for output devices */
+ MM_SOUND_DEVICE_IO_DIRECTION_BOTH_FLAG = 0x0004, /**< Flag for input/output devices (both directions are available) */
+ MM_SOUND_DEVICE_TYPE_INTERNAL_FLAG = 0x0010, /**< Flag for built-in devices */
+ MM_SOUND_DEVICE_TYPE_EXTERNAL_FLAG = 0x0020, /**< Flag for external devices */
+ MM_SOUND_DEVICE_STATE_DEACTIVATED_FLAG = 0x1000, /**< Flag for deactivated devices */
+ MM_SOUND_DEVICE_STATE_ACTIVATED_FLAG = 0x2000, /**< Flag for activated devices */
+ MM_SOUND_DEVICE_ALL_FLAG = 0xFFFF, /**< Flag for all devices */
+} mm_sound_device_flags_e;
- * @endcode
- */
-int mm_sound_add_active_device_changed_callback(mm_sound_active_device_changed_cb func, void *user_data);
+typedef enum {
+ MM_SOUND_DEVICE_IO_DIRECTION_IN = 0x1,
+ MM_SOUND_DEVICE_IO_DIRECTION_OUT = 0x2,
+ MM_SOUND_DEVICE_IO_DIRECTION_BOTH = MM_SOUND_DEVICE_IO_DIRECTION_IN | MM_SOUND_DEVICE_IO_DIRECTION_OUT,
+} mm_sound_device_io_direction_e;
-/**
- * This function is to remove active device callback.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @pre Active device callback should be registered.
- * @post Active device callback deregistered and does not be called anymore.
- * @see mm_sound_add_active_device_changed_callback mm_sound_active_device_changed_cb
- * @par Example
- * @code
-void __active_device_callback(void *data)
-{
- printf("Callback function\n");
-}
+typedef enum {
+ MM_SOUND_DEVICE_STATE_DEACTIVATED,
+ MM_SOUND_DEVICE_STATE_ACTIVATED,
+} mm_sound_device_state_e;
-int active_device_control()
+typedef enum
{
- int ret = 0;
-
- mm_sound_add_active_device_changed_callback(__active_device_callback, NULL);
-
- ret = mm_sound_remove_active_device_changed_callback();
- if ( MM_ERROR_NONE == ret)
- {
- printf("Remove callback success\n");
- }
- else
- {
- printf("Remove callback failed\n");
- }
-
- return ret;
-}
-
- * @endcode
- */
-int mm_sound_remove_active_device_changed_callback(void);
+ MM_SOUND_DEVICE_TYPE_BUILTIN_SPEAKER, /**< Built-in speaker. */
+ MM_SOUND_DEVICE_TYPE_BUILTIN_RECEIVER, /**< Built-in receiver. */
+ MM_SOUND_DEVICE_TYPE_BUILTIN_MIC, /**< Built-in mic. */
+ MM_SOUND_DEVICE_TYPE_AUDIOJACK, /**< Audio jack such as headphone, headset, and so on. */
+ MM_SOUND_DEVICE_TYPE_BLUETOOTH, /**< Bluetooth */
+ MM_SOUND_DEVICE_TYPE_BLUETOOTH_A2DP = MM_SOUND_DEVICE_TYPE_BLUETOOTH, /**< Bluetooth A2DP */
+ MM_SOUND_DEVICE_TYPE_HDMI, /**< HDMI. */
+ MM_SOUND_DEVICE_TYPE_MIRRORING, /**< MIRRORING. */
+ MM_SOUND_DEVICE_TYPE_USB_AUDIO, /**< USB Audio. */
+ MM_SOUND_DEVICE_TYPE_BLUETOOTH_SCO, /**< Bluetooth SCO */
+} mm_sound_device_type_e;
+
+typedef void *MMSoundDevice_t; /**< MMsound Device handle */
+typedef void *MMSoundDeviceList_t; /**< MMsound Device list handle */
+typedef void (*mm_sound_device_connected_cb) (MMSoundDevice_t device_h, bool is_connected, void *user_data);
+typedef void (*mm_sound_device_info_changed_cb) (MMSoundDevice_t device_h, int changed_info_type, void *user_data);
+typedef void (*mm_sound_device_state_changed_cb) (MMSoundDevice_t device_h, mm_sound_device_state_e state, void *user_data);
+
+int mm_sound_add_device_connected_callback(int flags, mm_sound_device_connected_cb func, void *user_data, unsigned int *id);
+int mm_sound_remove_device_connected_callback(unsigned int id);
+int mm_sound_add_device_information_changed_callback(int flags, mm_sound_device_info_changed_cb func, void *user_data, unsigned int *id);
+int mm_sound_remove_device_information_changed_callback(unsigned int id);
+int mm_sound_add_device_state_changed_callback(int flags, mm_sound_device_state_changed_cb func, void *user_data, unsigned int *id);
+int mm_sound_remove_device_state_changed_callback(unsigned int id);
+
+int mm_sound_get_current_device_list(mm_sound_device_flags_e device_mask, MMSoundDeviceList_t *device_list);
+int mm_sound_get_device_list(int device_mask, MMSoundDeviceList_t *device_list);
+/* Free this device handle with mm_sound_free_device */
+int mm_sound_get_device_by_id(int device_id, MMSoundDevice_t *device);
+int mm_sound_free_device_list(MMSoundDeviceList_t device_list);
+/* Use this only for the device handle which got from mm_sound_get_device_by_id */
+int mm_sound_free_device(MMSoundDevice_t device_h);
+int mm_sound_get_next_device (MMSoundDeviceList_t device_list, MMSoundDevice_t *device);
+int mm_sound_get_prev_device (MMSoundDeviceList_t device_list, MMSoundDevice_t *device);
+int mm_sound_get_device_type(MMSoundDevice_t device_h, mm_sound_device_type_e *type);
+int mm_sound_get_device_io_direction(MMSoundDevice_t device_h, mm_sound_device_io_direction_e *io_direction);
+int mm_sound_get_device_id(MMSoundDevice_t device_h, int *id);
+int mm_sound_get_device_state(MMSoundDevice_t device_h, mm_sound_device_state_e *state);
+int mm_sound_get_device_name(MMSoundDevice_t device_h, char **name);
+int mm_sound_get_device_vendor_id(MMSoundDevice_t device_h, int *vendor_id);
+int mm_sound_get_device_product_id(MMSoundDevice_t device_h, int *product_id);
/**
- * Available route changed callback function type.
+ * Active device changed callback function type.
*
* @param user_data [in] Argument passed when callback has called
*
* @remark None.
* @see mm_sound_add_active_device_changed_callback mm_sound_remove_active_device_changed_callback
*/
-typedef void (*mm_sound_available_route_changed_cb) (mm_sound_route route, bool available, void *user_data);
-
-/**
- * This function is to add available device callback.
- *
- * @param func [in] callback function pointer
- * @param user_data [in] user data passing to callback function
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @see mm_sound_remove_available_route_changed_callback mm_sound_active_device_changed_cb
- * @pre None.
- * @post None.
- * @par Example
- * @code
-
-void __available_device_callback(void *user_data)
-{
- printf("Callback function\n");
-}
-
-int available_device_control()
-{
- int ret = 0;
-
- ret = mm_sound_add_available_route_changed_callback(__available_device_callback, NULL);
- if ( MM_ERROR_NONE != ret)
- {
- printf("Can not add callback\n");
- }
- else
- {
- printf("Add callback success\n");
- }
-
- return ret;
-}
-
- * @endcode
- */
-int mm_sound_add_available_route_changed_callback(mm_sound_available_route_changed_cb func, void *user_data);
-
-/**
- * This function is to remove available device callback.
- *
- * @return This function returns MM_ERROR_NONE on success, or negative value
- * with error code.
- * @remark None.
- * @pre available device callback should be registered.
- * @post available device callback deregistered and does not be called anymore.
- * @see mm_sound_add_available_route_changed_callback mm_sound_active_device_changed_cb
- * @par Example
- * @code
-void __available_device_callback(void *data)
-{
- printf("Callback function\n");
-}
-
-int available_device_control()
-{
- int ret = 0;
+typedef void (*mm_sound_active_device_changed_cb) (mm_sound_device_in device_in, mm_sound_device_out device_out, void *user_data);
- mm_sound_add_available_route_changed_callback(__available_device_callback, NULL);
+typedef void (*mm_sound_test_cb) (int a, void *user_data);
+int mm_sound_test(int a, int b, int* get);
+int mm_sound_add_test_callback(mm_sound_test_cb func, void *user_data, unsigned int *id);
+int mm_sound_remove_test_callback(unsigned int sub_id);
- ret = mm_sound_remove_available_route_changed_callback();
- if ( MM_ERROR_NONE == ret)
- {
- printf("Remove callback success\n");
- }
- else
- {
- printf("Remove callback failed\n");
- }
+void mm_sound_convert_volume_type_to_stream_type(int volume_type, char *stream_type);
- return ret;
-}
+typedef enum {
+ MM_SOUND_SIGNAL_RELEASE_INTERNAL_FOCUS,
+ MM_SOUND_SIGNAL_MAX,
+} mm_sound_signal_name_t;
+
+typedef void (*mm_sound_signal_callback) (mm_sound_signal_name_t signal_type, int value, void *user_data);
+int mm_sound_subscribe_signal(mm_sound_signal_name_t signal_type, unsigned int *subscribe_id, mm_sound_signal_callback callback, void *user_data);
+int mm_sound_subscribe_signal_for_daemon(mm_sound_signal_name_t signal_type, int client_pid, unsigned int *subscribe_id, mm_sound_signal_callback callback, void *user_data);
+void mm_sound_unsubscribe_signal(unsigned int subscribe_id);
+int mm_sound_send_signal(mm_sound_signal_name_t signal_type, int value);
+int mm_sound_get_signal_value(mm_sound_signal_name_t signal_type, int *value);
+int mm_sound_is_stream_on_device(int stream_id, MMSoundDevice_t device_h, bool *is_on);
- * @endcode
- */
-int mm_sound_remove_available_route_changed_callback(void);
/**
@}
*/