/*
* This file is part of the libCEC(R) library.
*
- * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
+ * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
* libCEC(R) is an original work, containing original code.
*
* libCEC(R) is a trademark of Pulse-Eight Limited.
#include <string.h>
#if defined(_WIN32) || defined(_WIN64)
-#define CDECL __cdecl
+#define CEC_CDECL __cdecl
#else
-#define CDECL
+#define CEC_CDECL
#endif
#if !defined(DECLSPEC)
#if defined(_WIN32) || defined(_WIN64)
#include <windows.h>
-#define CDECL __cdecl
#if defined DLL_EXPORT
#define DECLSPEC __declspec(dllexport)
#else
#define ESCOFFSET 3
#define CEC_BUTTON_TIMEOUT 500
#define CEC_POWER_STATE_REFRESH_TIME 30000
-
-#define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
-#define CEC_DEFAULT_TRANSMIT_WAIT 2000
-#define CEC_DEFAULT_TRANSMIT_RETRIES 1
+#define CEC_FW_VERSION_UNKNOWN 0xFFFF
+#define CEC_CONNECT_TRIES 3
+
+#define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE 1
+#define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE 1
+#define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN 1
+#define CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER 1
+#define CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY 1
+#define CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY 0
+#define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE 1
+#define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1
+
+#define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
+#define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
+#define CEC_DEFAULT_TRANSMIT_WAIT 2000
+#define CEC_DEFAULT_TRANSMIT_RETRIES 1
#define CEC_MIN_LIB_VERSION 1
#define CEC_LIB_VERSION_MAJOR 1
-#define CEC_LIB_VERSION_MINOR 3
+#define CEC_LIB_VERSION_MINOR 6
typedef enum cec_abort_reason
{
CEC_USER_CONTROL_CODE_F4_YELLOW = 0x74,
CEC_USER_CONTROL_CODE_F5 = 0x75,
CEC_USER_CONTROL_CODE_DATA = 0x76,
- CEC_USER_CONTROL_CODE_MAX = 0x76,
+ CEC_USER_CONTROL_CODE_AN_RETURN = 0x91,
+ CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST = 0x96,
+ CEC_USER_CONTROL_CODE_MAX = 0x96,
CEC_USER_CONTROL_CODE_UNKNOWN
} cec_user_control_code;
-typedef enum cec_an_user_control_code
-{
- CEC_AN_USER_CONTROL_CODE_RETURN = 0x91
-} cec_an_user_control_code;
-
typedef enum cec_logical_address
{
CECDEVICE_UNKNOWN = -1, //not a valid logical address
MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
MSGCODE_FIRMWARE_VERSION,
MSGCODE_START_BOOTLOADER,
+ MSGCODE_SET_POWERSTATE,
+ MSGCODE_SET_CONTROLLED,
+ MSGCODE_GET_AUTO_ENABLED,
+ MSGCODE_SET_AUTO_ENABLED,
+ MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS,
+ MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS,
+ MSGCODE_GET_LOGICAL_ADDRESS_MASK,
+ MSGCODE_SET_LOGICAL_ADDRESS_MASK,
+ MSGCODE_GET_PHYSICAL_ADDRESS,
+ MSGCODE_SET_PHYSICAL_ADDRESS,
+ MSGCODE_GET_DEVICE_TYPE,
+ MSGCODE_SET_DEVICE_TYPE,
+ MSGCODE_GET_HDMI_VERSION,
+ MSGCODE_SET_HDMI_VERSION,
+ MSGCODE_GET_OSD_NAME,
+ MSGCODE_SET_OSD_NAME,
+ MSGCODE_WRITE_EEPROM,
MSGCODE_FRAME_EOM = 0x80,
MSGCODE_FRAME_ACK = 0x40,
} cec_adapter_messagecode;
CEC_VENDOR_YAMAHA = 0x00A0DE,
CEC_VENDOR_PHILIPS = 0x00903E,
CEC_VENDOR_SONY = 0x080046,
+ CEC_VENDOR_TOSHIBA = 0x000039,
CEC_VENDOR_UNKNOWN = 0
} cec_vendor_id;
typedef struct cec_menu_language
{
- char language[4];
- cec_logical_address device;
+ char language[4]; /**< the iso language code */
+ cec_logical_address device; /**< the logical address of the device */
} cec_menu_language;
typedef struct cec_osd_name
{
- char name[14];
- cec_logical_address device;
+ char name[14]; /**< the name of the device */
+ cec_logical_address device; /**< the logical address of the device */
} cec_osd_name;
typedef struct cec_log_message
{
- char message[1024];
- cec_log_level level;
- int64_t time;
+ char message[1024]; /**< the actual message */
+ cec_log_level level; /**< log level of the message */
+ int64_t time; /**< the timestamp of this message */
} cec_log_message;
typedef struct cec_keypress
{
- cec_user_control_code keycode;
- unsigned int duration;
+ cec_user_control_code keycode; /**< the keycode */
+ unsigned int duration; /**< the duration of the keypress */
} cec_keypress;
typedef struct cec_adapter
{
- char path[1024];
- char comm[1024];
+ char path[1024]; /**< the path to the com port */
+ char comm[1024]; /**< the name of the com port */
} cec_adapter;
typedef struct cec_datapacket
{
- uint8_t data[100];
- uint8_t size;
+ uint8_t data[100]; /**< the actual data */
+ uint8_t size; /**< the size of the data */
#ifdef __cplusplus
cec_datapacket &operator =(const struct cec_datapacket &packet)
typedef struct cec_command
{
- cec_logical_address initiator;
- cec_logical_address destination;
- int8_t ack;
- int8_t eom;
- cec_opcode opcode;
- cec_datapacket parameters;
- int8_t opcode_set;
- int32_t transmit_timeout;
+ cec_logical_address initiator; /**< the logical address of the initiator of this message */
+ cec_logical_address destination; /**< the logical address of the destination of this message */
+ int8_t ack; /**< 1 when the ACK bit is set, 0 otherwise */
+ int8_t eom; /**< 1 when the EOM bit is set, 0 otherwise */
+ cec_opcode opcode; /**< the opcode of this message */
+ cec_datapacket parameters; /**< the parameters attached to this message */
+ int8_t opcode_set; /**< 1 when an opcode is set, 0 otherwise (POLL message) */
+ int32_t transmit_timeout; /**< the timeout to use in ms */
#ifdef __cplusplus
cec_command &operator =(const struct cec_command &command)
typedef struct cec_device_type_list
{
- cec_device_type types[5];
+ cec_device_type types[5]; /**< the list of device types */
#ifdef __cplusplus
/*!
return bReturn;
}
- bool IsEmpty()
+ bool IsEmpty() const
{
bool bReturn(true);
for (unsigned int iPtr = 0; bReturn && iPtr < 5; iPtr++)
}
cec_device_type operator[](uint8_t pos) const { return pos < 5 ? types[pos] : CEC_DEVICE_TYPE_RESERVED; }
+ bool operator==(const cec_device_type_list &other) const
+ {
+ bool bEqual(true);
+ for (uint8_t iPtr = 0; iPtr < 5; iPtr++)
+ bEqual &= (types[iPtr] == other[iPtr]);
+ return bEqual;
+ }
+
+ bool operator!=(const cec_device_type_list &other) const
+ {
+ return !(*this == other);
+ }
#endif
} cec_device_type_list;
typedef struct cec_logical_addresses
{
- cec_logical_address primary;
- int addresses[16];
+ cec_logical_address primary; /**< the primary logical address to use */
+ int addresses[16]; /**< the list of addresses */
#ifdef __cplusplus
void Clear(void)
bool IsSet(cec_logical_address address) const { return addresses[(int) address] == 1; }
bool operator[](uint8_t pos) const { return pos < 16 ? IsSet((cec_logical_address) pos) : false; }
+
+ bool operator==(const cec_logical_addresses &other) const
+ {
+ bool bEqual(true);
+ for (uint8_t iPtr = 0; iPtr < 16; iPtr++)
+ bEqual &= ((addresses[(int)iPtr] == 1) == other[iPtr]);
+ return bEqual;
+ }
+
+ bool operator!=(const cec_logical_addresses &other) const
+ {
+ return !(*this == other);
+ }
#endif
} cec_logical_addresses;
+typedef enum libcec_alert
+{
+ CEC_ALERT_SERVICE_DEVICE
+} libcec_alert;
-typedef int (CDECL* CBCecLogMessageType)(void *param, const CEC::cec_log_message &);
-typedef int (CDECL* CBCecKeyPressType)(void *param, const cec_keypress &key);
-typedef int (CDECL* CBCecCommandType)(void *param, const cec_command &command);
+typedef enum libcec_parameter_type
+{
+ CEC_PARAMETER_TYPE_STRING
+} libcec_parameter_type;
+
+struct libcec_parameter
+{
+ libcec_parameter_type paramType; /**< the type of this parameter */
+ void* paramData; /**< the value of this parameter */
+};
+
+struct libcec_configuration;
+
+typedef int (CEC_CDECL* CBCecLogMessageType)(void *param, const cec_log_message &);
+typedef int (CEC_CDECL* CBCecKeyPressType)(void *param, const cec_keypress &);
+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 struct ICECCallbacks
{
* @return 1 when ok, 0 otherwise.
*/
CBCecCommandType CBCecCommand;
+
+ /*!
+ * @brief Transfer a changed configuration from libCEC to the client
+ * @param configuration The configuration to transfer
+ * @return 1 when ok, 0 otherwise
+ */
+ CBCecConfigurationChangedType CBCecConfigurationChanged;
+
+ /*!
+ * @brief Transfer a libcec alert message from libCEC to the client
+ * @param alert The alert type transfer.
+ * @param data Misc. additional information.
+ * @return 1 when ok, 0 otherwise
+ */
+ CBCecAlertType CBCecAlert;
} ICECCallbacks;
+typedef enum cec_client_version
+{
+ CEC_CLIENT_VERSION_PRE_1_5 = 0,
+ CEC_CLIENT_VERSION_1_5_0 = 0x1500,
+ CEC_CLIENT_VERSION_1_5_1 = 0x1501,
+ CEC_CLIENT_VERSION_1_5_2 = 0x1502,
+ CEC_CLIENT_VERSION_1_5_3 = 0x1503,
+ CEC_CLIENT_VERSION_1_6_0 = 0x1600,
+ CEC_CLIENT_VERSION_1_6_1 = 0x1601
+} cec_client_version;
+
+typedef enum cec_server_version
+{
+ CEC_SERVER_VERSION_PRE_1_5 = 0,
+ CEC_SERVER_VERSION_1_5_0 = 0x1500,
+ CEC_SERVER_VERSION_1_5_1 = 0x1501,
+ CEC_SERVER_VERSION_1_5_2 = 0x1502,
+ CEC_SERVER_VERSION_1_5_3 = 0x1503,
+ CEC_SERVER_VERSION_1_6_0 = 0x1600,
+ CEC_SERVER_VERSION_1_6_1 = 0x1601
+} cec_server_version;
+
+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 */
+ 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 */
+ uint64_t tvVendor; /*!< override the vendor ID of the TV. leave this untouched to autodetect */
+ cec_logical_addresses wakeDevices; /*!< wake these CEC devices when initialising libCEC or when calling PowerOnDevices() without any parameter */
+ cec_logical_addresses powerOffDevices; /*!< power off these devices when calling StandbyDevices() without any parameter */
+
+ uint32_t serverVersion; /*!< the version number of the server. read-only */
+
+ // player specific settings
+ uint8_t bGetSettingsFromROM; /*!< true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings. */
+ uint8_t bUseTVMenuLanguage; /*!< use the menu language of the TV in the player application */
+ uint8_t bActivateSource; /*!< make libCEC the active source on the bus when starting the player application */
+ uint8_t bPowerOffScreensaver; /*!< put devices in standby mode when activating the screensaver */
+ uint8_t bPowerOffOnStandby; /*!< put this PC in standby mode when the TV is switched off. only used when bShutdownOnStandby = 0 */
+ uint8_t bSendInactiveSource; /*!< send an 'inactive source' message when stopping the player. added in 1.5.1 */
+
+ 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 */
+ 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 */
+
+#ifdef __cplusplus
+ void Clear(void)
+ {
+ memset(strDeviceName, 0, 13);
+ deviceTypes.clear();
+ iPhysicalAddress = 0;
+ 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;
+ wakeDevices.Clear();
+ powerOffDevices.Clear();
+
+ bAutodetectAddress = 1;
+ bGetSettingsFromROM = 0;
+ bUseTVMenuLanguage = CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE;
+ bActivateSource = CEC_DEFAULT_SETTING_ACTIVATE_SOURCE;
+ #if CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1
+ powerOffDevices.Set(CECDEVICE_BROADCAST);
+ #endif
+ #if CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1
+ wakeDevices.Set(CECDEVICE_TV);
+ #endif
+ bPowerOffScreensaver = CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER;
+ bPowerOffOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY;
+ bShutdownOnStandby = CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY;
+ bSendInactiveSource = CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE;
+ logicalAddresses.Clear();
+ iFirmwareVersion = CEC_FW_VERSION_UNKNOWN;
+ bPowerOffDevicesOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY;
+
+ callbackParam = NULL;
+ callbacks = NULL;
+ }
+#endif
+} libcec_configuration;
+
#ifdef UNUSED
#elif defined(__GNUC__)
#define UNUSED(x) UNUSED_ ## x __attribute__((unused))
repositories / deb_libcec.git / blobdiff