src.com.android.server.hdmi.RequestSadAction Maven / Gradle / Ivy
/*
* Copyright (C) 2021 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 com.android.server.hdmi;
import android.hardware.hdmi.HdmiControlManager;
import android.util.Slog;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* Feature action that queries the Short Audio Descriptor (SAD) of another device. This action is
* initiated from the Android system working as TV device to get the SAD of the connected audio
* system device.
*
* Package-private
*/
final class RequestSadAction extends HdmiCecFeatureAction {
private static final String TAG = "RequestSadAction";
// State in which the action is waiting for .
private static final int STATE_WAITING_FOR_REPORT_SAD = 1;
private static final int MAX_SAD_PER_REQUEST = 4;
private static final int RETRY_COUNTER_MAX = 1;
private final int mTargetAddress;
private final RequestSadCallback mCallback;
private final List mCecCodecsToQuery = new ArrayList<>();
// List of all valid SADs reported by the target device. Not parsed nor deduplicated.
private final List mSupportedSads = new ArrayList<>();
private int mQueriedSadCount = 0; // Number of SADs queries that has already been completed
private int mTimeoutRetry = 0; // Number of times we have already retried on time-out
/**
* Constructor.
*
* @param source an instance of {@link HdmiCecLocalDevice}.
* @param targetAddress the logical address the SAD is directed at.
*/
RequestSadAction(HdmiCecLocalDevice source, int targetAddress, RequestSadCallback callback) {
super(source);
mTargetAddress = targetAddress;
mCallback = Objects.requireNonNull(callback);
HdmiCecConfig hdmiCecConfig = localDevice().mService.getHdmiCecConfig();
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_LPCM)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_LPCM);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_DD)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_DD);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_MPEG1)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_MPEG1);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_MP3)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_MP3);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_MPEG2)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_MPEG2);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_AAC)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_AAC);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_DTS)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_DTS);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_ATRAC)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_ATRAC);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_ONEBITAUDIO)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_ONEBITAUDIO);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_DDP)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_DDP);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_DTSHD)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_DTSHD);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_TRUEHD)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_TRUEHD);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_DST)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_DST);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_WMAPRO)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_WMAPRO);
}
if (hdmiCecConfig.getIntValue(
HdmiControlManager.CEC_SETTING_NAME_QUERY_SAD_MAX)
== HdmiControlManager.QUERY_SAD_ENABLED) {
mCecCodecsToQuery.add(Constants.AUDIO_CODEC_MAX);
}
}
@Override
boolean start() {
querySad();
return true;
}
private void querySad() {
if (mQueriedSadCount >= mCecCodecsToQuery.size()) {
wrapUpAndFinish();
return;
}
int[] codecsToQuery = mCecCodecsToQuery.subList(mQueriedSadCount,
Math.min(mCecCodecsToQuery.size(), mQueriedSadCount + MAX_SAD_PER_REQUEST))
.stream().mapToInt(i -> i).toArray();
sendCommand(HdmiCecMessageBuilder.buildRequestShortAudioDescriptor(getSourceAddress(),
mTargetAddress, codecsToQuery));
mState = STATE_WAITING_FOR_REPORT_SAD;
addTimer(mState, HdmiConfig.TIMEOUT_MS);
}
@Override
boolean processCommand(HdmiCecMessage cmd) {
if (mState != STATE_WAITING_FOR_REPORT_SAD
|| mTargetAddress != cmd.getSource()) {
return false;
}
if (cmd.getOpcode() == Constants.MESSAGE_REPORT_SHORT_AUDIO_DESCRIPTOR) {
if (cmd.getParams() == null || cmd.getParams().length == 0
|| cmd.getParams().length % 3 != 0) {
// Invalid message. Wait for time-out and query again.
return true;
}
for (int i = 0; i < cmd.getParams().length - 2; i += 3) {
if (isValidCodec(cmd.getParams()[i])) {
byte[] sad = new byte[]{cmd.getParams()[i], cmd.getParams()[i + 1],
cmd.getParams()[i + 2]};
updateResult(sad);
} else {
// Don't include invalid codecs in the result. Don't query again.
Slog.w(TAG, "Dropped invalid codec " + cmd.getParams()[i] + ".");
}
}
mQueriedSadCount += MAX_SAD_PER_REQUEST;
mTimeoutRetry = 0;
querySad();
return true;
}
if (cmd.getOpcode() == Constants.MESSAGE_FEATURE_ABORT
&& (cmd.getParams()[0] & 0xFF)
== Constants.MESSAGE_REQUEST_SHORT_AUDIO_DESCRIPTOR) {
if ((cmd.getParams()[1] & 0xFF) == Constants.ABORT_UNRECOGNIZED_OPCODE) {
// SAD feature is not supported
wrapUpAndFinish();
return true;
}
if ((cmd.getParams()[1] & 0xFF) == Constants.ABORT_INVALID_OPERAND) {
// Queried SADs are not supported
mQueriedSadCount += MAX_SAD_PER_REQUEST;
mTimeoutRetry = 0;
querySad();
return true;
}
}
return false;
}
private boolean isValidCodec(byte codec) {
return Constants.AUDIO_CODEC_NONE < (codec & 0xFF)
&& (codec & 0xFF) <= Constants.AUDIO_CODEC_MAX;
}
private void updateResult(byte[] sad) {
mSupportedSads.add(sad);
}
@Override
void handleTimerEvent(int state) {
if (mState != state) {
return;
}
if (state == STATE_WAITING_FOR_REPORT_SAD) {
if (++mTimeoutRetry <= RETRY_COUNTER_MAX) {
querySad();
return;
}
// Don't query any other SADs if one of the SAD queries ran into the maximum amount of
// retries.
wrapUpAndFinish();
}
}
private void wrapUpAndFinish() {
mCallback.onRequestSadDone(mSupportedSads);
finish();
}
/**
* Interface used to report result of SAD request.
*/
interface RequestSadCallback {
/**
* Called when SAD request is done.
*
* @param sads a list of all supported SADs. It can be an empty list.
*/
void onRequestSadDone(List supportedSads);
}
}