EffectsFactory.h revision f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8
1135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent/* 2135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * Copyright (C) 2010 The Android Open Source Project 3135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * 4135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * Licensed under the Apache License, Version 2.0 (the "License"); 5135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * you may not use this file except in compliance with the License. 6135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * You may obtain a copy of the License at 7135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * 8135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * http://www.apache.org/licenses/LICENSE-2.0 9135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * 10135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * Unless required by applicable law or agreed to in writing, software 11135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * distributed under the License is distributed on an "AS IS" BASIS, 12135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * See the License for the specific language governing permissions and 14135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent * limitations under the License. 15135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent */ 16135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 17135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#ifndef ANDROID_EFFECTSFACTORY_H_ 18135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#define ANDROID_EFFECTSFACTORY_H_ 19135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 20135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#include <cutils/log.h> 21135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#include <pthread.h> 22135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#include <dirent.h> 23f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana#include <hardware/audio_effect.h> 24135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 25135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#if __cplusplus 26135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurentextern "C" { 27135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#endif 28135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 29e1315cf0b63b4c14a77046519e6b01f6f60d74b0Eric Laurent 30135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurenttypedef struct list_elem_s { 31135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent void *object; 32135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent struct list_elem_s *next; 33135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent} list_elem_t; 34135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 352eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// Structure used for storing effects with their sub effects. 362eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// Used in creating gSubEffectList. Here, 372eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// object holds the effect desc and the list sub_elem holds the sub effects 382eab94f7dfd41a65e13aca379a1aed97447f8884jpadmanatypedef struct list_sub_elem_s { 392eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana void *object; 402eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana list_elem_t *sub_elem; 412eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana struct list_sub_elem_s *next; 422eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana} list_sub_elem_t; 432eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana 44135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurenttypedef struct lib_entry_s { 45e1315cf0b63b4c14a77046519e6b01f6f60d74b0Eric Laurent audio_effect_library_t *desc; 46e1315cf0b63b4c14a77046519e6b01f6f60d74b0Eric Laurent char *name; 47e1315cf0b63b4c14a77046519e6b01f6f60d74b0Eric Laurent char *path; 48135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent void *handle; 49135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent list_elem_t *effects; //list of effect_descriptor_t 50135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent pthread_mutex_t lock; 51135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent} lib_entry_t; 52135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 53135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurenttypedef struct effect_entry_s { 54135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent struct effect_interface_s *itfe; 55e1315cf0b63b4c14a77046519e6b01f6f60d74b0Eric Laurent effect_handle_t subItfe; 56135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent lib_entry_t *lib; 57135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent} effect_entry_t; 58135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 592eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// Structure used to store the lib entry 602eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// and the descriptor of the sub effects. 612eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// The library entry is to be stored in case of 622eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// sub effects as the sub effects are not linked 632eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana// to the library list - gLibraryList. 642eab94f7dfd41a65e13aca379a1aed97447f8884jpadmanatypedef struct sub_effect_entry_s { 652eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana lib_entry_t *lib; 662eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana void *object; 672eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana} sub_effect_entry_t; 682eab94f7dfd41a65e13aca379a1aed97447f8884jpadmana 69f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana 70f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana//////////////////////////////////////////////////////////////////////////////// 71f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// 72f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// Function: EffectGetSubEffects 73f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// 74f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// Description: Returns the descriptors of the sub effects of the effect 75f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// whose uuid is pointed to by first argument. 76f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// 77f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// Input: 78f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// pEffectUuid: pointer to the effect uuid. 79f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// size: max number of sub_effect_entry_t * in pSube. 80f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// 81f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// Input/Output: 82f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// pSube: address where to return the sub effect structures. 83f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// Output: 84f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// returned value: 0 successful operation. 85f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// -ENODEV factory failed to initialize 86f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// -EINVAL invalid pEffectUuid or pDescriptor 87f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// -ENOENT no effect with this uuid found 88f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// *pDescriptor: updated with the sub effect descriptors. 89f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana// 90f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana//////////////////////////////////////////////////////////////////////////////// 91f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmanaint EffectGetSubEffects(const effect_uuid_t *pEffectUuid, 92f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana sub_effect_entry_t **pSube, 93f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana size_t size); 94f90c7e0bb8d83d8b7f733bdf430d331ea3f221e8jpadmana 95135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#if __cplusplus 96135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent} // extern "C" 97135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#endif 98135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 99135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent 100135ad07e33d30e5202deb21061a0e3ecf0ffad35Eric Laurent#endif /*ANDROID_EFFECTSFACTORY_H_*/ 101