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(-1),
  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 int CAudioSessionHandler::getSubscribeId() {
 180     return __mSubscribeId;
 181 }
 182
 183 CAudioInfo CAudioSessionHandler::getAudioInfo() {
 184     return __mAudioInfo;
 185 }
 186
 187 void CAudioSessionHandler::__sound_pcm_signal_cb(mm_sound_signal_name_t signal, int value, void *user_data) {
 188     assert(user_data);
 189
 190     AUDIO_IO_LOGD("[signal:%d], [value:%d], [user_data:0x%x]", signal, value, user_data);
 191
 192     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 193     if (pHandler->__mpEventListener != NULL) {
 194         pHandler->__mpEventListener->onSignal(pHandler, signal, value);
 195     }
 196 }
 197
 198 void CAudioSessionHandler::initialize() throw (CAudioError) {
 199     AUDIO_IO_LOGD("");
 200     if (__mIsInit == true) {
 201         return;
 202     }
 203
 204     MMSessionType currentSession = MM_SESSION_TYPE_MEDIA;
 205     int           sessionOptions = 0;  // Mix with others by default
 206
 207     CAudioError err = __getAsmInformation(&currentSession, &sessionOptions);
 208     if (err == CAudioError::EError::ERROR_NONE) {
 209         if (currentSession == MM_SESSION_TYPE_REPLACED_BY_STREAM) {
 210             __mUseFocus = false;
 211             AUDIO_IO_LOGD("Stream info. was created outside, skip audio focus concept internally!");
 212         } else {
 213             // Session was configured before, use focus callback
 214             __mUseFocus = true;
 215             AUDIO_IO_LOGD("Use audio focus concept internally!");
 216         }
 217     } else {
 218         if (err == CAudioError::EError::ERROR_INVALID_HANDLE) {
 219             // No session, No stream_info, No focus watch callback before
 220             // Use focus watch callback with signal subscribe
 221             unsigned int subscribe_id;
 222             int errorCode = mm_sound_subscribe_signal(MM_SOUND_SIGNAL_RELEASE_INTERNAL_FOCUS, &subscribe_id, __sound_pcm_signal_cb, static_cast<void*>(this));
 223             if (errorCode != MM_ERROR_NONE) {
 224                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_subscribe_signal() err:0x%x", errorCode);
 225             }
 226
 227             __mSubscribeId = (int)subscribe_id;
 228             AUDIO_IO_LOGD("Subscribed mm_sound signal");
 229
 230             sessionOptions = 0;  // Mix with others by default
 231             __mUseFocus = true;
 232             AUDIO_IO_LOGD("Use audio focus(watch) concept internally!");
 233         } else {
 234             __mUseFocus = false;
 235             AUDIO_IO_LOGD("Skip audio focus concept!");
 236         }
 237
 238         if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 239             AUDIO_IO_LOGD("Set default \"Media_Record\" type");
 240             currentSession = MM_SESSION_TYPE_MEDIA_RECORD;
 241         } else {
 242             AUDIO_IO_LOGD("Set default \"Media\" type");
 243             currentSession = MM_SESSION_TYPE_MEDIA;
 244         }
 245     }
 246
 247     // Updates session information
 248     __mMultimediaSession = currentSession;
 249     __mOptions           = sessionOptions;
 250
 251     if (this->__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 252         __pcmCaptureCountInc();
 253     }
 254
 255     __mIsInit = true;
 256 }
 257
 258 void CAudioSessionHandler::finalize() {
 259     AUDIO_IO_LOGD("");
 260     if (__mIsInit == false) {
 261         return;
 262     }
 263
 264     if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 265         __pcmCaptureCountDec();
 266     }
 267
 268     if (__mSubscribeId >= 0) {
 269         mm_sound_unsubscribe_signal(__mSubscribeId);
 270     }
 271
 272     __mIsInit = false;
 273 }
 274
 275 bool CAudioSessionHandler::isSkipSessionEvent() throw (CAudioError) {
 276     bool ret = false;
 277
 278     // To be regarded...
 279 #if 0
 280     /* Only Support below Event */
 281     if (mEvent != ASM_EVENT_CALL              && mEvent != ASM_EVENT_VOIP              &&
 282         mEvent != ASM_EVENT_VIDEOCALL         && mEvent != ASM_EVENT_VOICE_RECOGNITION &&
 283         mEvent != ASM_EVENT_MMCAMCORDER_AUDIO && mEvent != ASM_EVENT_MMCAMCORDER_VIDEO) {
 284
 285         // Check AudioType
 286         switch (__mAudioInfo.getAudioType()) {
 287         case CAudioInfo::AUDIO_IN_TYPE_MEDIA:
 288         case CAudioInfo::AUDIO_IN_TYPE_VOICECONTROL:
 289             ret = false;
 290             break;
 291
 292         case CAudioInfo::AUDIO_IN_TYPE_MIRRORING:
 293         case CAudioInfo::AUDIO_IN_TYPE_LOOPBACK:
 294             ret = true;
 295             break;
 296
 297         default:
 298             return false;
 299         }
 300
 301         if (ret == true) {
 302             int captureCount = CAudioSessionHandler::__pcmCaptureCountGet();
 303             if (captureCount == 1) {/* If this is last one */
 304                 /* Recover session information to MEDIA */
 305                 int sessionResult = _mm_session_util_write_information(-1, MM_SESSION_TYPE_MEDIA, __mOptions);
 306                 if (sessionResult != 0) {
 307                     THROW_ERROR_MSG_FORMAT(CAudioError::ERROR_INTERNAL_OPERATION, "Failed _mm_session_util_write_information() ret:%d", sessionResult);
 308                 }
 309             }
 310         }
 311     }
 312 #endif
 313
 314     return ret;
 315 }
 316
 317 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, const char *additional_info, void *user_data) {
 318     assert(user_data);
 319
 320     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);
 321
 322     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 323     pHandler->__mFocusType       = focus_type;
 324     pHandler->__mState           = state;
 325     pHandler->__mReasonForChange = (char *)reason_for_change;
 326     pHandler->__mAdditionalInfo  = (char *)additional_info;
 327
 328     if (pHandler->__mpEventListener != NULL) {
 329         pHandler->__mpEventListener->onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
 330     }
 331
 332     return;
 333 }
 334
 335 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) {
 336     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);
 337
 338     CAudioSessionHandler::__sound_pcm_focus_cb(-1, focus_type, state, reason_for_change, additional_info, user_data);
 339
 340     return;
 341 }
 342
 343 void CAudioSessionHandler::registerSound() throw (CAudioError) {
 344     if (__mIsInit == false) {
 345         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 346     }
 347
 348     if (__mUseFocus == true) {
 349         if (__mId >= 0) {
 350             THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Already registered [id:%d]", __mId);
 351         }
 352
 353         int errorCode = 0;
 354
 355         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 356             int index = 0;
 357             CAudioError err = __convertStreamType(__mAudioSession, __mMultimediaSession, &index);
 358             if (err != CAudioError::EError::ERROR_NONE) {
 359                 throw err;
 360             }
 361
 362             errorCode = mm_sound_focus_get_id(&__mId);
 363             if (errorCode != MM_ERROR_NONE) {
 364                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_focus_get_id() err:0x%x", errorCode);
 365             }
 366
 367             // Register focus callback
 368             errorCode = mm_sound_register_focus_for_session(__mId,
 369                                                 getpid(),
 370                                                 __mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE ? __STREAM_TYPE_TABLE_IN[index].name : __STREAM_TYPE_TABLE_OUT[index].name,
 371                                                 __sound_pcm_focus_cb,
 372                                                 static_cast<void*>(this));
 373             if (errorCode != MM_ERROR_NONE) {
 374                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_register_focus_for_session() err:0x%x", errorCode);
 375             }
 376
 377             __focusIdCountInc();
 378
 379             AUDIO_IO_LOGD("Focus callback registered successfully [id:%d]", __mId);
 380         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 381             // Register focus watch callback
 382             errorCode = mm_sound_set_focus_watch_callback_for_session(getpid(), FOCUS_FOR_BOTH, __sound_pcm_focus_watch_cb, static_cast<void*>(this), &__mId);
 383             if (errorCode < 0) {
 384                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_set_focus_watch_callback_for_session() err:0x%x", errorCode);
 385             }
 386
 387             __focusIdCountInc();
 388
 389             AUDIO_IO_LOGD("Focus watch callback registered successfully [id:%d]", __mId);
 390         }
 391     }
 392 }
 393
 394 void CAudioSessionHandler::unregisterSound() throw (CAudioError) {
 395     if (__mIsInit == false) {
 396         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 397     }
 398
 399     if (__mUseFocus == true) {
 400         if (__mId < 0) {
 401             THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Did not register [id:%d]", __mId);
 402         }
 403
 404         int errorCode = 0;
 405
 406         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 407             // Unregister focus callback
 408             errorCode = mm_sound_unregister_focus(__mId);
 409             if (errorCode != MM_ERROR_NONE) {
 410                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_unregister_focus() err:0x%x", errorCode);
 411             }
 412
 413             __focusIdCountDec();
 414
 415             AUDIO_IO_LOGD("Focus callback unregistered successfully [id:%d]", __mId);
 416             __mId = -1;
 417         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 418             // Unregister focus watch callback.
 419             errorCode = mm_sound_unset_focus_watch_callback(__mId);
 420             if (errorCode < 0) {
 421                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_unset_focus_watch_callback() err:0x%x", errorCode);
 422             }
 423
 424             __focusIdCountDec();
 425
 426             AUDIO_IO_LOGD("Focus watch callback unregistered successfully [id:%d]", __mId);
 427             __mId = -1;
 428         }
 429     }
 430 }
 431
 432 void CAudioSessionHandler::updatePlaying() throw (CAudioError) {
 433     if (__mIsInit == false) {
 434         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 435     }
 436
 437     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 438         if (__mId >= 0) {
 439             int ret = mm_sound_acquire_focus(__mId, FOCUS_FOR_BOTH, "audio-io acquire focus");
 440             if (ret != MM_ERROR_NONE) {
 441                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_acquire_focus() err:0x%x", ret);
 442             }
 443             AUDIO_IO_LOGD("Focus acquired successfully [id:%d]", __mId);
 444         }
 445     }
 446 }
 447
 448 void CAudioSessionHandler::updateStop() throw (CAudioError) {
 449     if (__mIsInit == false) {
 450         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 451     }
 452
 453     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 454         if (__mId >= 0) {
 455             int ret = mm_sound_release_focus(__mId, FOCUS_FOR_BOTH, "audio-io release focus");
 456             if (ret != MM_ERROR_NONE) {
 457                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_release_focus() err:0x%x", ret);
 458             }
 459             AUDIO_IO_LOGD("Focus released successfully [id:%d]", __mId);
 460         }
 461     }
 462 }
 463
 464 void CAudioSessionHandler::disableSessionHandler() throw (CAudioError) {
 465     CAudioSessionHandler::updateStop();
 466     CAudioSessionHandler::unregisterSound();
 467
 468     CAudioSessionHandler::__mUseFocus = false;
 469 }
 470
 471 /**
 472  * class IAudioSessionEventListener
 473  */
 474 IAudioSessionEventListener::EInterruptCode IAudioSessionEventListener::convertInterruptedCode(int code, const char *reason_for_change) {
 475     EInterruptCode e = EInterruptCode::INTERRUPT_COMPLETED;
 476
 477     switch (code)
 478     {
 479     case FOCUS_IS_ACQUIRED:
 480         e = EInterruptCode::INTERRUPT_COMPLETED;
 481         break;
 482
 483     case FOCUS_IS_RELEASED:
 484         if (!strcmp(reason_for_change, "media"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 485         if (!strcmp(reason_for_change, "radio"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 486         if (!strcmp(reason_for_change, "loopback"))           e = EInterruptCode::INTERRUPT_BY_MEDIA;
 487         if (!strcmp(reason_for_change, "system"))             e = EInterruptCode::INTERRUPT_BY_MEDIA;
 488         if (!strcmp(reason_for_change, "alarm"))              e = EInterruptCode::INTERRUPT_BY_ALARM;
 489         if (!strcmp(reason_for_change, "notification"))       e = EInterruptCode::INTERRUPT_BY_NOTIFICATION;
 490         if (!strcmp(reason_for_change, "emergency"))          e = EInterruptCode::INTERRUPT_BY_EMERGENCY;
 491         if (!strcmp(reason_for_change, "voice-information"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 492         if (!strcmp(reason_for_change, "voice-recognition"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 493         if (!strcmp(reason_for_change, "ringtone-voip"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 494         if (!strcmp(reason_for_change, "ringtone-call"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 495         if (!strcmp(reason_for_change, "voip"))               e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 496         if (!strcmp(reason_for_change, "call-voice"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 497         if (!strcmp(reason_for_change, "call-video"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 498         break;
 499     }
 500
 501     return e;
 502 }