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

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

Removed class HdmiCec 

Most of the constants in HdmiCec are internal use only. Moved them
to service, and dispersed the rest to other relevant classes.

Also moved HdmiCecMessage class to service as it doesn't need to be
open ouside the service.

Change-Id: I7b2ce3bf465330aa4d7fcd05f9aefa1e6c8b056a
parent 96aacd2a

core/java/android/hardware/hdmi/HdmiCec.java

deleted100644 → 0
+0 −333
Original line number 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 android.hardware.hdmi;



import android.annotation.SystemApi;



/**

 * Defines constants and utility methods related to HDMI-CEC protocol.

 *

 * @hide

 */

@SystemApi

public final class HdmiCec {



    /** TV device type. */

    public static final int DEVICE_TV = 0;



    /** Recording device type. */

    public static final int DEVICE_RECORDER = 1;



    /** Device type reserved for future usage. */

    public static final int DEVICE_RESERVED = 2;



    /** Tuner device type. */

    public static final int DEVICE_TUNER = 3;



    /** Playback device type. */

    public static final int DEVICE_PLAYBACK = 4;



    /** Audio system device type. */

    public static final int DEVICE_AUDIO_SYSTEM = 5;



    // Value indicating the device is not an active source.

    public static final int DEVICE_INACTIVE = -1;



    /** Logical address for TV */

    public static final int ADDR_TV = 0;



    /** Logical address for recorder 1 */

    public static final int ADDR_RECORDER_1 = 1;



    /** Logical address for recorder 2 */

    public static final int ADDR_RECORDER_2 = 2;



    /** Logical address for tuner 1 */

    public static final int ADDR_TUNER_1 = 3;



    /** Logical address for playback 1 */

    public static final int ADDR_PLAYBACK_1 = 4;



    /** Logical address for audio system */

    public static final int ADDR_AUDIO_SYSTEM = 5;



    /** Logical address for tuner 2 */

    public static final int ADDR_TUNER_2 = 6;



    /** Logical address for tuner 3 */

    public static final int ADDR_TUNER_3 = 7;



    /** Logical address for playback 2 */

    public static final int ADDR_PLAYBACK_2 = 8;



    /** Logical address for recorder 3 */

    public static final int ADDR_RECORDER_3 = 9;



    /** Logical address for tuner 4 */

    public static final int ADDR_TUNER_4 = 10;



    /** Logical address for playback 3 */

    public static final int ADDR_PLAYBACK_3 = 11;



    /** Logical address reserved for future usage */

    public static final int ADDR_RESERVED_1 = 12;



    /** Logical address reserved for future usage */

    public static final int ADDR_RESERVED_2 = 13;



    /** Logical address for TV other than the one assigned with {@link #ADDR_TV} */

    public static final int ADDR_SPECIFIC_USE = 14;



    /** Logical address for devices to which address cannot be allocated */

    public static final int ADDR_UNREGISTERED = 15;



    /** Logical address used in the destination address field for broadcast messages */

    public static final int ADDR_BROADCAST = 15;



    /** Logical address used to indicate it is not initialized or invalid. */

    public static final int ADDR_INVALID = -1;



    /** Logical address used to indicate the source comes from internal device. */

    public static final int ADDR_INTERNAL = 0xFFFF;



    public static final int MESSAGE_FEATURE_ABORT = 0x00;

    public static final int MESSAGE_IMAGE_VIEW_ON = 0x04;

    public static final int MESSAGE_TUNER_STEP_INCREMENT = 0x05;

    public static final int MESSAGE_TUNER_STEP_DECREMENT = 0x06;

    public static final int MESSAGE_TUNER_DEVICE_STATUS = 0x07;

    public static final int MESSAGE_GIVE_TUNER_DEVICE_STATUS = 0x08;

    public static final int MESSAGE_RECORD_ON = 0x09;

    public static final int MESSAGE_RECORD_STATUS = 0x0A;

    public static final int MESSAGE_RECORD_OFF = 0x0B;

    public static final int MESSAGE_TEXT_VIEW_ON = 0x0D;

    public static final int MESSAGE_RECORD_TV_SCREEN = 0x0F;

    public static final int MESSAGE_GIVE_DECK_STATUS = 0x1A;

    public static final int MESSAGE_DECK_STATUS = 0x1B;

    public static final int MESSAGE_SET_MENU_LANGUAGE = 0x32;

    public static final int MESSAGE_CLEAR_ANALOG_TIMER = 0x33;

    public static final int MESSAGE_SET_ANALOG_TIMER = 0x34;

    public static final int MESSAGE_TIMER_STATUS = 0x35;

    public static final int MESSAGE_STANDBY = 0x36;

    public static final int MESSAGE_PLAY = 0x41;

    public static final int MESSAGE_DECK_CONTROL = 0x42;

    public static final int MESSAGE_TIMER_CLEARED_STATUS = 0x043;

    public static final int MESSAGE_USER_CONTROL_PRESSED = 0x44;

    public static final int MESSAGE_USER_CONTROL_RELEASED = 0x45;

    public static final int MESSAGE_GIVE_OSD_NAME = 0x46;

    public static final int MESSAGE_SET_OSD_NAME = 0x47;

    public static final int MESSAGE_SET_OSD_STRING = 0x64;

    public static final int MESSAGE_SET_TIMER_PROGRAM_TITLE = 0x67;

    public static final int MESSAGE_SYSTEM_AUDIO_MODE_REQUEST = 0x70;

    public static final int MESSAGE_GIVE_AUDIO_STATUS = 0x71;

    public static final int MESSAGE_SET_SYSTEM_AUDIO_MODE = 0x72;

    public static final int MESSAGE_REPORT_AUDIO_STATUS = 0x7A;

    public static final int MESSAGE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D;

    public static final int MESSAGE_SYSTEM_AUDIO_MODE_STATUS = 0x7E;

    public static final int MESSAGE_ROUTING_CHANGE = 0x80;

    public static final int MESSAGE_ROUTING_INFORMATION = 0x81;

    public static final int MESSAGE_ACTIVE_SOURCE = 0x82;

    public static final int MESSAGE_GIVE_PHYSICAL_ADDRESS = 0x83;

    public static final int MESSAGE_REPORT_PHYSICAL_ADDRESS = 0x84;

    public static final int MESSAGE_REQUEST_ACTIVE_SOURCE = 0x85;

    public static final int MESSAGE_SET_STREAM_PATH = 0x86;

    public static final int MESSAGE_DEVICE_VENDOR_ID = 0x87;

    public static final int MESSAGE_VENDOR_COMMAND = 0x89;

    public static final int MESSAGE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A;

    public static final int MESSAGE_VENDOR_REMOTE_BUTTON_UP = 0x8B;

    public static final int MESSAGE_GIVE_DEVICE_VENDOR_ID = 0x8C;

    public static final int MESSAGE_MENU_REQUEST = 0x8D;

    public static final int MESSAGE_MENU_STATUS = 0x8E;

    public static final int MESSAGE_GIVE_DEVICE_POWER_STATUS = 0x8F;

    public static final int MESSAGE_REPORT_POWER_STATUS = 0x90;

    public static final int MESSAGE_GET_MENU_LANGUAGE = 0x91;

    public static final int MESSAGE_SELECT_ANALOG_SERVICE = 0x92;

    public static final int MESSAGE_SELECT_DIGITAL_SERVICE = 0x93;

    public static final int MESSAGE_SET_DIGITAL_TIMER = 0x97;

    public static final int MESSAGE_CLEAR_DIGITAL_TIMER = 0x99;

    public static final int MESSAGE_SET_AUDIO_RATE = 0x9A;

    public static final int MESSAGE_INACTIVE_SOURCE = 0x9D;

    public static final int MESSAGE_CEC_VERSION = 0x9E;

    public static final int MESSAGE_GET_CEC_VERSION = 0x9F;

    public static final int MESSAGE_VENDOR_COMMAND_WITH_ID = 0xA0;

    public static final int MESSAGE_CLEAR_EXTERNAL_TIMER = 0xA1;

    public static final int MESSAGE_SET_EXTERNAL_TIMER = 0xA2;

    public static final int MESSAGE_INITIATE_ARC = 0xC0;

    public static final int MESSAGE_REPORT_ARC_INITIATED = 0xC1;

    public static final int MESSAGE_REPORT_ARC_TERMINATED = 0xC2;

    public static final int MESSAGE_REQUEST_ARC_INITIATION = 0xC3;

    public static final int MESSAGE_REQUEST_ARC_TERMINATION = 0xC4;

    public static final int MESSAGE_TERMINATE_ARC = 0xC5;

    public static final int MESSAGE_ABORT = 0xFF;



    public static final int UNKNOWN_VENDOR_ID = 0xFFFFFF;



    public static final int POWER_STATUS_UNKNOWN = -1;

    public static final int POWER_STATUS_ON = 0;

    public static final int POWER_STATUS_STANDBY = 1;

    public static final int POWER_STATUS_TRANSIENT_TO_ON = 2;

    public static final int POWER_STATUS_TRANSIENT_TO_STANDBY = 3;



    public static final int RESULT_SUCCESS = 0;

    public static final int RESULT_TIMEOUT = 1;

    public static final int RESULT_SOURCE_NOT_AVAILABLE = 2;

    public static final int RESULT_TARGET_NOT_AVAILABLE = 3;

    public static final int RESULT_ALREADY_IN_PROGRESS = 4;

    public static final int RESULT_EXCEPTION = 5;

    public static final int RESULT_INCORRECT_MODE = 6;



    // Definitions used for setOption(). These should be in sync with the definition

    // in hardware/libhardware/include/hardware/{hdmi_cec.h,mhl.h}.



    /**

     * TV gets turned on by incoming <Text/Image View On>. {@code ENABLED} by default.

     * If set to {@code DISABLED}, TV won't turn on automatically.

     */

    public static final int OPTION_CEC_AUTO_WAKEUP = 1;



    /**

     * If set to {@code DISABLED}, all CEC commands are discarded.

     *

     * <p> This option is for internal use only, not supposed to be used by other components.

     * @hide

     */

    public static final int OPTION_CEC_ENABLE = 2;



    /**

     * If set to {@code DISABLED}, system service yields control of CEC to sub-microcontroller.

     * If {@code ENABLED}, it take the control back.

     *

     * <p> This option is for internal use only, not supposed to be used by other components.

     * @hide

     */

    public static final int OPTION_CEC_SERVICE_CONTROL = 3;



    /**

     * Put other devices to standby when TV goes to standby. {@code ENABLED} by default.

     * If set to {@code DISABLED}, TV doesn't send &lt;Standby&gt; to other devices.

     */

    public static final int OPTION_CEC_AUTO_DEVICE_OFF = 4;



    /** If set to {@code DISABLED}, TV does not switch ports when mobile device is connected. */

    public static final int OPTION_MHL_INPUT_SWITCHING = 101;



    /** If set to {@code ENABLED}, TV disables power charging for mobile device. */

    public static final int OPTION_MHL_POWER_CHARGE = 102;



    /**

     * If set to {@code DISABLED}, all MHL commands are discarded.

     *

     * <p> This option is for internal use only, not supposed to be used by other components.

     * @hide

     */

    public static final int OPTION_MHL_ENABLE = 103;



    public static final int DISABLED = 0;

    public static final int ENABLED = 1;



    private static final int[] ADDRESS_TO_TYPE = {

        DEVICE_TV,  // ADDR_TV

        DEVICE_RECORDER,  // ADDR_RECORDER_1

        DEVICE_RECORDER,  // ADDR_RECORDER_2

        DEVICE_TUNER,  // ADDR_TUNER_1

        DEVICE_PLAYBACK,  // ADDR_PLAYBACK_1

        DEVICE_AUDIO_SYSTEM,  // ADDR_AUDIO_SYSTEM

        DEVICE_TUNER,  // ADDR_TUNER_2

        DEVICE_TUNER,  // ADDR_TUNER_3

        DEVICE_PLAYBACK,  // ADDR_PLAYBACK_2

        DEVICE_RECORDER,  // ADDR_RECORDER_3

        DEVICE_TUNER,  // ADDR_TUNER_4

        DEVICE_PLAYBACK,  // ADDR_PLAYBACK_3

        DEVICE_RESERVED,

        DEVICE_RESERVED,

        DEVICE_TV,  // ADDR_SPECIFIC_USE

    };



    private static final String[] DEFAULT_NAMES = {

        "TV",

        "Recorder_1",

        "Recorder_2",

        "Tuner_1",

        "Playback_1",

        "AudioSystem",

        "Tuner_2",

        "Tuner_3",

        "Playback_2",

        "Recorder_3",

        "Tuner_4",

        "Playback_3",

        "Reserved_1",

        "Reserved_2",

        "Secondary_TV",

    };



    private HdmiCec() { }  // Prevents instantiation.



    /**

     * Check if the given type is valid. A valid type is one of the actual

     * logical device types defined in the standard ({@link #DEVICE_TV},

     * {@link #DEVICE_PLAYBACK}, {@link #DEVICE_TUNER}, {@link #DEVICE_RECORDER},

     * and {@link #DEVICE_AUDIO_SYSTEM}).

     *

     * @param type device type

     * @return true if the given type is valid

     */

    public static boolean isValidType(int type) {

        return (DEVICE_TV <= type && type <= DEVICE_AUDIO_SYSTEM)

                && type != DEVICE_RESERVED;

    }



    /**

     * Check if the given logical address is valid. A logical address is valid

     * if it is one allocated for an actual device which allows communication

     * with other logical devices.

     *

     * @param address logical address

     * @return true if the given address is valid

     */

    public static boolean isValidAddress(int address) {

        return (ADDR_TV <= address && address <= ADDR_SPECIFIC_USE);

    }



    /**

     * Return the device type for the given logical address.

     *

     * @param address logical address

     * @return device type for the given logical address; DEVICE_INACTIVE

     *         if the address is not valid.

     */

    public static int getTypeFromAddress(int address) {

        if (isValidAddress(address)) {

            return ADDRESS_TO_TYPE[address];

        }

        return DEVICE_INACTIVE;

    }



    /**

     * Return the default device name for a logical address. This is the name

     * by which the logical device is known to others until a name is

     * set explicitly using HdmiCecService.setOsdName.

     *

     * @param address logical address

     * @return default device name; empty string if the address is not valid

     */

    public static String getDefaultDeviceName(int address) {

        if (isValidAddress(address)) {

            return DEFAULT_NAMES[address];

        }

        return "";

    }

}

core/java/android/hardware/hdmi/HdmiCecDeviceInfo.java

+31 −13
Original line number Diff line number Diff line
@@ -29,6 +29,28 @@ import android.os.Parcelable; 
 */

@SystemApi

public final class HdmiCecDeviceInfo implements Parcelable {



    /** TV device type. */

    public static final int DEVICE_TV = 0;



    /** Recording device type. */

    public static final int DEVICE_RECORDER = 1;



    /** Device type reserved for future usage. */

    public static final int DEVICE_RESERVED = 2;



    /** Tuner device type. */

    public static final int DEVICE_TUNER = 3;



    /** Playback device type. */

    public static final int DEVICE_PLAYBACK = 4;



    /** Audio system device type. */

    public static final int DEVICE_AUDIO_SYSTEM = 5;



    // Value indicating the device is not an active source.

    public static final int DEVICE_INACTIVE = -1;



    // Logical address, phsical address, device type, vendor id and display name

    // are immutable value.

    private final int mLogicalAddress;
@@ -37,7 +59,6 @@ public final class HdmiCecDeviceInfo implements Parcelable { 
    private final int mVendorId;

    private final String mDisplayName;





    /**

     * A helper class to deserialize {@link HdmiCecDeviceInfo} for a parcel.

     */
@@ -63,11 +84,10 @@ public final class HdmiCecDeviceInfo implements Parcelable { 
    /**

     * Constructor.

     *

     * @param logicalAddress logical address of HDMI-Cec device.

     *                       For more details, refer {@link HdmiCec}

     * @param physicalAddress physical address of HDMI-Cec device

     * @param deviceType type of device. For more details, refer {@link HdmiCec}

     * @param vendorId vendor id of device. It's used for vendor specific command

     * @param logicalAddress logical address of HDMI-CEC device

     * @param physicalAddress physical address of HDMI-CEC device

     * @param deviceType type of device

     * @param vendorId vendor id of device. Used for vendor specific command.

     * @param displayName name of device

     * @hide

     */
@@ -81,9 +101,7 @@ public final class HdmiCecDeviceInfo implements Parcelable { 
    }



    /**

     * Return the logical address of the device. It can have 0-15 values.

     * For more details, refer constants between {@link HdmiCec#ADDR_TV}

     * and {@link HdmiCec#ADDR_UNREGISTERED}.

     * Return the logical address of the device.

     */

    public int getLogicalAddress() {

        return mLogicalAddress;
@@ -98,7 +116,7 @@ public final class HdmiCecDeviceInfo implements Parcelable { 


    /**

     * Return type of the device. For more details, refer constants between

     * {@link HdmiCec#DEVICE_TV} and {@link HdmiCec#DEVICE_INACTIVE}.

     * {@link DEVICE_TV} and {@link DEVICE_INACTIVE}.

     */

    public int getDeviceType() {

        return mDeviceType;
@@ -108,9 +126,9 @@ public final class HdmiCecDeviceInfo implements Parcelable { 
     * Return {@code true} if the device is of a type that can be an input source.

     */

    public boolean isSourceType() {

        return mDeviceType == HdmiCec.DEVICE_PLAYBACK

                || mDeviceType == HdmiCec.DEVICE_RECORDER

                || mDeviceType == HdmiCec.DEVICE_TUNER;

        return mDeviceType == DEVICE_PLAYBACK

                || mDeviceType == DEVICE_RECORDER

                || mDeviceType == DEVICE_TUNER;

    }



    /**

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

deleted100644 → 0
+0 −19
Original line number 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 android.hardware.hdmi;



parcelable HdmiCecMessage;

core/java/android/hardware/hdmi/HdmiControlManager.java

+16 −2
Original line number Diff line number Diff line
@@ -36,6 +36,20 @@ import android.os.RemoteException; 
public final class HdmiControlManager {

    @Nullable private final IHdmiControlService mService;



    public static final int POWER_STATUS_UNKNOWN = -1;

    public static final int POWER_STATUS_ON = 0;

    public static final int POWER_STATUS_STANDBY = 1;

    public static final int POWER_STATUS_TRANSIENT_TO_ON = 2;

    public static final int POWER_STATUS_TRANSIENT_TO_STANDBY = 3;



    public static final int RESULT_SUCCESS = 0;

    public static final int RESULT_TIMEOUT = 1;

    public static final int RESULT_SOURCE_NOT_AVAILABLE = 2;

    public static final int RESULT_TARGET_NOT_AVAILABLE = 3;

    public static final int RESULT_ALREADY_IN_PROGRESS = 4;

    public static final int RESULT_EXCEPTION = 5;

    public static final int RESULT_INCORRECT_MODE = 6;



    // True if we have a logical device of type playback hosted in the system.

    private final boolean mHasPlaybackDevice;

    // True if we have a logical device of type TV hosted in the system.
@@ -57,8 +71,8 @@ public final class HdmiControlManager { 
                // Do nothing.

            }

        }

        mHasTvDevice = hasDeviceType(types, HdmiCec.DEVICE_TV);

        mHasPlaybackDevice = hasDeviceType(types, HdmiCec.DEVICE_PLAYBACK);

        mHasTvDevice = hasDeviceType(types, HdmiCecDeviceInfo.DEVICE_TV);

        mHasPlaybackDevice = hasDeviceType(types, HdmiCecDeviceInfo.DEVICE_PLAYBACK);

    }



    private static boolean hasDeviceType(int[] types, int type) {

core/java/android/hardware/hdmi/HdmiPlaybackClient.java

+6 −6
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ public final class HdmiPlaybackClient { 
        /**

         * Called when the result of the feature one touch play is returned.

         *

         * @param result the result of the operation. {@link HdmiCec#RESULT_SUCCESS}

         * @param result the result of the operation. {@link HdmiControlManager#RESULT_SUCCESS}

         *         if successful.

         */

        public void onComplete(int result);
@@ -56,11 +56,11 @@ public final class HdmiPlaybackClient { 
         * Called when display device status is reported.

         *

         * @param status display device status

         * @see {@link HdmiCec#POWER_STATUS_ON}

         * @see {@link HdmiCec#POWER_STATUS_STANDBY}

         * @see {@link HdmiCec#POWER_STATUS_TRANSIENT_TO_ON}

         * @see {@link HdmiCec#POWER_STATUS_TRANSIENT_TO_STANDBY}

         * @see {@link HdmiCec#POWER_STATUS_UNKNOWN}

         * @see {@link HdmiControlManager#POWER_STATUS_ON}

         * @see {@link HdmiControlManager#POWER_STATUS_STANDBY}

         * @see {@link HdmiControlManager#POWER_STATUS_TRANSIENT_TO_ON}

         * @see {@link HdmiControlManager#POWER_STATUS_TRANSIENT_TO_STANDBY}

         * @see {@link HdmiControlManager#POWER_STATUS_UNKNOWN}

         */

        public void onComplete(int status);

    }