tizen-audio-volume.c

   1 /*
   2  * audio-hal
   3  *
   4  * Copyright (c) 2015 - 2016 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19 #ifdef HAVE_CONFIG_H
  20 #include <config.h>
  21 #endif
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <stdbool.h>
  26 #include <string.h>
  27 #include <math.h>
  28 #include <vconf.h>
  29 #include <iniparser.h>
  30
  31 #include "tizen-audio-internal.h"
  32
  33 #define VOLUME_INI_DEFAULT_PATH     SYSCONFDIR"/multimedia/mmfw_audio_volume.ini" /* SYSCONFDIR is defined at .spec */
  34 #define VOLUME_INI_TEMP_PATH        "/opt/system/mmfw_audio_volume.ini"
  35 #define VOLUME_VALUE_MAX            (1.0f)
  36 #define GAIN_VALUE_MAX              (1.0f)
  37
  38 uint32_t g_master_volume_level = 100;
  39
  40 static const char *g_volume_vconf[AUDIO_VOLUME_TYPE_MAX] = {
  41     "file/private/sound/volume/system",         /* AUDIO_VOLUME_TYPE_SYSTEM */
  42     "file/private/sound/volume/notification",   /* AUDIO_VOLUME_TYPE_NOTIFICATION */
  43     "file/private/sound/volume/alarm",          /* AUDIO_VOLUME_TYPE_ALARM */
  44     "file/private/sound/volume/ringtone",       /* AUDIO_VOLUME_TYPE_RINGTONE */
  45     "file/private/sound/volume/media",          /* AUDIO_VOLUME_TYPE_MEDIA */
  46     "file/private/sound/volume/call",           /* AUDIO_VOLUME_TYPE_CALL */
  47     "file/private/sound/volume/voip",           /* AUDIO_VOLUME_TYPE_VOIP */
  48     "file/private/sound/volume/voice",          /* AUDIO_VOLUME_TYPE_VOICE */
  49 };
  50
  51 static const char *__get_volume_type_string_by_idx(uint32_t vol_type_idx)
  52 {
  53     switch (vol_type_idx) {
  54     case AUDIO_VOLUME_TYPE_SYSTEM:          return "system";
  55     case AUDIO_VOLUME_TYPE_NOTIFICATION:    return "notification";
  56     case AUDIO_VOLUME_TYPE_ALARM:           return "alarm";
  57     case AUDIO_VOLUME_TYPE_RINGTONE:        return "ringtone";
  58     case AUDIO_VOLUME_TYPE_MEDIA:           return "media";
  59     case AUDIO_VOLUME_TYPE_CALL:            return "call";
  60     case AUDIO_VOLUME_TYPE_VOIP:            return "voip";
  61     case AUDIO_VOLUME_TYPE_VOICE:           return "voice";
  62     default:                                return "invalid";
  63     }
  64 }
  65
  66 static uint32_t __get_volume_idx_by_string_type(const char *vol_type)
  67 {
  68     if (!strncmp(vol_type, "system", strlen(vol_type)) || !strncmp(vol_type, "0", strlen(vol_type)))
  69         return AUDIO_VOLUME_TYPE_SYSTEM;
  70     else if (!strncmp(vol_type, "notification", strlen(vol_type)) || !strncmp(vol_type, "1", strlen(vol_type)))
  71         return AUDIO_VOLUME_TYPE_NOTIFICATION;
  72     else if (!strncmp(vol_type, "alarm", strlen(vol_type)) || !strncmp(vol_type, "2", strlen(vol_type)))
  73         return AUDIO_VOLUME_TYPE_ALARM;
  74     else if (!strncmp(vol_type, "ringtone", strlen(vol_type)) || !strncmp(vol_type, "3", strlen(vol_type)))
  75         return AUDIO_VOLUME_TYPE_RINGTONE;
  76     else if (!strncmp(vol_type, "media", strlen(vol_type)) || !strncmp(vol_type, "4", strlen(vol_type)))
  77         return AUDIO_VOLUME_TYPE_MEDIA;
  78     else if (!strncmp(vol_type, "call", strlen(vol_type)) || !strncmp(vol_type, "5", strlen(vol_type)))
  79         return AUDIO_VOLUME_TYPE_CALL;
  80     else if (!strncmp(vol_type, "voip", strlen(vol_type)) || !strncmp(vol_type, "6", strlen(vol_type)))
  81         return AUDIO_VOLUME_TYPE_VOIP;
  82     else if (!strncmp(vol_type, "voice", strlen(vol_type)) || !strncmp(vol_type, "7", strlen(vol_type)))
  83         return AUDIO_VOLUME_TYPE_VOICE;
  84     else
  85         return AUDIO_VOLUME_TYPE_MEDIA;
  86 }
  87
  88 static const char *__get_gain_type_string_by_idx(uint32_t gain_type_idx)
  89 {
  90     switch (gain_type_idx) {
  91     case AUDIO_GAIN_TYPE_DEFAULT:           return "default";
  92     case AUDIO_GAIN_TYPE_DIALER:            return "dialer";
  93     case AUDIO_GAIN_TYPE_TOUCH:             return "touch";
  94     case AUDIO_GAIN_TYPE_AF:                return "af";
  95     case AUDIO_GAIN_TYPE_SHUTTER1:          return "shutter1";
  96     case AUDIO_GAIN_TYPE_SHUTTER2:          return "shutter2";
  97     case AUDIO_GAIN_TYPE_CAMCODING:         return "camcording";
  98     case AUDIO_GAIN_TYPE_MIDI:              return "midi";
  99     case AUDIO_GAIN_TYPE_BOOTING:           return "booting";
 100     case AUDIO_GAIN_TYPE_VIDEO:             return "video";
 101     case AUDIO_GAIN_TYPE_TTS:               return "tts";
 102     default:                                return "invalid";
 103     }
 104 }
 105
 106 static void __dump_tb(audio_hal_t *ah)
 107 {
 108     audio_volume_value_table_t *volume_value_table = ah->volume.volume_value_table;
 109     uint32_t vol_type_idx, vol_level_idx, gain_type_idx;
 110     const char *gain_type_str[] = {
 111         "def",          /* AUDIO_GAIN_TYPE_DEFAULT */
 112         "dial",         /* AUDIO_GAIN_TYPE_DIALER */
 113         "touch",        /* AUDIO_GAIN_TYPE_TOUCH */
 114         "af",           /* AUDIO_GAIN_TYPE_AF */
 115         "shut1",        /* AUDIO_GAIN_TYPE_SHUTTER1 */
 116         "shut2",        /* AUDIO_GAIN_TYPE_SHUTTER2 */
 117         "cam",          /* AUDIO_GAIN_TYPE_CAMCODING */
 118         "midi",         /* AUDIO_GAIN_TYPE_MIDI */
 119         "boot",         /* AUDIO_GAIN_TYPE_BOOTING */
 120         "video",        /* AUDIO_GAIN_TYPE_VIDEO */
 121         "tts",          /* AUDIO_GAIN_TYPE_TTS */
 122     };
 123     char dump_str[AUDIO_DUMP_STR_LEN], *dump_str_ptr;
 124
 125     /* Dump volume table */
 126     AUDIO_LOG_INFO("<<<<< volume table >>>>>");
 127
 128     const char *table_str = "volumes";
 129
 130     AUDIO_LOG_INFO("<< %s >>", table_str);
 131
 132     for (vol_type_idx = 0; vol_type_idx < AUDIO_VOLUME_TYPE_MAX; vol_type_idx++) {
 133         const char *vol_type_str = __get_volume_type_string_by_idx(vol_type_idx);
 134
 135         dump_str_ptr = &dump_str[0];
 136         memset(dump_str, 0x00, sizeof(char) * sizeof(dump_str));
 137         snprintf(dump_str_ptr, 8, "%6s:", vol_type_str);
 138         dump_str_ptr += strlen(dump_str_ptr);
 139
 140         for (vol_level_idx = 0; vol_level_idx < ah->volume.volume_level_max[vol_type_idx]; vol_level_idx++) {
 141             snprintf(dump_str_ptr, 6, "%01.2f ", volume_value_table->volume[vol_type_idx][vol_level_idx]);
 142             dump_str_ptr += strlen(dump_str_ptr);
 143         }
 144         AUDIO_LOG_INFO("%s", dump_str);
 145     }
 146
 147     volume_value_table = ah->volume.volume_value_table;
 148
 149     /* Dump gain table */
 150     AUDIO_LOG_INFO("<<<<< gain table >>>>>");
 151
 152     dump_str_ptr = &dump_str[0];
 153     memset(dump_str, 0x00, sizeof(char) * sizeof(dump_str));
 154
 155     snprintf(dump_str_ptr, 11, "%10s", " ");
 156     dump_str_ptr += strlen(dump_str_ptr);
 157
 158     for (gain_type_idx = 0; gain_type_idx < AUDIO_GAIN_TYPE_MAX; gain_type_idx++) {
 159         snprintf(dump_str_ptr, 7, "%5s ", gain_type_str[gain_type_idx]);
 160         dump_str_ptr += strlen(dump_str_ptr);
 161     }
 162     AUDIO_LOG_INFO("%s", dump_str);
 163
 164     dump_str_ptr = &dump_str[0];
 165     memset(dump_str, 0x00, sizeof(char) * sizeof(dump_str));
 166
 167     snprintf(dump_str_ptr, 11, "%9s:", table_str);
 168     dump_str_ptr += strlen(dump_str_ptr);
 169
 170     for (gain_type_idx = 0; gain_type_idx < AUDIO_GAIN_TYPE_MAX; gain_type_idx++) {
 171         snprintf(dump_str_ptr, 7, "%01.3f ", volume_value_table->gain[gain_type_idx]);
 172         dump_str_ptr += strlen(dump_str_ptr);
 173     }
 174     AUDIO_LOG_INFO("%s", dump_str);
 175
 176 }
 177
 178 static audio_return_t __load_volume_value_table_from_ini(audio_hal_t *ah)
 179 {
 180     dictionary * dict = NULL;
 181     uint32_t vol_type_idx, vol_level_idx, gain_type_idx;
 182     audio_volume_value_table_t *volume_value_table = ah->volume.volume_value_table;
 183     int size = 0;
 184
 185     if (access(VOLUME_INI_TEMP_PATH, F_OK) == 0)
 186         dict = iniparser_load(VOLUME_INI_TEMP_PATH);
 187     if (!dict) {
 188         AUDIO_LOG_DEBUG("Use default volume&gain ini file");
 189         dict = iniparser_load(VOLUME_INI_DEFAULT_PATH);
 190         if (!dict) {
 191             AUDIO_LOG_WARN("Loading volume&gain table from ini file failed");
 192             return AUDIO_ERR_UNDEFINED;
 193         }
 194     }
 195
 196     const char delimiter[] = ", ";
 197     char *key, *list_str, *token, *ptr = NULL;
 198     const char *table_str = "volumes";
 199
 200     /* Load volume table */
 201     for (vol_type_idx = 0; vol_type_idx < AUDIO_VOLUME_TYPE_MAX; vol_type_idx++) {
 202         const char *vol_type_str = __get_volume_type_string_by_idx(vol_type_idx);
 203
 204         ah->volume.volume_level_max[vol_type_idx] = 0;
 205         size = strlen(table_str) + strlen(vol_type_str) + 2;
 206         key = malloc(size);
 207         if (key) {
 208             snprintf(key, size, "%s:%s", table_str, vol_type_str);
 209             list_str = iniparser_getstring(dict, key, NULL);
 210             if (list_str) {
 211                 token = strtok_r(list_str, delimiter, &ptr);
 212                 while (token) {
 213                     /* convert dB volume to linear volume */
 214                     double vol_value = 0.0f;
 215                     if (strncmp(token, "0", strlen(token)))
 216                         vol_value = pow(10.0, (atof(token) - 100) / 20.0);
 217                     volume_value_table->volume[vol_type_idx][ah->volume.volume_level_max[vol_type_idx]++] = vol_value;
 218                     token = strtok_r(NULL, delimiter, &ptr);
 219                 }
 220             } else {
 221                 ah->volume.volume_level_max[vol_type_idx] = 1;
 222                 for (vol_level_idx = 0; vol_level_idx < AUDIO_VOLUME_LEVEL_MAX; vol_level_idx++) {
 223                     volume_value_table->volume[vol_type_idx][vol_level_idx] = VOLUME_VALUE_MAX;
 224                 }
 225             }
 226             free(key);
 227         }
 228     }
 229
 230     /* Load gain table */
 231     volume_value_table->gain[AUDIO_GAIN_TYPE_DEFAULT] = GAIN_VALUE_MAX;
 232     for (gain_type_idx = AUDIO_GAIN_TYPE_DEFAULT + 1; gain_type_idx < AUDIO_GAIN_TYPE_MAX; gain_type_idx++) {
 233         const char *gain_type_str = __get_gain_type_string_by_idx(gain_type_idx);
 234
 235         size = strlen(table_str) + strlen("gain") + strlen(gain_type_str) + 3;
 236         key = malloc(size);
 237         if (key) {
 238             snprintf(key, size, "%s:gain_%s", table_str, gain_type_str);
 239             token = iniparser_getstring(dict, key, NULL);
 240             if (token) {
 241                 volume_value_table->gain[gain_type_idx] = atof(token);
 242             } else {
 243                 volume_value_table->gain[gain_type_idx] = GAIN_VALUE_MAX;
 244             }
 245             free(key);
 246         } else {
 247             volume_value_table->gain[gain_type_idx] = GAIN_VALUE_MAX;
 248         }
 249     }
 250
 251     iniparser_freedict(dict);
 252
 253     __dump_tb(ah);
 254
 255     return AUDIO_RET_OK;
 256 }
 257
 258 audio_return_t _audio_volume_init(audio_hal_t *ah)
 259 {
 260     int i;
 261     int val = 0;
 262     audio_return_t audio_ret = AUDIO_RET_OK;
 263     int init_value[AUDIO_VOLUME_TYPE_MAX] = { 9, 11, 7, 11, 7, 4, 4, 7 };
 264
 265     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 266
 267     for (i = 0; i < AUDIO_VOLUME_TYPE_MAX; i++) {
 268         ah->volume.volume_level[i] = init_value[i];
 269     }
 270
 271     for (i = 0; i < AUDIO_VOLUME_TYPE_MAX; i++) {
 272         /* Get volume value string from VCONF */
 273         if (vconf_get_int(g_volume_vconf[i], &val) < 0) {
 274             AUDIO_LOG_ERROR("vconf_get_int(%s) failed", g_volume_vconf[i]);
 275             continue;
 276         }
 277
 278         AUDIO_LOG_INFO("read vconf. %s = %d", g_volume_vconf[i], val);
 279         ah->volume.volume_level[i] = val;
 280     }
 281
 282     if (!(ah->volume.volume_value_table = malloc(AUDIO_VOLUME_DEVICE_MAX * sizeof(audio_volume_value_table_t)))) {
 283         AUDIO_LOG_ERROR("volume_value_table malloc failed");
 284         return AUDIO_ERR_RESOURCE;
 285     }
 286
 287     audio_ret = __load_volume_value_table_from_ini(ah);
 288     if (audio_ret != AUDIO_RET_OK) {
 289         AUDIO_LOG_ERROR("gain table load error");
 290         return AUDIO_ERR_UNDEFINED;
 291     }
 292
 293     return audio_ret;
 294 }
 295
 296 audio_return_t _audio_volume_deinit(audio_hal_t *ah)
 297 {
 298     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 299
 300     if (ah->volume.volume_value_table) {
 301         free(ah->volume.volume_value_table);
 302         ah->volume.volume_value_table = NULL;
 303     }
 304
 305     return AUDIO_RET_OK;
 306 }
 307
 308 audio_return_t audio_get_volume_level_max(void *audio_handle, audio_volume_info_t *info, uint32_t *level)
 309 {
 310     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 311
 312     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 313     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 314     AUDIO_RETURN_VAL_IF_FAIL(level, AUDIO_ERR_PARAMETER);
 315
 316     /* Get max volume level by device & type */
 317     *level = ah->volume.volume_level_max[__get_volume_idx_by_string_type(info->type)];
 318
 319     AUDIO_LOG_DEBUG("get_[%s] volume_level_max: %d", info->type, *level);
 320
 321     return AUDIO_RET_OK;
 322 }
 323
 324 audio_return_t audio_get_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t *level)
 325 {
 326     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 327
 328     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 329     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 330     AUDIO_RETURN_VAL_IF_FAIL(level, AUDIO_ERR_PARAMETER);
 331
 332     if (!strncmp(info->type, "master", strlen("master"))) {
 333         *level = g_master_volume_level;
 334         return AUDIO_RET_OK;
 335     }
 336
 337     *level = ah->volume.volume_level[__get_volume_idx_by_string_type(info->type)];
 338
 339     AUDIO_LOG_INFO("get [%s] volume_level: %d, direction(%d)", info->type, *level, info->direction);
 340
 341     return AUDIO_RET_OK;
 342 }
 343
 344 audio_return_t audio_get_volume_value(void *audio_handle, audio_volume_info_t *info, uint32_t level, double *value)
 345 {
 346     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 347     audio_volume_value_table_t *volume_value_table;
 348     char dump_str[AUDIO_DUMP_STR_LEN] = {0,};
 349
 350     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 351     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 352     AUDIO_RETURN_VAL_IF_FAIL(value, AUDIO_ERR_PARAMETER);
 353     AUDIO_RETURN_VAL_IF_FAIL(ah->volume.volume_value_table, AUDIO_ERR_PARAMETER);
 354
 355     /* Get basic volume by device & type & level */
 356     volume_value_table = ah->volume.volume_value_table;
 357     if (ah->volume.volume_level_max[__get_volume_idx_by_string_type(info->type)] < level)
 358         *value = VOLUME_VALUE_MAX;
 359     else
 360         *value = volume_value_table->volume[__get_volume_idx_by_string_type(info->type)][level];
 361     *value *= volume_value_table->gain[AUDIO_GAIN_TYPE_DEFAULT]; /* need to fix getting gain via audio_info_t */
 362
 363     AUDIO_LOG_DEBUG("get_volume_value:%d(%s)=>%f %s", level, info->type, *value, &dump_str[0]);
 364
 365     return AUDIO_RET_OK;
 366 }
 367
 368 audio_return_t audio_set_volume_level(void *audio_handle, audio_volume_info_t *info, uint32_t level)
 369 {
 370     audio_return_t audio_ret = AUDIO_RET_OK;
 371     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 372
 373     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 374     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 375     if (!strncmp(info->type, "master", strlen("master"))) {
 376         g_master_volume_level = level;
 377         return AUDIO_RET_OK;
 378     }
 379     AUDIO_RETURN_VAL_IF_FAIL((ah->volume.volume_level_max[__get_volume_idx_by_string_type(info->type)] >= level), AUDIO_ERR_PARAMETER);
 380
 381     /* Update volume level */
 382     ah->volume.volume_level[__get_volume_idx_by_string_type(info->type)] = level;
 383     AUDIO_LOG_INFO("set [%s] volume_level: %d, direction(%d)", info->type, level, info->direction);
 384
 385     /* set mixer related to H/W volume if needed */
 386
 387     return audio_ret;
 388 }
 389
 390 audio_return_t audio_get_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t *mute)
 391 {
 392     audio_return_t audio_ret = AUDIO_RET_OK;
 393     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 394
 395     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 396     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 397     AUDIO_RETURN_VAL_IF_FAIL(mute, AUDIO_ERR_PARAMETER);
 398
 399     /* TODO. Not implemented */
 400
 401     return audio_ret;
 402 }
 403
 404 audio_return_t audio_set_volume_mute(void *audio_handle, audio_volume_info_t *info, uint32_t mute)
 405 {
 406     audio_return_t audio_ret = AUDIO_RET_OK;
 407     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 408
 409     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 410     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 411
 412     /* TODO. Not implemented */
 413
 414     return audio_ret;
 415 }
 416
 417 audio_return_t audio_set_volume_ratio(void *audio_handle, audio_stream_info_t *info, double ratio)
 418 {
 419     audio_return_t audio_ret = AUDIO_RET_OK;
 420     audio_hal_t *ah = (audio_hal_t *)audio_handle;
 421
 422     AUDIO_RETURN_VAL_IF_FAIL(ah, AUDIO_ERR_PARAMETER);
 423     AUDIO_RETURN_VAL_IF_FAIL(info, AUDIO_ERR_PARAMETER);
 424
 425     AUDIO_LOG_INFO("set [%s] volume_ratio: %f, direction(%u), index(%u)", info->role, ratio, info->direction, info->idx);
 426
 427     return audio_ret;
 428 }