services/audiopolicy/engineconfigurable/parameter-framework/examples/common/Structure/PolicySubsystem-CommonTypes.xml

<?xml version="1.0" encoding="UTF-8"?>
<ComponentTypeSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xsi:noNamespaceSchemaLocation="Schemas/ComponentTypeSet.xsd">
    <!-- Output devices definition as a bitfield for the supported devices per output
    profile. It must match with the output device enum parameter.
    -->
     <!--#################### GLOBAL COMPONENTS BEGIN ####################-->

     <!--#################### GLOBAL COMPONENTS END ####################-->

    <ComponentType Name="OutputDevicesMask" Description="32th bit is not allowed as dedicated
                                                     for input devices detection">
        <BitParameterBlock Name="mask" Size="32">
            <BitParameter Name="earpiece" Size="1" Pos="0"/>
            <BitParameter Name="speaker" Size="1" Pos="1"/>
            <BitParameter Name="wired_headset" Size="1" Pos="2"/>
            <BitParameter Name="wired_headphone" Size="1" Pos="3"/>
            <BitParameter Name="bluetooth_sco" Size="1" Pos="4"/>
            <BitParameter Name="bluetooth_sco_headset" Size="1" Pos="5"/>
            <BitParameter Name="bluetooth_sco_carkit" Size="1" Pos="6"/>
            <BitParameter Name="bluetooth_a2dp" Size="1" Pos="7"/>
            <BitParameter Name="bluetooth_a2dp_headphones" Size="1" Pos="8"/>
            <BitParameter Name="bluetooth_a2dp_speaker" Size="1" Pos="9"/>
            <BitParameter Name="hdmi" Size="1" Pos="10"/>
            <BitParameter Name="angl_dock_headset" Size="1" Pos="11"/>
            <BitParameter Name="dgtl_dock_headset" Size="1" Pos="12"/>
            <BitParameter Name="usb_accessory" Size="1" Pos="13"/>
            <BitParameter Name="usb_device" Size="1" Pos="14"/>
            <BitParameter Name="remote_submix" Size="1" Pos="15"/>
            <BitParameter Name="telephony_tx" Size="1" Pos="16"/>
            <BitParameter Name="line" Size="1" Pos="17"/>
            <BitParameter Name="hdmi_arc" Size="1" Pos="18"/>
            <BitParameter Name="spdif" Size="1" Pos="19"/>
            <BitParameter Name="fm" Size="1" Pos="20"/>
            <BitParameter Name="aux_line" Size="1" Pos="21"/>
            <BitParameter Name="speaker_safe" Size="1" Pos="22"/>
            <BitParameter Name="ip" Size="1" Pos="23"/>
            <BitParameter Name="bus" Size="1" Pos="24"/>
            <BitParameter Name="proxy" Size="1" Pos="25"/>
            <BitParameter Name="usb_headset" Size="1" Pos="26"/>
            <BitParameter Name="hearing_aid" Size="1" Pos="27"/>
            <BitParameter Name="echo_canceller" Size="1" Pos="28"/>
            <BitParameter Name="stub" Size="1" Pos="30"/>
        </BitParameterBlock>
    </ComponentType>

    <!-- Input devices definition as a bitfield for the supported devices per Input
    profile. It must match with the Input device enum parameter.
    -->
    <ComponentType Name="InputDevicesMask">
        <BitParameterBlock Name="mask" Size="32">
            <BitParameter Name="communication" Size="1" Pos="0"/>
            <BitParameter Name="ambient" Size="1" Pos="1"/>
            <BitParameter Name="builtin_mic" Size="1" Pos="2"/>
            <BitParameter Name="bluetooth_sco_headset" Size="1" Pos="3"/>
            <BitParameter Name="wired_headset" Size="1" Pos="4"/>
            <BitParameter Name="hdmi" Size="1" Pos="5"/>
            <BitParameter Name="telephony_rx" Size="1" Pos="6"/>
            <BitParameter Name="back_mic" Size="1" Pos="7"/>
            <BitParameter Name="remote_submix" Size="1" Pos="8"/>
            <BitParameter Name="anlg_dock_headset" Size="1" Pos="9"/>
            <BitParameter Name="dgtl_dock_headset" Size="1" Pos="10"/>
            <BitParameter Name="usb_accessory" Size="1" Pos="11"/>
            <BitParameter Name="usb_device" Size="1" Pos="12"/>
            <BitParameter Name="fm_tuner" Size="1" Pos="13"/>
            <BitParameter Name="tv_tuner" Size="1" Pos="14"/>
            <BitParameter Name="line" Size="1" Pos="15"/>
            <BitParameter Name="spdif" Size="1" Pos="16"/>
            <BitParameter Name="bluetooth_a2dp" Size="1" Pos="17"/>
            <BitParameter Name="loopback" Size="1" Pos="18"/>
            <BitParameter Name="ip" Size="1" Pos="19"/>
            <BitParameter Name="bus" Size="1" Pos="20"/>
            <BitParameter Name="proxy" Size="1" Pos="21"/>
            <BitParameter Name="usb_headset" Size="1" Pos="22"/>
            <BitParameter Name="bluetooth_ble" Size="1" Pos="23"/>
            <BitParameter Name="hdmi_arc" Size="1" Pos="24"/>
            <BitParameter Name="echo_reference" Size="1" Pos="25"/>
            <BitParameter Name="stub" Size="1" Pos="30"/>
        </BitParameterBlock>
    </ComponentType>

    <ComponentType Name="OutputFlags"
                   Description="the audio output flags serve two purposes:
                    - when an AudioTrack is created they indicate a wish to be connected to an
                      output stream with attributes corresponding to the specified flags.
                    - when present in an output profile descriptor listed for a particular audio
                      hardware module, they indicate that an output stream can be opened that
                      supports the attributes indicated by the flags.
                    The audio policy manager will try to match the flags in the request
                    (when getOuput() is called) to an available output stream.">
        <BitParameterBlock Name="mask" Size="32">
            <BitParameter Name="direct" Size="1" Pos="0"/>
            <BitParameter Name="primary" Size="1" Pos="1"/>
            <BitParameter Name="fast" Size="1" Pos="2"/>
            <BitParameter Name="deep_buffer" Size="1" Pos="3"/>
            <BitParameter Name="compress_offload" Size="1" Pos="4"/>
            <BitParameter Name="non_blocking" Size="1" Pos="5"/>
            <BitParameter Name="hw_av_sync" Size="1" Pos="6"/>
            <BitParameter Name="tts" Size="1" Pos="7"/>
            <BitParameter Name="raw" Size="1" Pos="8"/>
            <BitParameter Name="sync" Size="1" Pos="9"/>
            <BitParameter Name="iec958_nonaudio" Size="1" Pos="10"/>
        </BitParameterBlock>
    </ComponentType>

    <ComponentType Name="InputFlags"
                   Description="The audio input flags are analogous to audio output flags.
                                Currently they are used only when an AudioRecord is created,
                                to indicate a preference to be connected to an input stream with
                                attributes corresponding to the specified flags.">
        <BitParameterBlock Name="mask" Size="32">
            <BitParameter Name="fast" Size="1" Pos="0"/>
            <BitParameter Name="hw_hotword" Size="1" Pos="2"/>
            <BitParameter Name="raw" Size="1" Pos="3"/>
            <BitParameter Name="sync" Size="1" Pos="4"/>
        </BitParameterBlock>
    </ComponentType>

    <ComponentType Name="InputSourcesMask" Description="The audio input source is also known
                                                        as the use case.">
        <BitParameterBlock Name="mask" Size="32">
            <BitParameter Name="default" Size="1" Pos="0"/>
            <BitParameter Name="mic" Size="1" Pos="1"/>
            <BitParameter Name="voice_uplink" Size="1" Pos="2"/>
            <BitParameter Name="voice_downlink" Size="1" Pos="3"/>
            <BitParameter Name="voice_call" Size="1" Pos="4"/>
            <BitParameter Name="camcorder" Size="1" Pos="5"/>
            <BitParameter Name="voice_recognition" Size="1" Pos="6"/>
            <BitParameter Name="voice_communication" Size="1" Pos="7"/>
            <BitParameter Name="remote_submix" Size="1" Pos="8"/>
            <BitParameter Name="unprocessed" Size="1" Pos="9"/>
            <BitParameter Name="voice_performance" Size="1" Pos="10"/>
            <BitParameter Name="echo_reference" Size="1" Pos="11"/>
            <BitParameter Name="fm_tuner" Size="1" Pos="12"/>
            <BitParameter Name="hotword" Size="1" Pos="13"/>
        </BitParameterBlock>
    </ComponentType>

    <!--#################### STREAM COMMON TYPES BEGIN ####################-->

    <ComponentType Name="VolumeProfileType">
        <EnumParameter Name="volume_profile" Size="32">
            <ValuePair Literal="voice_call" Numerical="0"/>
            <ValuePair Literal="system" Numerical="1"/>
            <ValuePair Literal="ring" Numerical="2"/>
            <ValuePair Literal="music" Numerical="3"/>
            <ValuePair Literal="alarm" Numerical="4"/>
            <ValuePair Literal="notification" Numerical="5"/>
            <ValuePair Literal="bluetooth_sco" Numerical="6"/>
            <ValuePair Literal="enforced_audible" Numerical="7"/>
            <ValuePair Literal="dtmf" Numerical="8"/>
            <ValuePair Literal="tts" Numerical="9"/>
            <ValuePair Literal="accessibility" Numerical="10"/>
            <ValuePair Literal="rerouting" Numerical="11"/>
            <ValuePair Literal="patch" Numerical="12"/>
        </EnumParameter>
    </ComponentType>

    <ComponentType Name="Stream"  Mapping="Stream">
        <Component Name="applicable_volume_profile" Type="VolumeProfileType"
                   Description="Volume profile followed by a given stream type."/>
    </ComponentType>

    <!--#################### STREAM COMMON TYPES END ####################-->

    <!--#################### INPUT SOURCE COMMON TYPES BEGIN ####################-->

    <ComponentType Name="InputSource">
        <Component Name="applicable_input_device" Type="InputDevicesMask"
                   Mapping="InputSource" Description="Selected Input device"/>
    </ComponentType>

    <!--#################### INPUT SOURCE COMMON TYPES END ####################-->

    <!--#################### PRODUCT STRATEGY COMMON TYPES BEGIN ####################-->

    <ComponentType Name="ProductStrategy" Mapping="ProductStrategy">
        <Component Name="selected_output_devices" Type="OutputDevicesMask"/>
        <StringParameter Name="device_address" MaxLength="256"
                         Description="if any, device address associated"/>
    </ComponentType>

    <!--#################### PRODUCT STRATEGY COMMON TYPES END ####################-->

</ComponentTypeSet>