Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a6ce7708 authored by Jinsuk Kim's avatar Jinsuk Kim
Browse files

DeviceSelectAction for HdmiControlService 

DeviceSelectAction is the main handler for the API deviceSelect() which is
used to choose a new active source among logical devices on the bus.

Change-Id: I77582a1f873423fc316d89f67a89a867461a76b2
parent 85c26277

core/java/android/hardware/hdmi/HdmiTvClient.java

+44 −0
Original line number Original line Diff line number Diff line
@@ -16,6 +16,8 @@ 
package android.hardware.hdmi;

package android.hardware.hdmi;





import android.annotation.SystemApi;

import android.annotation.SystemApi;

import android.os.RemoteException;

import android.util.Log;





/**

/**

 * HdmiTvClient represents HDMI-CEC logical device of type TV in the Android system

 * HdmiTvClient represents HDMI-CEC logical device of type TV in the Android system
@@ -33,4 +35,46 @@ public final class HdmiTvClient { 
    HdmiTvClient(IHdmiControlService service) {

    HdmiTvClient(IHdmiControlService service) {

        mService = service;

        mService = service;

    }

    }



    // Factory method for HdmiTvClient.

    // Declared package-private. Accessed by HdmiControlManager only.

    static HdmiTvClient create(IHdmiControlService service) {

        return new HdmiTvClient(service);

    }



    /**

     * Callback interface used to get the result of {@link #deviceSelect}.

     */

    public interface SelectCallback {

        /**

         * Called when the operation is finished.

         *

         * @param result the result value of {@link #deviceSelect}

         */

        void onComplete(int result);

    }



    /**

     * Select a CEC logical device to be a new active source.

     *

     * @param logicalAddress

     * @param callback

     */

    public void deviceSelect(int logicalAddress, SelectCallback callback) {

        // TODO: Replace SelectCallback with PartialResult.

        try {

            mService.deviceSelect(logicalAddress, getCallbackWrapper(callback));

        } catch (RemoteException e) {

            Log.e(TAG, "failed to select device: ", e);

        }

    }



    private static IHdmiControlCallback getCallbackWrapper(final SelectCallback callback) {

        return new IHdmiControlCallback.Stub() {

            @Override

            public void onComplete(int result) {

                callback.onComplete(result);

            }

        };

    }

}
 
}

core/java/android/hardware/hdmi/IHdmiControlService.aidl

+1 −0
Original line number Original line Diff line number Diff line
@@ -33,4 +33,5 @@ interface IHdmiControlService { 
    void queryDisplayStatus(IHdmiControlCallback callback);

    void queryDisplayStatus(IHdmiControlCallback callback);

    void addHotplugEventListener(IHdmiHotplugEventListener listener);

    void addHotplugEventListener(IHdmiHotplugEventListener listener);

    void removeHotplugEventListener(IHdmiHotplugEventListener listener);

    void removeHotplugEventListener(IHdmiHotplugEventListener listener);

    void deviceSelect(int logicalAddress, IHdmiControlCallback callback);

}
 
}

services/core/java/com/android/server/hdmi/ActiveSourceHandler.java

0 → 100644
+112 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2014 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.annotation.Nullable;

import android.hardware.hdmi.IHdmiControlCallback;

import android.hardware.hdmi.HdmiCec;

import android.hardware.hdmi.HdmiCecDeviceInfo;

import android.hardware.hdmi.HdmiCecMessage;

import android.os.RemoteException;

import android.util.Slog;



/**

 * Handles CEC command <Active Source>.

 *

 * <p>Used by feature actions that need to handle the command in their flow.

 */

final class ActiveSourceHandler {

    private static final String TAG = "ActiveSourceHandler";



    private final HdmiControlService mService;

    private final int mSourceAddress;

    private final int mSourcePath;

    @Nullable private final IHdmiControlCallback mCallback;



    static ActiveSourceHandler create(HdmiControlService service, int sourceAddress,

            int sourcePath, IHdmiControlCallback callback) {

        if (service == null) {

            Slog.e(TAG, "Wrong arguments");

            return null;

        }

        return new ActiveSourceHandler(service, sourceAddress, sourcePath, callback);

    }



    private ActiveSourceHandler(HdmiControlService service, int sourceAddress, int sourcePath,

            IHdmiControlCallback callback) {

        mService = service;

        mSourceAddress = sourceAddress;

        mSourcePath = sourcePath;

        mCallback = callback;

    }



    /**

     * Handles the incoming active source command.

     *

     * @param deviceLogicalAddress logical address of the device to be the active source

     * @param routingPath routing path of the device to be the active source

     */

    void process(int deviceLogicalAddress, int routingPath) {

        if (mSourcePath == routingPath && mService.getActiveSource() == mSourceAddress) {

            invokeCallback(HdmiCec.RESULT_SUCCESS);

            return;

        }

        HdmiCecDeviceInfo device = mService.getDeviceInfo(deviceLogicalAddress);

        if (device == null) {

            // TODO: Start new device action (Device Discovery) sequence 5.

        }



        if (!mService.isInPresetInstallationMode()) {

            int prevActiveInput = mService.getActiveInput();

            mService.updateActiveDevice(deviceLogicalAddress, routingPath);

            if (prevActiveInput != mService.getActiveInput()) {

                // TODO: change port input here.

            }

            invokeCallback(HdmiCec.RESULT_SUCCESS);

        } else {

            // TV is in a mode that should keep its current source/input from

            // being changed for its operation. Reclaim the active source

            // or switch the port back to the one used for the current mode.

            if (mService.getActiveSource() == mSourceAddress) {

                HdmiCecMessage activeSource =

                        HdmiCecMessageBuilder.buildActiveSource(mSourceAddress, mSourcePath);

                mService.sendCecCommand(activeSource);

                mService.updateActiveDevice(deviceLogicalAddress, routingPath);

                invokeCallback(HdmiCec.RESULT_SUCCESS);

            } else {

                int activePath = mService.getActivePath();

                mService.sendCecCommand(HdmiCecMessageBuilder.buildRoutingChange(mSourceAddress,

                        routingPath, activePath));

                // TODO: Start port select action here

                // PortSelectAction action = new PortSelectAction(mService, mSourceAddress,

                //        activePath, mCallback);

                // mService.addActionAndStart(action);

            }

        }

    }



    private void invokeCallback(int result) {

        if (mCallback == null) {

            return;

        }

        try {

            mCallback.onComplete(result);

        } catch (RemoteException e) {

            Slog.e(TAG, "Callback failed:" + e);

        }

    }

}

services/core/java/com/android/server/hdmi/DeviceSelectAction.java

0 → 100644
+223 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2014 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.IHdmiControlCallback;

import android.hardware.hdmi.HdmiCecDeviceInfo;

import android.hardware.hdmi.HdmiCec;

import android.hardware.hdmi.HdmiCecMessage;

import android.os.RemoteException;

import android.util.Slog;



/**

 * Handles an action that selects a logical device as a new active source.

 *

 * Triggered by {@link HdmiTvClient}, attempts to select the given target device

 * for a new active source. It does its best to wake up the target in standby mode

 * before issuing the command &gt;Set Stream path&lt;.

 */

final class DeviceSelectAction extends FeatureAction {

    private static final String TAG = "DeviceSelect";



    // Time in milliseconds we wait for the device power status to switch to 'Standby'

    private static final int TIMEOUT_TRANSIT_TO_STANDBY_MS = 5 * 1000;



    // Time in milliseconds we wait for the device power status to turn to 'On'.

    private static final int TIMEOUT_POWER_ON_MS = 5 * 1000;



    // Time in milliseconds we wait for <Active Source>.

    private static final int TIMEOUT_ACTIVE_SOURCE_MS = 20 * 1000;



    // The number of times we try to wake up the target device before we give up

    // and just send <Set Stream Path>.

    private static final int LOOP_COUNTER_MAX = 20;



    // State in which we wait for <Report Power Status> to come in response to the command

    // <Give Device Power Status> we have sent.

    private static final int STATE_WAIT_FOR_REPORT_POWER_STATUS = 1;



    // State in which we wait for the device power status to switch to 'Standby'.

    // We wait till the status becomes 'Standby' before we send <Set Stream Path>

    // to wake up the device again.

    private static final int STATE_WAIT_FOR_DEVICE_TO_TRANSIT_TO_STANDBY = 2;



    // State in which we wait for the device power status to switch to 'on'. We wait

    // maximum 100 seconds (20 * 5) before we give up and just send <Set Stream Path>.

    private static final int STATE_WAIT_FOR_DEVICE_POWER_ON = 3;



    // State in which we wait for the <Active Source> in response to the command

    // <Set Stream Path> we have sent. We wait as much as TIMEOUT_ACTIVE_SOURCE_MS

    // before we give up and mark the action as failure.

    private static final int STATE_WAIT_FOR_ACTIVE_SOURCE = 4;



    private final HdmiCecDeviceInfo mTarget;

    private final IHdmiControlCallback mCallback;

    private final int mSourcePath;



    private int mPowerStatusCounter = 0;



    /**

     * Constructor.

     *

     * @param service {@link HdmiControlService} instance

     * @param sourceAddress logical address of TV initiating this action

     * @param sourcePath physical address of TV

     * @param target target logical device that will be a new active source

     * @param callback callback object

     */

    public DeviceSelectAction(HdmiControlService service, int sourceAddress, int sourcePath,

            HdmiCecDeviceInfo target, IHdmiControlCallback callback) {

        super(service, sourceAddress);

        mCallback = callback;

        mSourcePath = sourcePath;

        mTarget = target;

    }



    @Override

    public boolean start() {

        // TODO: Call the logic that display a banner saying the select action got started.

        queryDevicePowerStatus();

        return true;

    }



    private void queryDevicePowerStatus() {

        sendCommand(HdmiCecMessageBuilder.buildGiveDevicePowerStatus(

                mSourceAddress, mTarget.getLogicalAddress()));

        mState = STATE_WAIT_FOR_REPORT_POWER_STATUS;

        addTimer(mState, TIMEOUT_MS);

    }



    @Override

    public boolean processCommand(HdmiCecMessage cmd) {

        if (cmd.getSource() != mTarget.getLogicalAddress()) {

            return false;

        }

        int opcode = cmd.getOpcode();

        byte[] params = cmd.getParams();



        switch (mState) {

            case STATE_WAIT_FOR_REPORT_POWER_STATUS:

                if (opcode == HdmiCec.MESSAGE_REPORT_POWER_STATUS && params.length == 1) {

                    return handleReportPowerStatus(params[0]);

                }

                return false;

            case STATE_WAIT_FOR_ACTIVE_SOURCE:

                if (opcode == HdmiCec.MESSAGE_ACTIVE_SOURCE && params.length == 2) {

                    int activePath = HdmiUtils.twoBytesToInt(params);

                    ActiveSourceHandler.create(mService, mSourceAddress, mSourcePath, mCallback)

                            .process(cmd.getSource(), activePath);

                    finish();

                    return true;

                }

                return false;

            default:

                break;

        }

        return false;

    }



    private boolean handleReportPowerStatus(int powerStatus) {

        // TODO: Check TV's own status which might have been updated during the action.

        //       If in 'Standby' or 'Transit to standby', remove the banner

        //       and stop this action. Otherwise, send <Set Stream Path>

        switch (powerStatus) {

            case HdmiCec.POWER_STATUS_ON:

                sendSetStreamPath();

                return true;

            case HdmiCec.POWER_STATUS_TRANSIENT_TO_STANDBY:

                if (mPowerStatusCounter < 4) {

                    mState = STATE_WAIT_FOR_DEVICE_TO_TRANSIT_TO_STANDBY;

                    addTimer(mState, TIMEOUT_TRANSIT_TO_STANDBY_MS);

                } else {

                    sendSetStreamPath();

                }

                return true;

            case HdmiCec.POWER_STATUS_STANDBY:

                if (mPowerStatusCounter == 0) {

                    turnOnDevice();

                } else {

                    sendSetStreamPath();

                }

                return true;

            case HdmiCec.POWER_STATUS_TRANSIENT_TO_ON:

                if (mPowerStatusCounter < LOOP_COUNTER_MAX) {

                    mState = STATE_WAIT_FOR_DEVICE_POWER_ON;

                    addTimer(mState, TIMEOUT_POWER_ON_MS);

                } else {

                    sendSetStreamPath();

                }

                return true;

        }

        return false;

    }



    private void turnOnDevice() {

        sendRemoteKeyCommand(HdmiConstants.UI_COMMAND_POWER);

        sendRemoteKeyCommand(HdmiConstants.UI_COMMAND_POWER_ON_FUNCTION);

        mState = STATE_WAIT_FOR_DEVICE_POWER_ON;

        addTimer(mState, TIMEOUT_POWER_ON_MS);

    }



    private void sendSetStreamPath() {

        sendCommand(HdmiCecMessageBuilder.buildSetStreamPath(

                mSourceAddress, mTarget.getPhysicalAddress()));

        mState = STATE_WAIT_FOR_ACTIVE_SOURCE;

        addTimer(mState, TIMEOUT_ACTIVE_SOURCE_MS);

    }



    private void sendRemoteKeyCommand(int keyCode) {

        sendCommand(HdmiCecMessageBuilder.buildUserControlPressed(mSourceAddress,

                mTarget.getLogicalAddress(), keyCode));

        sendCommand(HdmiCecMessageBuilder.buildUserControlReleased(mSourceAddress,

                mTarget.getLogicalAddress()));

    }



    @Override

    public void handleTimerEvent(int timeoutState) {

        if (mState != timeoutState) {

            Slog.w(TAG, "Timer in a wrong state. Ignored.");

            return;

        }

        switch (mState) {

            case STATE_WAIT_FOR_REPORT_POWER_STATUS:

                sendSetStreamPath();

                break;

            case STATE_WAIT_FOR_DEVICE_TO_TRANSIT_TO_STANDBY:

            case STATE_WAIT_FOR_DEVICE_POWER_ON:

                mPowerStatusCounter++;

                queryDevicePowerStatus();

                break;

            case STATE_WAIT_FOR_ACTIVE_SOURCE:

                // TODO: Remove the banner

                //       Display banner "Communication failed. Please check your cable or connection"

                invokeCallback(HdmiCec.RESULT_TIMEOUT);

                finish();

                break;

        }

    }



    private void invokeCallback(int result) {

        if (mCallback == null) {

            return;

        }

        try {

            mCallback.onComplete(result);

        } catch (RemoteException e) {

            Slog.e(TAG, "Callback failed:" + e);

        }

    }

}

services/core/java/com/android/server/hdmi/FeatureAction.java

+3 −2
Original line number Original line Diff line number Diff line
@@ -46,8 +46,9 @@ abstract class FeatureAction { 
    // Timer handler message used for timeout event

    // Timer handler message used for timeout event

    protected static final int MSG_TIMEOUT = 100;

    protected static final int MSG_TIMEOUT = 100;





    // Default timeout for the incoming command to arrive in response to a request

    // Default timeout for the incoming command to arrive in response to a request.

    protected static final int TIMEOUT_MS = 1000;

    // TODO: Consider reading this value from configuration to allow customization.

    protected static final int TIMEOUT_MS = 2000;





    // Default state used in common by all the feature actions.

    // Default state used in common by all the feature actions.

    protected static final int STATE_NONE = 0;

    protected static final int STATE_NONE = 0;