/*
* 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 java.io.UnsupportedEncodingException;
import java.util.Arrays;
/**
* A helper class to build {@link HdmiCecMessage} from various cec commands.
*/
public class HdmiCecMessageBuilder {
private static final int OSD_NAME_MAX_LENGTH = 13;
private HdmiCecMessageBuilder() {}
/**
* Build {@link HdmiCecMessage} from raw data.
*
* @param src source address of command
* @param dest destination address of command
* @param body body of message. It includes opcode.
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage of(int src, int dest, byte[] body) {
byte opcode = body[0];
byte params[] = Arrays.copyOfRange(body, 1, body.length);
return new HdmiCecMessage(src, dest, opcode, params);
}
/**
* Build <Feature Abort> command. <Feature Abort> consists of
* 1 byte original opcode and 1 byte reason fields with basic fields.
*
* @param src source address of command
* @param dest destination address of command
* @param originalOpcode original opcode causing feature abort
* @param reason reason of feature abort
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildFeatureAbortCommand(int src, int dest, int originalOpcode,
int reason) {
byte[] params = new byte[] {
(byte) (originalOpcode & 0xFF),
(byte) (reason & 0xFF),
};
return buildCommand(src, dest, Constants.MESSAGE_FEATURE_ABORT, params);
}
/**
* Build <Give Physical Address> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGivePhysicalAddress(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_PHYSICAL_ADDRESS);
}
/**
* Build <Give Osd Name> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGiveOsdNameCommand(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_OSD_NAME);
}
/**
* Build <Give Vendor Id Command> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGiveDeviceVendorIdCommand(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_DEVICE_VENDOR_ID);
}
/**
* Build <Set Menu Language > command.
*
* <p>This is a broadcast message sent to all devices on the bus.
*
* @param src source address of command
* @param language 3-letter ISO639-2 based language code
* @return newly created {@link HdmiCecMessage} if language is valid.
* Otherwise, return null
*/
static HdmiCecMessage buildSetMenuLanguageCommand(int src, String language) {
if (language.length() != 3) {
return null;
}
// Hdmi CEC uses lower-cased ISO 639-2 (3 letters code).
String normalized = language.toLowerCase();
byte[] params = new byte[] {
(byte) (normalized.charAt(0) & 0xFF),
(byte) (normalized.charAt(1) & 0xFF),
(byte) (normalized.charAt(2) & 0xFF),
};
// <Set Menu Language> is broadcast message.
return buildCommand(src, Constants.ADDR_BROADCAST,
Constants.MESSAGE_SET_MENU_LANGUAGE, params);
}
/**
* Build <Set Osd Name > command.
*
* @param src source address of command
* @param name display (OSD) name of device
* @return newly created {@link HdmiCecMessage} if valid name. Otherwise,
* return null
*/
static HdmiCecMessage buildSetOsdNameCommand(int src, int dest, String name) {
int length = Math.min(name.length(), OSD_NAME_MAX_LENGTH);
byte[] params;
try {
params = name.substring(0, length).getBytes("US-ASCII");
} catch (UnsupportedEncodingException e) {
return null;
}
return buildCommand(src, dest, Constants.MESSAGE_SET_OSD_NAME, params);
}
/**
* Build <Report Physical Address> command. It has two bytes physical
* address and one byte device type as parameter.
*
* <p>This is a broadcast message sent to all devices on the bus.
*
* @param src source address of command
* @param address physical address of device
* @param deviceType type of device
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildReportPhysicalAddressCommand(int src, int address, int deviceType) {
byte[] params = new byte[] {
// Two bytes for physical address
(byte) ((address >> 8) & 0xFF),
(byte) (address & 0xFF),
// One byte device type
(byte) (deviceType & 0xFF)
};
// <Report Physical Address> is broadcast message.
return buildCommand(src, Constants.ADDR_BROADCAST,
Constants.MESSAGE_REPORT_PHYSICAL_ADDRESS, params);
}
/**
* Build <Device Vendor Id> command. It has three bytes vendor id as
* parameter.
*
* <p>This is a broadcast message sent to all devices on the bus.
*
* @param src source address of command
* @param vendorId device's vendor id
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildDeviceVendorIdCommand(int src, int vendorId) {
byte[] params = new byte[] {
(byte) ((vendorId >> 16) & 0xFF),
(byte) ((vendorId >> 8) & 0xFF),
(byte) (vendorId & 0xFF)
};
// <Device Vendor Id> is broadcast message.
return buildCommand(src, Constants.ADDR_BROADCAST,
Constants.MESSAGE_DEVICE_VENDOR_ID, params);
}
/**
* Build <Device Vendor Id> command. It has one byte cec version as parameter.
*
* @param src source address of command
* @param dest destination address of command
* @param version version of cec. Use 0x04 for "Version 1.3a" and 0x05 for
* "Version 1.4 or 1.4a or 1.4b
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildCecVersion(int src, int dest, int version) {
byte[] params = new byte[] {
(byte) (version & 0xFF)
};
return buildCommand(src, dest, Constants.MESSAGE_CEC_VERSION, params);
}
/**
* Build <Request Arc Initiation>
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildRequestArcInitiation(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_REQUEST_ARC_INITIATION);
}
/**
* Build <Request Arc Termination>
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildRequestArcTermination(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_REQUEST_ARC_TERMINATION);
}
/**
* Build <Report Arc Initiated>
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildReportArcInitiated(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_REPORT_ARC_INITIATED);
}
/**
* Build <Report Arc Terminated>
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildReportArcTerminated(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_REPORT_ARC_TERMINATED);
}
/**
* Build <Text View On> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildTextViewOn(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_TEXT_VIEW_ON);
}
/**
* Build <Active Source> command.
*
* @param src source address of command
* @param physicalAddress physical address of the device to become active
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildActiveSource(int src, int physicalAddress) {
return buildCommand(src, Constants.ADDR_BROADCAST, Constants.MESSAGE_ACTIVE_SOURCE,
physicalAddressToParam(physicalAddress));
}
/**
* Build <Inactive Source> command.
*
* @param src source address of command
* @param physicalAddress physical address of the device to become inactive
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildInactiveSource(int src, int physicalAddress) {
return buildCommand(src, Constants.ADDR_TV,
Constants.MESSAGE_INACTIVE_SOURCE, physicalAddressToParam(physicalAddress));
}
/**
* Build <Set Stream Path> command.
*
* <p>This is a broadcast message sent to all devices on the bus.
*
* @param src source address of command
* @param streamPath physical address of the device to start streaming
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildSetStreamPath(int src, int streamPath) {
return buildCommand(src, Constants.ADDR_BROADCAST,
Constants.MESSAGE_SET_STREAM_PATH, physicalAddressToParam(streamPath));
}
/**
* Build <Routing Change> command.
*
* <p>This is a broadcast message sent to all devices on the bus.
*
* @param src source address of command
* @param oldPath physical address of the currently active routing path
* @param newPath physical address of the new active routing path
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildRoutingChange(int src, int oldPath, int newPath) {
byte[] param = new byte[] {
(byte) ((oldPath >> 8) & 0xFF), (byte) (oldPath & 0xFF),
(byte) ((newPath >> 8) & 0xFF), (byte) (newPath & 0xFF)
};
return buildCommand(src, Constants.ADDR_BROADCAST, Constants.MESSAGE_ROUTING_CHANGE,
param);
}
/**
* Build <Give Device Power Status> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGiveDevicePowerStatus(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_DEVICE_POWER_STATUS);
}
/**
* Build <Report Power Status> command.
*
* @param src source address of command
* @param dest destination address of command
* @param powerStatus power status of the device
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildReportPowerStatus(int src, int dest, int powerStatus) {
byte[] param = new byte[] {
(byte) (powerStatus & 0xFF)
};
return buildCommand(src, dest, Constants.MESSAGE_REPORT_POWER_STATUS, param);
}
/**
* Build <Report Menu Status> command.
*
* @param src source address of command
* @param dest destination address of command
* @param menuStatus menu status of the device
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildReportMenuStatus(int src, int dest, int menuStatus) {
byte[] param = new byte[] {
(byte) (menuStatus & 0xFF)
};
return buildCommand(src, dest, Constants.MESSAGE_MENU_STATUS, param);
}
/**
* Build <System Audio Mode Request> command.
*
* @param src source address of command
* @param avr destination address of command, it should be AVR
* @param avrPhysicalAddress physical address of AVR
* @param enableSystemAudio whether to enable System Audio Mode or not
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildSystemAudioModeRequest(int src, int avr, int avrPhysicalAddress,
boolean enableSystemAudio) {
if (enableSystemAudio) {
return buildCommand(src, avr, Constants.MESSAGE_SYSTEM_AUDIO_MODE_REQUEST,
physicalAddressToParam(avrPhysicalAddress));
} else {
return buildCommand(src, avr, Constants.MESSAGE_SYSTEM_AUDIO_MODE_REQUEST);
}
}
/**
* Build <Give Audio Status> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGiveAudioStatus(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_AUDIO_STATUS);
}
/**
* Build <User Control Pressed> command.
*
* @param src source address of command
* @param dest destination address of command
* @param uiCommand keycode that user pressed
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildUserControlPressed(int src, int dest, int uiCommand) {
return buildUserControlPressed(src, dest, new byte[] { (byte) (uiCommand & 0xFF) });
}
/**
* Build <User Control Pressed> command.
*
* @param src source address of command
* @param dest destination address of command
* @param commandParam uiCommand and the additional parameter
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildUserControlPressed(int src, int dest, byte[] commandParam) {
return buildCommand(src, dest, Constants.MESSAGE_USER_CONTROL_PRESSED, commandParam);
}
/**
* Build <User Control Released> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildUserControlReleased(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_USER_CONTROL_RELEASED);
}
/**
* Build <Give System Audio Mode Status> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildGiveSystemAudioModeStatus(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_GIVE_SYSTEM_AUDIO_MODE_STATUS);
}
/**
* Build <Standby> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
public static HdmiCecMessage buildStandby(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_STANDBY);
}
/**
* Build <Vendor Command> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params vendor-specific parameters
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildVendorCommand(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_VENDOR_COMMAND, params);
}
/**
* Build <Vendor Command With ID> command.
*
* @param src source address of command
* @param dest destination address of command
* @param vendorId vendor ID
* @param operands vendor-specific parameters
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildVendorCommandWithId(int src, int dest, int vendorId,
byte[] operands) {
byte[] params = new byte[operands.length + 3]; // parameter plus len(vendorId)
params[0] = (byte) ((vendorId >> 16) & 0xFF);
params[1] = (byte) ((vendorId >> 8) & 0xFF);
params[2] = (byte) (vendorId & 0xFF);
System.arraycopy(operands, 0, params, 3, operands.length);
return buildCommand(src, dest, Constants.MESSAGE_VENDOR_COMMAND_WITH_ID, params);
}
/**
* Build <Record On> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params parameter of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildRecordOn(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_RECORD_ON, params);
}
/**
* Build <Record Off> command.
*
* @param src source address of command
* @param dest destination address of command
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildRecordOff(int src, int dest) {
return buildCommand(src, dest, Constants.MESSAGE_RECORD_OFF);
}
/**
* Build <Set Digital Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and digital service information to be recorded
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildSetDigitalTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_SET_DIGITAL_TIMER, params);
}
/**
* Build <Set Analogue Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and analog service information to be recorded
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildSetAnalogueTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_SET_ANALOG_TIMER, params);
}
/**
* Build <Set External Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and external source information to be recorded
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildSetExternalTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_SET_EXTERNAL_TIMER, params);
}
/**
* Build <Clear Digital Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and digital service information to be cleared
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildClearDigitalTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_CLEAR_DIGITAL_TIMER, params);
}
/**
* Build <Clear Analog Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and analog service information to be cleared
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildClearAnalogueTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_CLEAR_ANALOG_TIMER, params);
}
/**
* Build <Clear Digital Timer> command.
*
* @param src source address of command
* @param dest destination address of command
* @param params byte array of timing information and external source information to be cleared
* @return newly created {@link HdmiCecMessage}
*/
static HdmiCecMessage buildClearExternalTimer(int src, int dest, byte[] params) {
return buildCommand(src, dest, Constants.MESSAGE_CLEAR_EXTERNAL_TIMER, params);
}
/***** Please ADD new buildXXX() methods above. ******/
/**
* Build a {@link HdmiCecMessage} without extra parameter.
*
* @param src source address of command
* @param dest destination address of command
* @param opcode opcode for a message
* @return newly created {@link HdmiCecMessage}
*/
private static HdmiCecMessage buildCommand(int src, int dest, int opcode) {
return new HdmiCecMessage(src, dest, opcode, HdmiCecMessage.EMPTY_PARAM);
}
/**
* Build a {@link HdmiCecMessage} with given values.
*
* @param src source address of command
* @param dest destination address of command
* @param opcode opcode for a message
* @param params extra parameters for command
* @return newly created {@link HdmiCecMessage}
*/
private static HdmiCecMessage buildCommand(int src, int dest, int opcode, byte[] params) {
return new HdmiCecMessage(src, dest, opcode, params);
}
private static byte[] physicalAddressToParam(int physicalAddress) {
return new byte[] {
(byte) ((physicalAddress >> 8) & 0xFF),
(byte) (physicalAddress & 0xFF)
};
}
}
|
