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