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