src/cpp/CAudioSessionHandler.cpp

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #include <unistd.h>
  19 #include <mm_error.h>
  20 #include "CAudioIODef.h"
  21
  22
  23 using namespace std;
  24 using namespace tizen_media_audio;
  25
  26
  27 /**
  28  * class CAudioSessionHandler
  29  */
  30 int CAudioSessionHandler::__sCaptureRef = 0;
  31
  32 int CAudioSessionHandler::__pcmCaptureCountInc() {
  33     int actual;
  34     do {
  35         actual = __sCaptureRef;
  36     } while (!__sync_bool_compare_and_swap(&__sCaptureRef, actual, actual + 1));
  37     AUDIO_IO_LOGD("CaptureRefCount+1 > [%d]", __sCaptureRef);
  38     return __sCaptureRef;
  39 }
  40
  41 int CAudioSessionHandler::__pcmCaptureCountDec() {
  42     int actual;
  43     do {
  44         actual = __sCaptureRef;
  45     } while (!__sync_bool_compare_and_swap(&__sCaptureRef, actual, actual - 1));
  46     AUDIO_IO_LOGD("CaptureRefCount-1 > [%d]", __sCaptureRef);
  47     if (__sCaptureRef < 0) {
  48         AUDIO_IO_LOGE("A CaptureRef[%d] is not valid! Something is wrong!", __sCaptureRef);
  49         __sCaptureRef = 0;
  50     }
  51     return __sCaptureRef;
  52 }
  53
  54 int CAudioSessionHandler::__pcmCaptureCountGet() {
  55     AUDIO_IO_LOGD("CaptureRefCount > [%d]", __sCaptureRef);
  56     return __sCaptureRef;
  57 }
  58
  59 int CAudioSessionHandler::__sFocusRef = 0;
  60
  61 int CAudioSessionHandler::__focusIdCountInc() {
  62     int actual;
  63     do {
  64         actual = __sFocusRef;
  65     } while (!__sync_bool_compare_and_swap(&__sFocusRef, actual, actual + 1));
  66     AUDIO_IO_LOGD("FocusRefCount+1 > [%d]", __sFocusRef);
  67     return __sFocusRef;
  68 }
  69
  70 int CAudioSessionHandler::__focusIdCountDec() {
  71     int actual;
  72     do {
  73         actual = __sFocusRef;
  74     } while (!__sync_bool_compare_and_swap(&__sFocusRef, actual, actual - 1));
  75     AUDIO_IO_LOGD("FocusRefCount-1 > [%d]", __sFocusRef);
  76     return __sFocusRef;
  77 }
  78
  79 int CAudioSessionHandler::__focusIdCountGet() {
  80     /* AUDIO_IO_LOGD("FocusRefCount > [%d]", __sFocusRef); */
  81     return __sFocusRef;
  82 }
  83
  84 CAudioSessionHandler::CAudioSessionHandler(EAudioSessionType sessionType, CAudioInfo& audioInfo, IAudioSessionEventListener* listener) :
  85     __mId(-1),
  86     __mOptions(0),
  87     __mAudioSession(sessionType),
  88     __mMultimediaSession(MM_SESSION_TYPE_MEDIA),
  89     __mpEventListener(listener),
  90     __mIsInit(false),
  91     __mSubscribeId(0),
  92     __mUseFocus(false),
  93     __mFocusType(FOCUS_NONE),
  94     __mState(FOCUS_IS_RELEASED),
  95     __mReasonForChange(NULL),
  96     __mAdditionalInfo(NULL) {
  97     __mAudioInfo = audioInfo;
  98 }
  99
 100 CAudioSessionHandler::~CAudioSessionHandler() {
 101 }
 102
 103 CAudioError CAudioSessionHandler::__convertStreamType(EAudioSessionType type1, MMSessionType type2, int *index) {
 104     unsigned int i;
 105     int idx = -1;
 106
 107     assert(index != NULL);
 108
 109     if (type1 == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 110         for (i = 0 ; i < sizeof(__STREAM_TYPE_TABLE_IN) / sizeof(__STREAM_TYPE_TABLE_IN[0]) ; i++) {
 111             if (__STREAM_TYPE_TABLE_IN[i].type == type2) {
 112                 idx = i;
 113                 break;
 114             }
 115         }
 116     } else {
 117         for (i = 0 ; i < sizeof(__STREAM_TYPE_TABLE_OUT) / sizeof(__STREAM_TYPE_TABLE_OUT[0]) ; i++) {
 118             if (__STREAM_TYPE_TABLE_OUT[i].type == type2) {
 119                 idx = i;
 120                 break;
 121             }
 122         }
 123     }
 124
 125     if (idx < 0) {
 126         RET_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "Does not support session type.");
 127     }
 128     *index = idx;
 129     RET_ERROR(CAudioError::EError::ERROR_NONE);
 130 }
 131
 132 CAudioError CAudioSessionHandler::__getAsmInformation(MMSessionType *type, int *options) {
 133     assert(type != NULL);
 134     assert(options != NULL);
 135
 136     MMSessionType currentSession = MM_SESSION_TYPE_MEDIA;
 137     int           sessionOptions = 0;
 138
 139     /* Read session information */
 140     int ret = 0;
 141     if ((ret = _mm_session_util_read_information(-1, (int*)&currentSession, &sessionOptions)) < 0) {
 142         if (ret == (int) MM_ERROR_INVALID_HANDLE) {
 143             RET_ERROR_MSG(CAudioError::EError::ERROR_INVALID_HANDLE, "Failed _mm_session_util_read_information(). Invalid handle");
 144         } else {
 145             RET_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed _mm_session_util_read_information(). Not exist");
 146         }
 147     }
 148
 149     *type    = currentSession;
 150     *options = sessionOptions;
 151
 152     RET_ERROR(CAudioError::EError::ERROR_NONE);
 153 }
 154
 155 bool CAudioSessionHandler::__isFocusRequired(MMSessionType type, int options) {
 156     if ((options & MM_SESSION_OPTION_PAUSE_OTHERS)
 157         || ((type != MM_SESSION_TYPE_MEDIA) && (type != MM_SESSION_TYPE_MEDIA_RECORD)))
 158         return true;
 159     else
 160         return false;
 161 }
 162
 163 int CAudioSessionHandler::getId() {
 164     return __mId;
 165 }
 166
 167 int CAudioSessionHandler::getOptions() {
 168     return __mOptions;
 169 }
 170
 171 CAudioSessionHandler::EAudioSessionType CAudioSessionHandler::getAudioSession() {
 172     return __mAudioSession;
 173 }
 174
 175 MMSessionType CAudioSessionHandler::getMultimediaSession() {
 176     return __mMultimediaSession;
 177 }
 178
 179 void CAudioSessionHandler::getInternalVoipStreamInfo(sound_stream_info_h *stream_info) {
 180     int ret;
 181
 182     if ((ret = sound_manager_get_internal_voip_stream_information(stream_info))) {
 183         if (ret == SOUND_MANAGER_ERROR_NO_DATA) {
 184             AUDIO_IO_LOGW("there's no internal voip stream info.");
 185         } else {
 186             AUDIO_IO_LOGE("failed to sound_manager_get_internal_voip_stream_information(), ret(0x%x)", ret);
 187         }
 188     }
 189     return;
 190 }
 191
 192 unsigned int CAudioSessionHandler::getSubscribeId() {
 193     return __mSubscribeId;
 194 }
 195
 196 CAudioInfo CAudioSessionHandler::getAudioInfo() {
 197     return __mAudioInfo;
 198 }
 199
 200 void CAudioSessionHandler::__sound_pcm_signal_cb(mm_sound_signal_name_t signal, int value, void *user_data) {
 201     assert(user_data);
 202
 203     AUDIO_IO_LOGD("[signal:%d], [value:%d], [user_data:0x%x]", signal, value, user_data);
 204
 205     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 206     if (pHandler->__mpEventListener != NULL)
 207         pHandler->__mpEventListener->onSignal(pHandler, signal, value);
 208 }
 209
 210 void CAudioSessionHandler::initialize() throw(CAudioError) {
 211     AUDIO_IO_LOGD("");
 212     if (__mIsInit == true) {
 213         return;
 214     }
 215
 216     MMSessionType currentSession = MM_SESSION_TYPE_MEDIA;
 217     int           sessionOptions = 0;  // Mix with others by default
 218
 219     CAudioError err = __getAsmInformation(&currentSession, &sessionOptions);
 220     if (err == CAudioError::EError::ERROR_NONE) {
 221         if (currentSession == MM_SESSION_TYPE_REPLACED_BY_STREAM) {
 222             __mUseFocus = false;
 223             AUDIO_IO_LOGD("Stream info. was created outside, skip audio focus concept internally!");
 224         } else {
 225             // Session was configured before, use focus callback
 226             __mUseFocus = true;
 227             AUDIO_IO_LOGD("Use audio focus concept internally!");
 228         }
 229     } else {
 230         if (err == CAudioError::EError::ERROR_INVALID_HANDLE) {
 231             // No session, No stream_info, No focus watch callback before
 232             // Use focus watch callback with signal subscribe
 233
 234             int errorCode = mm_sound_subscribe_signal(MM_SOUND_SIGNAL_RELEASE_INTERNAL_FOCUS, &__mSubscribeId, __sound_pcm_signal_cb, static_cast<void*>(this));
 235             if (errorCode != MM_ERROR_NONE || __mSubscribeId == 0) {
 236                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_subscribe_signal() err:0x%x, __mSubscribeId:%u",
 237                                        errorCode, __mSubscribeId);
 238             }
 239
 240             AUDIO_IO_LOGD("Subscribed mm_sound signal");
 241
 242             sessionOptions = 0;  // Mix with others by default
 243             __mUseFocus = true;
 244             AUDIO_IO_LOGD("Use audio focus(watch) concept internally!");
 245         } else {
 246             __mUseFocus = false;
 247             AUDIO_IO_LOGD("Skip audio focus concept!");
 248         }
 249
 250         if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 251             AUDIO_IO_LOGD("Set default \"Media_Record\" type");
 252             currentSession = MM_SESSION_TYPE_MEDIA_RECORD;
 253         } else {
 254             AUDIO_IO_LOGD("Set default \"Media\" type");
 255             currentSession = MM_SESSION_TYPE_MEDIA;
 256         }
 257     }
 258
 259     // Updates session information
 260     __mMultimediaSession = currentSession;
 261     __mOptions           = sessionOptions;
 262
 263     if (this->__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 264         __pcmCaptureCountInc();
 265     }
 266
 267     __mIsInit = true;
 268 }
 269
 270 void CAudioSessionHandler::finalize() {
 271     AUDIO_IO_LOGD("");
 272     if (__mIsInit == false) {
 273         return;
 274     }
 275
 276     if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 277         __pcmCaptureCountDec();
 278     }
 279
 280     if (__mSubscribeId > 0) {
 281         mm_sound_unsubscribe_signal(__mSubscribeId);
 282         __mSubscribeId = 0;
 283     }
 284
 285     __mpEventListener = NULL;
 286
 287     __mIsInit = false;
 288 }
 289
 290 bool CAudioSessionHandler::isSkipSession() throw(CAudioError) {
 291     if (__mMultimediaSession == MM_SESSION_TYPE_REPLACED_BY_STREAM ||
 292         __mMultimediaSession == MM_SESSION_TYPE_VOIP ||
 293         __mMultimediaSession == MM_SESSION_TYPE_CALL ||
 294         __mMultimediaSession == MM_SESSION_TYPE_VIDEOCALL) {
 295         AUDIO_IO_LOGD("__mMultimediaSession is [%d], skip session", __mMultimediaSession);
 296         return true;
 297     }
 298
 299     return false;
 300 }
 301
 302 void CAudioSessionHandler::__sound_pcm_focus_cb(int id, mm_sound_focus_type_e focus_type, mm_sound_focus_state_e state, const char *reason_for_change, int option, const char *additional_info, void *user_data) {
 303     assert(user_data);
 304
 305     AUDIO_IO_LOGD("[id:%d], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s], [user_data:0x%x]", id, focus_type, state, reason_for_change, additional_info, user_data);
 306
 307 /* FIXME: disable it temporarily */
 308 #ifndef DISABLE_SESSION_BACK_COMP
 309
 310     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 311     pHandler->__mFocusType       = focus_type;
 312     pHandler->__mState           = state;
 313     pHandler->__mReasonForChange = (char *)reason_for_change;
 314     pHandler->__mAdditionalInfo  = (char *)additional_info;
 315
 316     if (pHandler->__mpEventListener != NULL)
 317         pHandler->__mpEventListener->onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
 318 #endif
 319     return;
 320 }
 321
 322 void CAudioSessionHandler::__sound_pcm_focus_watch_cb(int id, mm_sound_focus_type_e focus_type, mm_sound_focus_state_e state, const char *reason_for_change, const char *additional_info, void *user_data) {
 323     AUDIO_IO_LOGD("[id:%d], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s], [user_data:0x%x]", id, focus_type, state, reason_for_change, additional_info, user_data);
 324
 325     CAudioSessionHandler::__sound_pcm_focus_cb(-1, focus_type, state, reason_for_change, 0, additional_info, user_data);
 326
 327     return;
 328 }
 329
 330 void CAudioSessionHandler::registerSound() throw(CAudioError) {
 331     if (__mIsInit == false) {
 332         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 333     }
 334
 335     if (__mUseFocus == true) {
 336         if (__mId >= 0) {
 337             THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Already registered [id:%d]", __mId);
 338         }
 339
 340         int errorCode = 0;
 341
 342         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 343             int index = 0;
 344             CAudioError err = __convertStreamType(__mAudioSession, __mMultimediaSession, &index);
 345             if (err != CAudioError::EError::ERROR_NONE) {
 346                 throw err;
 347             }
 348
 349             errorCode = mm_sound_focus_get_id(&__mId);
 350             if (errorCode != MM_ERROR_NONE) {
 351                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_focus_get_id() err:0x%x", errorCode);
 352             }
 353
 354             // Register focus callback
 355             errorCode = mm_sound_register_focus_for_session(__mId,
 356                                                 getpid(),
 357                                                 __mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE ? __STREAM_TYPE_TABLE_IN[index].name : __STREAM_TYPE_TABLE_OUT[index].name,
 358                                                 __sound_pcm_focus_cb,
 359                                                 static_cast<void*>(this));
 360             if (errorCode != MM_ERROR_NONE) {
 361                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_register_focus_for_session() err:0x%x", errorCode);
 362             }
 363
 364             __focusIdCountInc();
 365
 366             AUDIO_IO_LOGD("Focus callback registered successfully [id:%d]", __mId);
 367         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 368             // Register focus watch callback
 369             errorCode = mm_sound_set_focus_watch_callback_for_session(getpid(), FOCUS_FOR_BOTH, __sound_pcm_focus_watch_cb, static_cast<void*>(this), &__mId);
 370             if (errorCode < 0) {
 371                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_set_focus_watch_callback_for_session() err:0x%x", errorCode);
 372             }
 373
 374             __focusIdCountInc();
 375
 376             AUDIO_IO_LOGD("Focus watch callback registered successfully [id:%d]", __mId);
 377         }
 378     }
 379 }
 380
 381 void CAudioSessionHandler::unregisterSound() throw(CAudioError) {
 382     if (__mIsInit == false) {
 383         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 384     }
 385
 386     if (__mUseFocus == true && __mId >= 0) {
 387         int errorCode = 0;
 388
 389         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 390             // Unregister focus callback
 391             errorCode = mm_sound_unregister_focus(__mId);
 392             if (errorCode != MM_ERROR_NONE) {
 393                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_unregister_focus() err:0x%x", errorCode);
 394             }
 395
 396             __focusIdCountDec();
 397
 398             AUDIO_IO_LOGD("Focus callback unregistered successfully [id:%d]", __mId);
 399             __mId = -1;
 400         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 401             // Unregister focus watch callback.
 402             errorCode = mm_sound_unset_focus_watch_callback(__mId);
 403             if (errorCode < 0) {
 404                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_unset_focus_watch_callback() err:0x%x", errorCode);
 405             }
 406
 407             __focusIdCountDec();
 408
 409             AUDIO_IO_LOGD("Focus watch callback unregistered successfully [id:%d]", __mId);
 410             __mId = -1;
 411         }
 412     }
 413 }
 414
 415 void CAudioSessionHandler::updatePlaying() throw(CAudioError) {
 416     if (__mIsInit == false) {
 417         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 418     }
 419
 420     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 421         if (__mId >= 0) {
 422             int ret = mm_sound_acquire_focus(__mId, FOCUS_FOR_BOTH, "audio-io acquire focus");
 423             if (ret != MM_ERROR_NONE) {
 424                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_acquire_focus() err:0x%x", ret);
 425             }
 426             AUDIO_IO_LOGD("Focus acquired successfully [id:%d]", __mId);
 427         }
 428     }
 429 }
 430
 431 void CAudioSessionHandler::updateStop() throw(CAudioError) {
 432     if (__mIsInit == false) {
 433         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 434     }
 435
 436     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 437         if (__mId >= 0) {
 438             int ret = mm_sound_release_focus(__mId, FOCUS_FOR_BOTH, "audio-io release focus");
 439             if (ret != MM_ERROR_NONE) {
 440                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_release_focus() err:0x%x", ret);
 441             }
 442             AUDIO_IO_LOGD("Focus released successfully [id:%d]", __mId);
 443         }
 444     }
 445 }
 446
 447 void CAudioSessionHandler::disableSessionHandler() throw(CAudioError) {
 448     CAudioSessionHandler::updateStop();
 449     CAudioSessionHandler::unregisterSound();
 450
 451     CAudioSessionHandler::__mUseFocus = false;
 452 }
 453
 454 /**
 455  * class IAudioSessionEventListener
 456  */
 457 IAudioSessionEventListener::EInterruptCode IAudioSessionEventListener::convertInterruptedCode(int code, const char *reason_for_change) {
 458     EInterruptCode e = EInterruptCode::INTERRUPT_COMPLETED;
 459
 460     switch (code) {
 461     case FOCUS_IS_ACQUIRED:
 462         e = EInterruptCode::INTERRUPT_COMPLETED;
 463         break;
 464
 465     case FOCUS_IS_RELEASED:
 466         if (!strcmp(reason_for_change, "media"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 467         if (!strcmp(reason_for_change, "radio"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 468         if (!strcmp(reason_for_change, "loopback"))           e = EInterruptCode::INTERRUPT_BY_MEDIA;
 469         if (!strcmp(reason_for_change, "system"))             e = EInterruptCode::INTERRUPT_BY_MEDIA;
 470         if (!strcmp(reason_for_change, "alarm"))              e = EInterruptCode::INTERRUPT_BY_ALARM;
 471         if (!strcmp(reason_for_change, "notification"))       e = EInterruptCode::INTERRUPT_BY_NOTIFICATION;
 472         if (!strcmp(reason_for_change, "emergency"))          e = EInterruptCode::INTERRUPT_BY_EMERGENCY;
 473         if (!strcmp(reason_for_change, "voice-information"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 474         if (!strcmp(reason_for_change, "voice-recognition"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 475         if (!strcmp(reason_for_change, "ringtone-voip"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 476         if (!strcmp(reason_for_change, "ringtone-call"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 477         if (!strcmp(reason_for_change, "voip"))               e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 478         if (!strcmp(reason_for_change, "call-voice"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 479         if (!strcmp(reason_for_change, "call-video"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 480         break;
 481     }
 482
 483     return e;
 484 }