xref: /aosp_15_r20/hardware/interfaces/automotive/audiocontrol/aidl/default/AudioControl.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1 /*
2  * Copyright (C) 2020 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 #ifndef ANDROID_HARDWARE_AUTOMOTIVE_AUDIOCONTROL_AUDIOCONTROL_H
17 #define ANDROID_HARDWARE_AUTOMOTIVE_AUDIOCONTROL_AUDIOCONTROL_H
18 
19 #include <aidl/android/hardware/automotive/audiocontrol/AudioFocusChange.h>
20 #include <aidl/android/hardware/automotive/audiocontrol/AudioGainConfigInfo.h>
21 #include <aidl/android/hardware/automotive/audiocontrol/BnAudioControl.h>
22 #include <aidl/android/hardware/automotive/audiocontrol/DuckingInfo.h>
23 #include <aidl/android/hardware/automotive/audiocontrol/IAudioGainCallback.h>
24 #include <aidl/android/hardware/automotive/audiocontrol/IModuleChangeCallback.h>
25 #include <aidl/android/hardware/automotive/audiocontrol/MutingInfo.h>
26 #include <aidl/android/hardware/automotive/audiocontrol/Reasons.h>
27 
28 #include <aidl/android/hardware/audio/common/PlaybackTrackMetadata.h>
29 
30 #include <aidl/android/media/audio/common/AudioChannelLayout.h>
31 #include <aidl/android/media/audio/common/AudioDeviceType.h>
32 #include <aidl/android/media/audio/common/AudioFormatDescription.h>
33 #include <aidl/android/media/audio/common/AudioFormatType.h>
34 #include <aidl/android/media/audio/common/AudioGainMode.h>
35 #include <aidl/android/media/audio/common/AudioIoFlags.h>
36 #include <aidl/android/media/audio/common/AudioOutputFlags.h>
37 
38 #include "converter/include/CarAudioConfigurationXmlConverter.h"
39 
40 namespace aidl::android::hardware::automotive::audiocontrol {
41 
42 namespace audiomediacommon = ::aidl::android::media::audio::common;
43 namespace audiohalcommon = ::aidl::android::hardware::audio::common;
44 
45 class AudioControl : public BnAudioControl {
46   public:
47     AudioControl();
48     AudioControl(const std::string& carAudioConfig, const std::string& audioFadeConfig);
49     ndk::ScopedAStatus onAudioFocusChange(const std::string& in_usage, int32_t in_zoneId,
50                                           AudioFocusChange in_focusChange) override;
51     ndk::ScopedAStatus onDevicesToDuckChange(
52             const std::vector<DuckingInfo>& in_duckingInfos) override;
53     ndk::ScopedAStatus onDevicesToMuteChange(
54             const std::vector<MutingInfo>& in_mutingInfos) override;
55     ndk::ScopedAStatus registerFocusListener(
56             const std::shared_ptr<IFocusListener>& in_listener) override;
57     ndk::ScopedAStatus setBalanceTowardRight(float in_value) override;
58     ndk::ScopedAStatus setFadeTowardFront(float in_value) override;
59     ndk::ScopedAStatus onAudioFocusChangeWithMetaData(
60             const audiohalcommon::PlaybackTrackMetadata& in_playbackMetaData, int32_t in_zoneId,
61             AudioFocusChange in_focusChange) override;
62     ndk::ScopedAStatus setAudioDeviceGainsChanged(
63             const std::vector<Reasons>& in_reasons,
64             const std::vector<AudioGainConfigInfo>& in_gains) override;
65     ndk::ScopedAStatus registerGainCallback(
66             const std::shared_ptr<IAudioGainCallback>& in_callback) override;
67     ndk::ScopedAStatus setModuleChangeCallback(
68             const std::shared_ptr<IModuleChangeCallback>& in_callback) override;
69     ndk::ScopedAStatus clearModuleChangeCallback() override;
70     ndk::ScopedAStatus getAudioDeviceConfiguration(
71             AudioDeviceConfiguration* audioDeviceConfig) override;
72     ndk::ScopedAStatus getOutputMirroringDevices(
73             std::vector<::aidl::android::media::audio::common::AudioPort>* mirrorDevices) override;
74     ndk::ScopedAStatus getCarAudioZones(std::vector<AudioZone>* audioZones) override;
75 
76     binder_status_t dump(int fd, const char** args, uint32_t numArgs) override;
77 
78   private:
79     // This focus listener will only be used by this HAL instance to communicate with
80     // a single instance of CarAudioService. As such, it doesn't have explicit serialization.
81     // If a different AudioControl implementation were to have multiple threads leveraging this
82     // listener, then it should also include mutexes or make the listener atomic.
83     std::shared_ptr<IFocusListener> mFocusListener;
84 
85     /**
86      * @brief mAudioGainCallback will be used by this HAL instance to communicate e.g. with a single
87      * instance of CarAudioService to report unexpected gain changed.
88      */
89     std::shared_ptr<IAudioGainCallback> mAudioGainCallback = nullptr;
90 
91     std::shared_ptr<IModuleChangeCallback> mModuleChangeCallback = nullptr;
92 
93     std::shared_ptr<::android::hardware::audiocontrol::internal::CarAudioConfigurationXmlConverter>
94             mCarAudioConfigurationConverter = nullptr;
95 
96     binder_status_t cmdHelp(int fd) const;
97     binder_status_t cmdRequestFocus(int fd, const char** args, uint32_t numArgs);
98     binder_status_t cmdAbandonFocus(int fd, const char** args, uint32_t numArgs);
99     binder_status_t cmdRequestFocusWithMetaData(int fd, const char** args, uint32_t numArgs);
100     binder_status_t cmdAbandonFocusWithMetaData(int fd, const char** args, uint32_t numArgs);
101     binder_status_t cmdOnAudioDeviceGainsChanged(int fd, const char** args, uint32_t numArgs);
102     binder_status_t cmdOnAudioPortsChanged(int fd, const char** args, uint32_t numArgs);
103 
104     binder_status_t parseMetaData(int fd, const std::string& metadataLiteral,
105                                   audiohalcommon::PlaybackTrackMetadata& trackMetadata);
106     binder_status_t parseAudioGains(
107             int fd, const std::string& stringGain,
108             std::vector<::aidl::android::media::audio::common::AudioGain>& gains);
109     binder_status_t parseSampleRates(int fd, const std::string& sampleRates,
110                                      std::vector<int32_t>& vecSampleRates);
111 
112     binder_status_t dumpsys(int fd);
113 };
114 
115 }  // namespace aidl::android::hardware::automotive::audiocontrol
116 
117 #endif  // ANDROID_HARDWARE_AUTOMOTIVE_AUDIOCONTROL_AUDIOCONTROL_H
118