1/*
2 * Copyright (C) 2015 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#pragma once
18
19#include <system/audio.h>
20
21static const audio_format_t gDynamicFormat = AUDIO_FORMAT_DEFAULT;
22
23// For mixed output and inputs, the policy will use max mixer sampling rates.
24// Do not limit sampling rate otherwise
25#define SAMPLE_RATE_HZ_MAX 192000
26
27// Used when a client opens a capture stream, without specifying a desired sample rate.
28#define SAMPLE_RATE_HZ_DEFAULT 48000
29
30// For mixed output and inputs, the policy will use max mixer channel count.
31// Do not limit channel count otherwise
32#define MAX_MIXER_CHANNEL_COUNT FCC_8
33
34/**
35 * A device mask for all audio input devices that are considered "virtual" when evaluating
36 * active inputs in getActiveInputs()
37 */
38#define APM_AUDIO_IN_DEVICE_VIRTUAL_ALL  (AUDIO_DEVICE_IN_REMOTE_SUBMIX)
39
40
41/**
42 * A device mask for all audio input and output devices where matching inputs/outputs on device
43 * type alone is not enough: the address must match too
44 */
45#define APM_AUDIO_DEVICE_OUT_MATCH_ADDRESS_ALL (AUDIO_DEVICE_OUT_REMOTE_SUBMIX|AUDIO_DEVICE_OUT_BUS)
46
47#define APM_AUDIO_DEVICE_IN_MATCH_ADDRESS_ALL (AUDIO_DEVICE_IN_REMOTE_SUBMIX|AUDIO_DEVICE_IN_BUS)
48
49/**
50 * Alias to AUDIO_DEVICE_OUT_DEFAULT defined for clarification when this value is used by volume
51 * control APIs (e.g setStreamVolumeIndex().
52 */
53#define AUDIO_DEVICE_OUT_DEFAULT_FOR_VOLUME AUDIO_DEVICE_OUT_DEFAULT
54
55
56/**
57 * Check if the state given correspond to an in call state.
58 * @TODO find a better name for widely call state
59 *
60 * @param[in] state to consider
61 *
62 * @return true if given state represents a device in a telephony or VoIP call
63 */
64static inline bool is_state_in_call(int state)
65{
66    return (state == AUDIO_MODE_IN_CALL) || (state == AUDIO_MODE_IN_COMMUNICATION);
67}
68
69/**
70 * Check if the input device given is considered as a virtual device.
71 *
72 * @param[in] device to consider
73 *
74 * @return true if the device is a virtual one, false otherwise.
75 */
76static inline bool is_virtual_input_device(audio_devices_t device)
77{
78    if ((device & AUDIO_DEVICE_BIT_IN) != 0) {
79        device &= ~AUDIO_DEVICE_BIT_IN;
80        if ((popcount(device) == 1) && ((device & ~APM_AUDIO_IN_DEVICE_VIRTUAL_ALL) == 0))
81            return true;
82    }
83    return false;
84}
85
86/**
87 * Check whether the device type is one
88 * where addresses are used to distinguish between one connected device and another
89 *
90 * @param[in] device to consider
91 *
92 * @return true if the device needs distinguish on address, false otherwise..
93 */
94static inline bool device_distinguishes_on_address(audio_devices_t device)
95{
96    return (((device & AUDIO_DEVICE_BIT_IN) != 0) &&
97            ((~AUDIO_DEVICE_BIT_IN & device & APM_AUDIO_DEVICE_IN_MATCH_ADDRESS_ALL) != 0)) ||
98           (((device & AUDIO_DEVICE_BIT_IN) == 0) &&
99            ((device & APM_AUDIO_DEVICE_OUT_MATCH_ADDRESS_ALL) != 0));
100}
101
102/**
103 * Returns the priority of a given audio source for capture. The priority is used when more than one
104 * capture session is active on a given input stream to determine which session drives routing and
105 * effect configuration.
106 *
107 * @param[in] inputSource to consider. Valid sources are:
108 * - AUDIO_SOURCE_VOICE_COMMUNICATION
109 * - AUDIO_SOURCE_CAMCORDER
110 * - AUDIO_SOURCE_MIC
111 * - AUDIO_SOURCE_FM_TUNER
112 * - AUDIO_SOURCE_VOICE_RECOGNITION
113 * - AUDIO_SOURCE_HOTWORD
114 *
115 * @return the corresponding input source priority or 0 if priority is irrelevant for this source.
116 *      This happens when the specified source cannot share a given input stream (e.g remote submix)
117 *      The higher the value, the higher the priority.
118 */
119static inline int32_t source_priority(audio_source_t inputSource)
120{
121    switch (inputSource) {
122    case AUDIO_SOURCE_VOICE_COMMUNICATION:
123        return 6;
124    case AUDIO_SOURCE_CAMCORDER:
125        return 5;
126    case AUDIO_SOURCE_MIC:
127        return 4;
128    case AUDIO_SOURCE_FM_TUNER:
129        return 3;
130    case AUDIO_SOURCE_VOICE_RECOGNITION:
131        return 2;
132    case AUDIO_SOURCE_HOTWORD:
133        return 1;
134    default:
135        break;
136    }
137    return 0;
138}
139
140/* Indicates if audio formats are equivalent when considering a match between
141 * audio HAL supported formats and client requested formats
142 */
143static inline bool audio_formats_match(audio_format_t format1,
144                                       audio_format_t format2)
145{
146    if (audio_is_linear_pcm(format1) &&
147            (audio_bytes_per_sample(format1) > 2) &&
148            audio_is_linear_pcm(format2) &&
149            (audio_bytes_per_sample(format2) > 2)) {
150        return true;
151    }
152    return format1 == format2;
153}
154