X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcectypes.h;h=4656141d9619c3007e6c2adff31c22976e8c2144;hb=7e316a2f39ded0dfe46661cc4007f5c20c58da96;hp=4775e74c558da593d5c83c9eb4065c5140ee20d8;hpb=4fde2fd01093a27bf5a73b46b7ed15abba448ed0;p=deb_libcec.git diff --git a/include/cectypes.h b/include/cectypes.h index 4775e74..4656141 100644 --- a/include/cectypes.h +++ b/include/cectypes.h @@ -72,8 +72,22 @@ namespace CEC { #define CEC_BUTTON_TIMEOUT 500 #define CEC_POWER_STATE_REFRESH_TIME 30000 #define CEC_FW_VERSION_UNKNOWN 0xFFFF +#define CEC_FW_BUILD_UNKNOWN 0 #define CEC_CONNECT_TRIES 3 +#define CEC_PHYSICAL_ADDRESS_TV 0 +#define CEC_MIN_PHYSICAL_ADDRESS 0x1000 +#define CEC_MAX_PHYSICAL_ADDRESS 0xFFFE +#define CEC_INVALID_PHYSICAL_ADDRESS 0xFFFF + +#define CEC_MIN_VENDORID 1 +#define CEC_MAX_VENDORID 0xFFFFFE +#define CEC_INVALID_VENDORID 0xFFFFFF + +#define CEC_MIN_HDMI_PORTNUMBER 1 +#define CEC_MAX_HDMI_PORTNUMBER 15 +#define CEC_HDMI_PORTNUMBER_NONE 0 + #define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE 1 #define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE 1 #define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN 1 @@ -83,16 +97,30 @@ namespace CEC { #define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE 1 #define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1 #define CEC_DEFAULT_DEVICE_LANGUAGE "eng" -#define CEC_DEFAULT_FIRMWARE_BUILD_DATE 0 +#define CEC_DEFAULT_SETTING_AUTODETECT_ADDRESS 0 +#define CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM 0 +#define CEC_DEFAULT_SETTING_CEC_VERSION 0x05 #define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000 -#define CEC_DEFAULT_TRANSMIT_WAIT 2000 +#define CEC_DEFAULT_TRANSMIT_WAIT 1000 #define CEC_DEFAULT_TRANSMIT_RETRIES 1 +#define CEC_DEFAULT_CONNECT_TIMEOUT 10000 +#define CEC_DEFAULT_CONNECT_RETRY_WAIT 1000 +#define CEC_SERIAL_DEFAULT_BAUDRATE 38400 +#define CEC_CLEAR_INPUT_DEFAULT_WAIT 1000 + +#define CEC_ACTIVE_SOURCE_SWITCH_RETRY_TIME_MS 5000 +#define CEC_FORWARD_STANDBY_MIN_INTERVAL 10000 + +#define CEC_RPI_VIRTUAL_PATH "Raspberry Pi" +#define CEC_RPI_VIRTUAL_COM "RPI" + #define CEC_MIN_LIB_VERSION 1 #define CEC_LIB_VERSION_MAJOR 1 -#define CEC_LIB_VERSION_MINOR 6 +#define CEC_LIB_VERSION_MAJOR_STR "1" +#define CEC_LIB_VERSION_MINOR 8 typedef enum cec_abort_reason { @@ -564,6 +592,15 @@ typedef enum cec_opcode CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST = 0x70, CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS = 0x7E, CEC_OPCODE_SET_AUDIO_RATE = 0x9A, + + /* CEC 1.4 */ + CEC_OPCODE_START_ARC = 0xC0, + CEC_OPCODE_REPORT_ARC_STARTED = 0xC1, + CEC_OPCODE_REPORT_ARC_ENDED = 0xC2, + CEC_OPCODE_REQUEST_ARC_START = 0xC3, + CEC_OPCODE_REQUEST_ARC_END = 0xC4, + CEC_OPCODE_END_ARC = 0xC5, + CEC_OPCODE_CDC = 0xF8, /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */ CEC_OPCODE_NONE = 0xFD } cec_opcode; @@ -643,6 +680,16 @@ typedef enum cec_vendor_id CEC_VENDOR_PHILIPS = 0x00903E, CEC_VENDOR_SONY = 0x080046, CEC_VENDOR_TOSHIBA = 0x000039, + CEC_VENDOR_AKAI = 0x0020C7, + CEC_VENDOR_AOC = 0x002467, + CEC_VENDOR_BENQ = 0x8065E9, + CEC_VENDOR_DAEWOO = 0x009053, + CEC_VENDOR_GRUNDIG = 0x00D0D5, + CEC_VENDOR_MEDION = 0x000CB8, + CEC_VENDOR_SHARP = 0x08001F, + CEC_VENDOR_VIZIO = 0x6B746D, + CEC_VENDOR_BROADCOM = 0x18C086, + CEC_VENDOR_UNKNOWN = 0 } cec_vendor_id; @@ -760,10 +807,11 @@ typedef struct cec_command int32_t transmit_timeout; /**< the timeout to use in ms */ #ifdef __cplusplus - cec_command(void) - { - Clear(); - } + // @todo re-add in v2.0 (breaks ABI) + //cec_command(void) + //{ + // Clear(); + //} cec_command &operator =(const struct cec_command &command) { @@ -871,6 +919,12 @@ typedef struct cec_command return CEC_OPCODE_NONE; } + + void PushArray(size_t len, uint8_t *data) + { + for (size_t iPtr = 0; iPtr < len; iPtr++) + PushBack(data[iPtr]); + } #endif } cec_command; @@ -979,7 +1033,7 @@ typedef struct cec_logical_addresses */ void Clear(void) { - primary = CECDEVICE_UNKNOWN; + primary = CECDEVICE_UNREGISTERED; for (unsigned int iPtr = 0; iPtr < 16; iPtr++) addresses[iPtr] = 0; } @@ -989,7 +1043,7 @@ typedef struct cec_logical_addresses */ bool IsEmpty(void) const { - return primary == CECDEVICE_UNKNOWN; + return primary == CECDEVICE_UNREGISTERED; } /*! @@ -1011,7 +1065,7 @@ typedef struct cec_logical_addresses */ void Set(cec_logical_address address) { - if (primary == CECDEVICE_UNKNOWN) + if (primary == CECDEVICE_UNREGISTERED) primary = address; addresses[(int) address] = 1; @@ -1021,10 +1075,10 @@ typedef struct cec_logical_addresses * @brief Mark a logical address as 'unset' * @param address The logical address to remove from this list. */ - void Unset(cec_logical_address address) + void Unset(const cec_logical_address address) { if (primary == address) - primary = CECDEVICE_UNKNOWN; + primary = CECDEVICE_UNREGISTERED; addresses[(int) address] = 0; } @@ -1061,12 +1115,15 @@ typedef struct cec_logical_addresses typedef enum libcec_alert { CEC_ALERT_SERVICE_DEVICE, - CEC_ALERT_CONNECTION_LOST + CEC_ALERT_CONNECTION_LOST, + CEC_ALERT_PERMISSION_ERROR, + CEC_ALERT_PORT_BUSY } libcec_alert; typedef enum libcec_parameter_type { - CEC_PARAMETER_TYPE_STRING + CEC_PARAMETER_TYPE_STRING, + CEC_PARAMETER_TYPE_UNKOWN } libcec_parameter_type; struct libcec_parameter @@ -1083,6 +1140,7 @@ typedef int (CEC_CDECL* CBCecCommandType)(void *param, const cec_command &); typedef int (CEC_CDECL* CBCecConfigurationChangedType)(void *param, const libcec_configuration &); typedef int (CEC_CDECL* CBCecAlertType)(void *param, const libcec_alert, const libcec_parameter &); typedef int (CEC_CDECL* CBCecMenuStateChangedType)(void *param, const cec_menu_state); +typedef void (CEC_CDECL* CBCecSourceActivatedType)(void *param, const cec_logical_address, const uint8_t); typedef struct ICECCallbacks { @@ -1133,9 +1191,17 @@ typedef struct ICECCallbacks */ CBCecMenuStateChangedType CBCecMenuStateChanged; + /*! + * @brief Called when a source that's handled by this client is activated. + * @param logicalAddress The address that was just activated. + * @param bActivated 1 when activated, 0 when deactivated. + */ + CBCecSourceActivatedType CBCecSourceActivated; + #ifdef __cplusplus - ICECCallbacks(void) { Clear(); } - ~ICECCallbacks(void) { Clear(); }; + // @todo re-add in v2.0 (breaks ABI) + // ICECCallbacks(void) { Clear(); } + //~ICECCallbacks(void) { Clear(); }; void Clear(void) { @@ -1145,6 +1211,7 @@ typedef struct ICECCallbacks CBCecConfigurationChanged = NULL; CBCecAlert = NULL; CBCecMenuStateChanged = NULL; + CBCecSourceActivated = NULL; } #endif } ICECCallbacks; @@ -1158,7 +1225,13 @@ typedef enum cec_client_version CEC_CLIENT_VERSION_1_5_3 = 0x1503, CEC_CLIENT_VERSION_1_6_0 = 0x1600, CEC_CLIENT_VERSION_1_6_1 = 0x1601, - CEC_CLIENT_VERSION_1_6_2 = 0x1602 + CEC_CLIENT_VERSION_1_6_2 = 0x1602, + CEC_CLIENT_VERSION_1_6_3 = 0x1603, + CEC_CLIENT_VERSION_1_7_0 = 0x1700, + CEC_CLIENT_VERSION_1_7_1 = 0x1701, + CEC_CLIENT_VERSION_1_7_2 = 0x1702, + CEC_CLIENT_VERSION_1_8_0 = 0x1800, + CEC_CLIENT_VERSION_1_8_1 = 0x1801 } cec_client_version; typedef enum cec_server_version @@ -1170,7 +1243,13 @@ typedef enum cec_server_version CEC_SERVER_VERSION_1_5_3 = 0x1503, CEC_SERVER_VERSION_1_6_0 = 0x1600, CEC_SERVER_VERSION_1_6_1 = 0x1601, - CEC_SERVER_VERSION_1_6_2 = 0x1602 + CEC_SERVER_VERSION_1_6_2 = 0x1602, + CEC_SERVER_VERSION_1_6_3 = 0x1603, + CEC_SERVER_VERSION_1_7_0 = 0x1700, + CEC_SERVER_VERSION_1_7_1 = 0x1701, + CEC_SERVER_VERSION_1_7_2 = 0x1702, + CEC_SERVER_VERSION_1_8_0 = 0x1800, + CEC_SERVER_VERSION_1_8_1 = 0x1801 } cec_server_version; typedef struct libcec_configuration @@ -1178,7 +1257,7 @@ typedef struct libcec_configuration uint32_t clientVersion; /*!< the version of the client that is connecting */ char strDeviceName[13]; /*!< how to name the device on the CEC bus */ cec_device_type_list deviceTypes; /*!< the CEC device types to emulate */ - uint8_t bAutodetectAddress; /*!< try to autodetect the physical address when 1 */ + uint8_t bAutodetectAddress; /*!< (read only) set to 1 by libCEC when the physical address was autodetected */ uint16_t iPhysicalAddress; /*!< the physical address of the CEC adapter. only used when bAutodetectAddress = 0 or when the adapter doesn't support autodetection */ cec_logical_address baseDevice; /*!< the logical address of the device to which the adapter is connected. only used when iPhysicalAddress = 0 and bAutodetectAddress = 0 or when the adapter doesn't support autodetection */ uint8_t iHDMIPort; /*!< the HDMI port to which the adapter is connected. only used when iPhysicalAddress = 0 and bAutodetectAddress = 0 or when the adapter doesn't support autodetection */ @@ -1199,30 +1278,72 @@ typedef struct libcec_configuration void * callbackParam; /*!< the object to pass along with a call of the callback methods. NULL to ignore */ ICECCallbacks * callbacks; /*!< the callback methods to use. set this to NULL when not using callbacks */ - cec_logical_addresses logicalAddresses; /*!< the current logical addresses. read-only. added in 1.5.3 */ - uint16_t iFirmwareVersion; /*!< the firmware version of the adapter. added in 1.6.0 */ + cec_logical_addresses logicalAddresses; /*!< (read-only) the current logical addresses. added in 1.5.3 */ + uint16_t iFirmwareVersion; /*!< (read-only) the firmware version of the adapter. added in 1.6.0 */ uint8_t bPowerOffDevicesOnStandby; /*!< put devices in standby when the PC/player is put in standby. added in 1.6.0 */ uint8_t bShutdownOnStandby; /*!< shutdown this PC when the TV is switched off. only used when bPowerOffOnStandby = 0. added in 1.6.0 */ char strDeviceLanguage[3]; /*!< the menu language used by the client. 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ added in 1.6.2 */ - uint32_t iFirmwareBuildDate; /*!< the build date of the firmware, in seconds since epoch. if not available, this value will be set to 0. added in 1.6.2 */ + uint32_t iFirmwareBuildDate; /*!< (read-only) the build date of the firmware, in seconds since epoch. if not available, this value will be set to 0. added in 1.6.2 */ + uint8_t bMonitorOnly; /*!< won't allocate a CCECClient when starting the connection when set (same as monitor mode). added in 1.6.3 */ + cec_version cecVersion; /*!< CEC spec version to use by libCEC. defaults to v1.4. added in 1.8.0 */ #ifdef __cplusplus - libcec_configuration(void) { Clear(); } - ~libcec_configuration(void) { Clear(); } + // @todo re-add in v2.0 (breaks ABI) + // libcec_configuration(void) { Clear(); } + //~libcec_configuration(void) { Clear(); } + + bool operator==(const libcec_configuration &other) const + { + return ( clientVersion == other.clientVersion && + !strncmp(strDeviceName, other.strDeviceName, 13) && + deviceTypes == other.deviceTypes && + bAutodetectAddress == other.bAutodetectAddress && + iPhysicalAddress == other.iPhysicalAddress && + baseDevice == other.baseDevice && + iHDMIPort == other.iHDMIPort && + tvVendor == other.tvVendor && + wakeDevices == other.wakeDevices && + powerOffDevices == other.powerOffDevices && + serverVersion == other.serverVersion && + bGetSettingsFromROM == other.bGetSettingsFromROM && + bUseTVMenuLanguage == other.bUseTVMenuLanguage && + bActivateSource == other.bActivateSource && + bPowerOffScreensaver == other.bPowerOffScreensaver && + bPowerOffOnStandby == other.bPowerOffOnStandby && + bSendInactiveSource == other.bSendInactiveSource && + /* libcec 1.5.3+ */ + (other.clientVersion < CEC_CLIENT_VERSION_1_5_3 || logicalAddresses == other.logicalAddresses) && + /* libcec 1.6.0+ */ + (other.clientVersion < CEC_CLIENT_VERSION_1_6_0 || iFirmwareVersion == other.iFirmwareVersion) && + (other.clientVersion < CEC_CLIENT_VERSION_1_6_0 || bPowerOffDevicesOnStandby == other.bPowerOffDevicesOnStandby) && + (other.clientVersion < CEC_CLIENT_VERSION_1_6_0 || bShutdownOnStandby == other.bShutdownOnStandby) && + /* libcec 1.6.2+ */ + (other.clientVersion < CEC_CLIENT_VERSION_1_6_2 || !strncmp(strDeviceLanguage, other.strDeviceLanguage, 3)) && + (other.clientVersion < CEC_CLIENT_VERSION_1_6_2 || iFirmwareBuildDate == other.iFirmwareBuildDate) && + /* libcec 1.6.3+ */ + (other.clientVersion < CEC_CLIENT_VERSION_1_6_3 || bMonitorOnly == other.bMonitorOnly) && + /* libcec 1.8.0+ */ + (other.clientVersion < CEC_CLIENT_VERSION_1_8_0 || cecVersion == other.cecVersion)); + } + + bool operator!=(const libcec_configuration &other) const + { + return !(*this == other); + } /*! * @brief Reset this configution struct to the default values. */ void Clear(void) { - iPhysicalAddress = 0; + iPhysicalAddress = CEC_PHYSICAL_ADDRESS_TV; baseDevice = (cec_logical_address)CEC_DEFAULT_BASE_DEVICE; iHDMIPort = CEC_DEFAULT_HDMI_PORT; tvVendor = (uint64_t)CEC_VENDOR_UNKNOWN; clientVersion = (uint32_t)CEC_CLIENT_VERSION_PRE_1_5; serverVersion = (uint32_t)CEC_SERVER_VERSION_PRE_1_5; - bAutodetectAddress = 1; - bGetSettingsFromROM = 0; + bAutodetectAddress = 0; + bGetSettingsFromROM = CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM; bUseTVMenuLanguage = CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE; bActivateSource = CEC_DEFAULT_SETTING_ACTIVATE_SOURCE; bPowerOffScreensaver = CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER; @@ -1232,7 +1353,9 @@ typedef struct libcec_configuration iFirmwareVersion = CEC_FW_VERSION_UNKNOWN; bPowerOffDevicesOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY; memcpy(strDeviceLanguage, CEC_DEFAULT_DEVICE_LANGUAGE, 3); - iFirmwareBuildDate = CEC_DEFAULT_FIRMWARE_BUILD_DATE; + iFirmwareBuildDate = CEC_FW_BUILD_UNKNOWN; + bMonitorOnly = 0; + cecVersion = (cec_version)CEC_DEFAULT_SETTING_CEC_VERSION; memset(strDeviceName, 0, 13); deviceTypes.clear(); @@ -1253,15 +1376,6 @@ typedef struct libcec_configuration #endif } libcec_configuration; -#ifdef UNUSED -#elif defined(__GNUC__) -#define UNUSED(x) UNUSED_ ## x __attribute__((unused)) -#elif defined(__LCLINT__) -#define UNUSED(x) /*@unused@*/ x -#else -#define UNUSED(x) x -#endif - #ifdef __cplusplus }; };