Declare deprecation of device state APIs since tizen 4.0.

 - sound_manager_get_device_state()
 - sound_manager_add_device_state_changed_cb()
 - sound_manager_remove_device_state_changed_cb()

Theses APIs for device state are not related to state of actual streams
which are running on the device. Rather the device state is changed by
session activation globally. It is called 'active device' concept.
As a result, it is not suitable for stream based concept that we seek
since tizen 3.0.

[Version] 0.4.23
[Issue Type] Deprecation

Change-Id: Ia8ab9f5c13689bbd41ae3463240fba90dd0f28df
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
(cherry picked from commit 72fa27d38e32e0c7c09f2c65d50118e22d48149d)

diff --git a/include/sound_manager.h b/include/sound_manager.h
index 9b9ec4e..305b1e0 100644 (file)
--- a/include/sound_manager.h
+++ b/include/sound_manager.h
@@ -286,6 +286,7 @@ typedef enum {
 
 
 /**
+* @deprecated Deprecated since 4.0.
 * @brief Enumeration for sound device state.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 */
@@ -464,6 +465,7 @@ typedef void (*sound_device_information_changed_cb) (sound_device_h device, soun
 typedef void (*sound_device_connection_changed_cb) (sound_device_h device, bool is_connected, void *user_data);
 
 /**
+ * @deprecated Deprecated since 4.0.
  * @brief Called when the state of a sound device was changed.
  * @since_tizen 3.0
  * @param[in]   device The sound_device
@@ -1347,7 +1349,6 @@ int sound_manager_unset_session_interrupted_cb(void) TIZEN_DEPRECATED_API;
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  */
 int sound_manager_get_current_device_list(sound_device_mask_e device_mask, sound_device_list_h *device_list) TIZEN_DEPRECATED_API;
 
@@ -1372,7 +1373,6 @@ int sound_manager_get_current_device_list(sound_device_mask_e device_mask, sound
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_device_list(int device_mask, sound_device_list_h *device_list);
@@ -1397,7 +1397,6 @@ int sound_manager_get_device_list(int device_mask, sound_device_list_h *device_l
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  */
 int sound_manager_free_device_list(sound_device_list_h device_list);
 
@@ -1417,7 +1416,6 @@ int sound_manager_free_device_list(sound_device_list_h device_list);
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_next_device(sound_device_list_h device_list, sound_device_h *device);
@@ -1438,7 +1436,6 @@ int sound_manager_get_next_device(sound_device_list_h device_list, sound_device_
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_prev_device(sound_device_list_h device_list, sound_device_h *device);
@@ -1458,7 +1455,6 @@ int sound_manager_get_prev_device(sound_device_list_h device_list, sound_device_
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_device_type(sound_device_h device, sound_device_type_e *type);
@@ -1478,7 +1474,6 @@ int sound_manager_get_device_type(sound_device_h device, sound_device_type_e *ty
  * @see sound_manager_get_device_type()
  * @see sound_manager_get_device_id()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_device_io_direction(sound_device_h device, sound_device_io_direction_e *io_direction);
@@ -1498,7 +1493,6 @@ int sound_manager_get_device_io_direction(sound_device_h device, sound_device_io
  * @see sound_manager_get_device_type()
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_name()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_device_id(sound_device_h device, int *id);
@@ -1519,12 +1513,12 @@ int sound_manager_get_device_id(sound_device_h device, int *id);
  * @see sound_manager_get_device_type()
  * @see sound_manager_get_device_io_direction()
  * @see sound_manager_get_device_id()
- * @see sound_manager_get_device_state()
  * @see sound_manager_free_device_list()
  */
 int sound_manager_get_device_name(sound_device_h device, char **name);
 
 /**
+ * @deprecated Deprecated since 4.0.
  * @brief Gets the state of the device.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in]  device  The device item
@@ -1542,7 +1536,7 @@ int sound_manager_get_device_name(sound_device_h device, char **name);
  * @see sound_manager_get_device_name()
  * @see sound_manager_free_device_list()
  */
-int sound_manager_get_device_state(sound_device_h device, sound_device_state_e *state);
+int sound_manager_get_device_state(sound_device_h device, sound_device_state_e *state) TIZEN_DEPRECATED_API;
 
 /**
  * @deprecated Deprecated since 3.0. Use sound_manager_add_device_connection_changed_cb() instead.
@@ -1641,6 +1635,7 @@ int sound_manager_set_device_information_changed_cb(sound_device_mask_e device_m
 int sound_manager_unset_device_information_changed_cb(void) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 4.0.
  * @brief Adds a callback function to be invoked when the state of a sound device was changed.
  * @since_tizen 3.0
  *
@@ -1657,9 +1652,10 @@ int sound_manager_unset_device_information_changed_cb(void) TIZEN_DEPRECATED_API
  * @see sound_manager_remove_device_state_changed_cb()
  * @see sound_device_state_connected_cb()
  */
-int sound_manager_add_device_state_changed_cb(int device_mask, sound_device_state_changed_cb callback, void *user_data, int *id);
+int sound_manager_add_device_state_changed_cb(int device_mask, sound_device_state_changed_cb callback, void *user_data, int *id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 4.0.
  * @brief Removes a callback function invoked when the state of a sound device was changed.
  * @since_tizen 3.0
  *
@@ -1671,7 +1667,7 @@ int sound_manager_add_device_state_changed_cb(int device_mask, sound_device_stat
  * @retval #SOUND_MANAGER_ERROR_INTERNAL Internal error inside the sound system
  * @see sound_manager_add_device_state_changed_cb()
  */
-int sound_manager_remove_device_state_changed_cb(int id);
+int sound_manager_remove_device_state_changed_cb(int id) TIZEN_DEPRECATED_API;
 
 /**
  * @}

diff --git a/packaging/capi-media-sound-manager.spec b/packaging/capi-media-sound-manager.spec
index b623556..cb68ac9 100644 (file)
--- a/packaging/capi-media-sound-manager.spec
+++ b/packaging/capi-media-sound-manager.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-sound-manager
 Summary:    Sound Manager library
-Version:    0.4.22
+Version:    0.4.23
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0

diff --git a/src/sound_manager.c b/src/sound_manager.c
index 2eead77..34f3103 100644 (file)
--- a/src/sound_manager.c
+++ b/src/sound_manager.c
@@ -1492,6 +1492,7 @@ int sound_manager_get_device_state(sound_device_h device, sound_device_state_e *
 {
        int ret = MM_ERROR_NONE;
 
+       LOGW("DEPRECATION WARNING: %s() is deprecated and will be removed from next release.", __func__);
        ret = mm_sound_get_device_state(device, (mm_sound_device_state_e*)state);
 
        return _convert_sound_manager_error_code(__func__, ret);
@@ -1621,6 +1622,7 @@ int sound_manager_add_device_state_changed_cb(int device_mask, sound_device_stat
 {
        int ret = MM_ERROR_NONE;
 
+       LOGW("DEPRECATION WARNING: %s() is deprecated and will be removed from next release.", __func__);
        if (!callback || !id)
                return _convert_sound_manager_error_code(__func__, MM_ERROR_INVALID_ARGUMENT);
 
@@ -1633,6 +1635,7 @@ int sound_manager_remove_device_state_changed_cb(int id)
 {
        int ret = MM_ERROR_NONE;
 
+       LOGW("DEPRECATION WARNING: %s() is deprecated and will be removed from next release.", __func__);
        if (id < 0)
                return _convert_sound_manager_error_code(__func__, MM_ERROR_INVALID_ARGUMENT);