oshi.util.EdidUtil Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2016-2023 The OSHI Project Contributors
* SPDX-License-Identifier: MIT
*/
package oshi.util;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Locale;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import oshi.annotation.SuppressForbidden;
import oshi.annotation.concurrent.ThreadSafe;
/**
* EDID parsing utility.
*/
@ThreadSafe
public final class EdidUtil {
private static final Logger LOG = LoggerFactory.getLogger(EdidUtil.class);
private EdidUtil() {
}
/**
* Gets the Manufacturer ID from (up to) 3 5-bit characters in bytes 8 and 9
*
* @param edid The EDID byte array
* @return The manufacturer ID
*/
@SuppressForbidden(reason = "customized base 2 parsing not in Util class")
public static String getManufacturerID(byte[] edid) {
// Bytes 8-9 are manufacturer ID in 3 5-bit characters.
String temp = String.format(Locale.ROOT, "%8s%8s", Integer.toBinaryString(edid[8] & 0xFF),
Integer.toBinaryString(edid[9] & 0xFF)).replace(' ', '0');
LOG.debug("Manufacurer ID: {}", temp);
return String.format(Locale.ROOT, "%s%s%s", (char) (64 + Integer.parseInt(temp.substring(1, 6), 2)),
(char) (64 + Integer.parseInt(temp.substring(7, 11), 2)),
(char) (64 + Integer.parseInt(temp.substring(12, 16), 2))).replace("@", "");
}
/**
* Gets the Product ID, bytes 10 and 11
*
* @param edid The EDID byte array
* @return The product ID
*/
public static String getProductID(byte[] edid) {
// Bytes 10-11 are product ID expressed in hex characters
return Integer.toHexString(
ByteBuffer.wrap(Arrays.copyOfRange(edid, 10, 12)).order(ByteOrder.LITTLE_ENDIAN).getShort() & 0xffff);
}
/**
* Gets the Serial number, bytes 12-15
*
* @param edid The EDID byte array
* @return If all 4 bytes represent alphanumeric characters, a 4-character string, otherwise a hex string.
*/
public static String getSerialNo(byte[] edid) {
// Bytes 12-15 are Serial number (last 4 characters)
if (LOG.isDebugEnabled()) {
LOG.debug("Serial number: {}", Arrays.toString(Arrays.copyOfRange(edid, 12, 16)));
}
return String.format(Locale.ROOT, "%s%s%s%s", getAlphaNumericOrHex(edid[15]), getAlphaNumericOrHex(edid[14]),
getAlphaNumericOrHex(edid[13]), getAlphaNumericOrHex(edid[12]));
}
private static String getAlphaNumericOrHex(byte b) {
return Character.isLetterOrDigit((char) b) ? String.format(Locale.ROOT, "%s", (char) b)
: String.format(Locale.ROOT, "%02X", b);
}
/**
* Return the week of year of manufacture
*
* @param edid The EDID byte array
* @return The week of year
*/
public static byte getWeek(byte[] edid) {
// Byte 16 is manufacture week
return edid[16];
}
/**
* Return the year of manufacture
*
* @param edid The EDID byte array
* @return The year of manufacture
*/
public static int getYear(byte[] edid) {
// Byte 17 is manufacture year-1990
byte temp = edid[17];
LOG.debug("Year-1990: {}", temp);
return temp + 1990;
}
/**
* Return the EDID version
*
* @param edid The EDID byte array
* @return The EDID version
*/
public static String getVersion(byte[] edid) {
// Bytes 18-19 are EDID version
return edid[18] + "." + edid[19];
}
/**
* Test if this EDID is a digital monitor based on byte 20
*
* @param edid The EDID byte array
* @return True if the EDID represents a digital monitor, false otherwise
*/
public static boolean isDigital(byte[] edid) {
// Byte 20 is Video input params
return 1 == (edid[20] & 0xff) >> 7;
}
/**
* Get monitor width in cm
*
* @param edid The EDID byte array
* @return Monitor width in cm
*/
public static int getHcm(byte[] edid) {
// Byte 21 is horizontal size in cm
return edid[21];
}
/**
* Get monitor height in cm
*
* @param edid The EDID byte array
* @return Monitor height in cm
*/
public static int getVcm(byte[] edid) {
// Byte 22 is vertical size in cm
return edid[22];
}
/**
* Get the VESA descriptors
*
* @param edid The EDID byte array
* @return A 2D array with four 18-byte elements representing VESA descriptors
*/
public static byte[][] getDescriptors(byte[] edid) {
byte[][] desc = new byte[4][18];
for (int i = 0; i < desc.length; i++) {
System.arraycopy(edid, 54 + 18 * i, desc[i], 0, 18);
}
return desc;
}
/**
* Get the VESA descriptor type
*
* @param desc An 18-byte VESA descriptor
* @return An integer representing the first four bytes of the VESA descriptor
*/
public static int getDescriptorType(byte[] desc) {
return ByteBuffer.wrap(Arrays.copyOfRange(desc, 0, 4)).getInt();
}
/**
* Parse a detailed timing descriptor
*
* @param desc An 18-byte VESA descriptor
* @return A string describing part of the detailed timing descriptor
*/
public static String getTimingDescriptor(byte[] desc) {
int clock = ByteBuffer.wrap(Arrays.copyOfRange(desc, 0, 2)).order(ByteOrder.LITTLE_ENDIAN).getShort() / 100;
int hActive = (desc[2] & 0xff) + ((desc[4] & 0xf0) << 4);
int vActive = (desc[5] & 0xff) + ((desc[7] & 0xf0) << 4);
return String.format(Locale.ROOT, "Clock %dMHz, Active Pixels %dx%d ", clock, hActive, vActive);
}
/**
* Parse descriptor range limits
*
* @param desc An 18-byte VESA descriptor
* @return A string describing some of the range limits
*/
public static String getDescriptorRangeLimits(byte[] desc) {
return String.format(Locale.ROOT, "Field Rate %d-%d Hz vertical, %d-%d Hz horizontal, Max clock: %d MHz",
desc[5], desc[6], desc[7], desc[8], desc[9] * 10);
}
/**
* Parse descriptor text
*
* @param desc An 18-byte VESA descriptor
* @return Plain text starting at the 4th byte
*/
public static String getDescriptorText(byte[] desc) {
return new String(Arrays.copyOfRange(desc, 4, 18), StandardCharsets.US_ASCII).trim();
}
/**
* Parse an EDID byte array into user-readable information
*
* @param edid An EDID byte array
* @return User-readable text represented by the EDID
*/
public static String toString(byte[] edid) {
StringBuilder sb = new StringBuilder();
sb.append(" Manuf. ID=").append(EdidUtil.getManufacturerID(edid));
sb.append(", Product ID=").append(EdidUtil.getProductID(edid));
sb.append(", ").append(EdidUtil.isDigital(edid) ? "Digital" : "Analog");
sb.append(", Serial=").append(EdidUtil.getSerialNo(edid));
sb.append(", ManufDate=").append(EdidUtil.getWeek(edid) * 12 / 52 + 1).append('/')
.append(EdidUtil.getYear(edid));
sb.append(", EDID v").append(EdidUtil.getVersion(edid));
int hSize = EdidUtil.getHcm(edid);
int vSize = EdidUtil.getVcm(edid);
sb.append(String.format(Locale.ROOT, "%n %d x %d cm (%.1f x %.1f in)", hSize, vSize, hSize / 2.54,
vSize / 2.54));
byte[][] desc = EdidUtil.getDescriptors(edid);
for (byte[] b : desc) {
switch (EdidUtil.getDescriptorType(b)) {
case 0xff:
sb.append("\n Serial Number: ").append(EdidUtil.getDescriptorText(b));
break;
case 0xfe:
sb.append("\n Unspecified Text: ").append(EdidUtil.getDescriptorText(b));
break;
case 0xfd:
sb.append("\n Range Limits: ").append(EdidUtil.getDescriptorRangeLimits(b));
break;
case 0xfc:
sb.append("\n Monitor Name: ").append(EdidUtil.getDescriptorText(b));
break;
case 0xfb:
sb.append("\n White Point Data: ").append(ParseUtil.byteArrayToHexString(b));
break;
case 0xfa:
sb.append("\n Standard Timing ID: ").append(ParseUtil.byteArrayToHexString(b));
break;
default:
if (EdidUtil.getDescriptorType(b) <= 0x0f && EdidUtil.getDescriptorType(b) >= 0x00) {
sb.append("\n Manufacturer Data: ").append(ParseUtil.byteArrayToHexString(b));
} else {
sb.append("\n Preferred Timing: ").append(EdidUtil.getTimingDescriptor(b));
}
break;
}
}
return sb.toString();
}
}