include/cectypes.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited.  All rights reserved.
   6  * libCEC(R) is an original work, containing original code.
   7  *
   8  * libCEC(R) is a trademark of Pulse-Eight Limited.
   9  *
  10  * This program is dual-licensed; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  *
  25  * Alternatively, you can license this library under a commercial license,
  26  * please contact Pulse-Eight Licensing for more information.
  27  *
  28  * For more information contact:
  29  * Pulse-Eight Licensing       <license@pulse-eight.com>
  30  *     http://www.pulse-eight.com/
  31  *     http://www.pulse-eight.net/
  32  */
  33
  34 #ifndef CECTYPES_H_
  35 #define CECTYPES_H_
  36
  37 #include <stdint.h>
  38 #include <string.h>
  39
  40 #if defined(_WIN32) || defined(_WIN64)
  41 #define CEC_CDECL    __cdecl
  42 #else
  43 #define CEC_CDECL
  44 #endif
  45
  46 #if !defined(DECLSPEC)
  47 #if defined(_WIN32) || defined(_WIN64)
  48 #include <windows.h>
  49 #if defined DLL_EXPORT
  50 #define DECLSPEC __declspec(dllexport)
  51 #else
  52 #define DECLSPEC __declspec(dllimport)
  53 #endif
  54 #else
  55 #define DECLSPEC
  56 #endif
  57 #endif
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 namespace CEC {
  62 #endif
  63
  64 //default physical address 1.0.0.0, HDMI port 1
  65 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
  66 #define CEC_DEFAULT_HDMI_PORT        1
  67 #define CEC_DEFAULT_BASE_DEVICE      0
  68 #define MSGSTART                     0xFF
  69 #define MSGEND                       0xFE
  70 #define MSGESC                       0xFD
  71 #define ESCOFFSET                    3
  72 #define CEC_BUTTON_TIMEOUT           500
  73 #define CEC_POWER_STATE_REFRESH_TIME 30000
  74 #define CEC_FW_VERSION_UNKNOWN       0xFFFF
  75
  76 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
  77 #define CEC_DEFAULT_TRANSMIT_WAIT    2000
  78 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
  79 #define CEC_PING_ADAPTER_TRIES       5
  80 #define CEC_FW_VERSION_TRIES         5
  81
  82 #define CEC_MIN_LIB_VERSION          1
  83 #define CEC_LIB_VERSION_MAJOR        1
  84 #define CEC_LIB_VERSION_MINOR        4
  85
  86 typedef enum cec_abort_reason
  87 {
  88   CEC_ABORT_REASON_UNRECOGNIZED_OPCODE            = 0,
  89   CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,
  90   CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE          = 2,
  91   CEC_ABORT_REASON_INVALID_OPERAND                = 3,
  92   CEC_ABORT_REASON_REFUSED                        = 4
  93 } cec_abort_reason;
  94
  95 typedef enum cec_analogue_broadcast_type
  96 {
  97   CEC_ANALOGUE_BROADCAST_TYPE_CABLE      = 0x00,
  98   CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE  = 0x01,
  99   CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
 100 } cec_analogue_broadcast_type;
 101
 102 typedef enum cec_audio_rate
 103 {
 104   CEC_AUDIO_RATE_RATE_CONTROL_OFF    = 0,
 105   CEC_AUDIO_RATE_STANDARD_RATE_100   = 1,
 106   CEC_AUDIO_RATE_FAST_RATE_MAX_101   = 2,
 107   CEC_AUDIO_RATE_SLOW_RATE_MIN_99    = 3,
 108   CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
 109   CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
 110   CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9  = 6
 111 } cec_audio_rate;
 112
 113 typedef enum cec_audio_status
 114 {
 115   CEC_AUDIO_MUTE_STATUS_MASK      = 0x80,
 116   CEC_AUDIO_VOLUME_STATUS_MASK    = 0x7F,
 117   CEC_AUDIO_VOLUME_MIN            = 0x00,
 118   CEC_AUDIO_VOLUME_MAX            = 0x64,
 119   CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
 120 } cec_audio_status;
 121
 122 typedef enum cec_boolean
 123 {
 124   CEC_FALSE = 0,
 125   CEC_TRUE  = 1
 126 } cec_boolean;
 127
 128 typedef enum cec_version
 129 {
 130   CEC_VERSION_UNKNOWN = 0x00,
 131   CEC_VERSION_1_2     = 0x01,
 132   CEC_VERSION_1_2A    = 0x02,
 133   CEC_VERSION_1_3     = 0x03,
 134   CEC_VERSION_1_3A    = 0x04,
 135   CEC_VERSION_1_4     = 0x05
 136 } cec_version;
 137
 138 typedef enum cec_channel_identifier
 139 {
 140   CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
 141   CEC_1_PART_CHANNEL_NUMBER      = 0x04000000,
 142   CEC_2_PART_CHANNEL_NUMBER      = 0x08000000,
 143   CEC_MAJOR_CHANNEL_NUMBER_MASK  = 0x3FF0000,
 144   CEC_MINOR_CHANNEL_NUMBER_MASK  = 0xFFFF
 145 } cec_channel_identifier;
 146
 147 typedef enum cec_deck_control_mode
 148 {
 149   CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND   = 1,
 150   CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
 151   CEC_DECK_CONTROL_MODE_STOP                = 3,
 152   CEC_DECK_CONTROL_MODE_EJECT               = 4
 153 } cec_deck_control_mode;
 154
 155 typedef enum cec_deck_info
 156 {
 157   CEC_DECK_INFO_PLAY                 = 0x11,
 158   CEC_DECK_INFO_RECORD               = 0x12,
 159   CEC_DECK_INFO_PLAY_REVERSE         = 0x13,
 160   CEC_DECK_INFO_STILL                = 0x14,
 161   CEC_DECK_INFO_SLOW                 = 0x15,
 162   CEC_DECK_INFO_SLOW_REVERSE         = 0x16,
 163   CEC_DECK_INFO_FAST_FORWARD         = 0x17,
 164   CEC_DECK_INFO_FAST_REVERSE         = 0x18,
 165   CEC_DECK_INFO_NO_MEDIA             = 0x19,
 166   CEC_DECK_INFO_STOP                 = 0x1A,
 167   CEC_DECK_INFO_SKIP_FORWARD_WIND    = 0x1B,
 168   CEC_DECK_INFO_SKIP_REVERSE_REWIND  = 0x1C,
 169   CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
 170   CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
 171   CEC_DECK_INFO_OTHER_STATUS         = 0x1F,
 172   CEC_DECK_INFO_OTHER_STATUS_LG      = 0x20
 173 } cec_deck_info;
 174
 175 typedef enum cec_device_type
 176 {
 177   CEC_DEVICE_TYPE_TV               = 0,
 178   CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
 179   CEC_DEVICE_TYPE_RESERVED         = 2,
 180   CEC_DEVICE_TYPE_TUNER            = 3,
 181   CEC_DEVICE_TYPE_PLAYBACK_DEVICE  = 4,
 182   CEC_DEVICE_TYPE_AUDIO_SYSTEM     = 5
 183 } cec_device_type;
 184
 185 typedef enum cec_display_control
 186 {
 187   CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
 188   CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED    = 0x40,
 189   CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE   = 0x80,
 190   CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE  = 0xC0
 191 } cec_display_control;
 192
 193 typedef enum cec_external_source_specifier
 194 {
 195   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG             = 4,
 196   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
 197 } cec_external_source_specifier;
 198
 199 typedef enum cec_menu_request_type
 200 {
 201   CEC_MENU_REQUEST_TYPE_ACTIVATE   = 0,
 202   CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
 203   CEC_MENU_REQUEST_TYPE_QUERY      = 2
 204 } cec_menu_request_type;
 205
 206 typedef enum cec_menu_state
 207 {
 208   CEC_MENU_STATE_ACTIVATED   = 0,
 209   CEC_MENU_STATE_DEACTIVATED = 1
 210 } cec_menu_state;
 211
 212 typedef enum cec_play_mode
 213 {
 214   CEC_PLAY_MODE_PLAY_FORWARD              = 0x24,
 215   CEC_PLAY_MODE_PLAY_REVERSE              = 0x20,
 216   CEC_PLAY_MODE_PLAY_STILL                = 0x25,
 217   CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED    = 0x05,
 218   CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
 219   CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED    = 0x07,
 220   CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED    = 0x09,
 221   CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
 222   CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED    = 0x0B,
 223   CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED    = 0x15,
 224   CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
 225   CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED    = 0x17,
 226   CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED    = 0x19,
 227   CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
 228   CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED    = 0x1B
 229 } cec_play_mode;
 230
 231 typedef enum cec_power_status
 232 {
 233   CEC_POWER_STATUS_ON                          = 0x00,
 234   CEC_POWER_STATUS_STANDBY                     = 0x01,
 235   CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
 236   CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03,
 237   CEC_POWER_STATUS_UNKNOWN                     = 0x99
 238 } cec_power_status;
 239
 240 typedef enum cec_record_source_type
 241 {
 242   CEC_RECORD_SOURCE_TYPE_OWN_SOURCE                = 1,
 243   CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE           = 2,
 244   CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE          = 3,
 245   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS             = 4,
 246   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
 247 } cec_record_source_type;
 248
 249 typedef enum cec_record_status_info
 250 {
 251   CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE            = 0x01,
 252   CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE                      = 0x02,
 253   CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE                     = 0x03,
 254   CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT                       = 0x04,
 255   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE  = 0x05,
 256   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
 257   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
 258   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER      = 0x09,
 259   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS          = 0x0A,
 260   CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED           = 0x0B,
 261   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS   = 0x0C,
 262   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE        = 0x0D,
 263   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED         = 0x0E,
 264   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA                          = 0x10,
 265   CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING                           = 0x11,
 266   CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING                 = 0x12,
 267   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED                   = 0x13,
 268   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL                  = 0x14,
 269   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM                     = 0x15,
 270   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE        = 0x16,
 271   CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON                  = 0x17,
 272   CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY                  = 0x1A,
 273   CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED               = 0x1B,
 274   CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON                      = 0x1F
 275 } cec_record_status_info;
 276
 277 typedef enum cec_recording_sequence
 278 {
 279   CEC_RECORDING_SEQUENCE_SUNDAY    = 0x01,
 280   CEC_RECORDING_SEQUENCE_MONDAY    = 0x02,
 281   CEC_RECORDING_SEQUENCE_TUESDAY   = 0x04,
 282   CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
 283   CEC_RECORDING_SEQUENCE_THURSDAY  = 0x10,
 284   CEC_RECORDING_SEQUENCE_FRIDAY    = 0x20,
 285   CEC_RECORDING_SEQUENCE_SATURDAY  = 0x40,
 286   CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
 287 } cec_recording_sequence;
 288
 289 typedef enum cec_status_request
 290 {
 291   CEC_STATUS_REQUEST_ON   = 1,
 292   CEC_STATUS_REQUEST_OFF  = 2,
 293   CEC_STATUS_REQUEST_ONCE = 3
 294 } cec_status_request;
 295
 296 typedef enum cec_system_audio_status
 297 {
 298   CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
 299   CEC_SYSTEM_AUDIO_STATUS_ON  = 1
 300 } cec_system_audio_status;
 301
 302 typedef enum cec_timer_cleared_status_data
 303 {
 304   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING         = 0x00,
 305   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING       = 0x01,
 306   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
 307   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED                       = 0x80
 308 } cec_timer_cleared_status_data;
 309
 310 typedef enum cec_timer_overlap_warning
 311 {
 312   CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP           = 0,
 313   CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
 314 } cec_timer_overlap_warning;
 315
 316 typedef enum cec_media_info
 317 {
 318   CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
 319   CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED     = 0x01,
 320   CEC_MEDIA_INFO_MEDIA_NOT_PRESENT               = 0x02,
 321   CEC_MEDIA_INFO_FUTURE_USE                      = 0x03
 322 } cec_media_info;
 323
 324 typedef enum cec_programmed_indicator
 325 {
 326   CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
 327   CEC_PROGRAMMED_INDICATOR_PROGRAMMED     = 1
 328 } cec_programmed_indicator;
 329
 330 typedef enum cec_programmed_info
 331 {
 332   CEC_PROGRAMMED_INFO_FUTURE_USE                               = 0x0,
 333   CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING     = 0x08,
 334   CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
 335   CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE        = 0x0B,
 336   CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE                  = 0x0A
 337 } cec_programmed_info;
 338
 339 typedef enum cec_not_programmed_error_info
 340 {
 341   CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE                         = 0x0,
 342   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE            = 0x01,
 343   CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE                  = 0x02,
 344   CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR           = 0x03,
 345   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER       = 0x04,
 346   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS  = 0x05,
 347   CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED            = 0x06,
 348   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
 349   CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION        = 0x08,
 350   CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON                   = 0x09,
 351   CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE                      = 0x0A,
 352   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START      = 0x0B,
 353   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END        = 0x0D,
 354   CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED       = 0x0E
 355 } cec_not_programmed_error_info;
 356
 357 typedef enum cec_recording_flag
 358 {
 359   CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
 360   CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING     = 1
 361 } cec_recording_flag;
 362
 363 typedef enum cec_tuner_display_info
 364 {
 365   CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER  = 0,
 366   CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER      = 1,
 367   CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
 368 } cec_tuner_display_info;
 369
 370 typedef enum cec_broadcast_system
 371 {
 372   CEC_BROADCAST_SYSTEM_PAL_B_G      = 0,
 373   CEC_BROADCAST_SYSTEM_SECAM_L1     = 1,
 374   CEC_BROADCAST_SYSTEM_PAL_M        = 2,
 375   CEC_BROADCAST_SYSTEM_NTSC_M       = 3,
 376   CEC_BROADCAST_SYSTEM_PAL_I        = 4,
 377   CEC_BROADCAST_SYSTEM_SECAM_DK     = 5,
 378   CEC_BROADCAST_SYSTEM_SECAM_B_G    = 6,
 379   CEC_BROADCAST_SYSTEM_SECAM_L2     = 7,
 380   CEC_BROADCAST_SYSTEM_PAL_DK       = 8,
 381   CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
 382 } cec_broadcast_system;
 383
 384 typedef enum cec_user_control_code
 385 {
 386   CEC_USER_CONTROL_CODE_SELECT                      = 0x00,
 387   CEC_USER_CONTROL_CODE_UP                          = 0x01,
 388   CEC_USER_CONTROL_CODE_DOWN                        = 0x02,
 389   CEC_USER_CONTROL_CODE_LEFT                        = 0x03,
 390   CEC_USER_CONTROL_CODE_RIGHT                       = 0x04,
 391   CEC_USER_CONTROL_CODE_RIGHT_UP                    = 0x05,
 392   CEC_USER_CONTROL_CODE_RIGHT_DOWN                  = 0x06,
 393   CEC_USER_CONTROL_CODE_LEFT_UP                     = 0x07,
 394   CEC_USER_CONTROL_CODE_LEFT_DOWN                   = 0x08,
 395   CEC_USER_CONTROL_CODE_ROOT_MENU                   = 0x09,
 396   CEC_USER_CONTROL_CODE_SETUP_MENU                  = 0x0A,
 397   CEC_USER_CONTROL_CODE_CONTENTS_MENU               = 0x0B,
 398   CEC_USER_CONTROL_CODE_FAVORITE_MENU               = 0x0C,
 399   CEC_USER_CONTROL_CODE_EXIT                        = 0x0D,
 400   CEC_USER_CONTROL_CODE_NUMBER0                     = 0x20,
 401   CEC_USER_CONTROL_CODE_NUMBER1                     = 0x21,
 402   CEC_USER_CONTROL_CODE_NUMBER2                     = 0x22,
 403   CEC_USER_CONTROL_CODE_NUMBER3                     = 0x23,
 404   CEC_USER_CONTROL_CODE_NUMBER4                     = 0x24,
 405   CEC_USER_CONTROL_CODE_NUMBER5                     = 0x25,
 406   CEC_USER_CONTROL_CODE_NUMBER6                     = 0x26,
 407   CEC_USER_CONTROL_CODE_NUMBER7                     = 0x27,
 408   CEC_USER_CONTROL_CODE_NUMBER8                     = 0x28,
 409   CEC_USER_CONTROL_CODE_NUMBER9                     = 0x29,
 410   CEC_USER_CONTROL_CODE_DOT                         = 0x2A,
 411   CEC_USER_CONTROL_CODE_ENTER                       = 0x2B,
 412   CEC_USER_CONTROL_CODE_CLEAR                       = 0x2C,
 413   CEC_USER_CONTROL_CODE_NEXT_FAVORITE               = 0x2F,
 414   CEC_USER_CONTROL_CODE_CHANNEL_UP                  = 0x30,
 415   CEC_USER_CONTROL_CODE_CHANNEL_DOWN                = 0x31,
 416   CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL            = 0x32,
 417   CEC_USER_CONTROL_CODE_SOUND_SELECT                = 0x33,
 418   CEC_USER_CONTROL_CODE_INPUT_SELECT                = 0x34,
 419   CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION         = 0x35,
 420   CEC_USER_CONTROL_CODE_HELP                        = 0x36,
 421   CEC_USER_CONTROL_CODE_PAGE_UP                     = 0x37,
 422   CEC_USER_CONTROL_CODE_PAGE_DOWN                   = 0x38,
 423   CEC_USER_CONTROL_CODE_POWER                       = 0x40,
 424   CEC_USER_CONTROL_CODE_VOLUME_UP                   = 0x41,
 425   CEC_USER_CONTROL_CODE_VOLUME_DOWN                 = 0x42,
 426   CEC_USER_CONTROL_CODE_MUTE                        = 0x43,
 427   CEC_USER_CONTROL_CODE_PLAY                        = 0x44,
 428   CEC_USER_CONTROL_CODE_STOP                        = 0x45,
 429   CEC_USER_CONTROL_CODE_PAUSE                       = 0x46,
 430   CEC_USER_CONTROL_CODE_RECORD                      = 0x47,
 431   CEC_USER_CONTROL_CODE_REWIND                      = 0x48,
 432   CEC_USER_CONTROL_CODE_FAST_FORWARD                = 0x49,
 433   CEC_USER_CONTROL_CODE_EJECT                       = 0x4A,
 434   CEC_USER_CONTROL_CODE_FORWARD                     = 0x4B,
 435   CEC_USER_CONTROL_CODE_BACKWARD                    = 0x4C,
 436   CEC_USER_CONTROL_CODE_STOP_RECORD                 = 0x4D,
 437   CEC_USER_CONTROL_CODE_PAUSE_RECORD                = 0x4E,
 438   CEC_USER_CONTROL_CODE_ANGLE                       = 0x50,
 439   CEC_USER_CONTROL_CODE_SUB_PICTURE                 = 0x51,
 440   CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND             = 0x52,
 441   CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE    = 0x53,
 442   CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING           = 0x54,
 443   CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION       = 0x55,
 444   CEC_USER_CONTROL_CODE_PLAY_FUNCTION               = 0x60,
 445   CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION         = 0x61,
 446   CEC_USER_CONTROL_CODE_RECORD_FUNCTION             = 0x62,
 447   CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION       = 0x63,
 448   CEC_USER_CONTROL_CODE_STOP_FUNCTION               = 0x64,
 449   CEC_USER_CONTROL_CODE_MUTE_FUNCTION               = 0x65,
 450   CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION     = 0x66,
 451   CEC_USER_CONTROL_CODE_TUNE_FUNCTION               = 0x67,
 452   CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION       = 0x68,
 453   CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION    = 0x69,
 454   CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
 455   CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION       = 0x6B,
 456   CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION          = 0x6C,
 457   CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION           = 0x6D,
 458   CEC_USER_CONTROL_CODE_F1_BLUE                     = 0x71,
 459   CEC_USER_CONTROL_CODE_F2_RED                      = 0X72,
 460   CEC_USER_CONTROL_CODE_F3_GREEN                    = 0x73,
 461   CEC_USER_CONTROL_CODE_F4_YELLOW                   = 0x74,
 462   CEC_USER_CONTROL_CODE_F5                          = 0x75,
 463   CEC_USER_CONTROL_CODE_DATA                        = 0x76,
 464   CEC_USER_CONTROL_CODE_MAX                         = 0x76,
 465   CEC_USER_CONTROL_CODE_UNKNOWN
 466 } cec_user_control_code;
 467
 468 typedef enum cec_an_user_control_code
 469 {
 470   CEC_AN_USER_CONTROL_CODE_RETURN = 0x91
 471 } cec_an_user_control_code;
 472
 473 typedef enum cec_logical_address
 474 {
 475   CECDEVICE_UNKNOWN          = -1, //not a valid logical address
 476   CECDEVICE_TV               = 0,
 477   CECDEVICE_RECORDINGDEVICE1 = 1,
 478   CECDEVICE_RECORDINGDEVICE2 = 2,
 479   CECDEVICE_TUNER1           = 3,
 480   CECDEVICE_PLAYBACKDEVICE1  = 4,
 481   CECDEVICE_AUDIOSYSTEM      = 5,
 482   CECDEVICE_TUNER2           = 6,
 483   CECDEVICE_TUNER3           = 7,
 484   CECDEVICE_PLAYBACKDEVICE2  = 8,
 485   CECDEVICE_RECORDINGDEVICE3 = 9,
 486   CECDEVICE_TUNER4           = 10,
 487   CECDEVICE_PLAYBACKDEVICE3  = 11,
 488   CECDEVICE_RESERVED1        = 12,
 489   CECDEVICE_RESERVED2        = 13,
 490   CECDEVICE_FREEUSE          = 14,
 491   CECDEVICE_UNREGISTERED     = 15,
 492   CECDEVICE_BROADCAST        = 15
 493 } cec_logical_address;
 494
 495 typedef enum cec_opcode
 496 {
 497   CEC_OPCODE_ACTIVE_SOURCE                 = 0x82,
 498   CEC_OPCODE_IMAGE_VIEW_ON                 = 0x04,
 499   CEC_OPCODE_TEXT_VIEW_ON                  = 0x0D,
 500   CEC_OPCODE_INACTIVE_SOURCE               = 0x9D,
 501   CEC_OPCODE_REQUEST_ACTIVE_SOURCE         = 0x85,
 502   CEC_OPCODE_ROUTING_CHANGE                = 0x80,
 503   CEC_OPCODE_ROUTING_INFORMATION           = 0x81,
 504   CEC_OPCODE_SET_STREAM_PATH               = 0x86,
 505   CEC_OPCODE_STANDBY                       = 0x36,
 506   CEC_OPCODE_RECORD_OFF                    = 0x0B,
 507   CEC_OPCODE_RECORD_ON                     = 0x09,
 508   CEC_OPCODE_RECORD_STATUS                 = 0x0A,
 509   CEC_OPCODE_RECORD_TV_SCREEN              = 0x0F,
 510   CEC_OPCODE_CLEAR_ANALOGUE_TIMER          = 0x33,
 511   CEC_OPCODE_CLEAR_DIGITAL_TIMER           = 0x99,
 512   CEC_OPCODE_CLEAR_EXTERNAL_TIMER          = 0xA1,
 513   CEC_OPCODE_SET_ANALOGUE_TIMER            = 0x34,
 514   CEC_OPCODE_SET_DIGITAL_TIMER             = 0x97,
 515   CEC_OPCODE_SET_EXTERNAL_TIMER            = 0xA2,
 516   CEC_OPCODE_SET_TIMER_PROGRAM_TITLE       = 0x67,
 517   CEC_OPCODE_TIMER_CLEARED_STATUS          = 0x43,
 518   CEC_OPCODE_TIMER_STATUS                  = 0x35,
 519   CEC_OPCODE_CEC_VERSION                   = 0x9E,
 520   CEC_OPCODE_GET_CEC_VERSION               = 0x9F,
 521   CEC_OPCODE_GIVE_PHYSICAL_ADDRESS         = 0x83,
 522   CEC_OPCODE_GET_MENU_LANGUAGE             = 0x91,
 523   CEC_OPCODE_REPORT_PHYSICAL_ADDRESS       = 0x84,
 524   CEC_OPCODE_SET_MENU_LANGUAGE             = 0x32,
 525   CEC_OPCODE_DECK_CONTROL                  = 0x42,
 526   CEC_OPCODE_DECK_STATUS                   = 0x1B,
 527   CEC_OPCODE_GIVE_DECK_STATUS              = 0x1A,
 528   CEC_OPCODE_PLAY                          = 0x41,
 529   CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS      = 0x08,
 530   CEC_OPCODE_SELECT_ANALOGUE_SERVICE       = 0x92,
 531   CEC_OPCODE_SELECT_DIGITAL_SERVICE        = 0x93,
 532   CEC_OPCODE_TUNER_DEVICE_STATUS           = 0x07,
 533   CEC_OPCODE_TUNER_STEP_DECREMENT          = 0x06,
 534   CEC_OPCODE_TUNER_STEP_INCREMENT          = 0x05,
 535   CEC_OPCODE_DEVICE_VENDOR_ID              = 0x87,
 536   CEC_OPCODE_GIVE_DEVICE_VENDOR_ID         = 0x8C,
 537   CEC_OPCODE_VENDOR_COMMAND                = 0x89,
 538   CEC_OPCODE_VENDOR_COMMAND_WITH_ID        = 0xA0,
 539   CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN     = 0x8A,
 540   CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP       = 0x8B,
 541   CEC_OPCODE_SET_OSD_STRING                = 0x64,
 542   CEC_OPCODE_GIVE_OSD_NAME                 = 0x46,
 543   CEC_OPCODE_SET_OSD_NAME                  = 0x47,
 544   CEC_OPCODE_MENU_REQUEST                  = 0x8D,
 545   CEC_OPCODE_MENU_STATUS                   = 0x8E,
 546   CEC_OPCODE_USER_CONTROL_PRESSED          = 0x44,
 547   CEC_OPCODE_USER_CONTROL_RELEASE          = 0x45,
 548   CEC_OPCODE_GIVE_DEVICE_POWER_STATUS      = 0x8F,
 549   CEC_OPCODE_REPORT_POWER_STATUS           = 0x90,
 550   CEC_OPCODE_FEATURE_ABORT                 = 0x00,
 551   CEC_OPCODE_ABORT                         = 0xFF,
 552   CEC_OPCODE_GIVE_AUDIO_STATUS             = 0x71,
 553   CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
 554   CEC_OPCODE_REPORT_AUDIO_STATUS           = 0x7A,
 555   CEC_OPCODE_SET_SYSTEM_AUDIO_MODE         = 0x72,
 556   CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST     = 0x70,
 557   CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS      = 0x7E,
 558   CEC_OPCODE_SET_AUDIO_RATE                = 0x9A,
 559   /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
 560   CEC_OPCODE_NONE                          = 0xFD
 561 } cec_opcode;
 562
 563 typedef enum cec_log_level
 564 {
 565   CEC_LOG_ERROR   = 1,
 566   CEC_LOG_WARNING = 2,
 567   CEC_LOG_NOTICE  = 4,
 568   CEC_LOG_TRAFFIC = 8,
 569   CEC_LOG_DEBUG   = 16,
 570   CEC_LOG_ALL     = 31
 571 } cec_log_level;
 572
 573 typedef enum cec_adapter_messagecode
 574 {
 575   MSGCODE_NOTHING = 0,
 576   MSGCODE_PING,
 577   MSGCODE_TIMEOUT_ERROR,
 578   MSGCODE_HIGH_ERROR,
 579   MSGCODE_LOW_ERROR,
 580   MSGCODE_FRAME_START,
 581   MSGCODE_FRAME_DATA,
 582   MSGCODE_RECEIVE_FAILED,
 583   MSGCODE_COMMAND_ACCEPTED,
 584   MSGCODE_COMMAND_REJECTED,
 585   MSGCODE_SET_ACK_MASK,
 586   MSGCODE_TRANSMIT,
 587   MSGCODE_TRANSMIT_EOM,
 588   MSGCODE_TRANSMIT_IDLETIME,
 589   MSGCODE_TRANSMIT_ACK_POLARITY,
 590   MSGCODE_TRANSMIT_LINE_TIMEOUT,
 591   MSGCODE_TRANSMIT_SUCCEEDED,
 592   MSGCODE_TRANSMIT_FAILED_LINE,
 593   MSGCODE_TRANSMIT_FAILED_ACK,
 594   MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
 595   MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
 596   MSGCODE_FIRMWARE_VERSION,
 597   MSGCODE_START_BOOTLOADER,
 598   MSGCODE_FRAME_EOM = 0x80,
 599   MSGCODE_FRAME_ACK = 0x40,
 600 } cec_adapter_messagecode;
 601
 602 typedef enum cec_bus_device_status
 603 {
 604   CEC_DEVICE_STATUS_UNKNOWN,
 605   CEC_DEVICE_STATUS_PRESENT,
 606   CEC_DEVICE_STATUS_NOT_PRESENT,
 607   CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
 608 } cec_bus_device_status;
 609
 610 typedef enum cec_vendor_id
 611 {
 612   CEC_VENDOR_SAMSUNG   = 0x0000F0,
 613   CEC_VENDOR_LG        = 0x00E091,
 614   CEC_VENDOR_PANASONIC = 0x008045,
 615   CEC_VENDOR_PIONEER   = 0x00E036,
 616   CEC_VENDOR_ONKYO     = 0x0009B0,
 617   CEC_VENDOR_YAMAHA    = 0x00A0DE,
 618   CEC_VENDOR_PHILIPS   = 0x00903E,
 619   CEC_VENDOR_SONY      = 0x080046,
 620   CEC_VENDOR_UNKNOWN   = 0
 621 } cec_vendor_id;
 622
 623 typedef struct cec_menu_language
 624 {
 625   char                language[4];
 626   cec_logical_address device;
 627 } cec_menu_language;
 628
 629 typedef struct cec_osd_name
 630 {
 631   char                name[14];
 632   cec_logical_address device;
 633 } cec_osd_name;
 634
 635 typedef struct cec_log_message
 636 {
 637   char          message[1024];
 638   cec_log_level level;
 639   int64_t       time;
 640 } cec_log_message;
 641
 642 typedef struct cec_keypress
 643 {
 644   cec_user_control_code keycode;
 645   unsigned int          duration;
 646 } cec_keypress;
 647
 648 typedef struct cec_adapter
 649 {
 650   char path[1024];
 651   char comm[1024];
 652 } cec_adapter;
 653
 654 typedef struct cec_datapacket
 655 {
 656   uint8_t data[100];
 657   uint8_t size;
 658
 659 #ifdef __cplusplus
 660   cec_datapacket &operator =(const struct cec_datapacket &packet)
 661   {
 662     Clear();
 663     for (uint8_t iPtr = 0; iPtr < packet.size; iPtr++)
 664       PushBack(packet[iPtr]);
 665
 666     return *this;
 667   }
 668
 669   bool    IsEmpty(void) const             { return size == 0; }
 670   bool    IsFull(void) const              { return size == 100; }
 671   uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
 672   uint8_t At(uint8_t pos) const         { return pos < size ? data[pos] : 0; }
 673
 674   void Shift(uint8_t iShiftBy)
 675   {
 676     if (iShiftBy >= size)
 677     {
 678       Clear();
 679     }
 680     else
 681     {
 682       for (uint8_t iPtr = 0; iPtr < size; iPtr++)
 683         data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
 684       size = (uint8_t) (size - iShiftBy);
 685     }
 686   }
 687
 688   void PushBack(uint8_t add)
 689   {
 690     if (size < 100)
 691       data[size++] = add;
 692   }
 693
 694   void Clear(void)
 695   {
 696     memset(data, 0, sizeof(data));
 697     size = 0;
 698   }
 699 #endif
 700
 701 } cec_datapacket;
 702
 703 typedef struct cec_command
 704 {
 705   cec_logical_address initiator;
 706   cec_logical_address destination;
 707   int8_t              ack;
 708   int8_t              eom;
 709   cec_opcode          opcode;
 710   cec_datapacket      parameters;
 711   int8_t              opcode_set;
 712   int32_t             transmit_timeout;
 713
 714 #ifdef __cplusplus
 715   cec_command &operator =(const struct cec_command &command)
 716   {
 717     initiator        = command.initiator;
 718     destination      = command.destination;
 719     ack              = command.ack;
 720     eom              = command.eom;
 721     opcode           = command.opcode;
 722     opcode_set       = command.opcode_set;
 723     transmit_timeout = command.transmit_timeout;
 724     parameters       = command.parameters;
 725
 726     return *this;
 727   }
 728
 729   static void Format(cec_command &command, cec_logical_address initiator, cec_logical_address destination, cec_opcode opcode, int32_t timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT)
 730   {
 731     command.Clear();
 732     command.initiator        = initiator;
 733     command.destination      = destination;
 734     command.transmit_timeout = timeout;
 735     if (opcode != CEC_OPCODE_NONE)
 736     {
 737       command.opcode     = opcode;
 738       command.opcode_set = 1;
 739     }
 740   }
 741
 742   void PushBack(uint8_t data)
 743   {
 744     if (initiator == CECDEVICE_UNKNOWN && destination == CECDEVICE_UNKNOWN)
 745     {
 746       initiator   = (cec_logical_address) (data >> 4);
 747       destination = (cec_logical_address) (data & 0xF);
 748     }
 749     else if (!opcode_set)
 750     {
 751       opcode_set = 1;
 752       opcode = (cec_opcode) data;
 753     }
 754     else
 755       parameters.PushBack(data);
 756   }
 757
 758   void Clear(void)
 759   {
 760     initiator        = CECDEVICE_UNKNOWN;
 761     destination      = CECDEVICE_UNKNOWN;
 762     ack              = 0;
 763     eom              = 0;
 764     opcode_set       = 0;
 765     opcode           = CEC_OPCODE_FEATURE_ABORT;
 766     transmit_timeout = CEC_DEFAULT_TRANSMIT_TIMEOUT;
 767     parameters.Clear();
 768   };
 769 #endif
 770 } cec_command;
 771
 772 typedef struct cec_device_type_list
 773 {
 774   cec_device_type types[5];
 775
 776 #ifdef __cplusplus
 777   /*!
 778    * @deprecated
 779    */
 780   void clear(void) { Clear(); }
 781   /*!
 782    * @deprecated
 783    */
 784   void add(const cec_device_type type) { Add(type); }
 785
 786   void Clear(void)
 787   {
 788     for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
 789      types[iPtr] = CEC_DEVICE_TYPE_RESERVED;
 790   }
 791
 792   void Add(const cec_device_type type)
 793   {
 794     for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
 795     {
 796       if (types[iPtr] == CEC_DEVICE_TYPE_RESERVED)
 797       {
 798         types[iPtr] = type;
 799         break;
 800       }
 801     }
 802   }
 803
 804   bool IsSet(cec_device_type type)
 805   {
 806     bool bReturn(false);
 807     for (unsigned int iPtr = 0; !bReturn && iPtr < 5; iPtr++)
 808     {
 809       if (types[iPtr] == type)
 810         bReturn = true;
 811     }
 812     return bReturn;
 813   }
 814
 815   bool IsEmpty()
 816   {
 817     bool bReturn(true);
 818     for (unsigned int iPtr = 0; bReturn && iPtr < 5; iPtr++)
 819     {
 820       if (types[iPtr] != CEC_DEVICE_TYPE_RESERVED)
 821         bReturn = false;
 822     }
 823     return bReturn;
 824   }
 825
 826   cec_device_type operator[](uint8_t pos) const { return pos < 5 ? types[pos] : CEC_DEVICE_TYPE_RESERVED; }
 827 #endif
 828 } cec_device_type_list;
 829
 830 typedef struct cec_logical_addresses
 831 {
 832   cec_logical_address primary;
 833   int                 addresses[16];
 834
 835 #ifdef __cplusplus
 836   void Clear(void)
 837   {
 838     primary = CECDEVICE_UNKNOWN;
 839     for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
 840       addresses[iPtr] = 0;
 841   }
 842
 843   bool IsEmpty(void) const
 844   {
 845     return primary == CECDEVICE_UNKNOWN;
 846   }
 847
 848   uint16_t AckMask(void) const
 849   {
 850     uint16_t mask = 0;
 851     for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
 852       if (addresses[iPtr] == 1)
 853         mask |= 0x1 << iPtr;
 854     return mask;
 855   }
 856
 857   void Set(cec_logical_address address)
 858   {
 859     if (primary == CECDEVICE_UNKNOWN)
 860       primary = address;
 861
 862     addresses[(int) address] = 1;
 863   }
 864
 865   void Unset(cec_logical_address address)
 866   {
 867     if (primary == address)
 868       primary = CECDEVICE_UNKNOWN;
 869
 870     addresses[(int) address] = 0;
 871   }
 872
 873   bool IsSet(cec_logical_address address) const { return addresses[(int) address] == 1; }
 874   bool operator[](uint8_t pos) const { return pos < 16 ? IsSet((cec_logical_address) pos) : false; }
 875 #endif
 876 } cec_logical_addresses;
 877
 878
 879 typedef int (CEC_CDECL* CBCecLogMessageType)(void *param, const CEC::cec_log_message &);
 880 typedef int (CEC_CDECL* CBCecKeyPressType)(void *param, const cec_keypress &key);
 881 typedef int (CEC_CDECL* CBCecCommandType)(void *param, const cec_command &command);
 882
 883 typedef struct ICECCallbacks
 884 {
 885   /*!
 886    * @brief Transfer a log message from libCEC to the client.
 887    * @param message The message to transfer.
 888    * @return 1 when ok, 0 otherwise.
 889    */
 890   CBCecLogMessageType CBCecLogMessage;
 891
 892   /*!
 893    * @brief Transfer a keypress from libCEC to the client.
 894    * @param key The keypress to transfer.
 895    * @return 1 when ok, 0 otherwise.
 896    */
 897   CBCecKeyPressType CBCecKeyPress;
 898
 899   /*!
 900    * @brief Transfer a CEC command from libCEC to the client.
 901    * @param command The command to transfer.
 902    * @return 1 when ok, 0 otherwise.
 903    */
 904   CBCecCommandType CBCecCommand;
 905 } ICECCallbacks;
 906
 907 #ifdef UNUSED
 908 #elif defined(__GNUC__)
 909 #define UNUSED(x) UNUSED_ ## x __attribute__((unused))
 910 #elif defined(__LCLINT__)
 911 #define UNUSED(x) /*@unused@*/ x
 912 #else
 913 #define UNUSED(x) x
 914 #endif
 915
 916 #ifdef __cplusplus
 917 };
 918 };
 919 #endif
 920
 921 #endif /* CECTYPES_H_ */