1/*
2 * Copyright (C) 2016 The Android Open Source Project
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#ifndef ANDROID_HARDWARE_EFFECTS_FACTORY_HAL_INTERFACE_H
18#define ANDROID_HARDWARE_EFFECTS_FACTORY_HAL_INTERFACE_H
19
20#include <media/audiohal/EffectHalInterface.h>
21#include <system/audio_effect.h>
22#include <utils/Errors.h>
23#include <utils/RefBase.h>
24
25namespace android {
26
27class EffectsFactoryHalInterface : public RefBase
28{
29  public:
30    // Returns the number of different effects in all loaded libraries.
31    virtual status_t queryNumberEffects(uint32_t *pNumEffects) = 0;
32
33    // Returns a descriptor of the next available effect.
34    virtual status_t getDescriptor(uint32_t index,
35            effect_descriptor_t *pDescriptor) = 0;
36
37    virtual status_t getDescriptor(const effect_uuid_t *pEffectUuid,
38            effect_descriptor_t *pDescriptor) = 0;
39
40    // Creates an effect engine of the specified type.
41    // To release the effect engine, it is necessary to release references
42    // to the returned effect object.
43    virtual status_t createEffect(const effect_uuid_t *pEffectUuid,
44            int32_t sessionId, int32_t ioId,
45            sp<EffectHalInterface> *effect) = 0;
46
47    virtual status_t dumpEffects(int fd) = 0;
48
49    static sp<EffectsFactoryHalInterface> create();
50
51    virtual status_t allocateBuffer(size_t size, sp<EffectBufferHalInterface>* buffer) = 0;
52    virtual status_t mirrorBuffer(void* external, size_t size,
53                                  sp<EffectBufferHalInterface>* buffer) = 0;
54
55    // Helper function to compare effect uuid to EFFECT_UUID_NULL.
56    static bool isNullUuid(const effect_uuid_t *pEffectUuid);
57
58  protected:
59    // Subclasses can not be constructed directly by clients.
60    EffectsFactoryHalInterface() {}
61
62    virtual ~EffectsFactoryHalInterface() {}
63};
64
65} // namespace android
66
67#endif // ANDROID_HARDWARE_EFFECTS_FACTORY_HAL_INTERFACE_H
68