Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d56bc22d authored by Shunkai Yao's avatar Shunkai Yao
Browse files

AIDL effect: Initial IFactory interface definition 

Bug: 238913361
Test: atest VtsHalAudioEffectTargetTest

Change-Id: I9f5ef1284bb5d77a9d60cb8b901742fc8e467926
parent d2847d4c

audio/aidl/Android.bp

+23 −0
Original line number Diff line number Diff line
@@ -96,3 +96,26 @@ aidl_interface { 
        },

    },

}



aidl_interface {

    name: "android.hardware.audio.effect",

    vendor_available: true,

    srcs: [

        "android/hardware/audio/effect/Descriptor.aidl",

        "android/hardware/audio/effect/IFactory.aidl",

    ],

    imports: [

        "android.hardware.audio.common-V1",

        "android.media.audio.common.types-V1",

    ],

    stability: "vintf",

    backend: {

        // The C++ backend is disabled transitively due to use of FMQ.

        cpp: {

            enabled: false,

        },

        java: {

            sdk_version: "module_current",

        },

    },

}

audio/aidl/aidl_api/android.hardware.audio.effect/current/android/hardware/audio/effect/Descriptor.aidl

0 → 100644
+60 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

///////////////////////////////////////////////////////////////////////////////

// THIS FILE IS IMMUTABLE. DO NOT EDIT IN ANY CASE.                          //

///////////////////////////////////////////////////////////////////////////////



// This file is a snapshot of an AIDL file. Do not edit it manually. There are

// two cases:

// 1). this is a frozen version file - do not edit this in any case.

// 2). this is a 'current' file. If you make a backwards compatible change to

//     the interface (from the latest frozen version), the build system will

//     prompt you to update this file with `m <name>-update-api`.

//

// You must not make a backward incompatible change to any AIDL file built

// with the aidl_interface module type with versions property set. The module

// type is used to build AIDL files in a way that they can be used across

// independently updatable components of the system. If a device is shipped

// with such a backward incompatible change, it has a high risk of breaking

// later when a module using the interface is updated, e.g., Mainline modules.



package android.hardware.audio.effect;

@VintfStability

parcelable Descriptor {

  android.hardware.audio.effect.Descriptor.Common common;

  const String EFFECT_TYPE_UUID_ENV_REVERB = "c2e5d5f0-94bd-4763-9cac-4e234d06839e";

  const String EFFECT_TYPE_UUID_PRESET_REVERB = "47382d60-ddd8-11db-bf3a-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_EQUALIZER = "0bed4300-ddd6-11db-8f34-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_BASS_BOOST = "0634f220-ddd4-11db-a0fc-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_VIRTUALIZER = "37cc2c00-dddd-11db-8577-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_AGC = "0a8abfe0-654c-11e0-ba26-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_AEC = "7b491460-8d4d-11e0-bd61-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_NS = "58b4b260-8e06-11e0-aa8e-0002a5d5c51b";

  const String EFFECT_TYPE_UUID_LOUDNESS_ENHANCER = "fe3199be-aed0-413f-87bb-11260eb63cf1";

  const String EFFECT_TYPE_UUID_DYNAMICS_PROCESSING = "7261676f-6d75-7369-6364-28e2fd3ac39e";

  const String EFFECT_TYPE_UUID_HAPTIC_GENERATOR = "1411e6d6-aecd-4021-a1cf-a6aceb0d71e5";

  const String EFFECT_TYPE_UUID_SPATIALIZER = "ccd4cf09-a79d-46c2-9aae-06a1698d6c8f";

  const String EFFECT_TYPE_UUID_VOLUME = "09e8ede0-ddde-11db-b4f6-0002a5d5c51b";

  @VintfStability

  parcelable Identity {

    android.media.audio.common.AudioUuid type;

    android.media.audio.common.AudioUuid uuid;

  }

  @VintfStability

  parcelable Common {

    android.hardware.audio.effect.Descriptor.Identity id;

  }

}

audio/aidl/aidl_api/android.hardware.audio.effect/current/android/hardware/audio/effect/IFactory.aidl

0 → 100644
+38 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

///////////////////////////////////////////////////////////////////////////////

// THIS FILE IS IMMUTABLE. DO NOT EDIT IN ANY CASE.                          //

///////////////////////////////////////////////////////////////////////////////



// This file is a snapshot of an AIDL file. Do not edit it manually. There are

// two cases:

// 1). this is a frozen version file - do not edit this in any case.

// 2). this is a 'current' file. If you make a backwards compatible change to

//     the interface (from the latest frozen version), the build system will

//     prompt you to update this file with `m <name>-update-api`.

//

// You must not make a backward incompatible change to any AIDL file built

// with the aidl_interface module type with versions property set. The module

// type is used to build AIDL files in a way that they can be used across

// independently updatable components of the system. If a device is shipped

// with such a backward incompatible change, it has a high risk of breaking

// later when a module using the interface is updated, e.g., Mainline modules.



package android.hardware.audio.effect;

@VintfStability

interface IFactory {

  android.hardware.audio.effect.Descriptor.Identity[] queryEffects(in @nullable android.media.audio.common.AudioUuid type, in @nullable android.media.audio.common.AudioUuid implementation);

}

audio/aidl/android/hardware/audio/effect/Descriptor.aidl

0 → 100644
+82 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.hardware.audio.effect;



import android.media.audio.common.AudioUuid;



/**

 * Effect descriptor contains all information (capabilities, attributes, and ownership) for an

 * effect implemented in the Audio Effect HAL. Framework uses this information to decide when and

 * how to apply the effect.

 */

@VintfStability

parcelable Descriptor {

    /**

     * UUID for effect types, these definitions are in sync with SDK, see @c AudioEffect.java.

     */

    // UUID for environmental reverberation effect type.

    const String EFFECT_TYPE_UUID_ENV_REVERB = "c2e5d5f0-94bd-4763-9cac-4e234d06839e";

    // UUID for preset reverberation effect type.

    const String EFFECT_TYPE_UUID_PRESET_REVERB = "47382d60-ddd8-11db-bf3a-0002a5d5c51b";

    // UUID for equalizer effect type.

    const String EFFECT_TYPE_UUID_EQUALIZER = "0bed4300-ddd6-11db-8f34-0002a5d5c51b";

    // UUID for bass boost effect type.

    const String EFFECT_TYPE_UUID_BASS_BOOST = "0634f220-ddd4-11db-a0fc-0002a5d5c51b";

    // UUID for virtualizer effect type.

    const String EFFECT_TYPE_UUID_VIRTUALIZER = "37cc2c00-dddd-11db-8577-0002a5d5c51b";

    // UUID for Automatic Gain Control (AGC) type.

    const String EFFECT_TYPE_UUID_AGC = "0a8abfe0-654c-11e0-ba26-0002a5d5c51b";

    // UUID for Acoustic Echo Canceler (AEC) type.

    const String EFFECT_TYPE_UUID_AEC = "7b491460-8d4d-11e0-bd61-0002a5d5c51b";

    // UUID for Noise Suppressor (NS) type.

    const String EFFECT_TYPE_UUID_NS = "58b4b260-8e06-11e0-aa8e-0002a5d5c51b";

    // UUID for Loudness Enhancer type.

    const String EFFECT_TYPE_UUID_LOUDNESS_ENHANCER = "fe3199be-aed0-413f-87bb-11260eb63cf1";

    // UUID for Dynamics Processing type.

    const String EFFECT_TYPE_UUID_DYNAMICS_PROCESSING = "7261676f-6d75-7369-6364-28e2fd3ac39e";

    // UUID for Haptic Generator type.

    const String EFFECT_TYPE_UUID_HAPTIC_GENERATOR = "1411e6d6-aecd-4021-a1cf-a6aceb0d71e5";

    // UUID for Spatializer type.

    const String EFFECT_TYPE_UUID_SPATIALIZER = "ccd4cf09-a79d-46c2-9aae-06a1698d6c8f";

    // UUID for Volume type. The volume effect is used for automated tests only.

    const String EFFECT_TYPE_UUID_VOLUME = "09e8ede0-ddde-11db-b4f6-0002a5d5c51b";



    /**

     * This structure completely identifies an effect implementation.

     */

    @VintfStability

    parcelable Identity {

        /**

         * UUID for the type of effect.

         */

        AudioUuid type;

        /**

         * UUID for this particular implementation.

         */

        AudioUuid uuid;

    }



    // Common attributes of all effect implementation.

    @VintfStability

    parcelable Common {

        /**

         * Identity of effect implementation.

         */

        Identity id;

    }

    Common common;

}

audio/aidl/android/hardware/audio/effect/IFactory.aidl

0 → 100644
+45 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.hardware.audio.effect;



import android.hardware.audio.effect.Descriptor;

import android.media.audio.common.AudioUuid;



/**

 * Provides system-wide effect factory interfaces.

 *

 * An android.hardware.audio.effect.IFactory platform service is registered with ServiceManager, and

 * is always available on the device.

 *

 */

@VintfStability

interface IFactory {

    /**

     * Return a list of effect identities supported by this device, with the optional

     * filter by type and/or by instance UUID.

     *

     * @param type UUID identifying the effect type.

     *        This is an optional parameter, pass in null if this parameter is not necessary; if non

     *        null, used as a filter for effect type UUIDs.

     * @param implementation Indicates the particular implementation of the effect in that type.

     *        This is an optional parameter, pass in null if this parameter is not necessary; if

     *        non null, used as a filter for effect type UUIDs.

     * @return List of effect identities supported and filtered by type/implementation UUID.

     */

    Descriptor.Identity[] queryEffects(

            in @nullable AudioUuid type, in @nullable AudioUuid implementation);

}