140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov/* 240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Copyright (C) 2016 The Android Open Source Project 340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * 440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Licensed under the Apache License, Version 2.0 (the "License"); 540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * you may not use this file except in compliance with the License. 640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * You may obtain a copy of the License at 740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * 840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * http://www.apache.org/licenses/LICENSE-2.0 940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * 1040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Unless required by applicable law or agreed to in writing, software 1140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * distributed under the License is distributed on an "AS IS" BASIS, 1240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * See the License for the specific language governing permissions and 1440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * limitations under the License. 1540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 1640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 1740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganovpackage android.hardware.audio.effect@2.0; 1840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 1940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganovimport android.hardware.audio.common@2.0; 2040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganovimport IEffect; 2140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 2240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganovinterface IVirtualizerEffect extends IEffect { 2340d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 2440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Returns whether setting virtualization strength is supported. 2540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 2640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov isStrengthSupported() generates (bool strengthSupported); 2740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 2840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov enum StrengthRange : uint16_t { 2940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov MIN = 0, 3040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov MAX = 1000 3140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov }; 3240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 3340d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 3440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Sets virtualization strength. 3540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * 3640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * @param strength strength of the effect. The valid range for strength 3740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * strength is [0, 1000], where 0 per mille designates the 3840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * mildest effect and 1000 per mille designates the 3940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * strongest. 4040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * @return retval operation completion status. 4140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 4240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov setStrength(uint16_t strength) generates (Result retval); 4340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 4440d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 4540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Gets virtualization strength. 4640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 4740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov getStrength() generates (Result retval, uint16_t strength); 4840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 4940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov struct SpeakerAngle { 5040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov AudioChannelMask mask; // speaker channel mask (1 bit set). 5140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov // all angles are expressed in degrees and 5240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov // are relative to the listener. 5340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov int16_t azimuth; // 0 is the direction the listener faces 5440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov // 180 is behind the listener 5540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov // -90 is to their left 5640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov int16_t elevation; // 0 is the horizontal plane 5740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov // +90 is above the listener, -90 is below 5840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov }; 5940d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 6040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Retrieves virtual speaker angles for the given channel mask on the 6140be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * specified device. 6240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 6340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov getVirtualSpeakerAngles(AudioChannelMask mask, AudioDevice device) 6440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov generates (Result retval, vec<SpeakerAngle> speakerAngles); 6540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 6640d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 6740be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Forces the virtualizer effect for the given output device. 6840be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 6940be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov forceVirtualizationMode(AudioDevice device) generates (Result retval); 7040be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov 7140d3a9bd8c62714ee58f9363c4456f764aa5a95dAndreas Huber /** 7240be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * Returns audio device reflecting the current virtualization mode, 7340be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov * AUDIO_DEVICE_NONE when not virtualizing. 7440be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov */ 7540be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov getVirtualizationMode() generates (Result retval, AudioDevice device); 7640be06cdf3a34856144574cf5e70b60e4ad4940cMikhail Naganov}; 77