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