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