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