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