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 typedef enum
  35 {
  36   CEC_ABORT_REASON_UNRECOGNIZED_OPCODE = 0,
  37   CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND = 1,
  38   CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE = 2,
  39   CEC_ABORT_REASON_INVALID_OPERAND = 3,
  40   CEC_ABORT_REASON_REFUSED = 4
  41 } ECecAbortReason;
  42
  43 typedef enum
  44 {
  45   CEC_ANALOGUE_BROADCAST_TYPE_CABLE = 0x00,
  46   CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE = 0x01,
  47   CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL = 0x02
  48 } ECecAnalogueBroadcastType;
  49
  50 typedef enum
  51 {
  52   CEC_AUDIO_RATE_RATE_CONTROL_OFF = 0,
  53   CEC_AUDIO_RATE_STANDARD_RATE_100 = 1,
  54   CEC_AUDIO_RATE_FAST_RATE_MAX_101 = 2,
  55   CEC_AUDIO_RATE_SLOW_RATE_MIN_99 = 3,
  56   CEC_AUDIO_RATE_STANDARD_RATE_100_0 = 4,
  57   CEC_AUDIO_RATE_FAST_RATE_MAX_100_1 = 5,
  58   CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9 = 6
  59 } ECecAudioRate;
  60
  61 typedef enum
  62 {
  63   CEC_AUDIO_MUTE_STATUS_MASK = 0x80,
  64   CEC_AUDIO_VOLUME_STATUS_MASK = 0x7F,
  65   CEC_AUDIO_VOLUME_MIN = 0x00,
  66   CEC_AUDIO_VOLUME_MAX = 0x64,
  67   CEC_AUDIO_VOLUME_STATUS_UNKNOWN = 0x7F
  68 } ECecAudioStatus;
  69
  70 typedef enum
  71 {
  72   CEC_FALSE = 0,
  73   CEC_TRUE = 1
  74 } ECecBoolean;
  75
  76 typedef enum
  77 {
  78   CEC_VERSION_1_2 = 0x01,
  79   CEC_VERSION_1_2A = 0x02,
  80   CEC_VERSION_1_3 = 0x03,
  81   CEC_VERSION_1_3A = 0x04
  82 } ECecVersion;
  83
  84 typedef enum
  85 {
  86   CEC_CHANNEL_NUMBER_FORMAT_MASK = 0xFC000000,
  87   CEC_1_PART_CHANNEL_NUMBER = 0x04000000,
  88   CEC_2_PART_CHANNEL_NUMBER = 0x08000000,
  89   CEC_MAJOR_CHANNEL_NUMBER_MASK = 0x3FF0000,
  90   CEC_MINOR_CHANNEL_NUMBER_MASK = 0xFFFF
  91 } ECecChannelIdentifier;
  92
  93 typedef enum
  94 {
  95   CEC_DESK_CONTROL_MODE_SKIP_FORWARD_WIND = 1,
  96   CEC_DESK_CONTROL_MODE_SKIP_REVERSE_REWIND = 2,
  97   CEC_DESK_CONTROL_MODE_STOP = 3,
  98   CEC_DESK_CONTROL_MODE_EJECT = 4
  99 } ECecDeskControlMode;
 100
 101 typedef enum
 102 {
 103   CEC_DECK_INFO_PLAY = 0x11,
 104   CEC_DECK_INFO_RECORD = 0x12,
 105   CEC_DECK_INFO_PLAY_REVERSE = 0x13,
 106   CEC_DECK_INFO_STILL = 0x14,
 107   CEC_DECK_INFO_SLOW = 0x15,
 108   CEC_DECK_INFO_SLOW_REVERSE = 0x16,
 109   CEC_DECK_INFO_FAST_FORWARD = 0x17,
 110   CEC_DECK_INFO_FAST_REVERSE = 0x18,
 111   CEC_DECK_INFO_NO_MEDIA = 0x19,
 112   CEC_DECK_INFO_STOP = 0x1A,
 113   CEC_DECK_INFO_SKIP_FORWARD_WIND = 0x1B,
 114   CEC_DECK_INFO_SKIP_REVERSE_REWIND = 0x1C,
 115   CEC_DECK_INFO_INDEX_SEARCH_FORWARD = 0x1D,
 116   CEC_DECK_INFO_INDEX_SEARCH_REVERSE = 0x1E,
 117   CEC_DECK_INFO_OTHER_STATUS = 0x1F
 118 } ECecDeckInfo;
 119
 120 typedef enum
 121 {
 122   CEC_DEVICE_TYPE_TV = 0,
 123   CEC_DEVICE_TYPE_RECORDING_DEVICE = 1,
 124   CEC_DEVICE_TYPE_RESERVED = 2,
 125   CEC_DEVICE_TYPE_TUNER = 3,
 126   CEC_DEVICE_TYPE_PLAYBACK_DEVICE = 4,
 127   CEC_DEVICE_TYPE_AUDIO_SYSTEM = 5
 128 } ECecDeviceType;
 129
 130 typedef enum
 131 {
 132   CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
 133   CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
 134   CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
 135   CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
 136 } ECecDisplayControl;
 137
 138 typedef enum
 139 {
 140   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
 141   CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
 142 } ECecExternalSourceSpecifier;
 143
 144 typedef enum
 145 {
 146   CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
 147   CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
 148   CEC_MENU_REQUEST_TYPE_QUERY = 2
 149 } ECecMenuRequestType;
 150
 151 typedef enum
 152 {
 153   CEC_MENU_STATE_ACTIVATED = 0,
 154   CEC_MENU_STATE_DEACTIVATED = 1
 155 } ECecMenuState;
 156
 157 typedef enum
 158 {
 159   CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
 160   CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
 161   CEC_PLAY_MODE_PLAY_STILL = 0x25,
 162   CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
 163   CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
 164   CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
 165   CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
 166   CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
 167   CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
 168   CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
 169   CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
 170   CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
 171   CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
 172   CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
 173   CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
 174 } ECecPlayMode;
 175
 176 typedef enum
 177 {
 178   CEC_POWER_STATUS_ON = 0x00,
 179   CEC_POWER_STATUS_STANDBY = 0x01,
 180   CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
 181   CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03
 182 } ECecPowerStatus;
 183
 184 typedef enum
 185 {
 186   CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
 187   CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
 188   CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
 189   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
 190   CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
 191 } ECecRecordSourceType;
 192
 193 typedef enum
 194 {
 195   CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
 196   CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
 197   CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
 198   CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
 199   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
 200   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
 201   CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
 202   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
 203   CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
 204   CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
 205   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
 206   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
 207   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
 208   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
 209   CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
 210   CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
 211   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
 212   CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
 213   CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
 214   CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
 215   CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
 216   CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
 217   CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
 218   CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
 219 } ECecRecordStatusInfo;
 220
 221 typedef enum
 222 {
 223   CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
 224   CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
 225   CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
 226   CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
 227   CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
 228   CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
 229   CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
 230   CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
 231 } ECecRecordingSequence;
 232
 233 typedef enum
 234 {
 235   CEC_STATUS_REQUEST_ON = 1,
 236   CEC_STATUS_REQUEST_OFF = 2,
 237   CEC_STATUS_REQUEST_ONCE = 3
 238 } ECecStatusRequest;
 239
 240 typedef enum
 241 {
 242   CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
 243   CEC_SYSTEM_AUDIO_STATUS_ON = 1
 244 } ECecSystemAudioStatus;
 245
 246 typedef enum
 247 {
 248   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
 249   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
 250   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
 251   CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
 252 } ECecTimerClearedStatusData;
 253
 254 typedef enum
 255 {
 256   CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
 257   CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
 258 } ECecTimerOverlapWarning;
 259
 260 typedef enum
 261 {
 262   CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
 263   CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
 264   CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
 265   CEC_MEDIA_INFO_FUTURE_USE = 0x03
 266 } ECecMediaInfo;
 267
 268 typedef enum
 269 {
 270   CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
 271   CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
 272 } ECecProgrammedIndicator;
 273
 274 typedef enum
 275 {
 276   CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
 277   CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
 278   CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
 279   CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
 280   CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
 281 } ECecProgrammedInfo;
 282
 283 typedef enum
 284 {
 285   CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
 286   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
 287   CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
 288   CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
 289   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
 290   CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
 291   CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
 292   CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
 293   CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
 294   CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
 295   CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
 296   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
 297   CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
 298   CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
 299 } ECecNotProgrammedErrorInfo;
 300
 301 typedef enum
 302 {
 303   CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
 304   CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
 305 } ECecRecordingFlag;
 306
 307 typedef enum
 308 {
 309   CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
 310   CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
 311   CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
 312 } ECecTunerDisplayInfo;
 313
 314
 315 typedef enum
 316 {
 317   CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
 318   CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
 319   CEC_BROADCAST_SYSTEM_PAL_M = 2,
 320   CEC_BROADCAST_SYSTEM_NTSC_M = 3,
 321   CEC_BROADCAST_SYSTEM_PAL_I = 4,
 322   CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
 323   CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
 324   CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
 325   CEC_BROADCAST_SYSTEM_PAL_DK = 8,
 326   CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
 327 } ECecBroadcastSystem;
 328
 329 #define MSGSTART                     0xFF
 330 #define MSGEND                       0xFE
 331 #define MSGESC                       0xFD
 332 #define ESCOFFSET                    3