src/source.c

   1 /*
   2  * Copyright (c) 2016 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  * @file source.c
  19  * @brief This file include implementation of protected API
  20  * for the sound sources(OpenAL buffers) as part of SoundPool.
  21  */
  22
  23 #include "internal/source.h"
  24 #include "internal/stream.h"
  25
  26 #include <unistd.h>
  27 #ifdef ENABLE_ALURE
  28 #include <AL/alure.h>
  29 #else
  30 #include <AL/alut.h>
  31 #endif
  32
  33 static sound_pool_error_e __sound_pool_add_source(sound_pool_t *pool, sound_source_t *src);
  34 static sound_pool_error_e __sound_pool_remove_source(sound_pool_t *pool, sound_source_t *src);
  35 static sound_pool_error_e __probe_file_access(const char *file, int amode);
  36
  37 static sound_pool_error_e __sound_pool_add_source(sound_pool_t *pool, sound_source_t *src)
  38 {
  39         SP_DEBUG_FENTER();
  40         SP_INST_CHECK(pool, SOUND_POOL_ERROR_INVALID_PARAMETER);
  41         SP_INST_CHECK(src, SOUND_POOL_ERROR_INVALID_PARAMETER);
  42         SP_RETVM_IF(!pool->sources, SOUND_POOL_ERROR_INVALID_OPERATION, "Sound "
  43                         "pool to add the source is corrupted: NULL sources hash table");
  44         SP_RETVM_IF(!src->tag_name, SOUND_POOL_ERROR_INVALID_OPERATION,
  45                         "Source to be added to sound pool is corrupted: NULL tag name");
  46         SP_RETVM_IF(src->parent_pool != pool, SOUND_POOL_ERROR_INVALID_OPERATION,
  47                         "Sound source can't be added to the pool different to the pool for"
  48                         " which sound source was created");
  49         SP_RETVM_IF(g_hash_table_contains(pool->sources, src->tag_name),
  50                         SOUND_POOL_ERROR_INVALID_PARAMETER,
  51                         "Tag already exists in sources hash table.");
  52
  53         SP_RETVM_IF(!g_hash_table_insert(pool->sources, src->tag_name, src),
  54                         SOUND_POOL_ERROR_INVALID_OPERATION, "Error occurred when adding "
  55                         "the source tagged [%s] to the sound pool", src->tag_name);
  56
  57         SP_DEBUG_FLEAVE();
  58         return SOUND_POOL_ERROR_NONE;
  59 }
  60
  61 static sound_pool_error_e __sound_pool_remove_source(sound_pool_t *pool, sound_source_t *src)
  62 {
  63         SP_DEBUG_FENTER();
  64         SP_INST_CHECK(pool, SOUND_POOL_ERROR_INVALID_PARAMETER);
  65         SP_INST_CHECK(pool->sources, SOUND_POOL_ERROR_INVALID_PARAMETER);
  66         SP_INST_CHECK(src, SOUND_POOL_ERROR_INVALID_PARAMETER);
  67
  68         if (src->parent_pool == pool && src->tag_name) {
  69                 if (!g_hash_table_steal(pool->sources, src->tag_name)) {
  70                         SP_DEBUG("Tag [%s] doesn't exist in sources hash table",
  71                                         src->tag_name);
  72                         SP_DEBUG_FLEAVE();
  73                         return SOUND_POOL_ERROR_NONE;
  74                 }
  75                 GHashTableIter iter;
  76                 gpointer key, value;
  77                 g_hash_table_iter_init(&iter, pool->streams);
  78                 while (g_hash_table_iter_next(&iter, &key, &value)) {
  79                         guint size_before = g_hash_table_size(pool->streams);
  80                         sound_stream_t *stream = (sound_stream_t*)value;
  81                         if (src == stream->parent_source)
  82                                 _sound_stream_destroy((sound_stream_t*)value);
  83                         guint size_after = g_hash_table_size(pool->streams);
  84                         if (size_before != size_after)
  85                                 g_hash_table_iter_init(&iter, pool->streams);
  86                 }
  87         } else {
  88                         SP_DEBUG("Source wasn't removed from sound pool as it isn't known by "
  89                                         "the pool for which operation is performed, or tag corrupted");
  90         }
  91
  92         SP_DEBUG_FLEAVE();
  93         return SOUND_POOL_ERROR_NONE;
  94 }
  95
  96 /* file parameter should be not-NULL and not empty c-string */
  97 static sound_pool_error_e __probe_file_access(const char *file, int amode)
  98 {
  99         SP_DEBUG_FENTER();
 100         sound_pool_error_e ret = SOUND_POOL_ERROR_NONE;
 101
 102         if (-1 == access(file, amode)) {
 103                 char errmsg[256];
 104                 strerror_r(errno, errmsg, sizeof(errmsg));
 105                 SP_ERROR("Couldn`t open file in [%i] mode, reason [%s].", amode, errmsg);
 106                 if (EACCES == errno)
 107                         ret = SOUND_POOL_ERROR_NOT_PERMITTED;
 108                 else if (ENOENT == errno)
 109                         ret = SOUND_POOL_ERROR_NO_SUCH_FILE;
 110                 else
 111                         ret = SOUND_POOL_ERROR_INVALID_OPERATION;
 112                 SP_DEBUG_FLEAVE();
 113                 return ret;
 114         }
 115
 116         SP_DEBUG_FLEAVE();
 117         return ret;
 118 }
 119
 120 sound_pool_error_e _sound_source_create(sound_pool_t *pool, const char *tag,
 121                 sound_source_t **src)
 122 {
 123         SP_DEBUG_FENTER();
 124         SP_RETVM_IF(!pool, SOUND_POOL_ERROR_INVALID_PARAMETER,
 125                         "Can't create sound source in NULL sound pool");
 126         SP_RETVM_IF(!tag, SOUND_POOL_ERROR_INVALID_PARAMETER,
 127                         "Can't create sound source with NULL tag name");
 128         SP_RETVM_IF(!src, SOUND_POOL_ERROR_INVALID_PARAMETER,
 129                         "Can't create sound source. Source pointer is NULL");
 130         SP_RETVM_IF(strnlen(tag, MAX_TAG_LEN + 1) == MAX_TAG_LEN + 1,
 131                         SOUND_POOL_ERROR_INVALID_PARAMETER, "Can't create sound source "
 132                         "with tag name longer than %u", MAX_TAG_LEN);
 133         SP_RETVM_IF(!pool->sources, SOUND_POOL_ERROR_INVALID_OPERATION, "Sound "
 134                         "pool to create source is corrupted: NULL sources hash table.");
 135         SP_RETVM_IF(g_hash_table_contains(pool->sources, tag),
 136                         SOUND_POOL_ERROR_INVALID_PARAMETER,
 137                         "Tag already exists in sources hash table.");
 138
 139         SP_RETVM_IF(!alcMakeContextCurrent(pool->al_context),
 140                         SOUND_POOL_ERROR_INVALID_OPERATION,
 141                         "Can't set current context.");
 142
 143         sound_source_t *_src = NULL;
 144         SP_RETVM_IF(!(_src = g_try_malloc0(sizeof(*_src))),
 145                         SOUND_POOL_ERROR_OUT_OF_MEMORY,
 146                         "Memory alloc failure. Can't create sound _src");
 147
 148         sound_pool_error_e ret_destroy = SOUND_POOL_ERROR_NONE;
 149         sound_pool_error_e ret = SOUND_POOL_ERROR_NONE;
 150         alGenBuffers(1, &_src->al_buffer);
 151         if (alGetError() != AL_NO_ERROR) {
 152                 ret = SOUND_POOL_ERROR_OUT_OF_MEMORY;
 153                 GOTO_FAIL("OpenAL error occurred when trying to generate Buffer id", cfail);
 154         }
 155
 156         _src->parent_pool = pool;
 157         _src->tag_name = NULL;
 158         _src->tag_name = g_strndup(tag, MAX_TAG_LEN);
 159
 160         ret = __sound_pool_add_source(pool, _src);
 161         if (ret != SOUND_POOL_ERROR_NONE)
 162                 GOTO_FAIL("Error occurred when trying to add source to pool", cfail);
 163
 164         *src = _src;
 165         SP_DEBUG_FLEAVE();
 166         return ret;
 167
 168 cfail:
 169         ret_destroy = _sound_source_destroy(_src);
 170         SP_RETVM_IF(SOUND_POOL_ERROR_NONE != ret_destroy, ret_destroy,
 171                         "Error occurred during removal of sound source[%s].", tag);
 172         SP_DEBUG_FLEAVE();
 173         return ret;
 174 }
 175
 176 sound_pool_error_e _sound_source_destroy(sound_source_t *src)
 177 {
 178         SP_DEBUG_FENTER();
 179         SP_RETVM_IF(!src, SOUND_POOL_ERROR_INVALID_PARAMETER,
 180                         "Can't destroy NULL sound source");
 181
 182         /* If parent pool exists, then source has to be removed from the pool */
 183         if (src->parent_pool && __sound_pool_remove_source(src->parent_pool, src)
 184                         != SOUND_POOL_ERROR_NONE)
 185                 SP_DEBUG("Source wasn't removed from sound pool.");
 186
 187         SP_DEBUG("Deleting OpenAL buffer with id [%u]", src->al_buffer);
 188         alDeleteBuffers(1, &src->al_buffer);
 189
 190         SP_SAFE_GFREE(src->tag_name);
 191         SP_SAFE_GFREE(src);
 192
 193         SP_DEBUG_FLEAVE();
 194         return SOUND_POOL_ERROR_NONE;
 195 }
 196
 197 sound_pool_error_e _sound_source_load_from_file(sound_source_t *src,
 198                 const char *fname)
 199 {
 200         SP_DEBUG_FENTER();
 201         SP_INST_CHECK(src, SOUND_POOL_ERROR_INVALID_PARAMETER);
 202         SP_INST_CHECK(fname, SOUND_POOL_ERROR_INVALID_PARAMETER);
 203         SP_INST_CHECK(src->parent_pool, SOUND_POOL_ERROR_INVALID_OPERATION);
 204         SP_RETVM_IF(!alcMakeContextCurrent(src->parent_pool->al_context),
 205                         SOUND_POOL_ERROR_INVALID_OPERATION, "Can't set current AL context.");
 206
 207         sound_pool_error_e ret = __probe_file_access(fname, R_OK);
 208         SP_RETVM_IF(SOUND_POOL_ERROR_NONE != ret, ret,
 209                         "Can't load source from [%s] file.", fname);
 210
 211         ALuint buffer_handle = AL_NONE;
 212         src->al_buffer = AL_NONE;
 213
 214 #ifdef ENABLE_ALURE
 215         buffer_handle = alureCreateBufferFromFile((const ALchar *)fname);
 216         SP_RETVM_IF(buffer_handle == AL_NONE, SOUND_POOL_ERROR_INVALID_OPERATION,
 217                         "Can't load audio file [%s]. Error message [%s]", fname,
 218                         alureGetErrorString());
 219 #else
 220         alutInitWithoutContext(NULL, NULL);
 221         buffer_handle = alutCreateBufferFromFile(fname);
 222         ALenum error = alutGetError();
 223         alutExit();
 224         SP_RETVM_IF(error != ALUT_ERROR_NO_ERROR || buffer_handle == AL_NONE,
 225                         SOUND_POOL_ERROR_INVALID_OPERATION, "Can't load audio file [%s]. "
 226                         "Error message [%s]", fname, alutGetErrorString(error));
 227 #endif
 228
 229         src->al_buffer = buffer_handle;
 230         SP_DEBUG_FLEAVE();
 231         return ret;
 232 }
 233
 234 sound_pool_error_e _sound_pool_get_source_by_tag(sound_pool_t *pool,
 235                 const char *tag, sound_source_t **src)
 236 {
 237         SP_DEBUG_FENTER();
 238         SP_INST_CHECK(pool, SOUND_POOL_ERROR_INVALID_PARAMETER);
 239         SP_INST_CHECK(tag, SOUND_POOL_ERROR_INVALID_PARAMETER);
 240         SP_INST_CHECK(src, SOUND_POOL_ERROR_INVALID_PARAMETER);
 241         SP_RETVM_IF(!pool->sources, SOUND_POOL_ERROR_INVALID_PARAMETER, "Corrupted "
 242                         "sound pool. Sources hash table is NULL");
 243
 244         *src = (sound_source_t *)g_hash_table_lookup(pool->sources, tag);
 245         SP_RETVM_IF(!(*src), SOUND_POOL_ERROR_KEY_NOT_AVAILABLE, "Tag doesn't "
 246                         "exist in sources hash table");
 247
 248         SP_DEBUG_FLEAVE();
 249         return SOUND_POOL_ERROR_NONE;
 250 }