cec: added vendor code for pioneer
[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
145typedef enum
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
153} ECecDeviceType;
154
1969b140 155typedef enum cec_display_control
acec5f48
LOK
156{
157 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME = 0x00,
158 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED = 0x40,
159 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE = 0x80,
160 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE = 0xC0
1969b140 161} cec_display_control;
acec5f48
LOK
162
163typedef enum
164{
165 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG = 4,
166 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS = 5
167} ECecExternalSourceSpecifier;
168
169typedef enum
170{
171 CEC_MENU_REQUEST_TYPE_ACTIVATE = 0,
172 CEC_MENU_REQUEST_TYPE_DEACTIVATE = 1,
173 CEC_MENU_REQUEST_TYPE_QUERY = 2
174} ECecMenuRequestType;
175
176typedef enum
177{
178 CEC_MENU_STATE_ACTIVATED = 0,
179 CEC_MENU_STATE_DEACTIVATED = 1
180} ECecMenuState;
181
182typedef enum
183{
184 CEC_PLAY_MODE_PLAY_FORWARD = 0x24,
185 CEC_PLAY_MODE_PLAY_REVERSE = 0x20,
186 CEC_PLAY_MODE_PLAY_STILL = 0x25,
187 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED = 0x05,
188 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED = 0x06,
189 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED = 0x07,
190 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED = 0x09,
191 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED = 0x0A,
192 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED = 0x0B,
193 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED = 0x15,
194 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED = 0x16,
195 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED = 0x17,
196 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED = 0x19,
197 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED = 0x1A,
198 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED = 0x1B
199} ECecPlayMode;
200
e55f3f70 201typedef enum cec_power_status
acec5f48
LOK
202{
203 CEC_POWER_STATUS_ON = 0x00,
204 CEC_POWER_STATUS_STANDBY = 0x01,
205 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON = 0x02,
e55f3f70
LOK
206 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY = 0x03,
207 CEC_POWER_STATUS_UNKNOWN = 0x99
208} cec_power_status;
acec5f48
LOK
209
210typedef enum
211{
212 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE = 1,
213 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE = 2,
214 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE = 3,
215 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS = 4,
216 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS = 5
217} ECecRecordSourceType;
218
219typedef enum
220{
221 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE = 0x01,
222 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE = 0x02,
223 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE = 0x03,
224 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT = 0x04,
225 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE = 0x05,
226 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE = 0x06,
227 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE = 0x07,
228 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER = 0x09,
229 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS = 0x0A,
230 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED = 0x0B,
231 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS = 0x0C,
232 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE = 0x0D,
233 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED = 0x0E,
234 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA = 0x10,
235 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING = 0x11,
236 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING = 0x12,
237 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED = 0x13,
238 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL = 0x14,
239 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM = 0x15,
240 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE = 0x16,
241 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON = 0x17,
242 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY = 0x1A,
243 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED = 0x1B,
244 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON = 0x1F
245} ECecRecordStatusInfo;
246
247typedef enum
248{
249 CEC_RECORDING_SEQUENCE_SUNDAY = 0x01,
250 CEC_RECORDING_SEQUENCE_MONDAY = 0x02,
251 CEC_RECORDING_SEQUENCE_TUESDAY = 0x04,
252 CEC_RECORDING_SEQUENCE_WEDNESDAY = 0x08,
253 CEC_RECORDING_SEQUENCE_THURSDAY = 0x10,
254 CEC_RECORDING_SEQUENCE_FRIDAY = 0x20,
255 CEC_RECORDING_SEQUENCE_SATURDAY = 0x40,
256 CEC_RECORDING_SEQUENCE_ONCE_ONLY = 0x00
257} ECecRecordingSequence;
258
259typedef enum
260{
261 CEC_STATUS_REQUEST_ON = 1,
262 CEC_STATUS_REQUEST_OFF = 2,
263 CEC_STATUS_REQUEST_ONCE = 3
264} ECecStatusRequest;
265
266typedef enum
267{
268 CEC_SYSTEM_AUDIO_STATUS_OFF = 0,
269 CEC_SYSTEM_AUDIO_STATUS_ON = 1
270} ECecSystemAudioStatus;
271
272typedef enum
273{
274 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING = 0x00,
275 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING = 0x01,
276 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE = 0x02,
277 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED = 0x80
278} ECecTimerClearedStatusData;
279
280typedef enum
281{
282 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP = 0,
283 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP = 1
284} ECecTimerOverlapWarning;
285
286typedef enum
287{
288 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED = 0x00,
289 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED = 0x01,
290 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT = 0x02,
291 CEC_MEDIA_INFO_FUTURE_USE = 0x03
292} ECecMediaInfo;
293
294typedef enum
295{
296 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED = 0,
297 CEC_PROGRAMMED_INDICATOR_PROGRAMMED = 1
298} ECecProgrammedIndicator;
299
300typedef enum
301{
302 CEC_PROGRAMMED_INFO_FUTURE_USE = 0x0,
303 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x08,
304 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING = 0x09,
305 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE = 0x0B,
306 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE = 0x0A
307} ECecProgrammedInfo;
308
309typedef enum
310{
311 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE = 0x0,
312 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE = 0x01,
313 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE = 0x02,
314 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR = 0x03,
315 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER = 0x04,
316 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS = 0x05,
317 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED = 0x06,
318 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS = 0x07,
319 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION = 0x08,
320 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON = 0x09,
321 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE = 0x0A,
322 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START = 0x0B,
323 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END = 0x0D,
324 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED = 0x0E
325} ECecNotProgrammedErrorInfo;
326
327typedef enum
328{
329 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING = 0,
330 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING = 1
331} ECecRecordingFlag;
332
333typedef enum
334{
335 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER = 0,
336 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER = 1,
337 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER = 2
338} ECecTunerDisplayInfo;
339
340
341typedef enum
342{
343 CEC_BROADCAST_SYSTEM_PAL_B_G = 0,
344 CEC_BROADCAST_SYSTEM_SECAM_L1 = 1,
345 CEC_BROADCAST_SYSTEM_PAL_M = 2,
346 CEC_BROADCAST_SYSTEM_NTSC_M = 3,
347 CEC_BROADCAST_SYSTEM_PAL_I = 4,
348 CEC_BROADCAST_SYSTEM_SECAM_DK = 5,
349 CEC_BROADCAST_SYSTEM_SECAM_B_G = 6,
350 CEC_BROADCAST_SYSTEM_SECAM_L2 = 7,
351 CEC_BROADCAST_SYSTEM_PAL_DK = 8,
352 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM = 30
353} ECecBroadcastSystem;
354
355typedef enum cec_user_control_code
356{
357 CEC_USER_CONTROL_CODE_SELECT = 0x00,
358 CEC_USER_CONTROL_CODE_UP = 0x01,
359 CEC_USER_CONTROL_CODE_DOWN = 0x02,
360 CEC_USER_CONTROL_CODE_LEFT = 0x03,
361 CEC_USER_CONTROL_CODE_RIGHT = 0x04,
362 CEC_USER_CONTROL_CODE_RIGHT_UP = 0x05,
363 CEC_USER_CONTROL_CODE_RIGHT_DOWN = 0x06,
364 CEC_USER_CONTROL_CODE_LEFT_UP = 0x07,
365 CEC_USER_CONTROL_CODE_LEFT_DOWN = 0x08,
366 CEC_USER_CONTROL_CODE_ROOT_MENU = 0x09,
367 CEC_USER_CONTROL_CODE_SETUP_MENU = 0x0A,
368 CEC_USER_CONTROL_CODE_CONTENTS_MENU = 0x0B,
369 CEC_USER_CONTROL_CODE_FAVORITE_MENU = 0x0C,
370 CEC_USER_CONTROL_CODE_EXIT = 0x0D,
371 CEC_USER_CONTROL_CODE_NUMBER0 = 0x20,
372 CEC_USER_CONTROL_CODE_NUMBER1 = 0x21,
373 CEC_USER_CONTROL_CODE_NUMBER2 = 0x22,
374 CEC_USER_CONTROL_CODE_NUMBER3 = 0x23,
375 CEC_USER_CONTROL_CODE_NUMBER4 = 0x24,
376 CEC_USER_CONTROL_CODE_NUMBER5 = 0x25,
377 CEC_USER_CONTROL_CODE_NUMBER6 = 0x26,
378 CEC_USER_CONTROL_CODE_NUMBER7 = 0x27,
379 CEC_USER_CONTROL_CODE_NUMBER8 = 0x28,
380 CEC_USER_CONTROL_CODE_NUMBER9 = 0x29,
381 CEC_USER_CONTROL_CODE_DOT = 0x2A,
382 CEC_USER_CONTROL_CODE_ENTER = 0x2B,
383 CEC_USER_CONTROL_CODE_CLEAR = 0x2C,
384 CEC_USER_CONTROL_CODE_NEXT_FAVORITE = 0x2F,
385 CEC_USER_CONTROL_CODE_CHANNEL_UP = 0x30,
386 CEC_USER_CONTROL_CODE_CHANNEL_DOWN = 0x31,
387 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL = 0x32,
388 CEC_USER_CONTROL_CODE_SOUND_SELECT = 0x33,
389 CEC_USER_CONTROL_CODE_INPUT_SELECT = 0x34,
390 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION = 0x35,
391 CEC_USER_CONTROL_CODE_HELP = 0x36,
392 CEC_USER_CONTROL_CODE_PAGE_UP = 0x37,
393 CEC_USER_CONTROL_CODE_PAGE_DOWN = 0x38,
394 CEC_USER_CONTROL_CODE_POWER = 0x40,
395 CEC_USER_CONTROL_CODE_VOLUME_UP = 0x41,
396 CEC_USER_CONTROL_CODE_VOLUME_DOWN = 0x42,
397 CEC_USER_CONTROL_CODE_MUTE = 0x43,
398 CEC_USER_CONTROL_CODE_PLAY = 0x44,
399 CEC_USER_CONTROL_CODE_STOP = 0x45,
400 CEC_USER_CONTROL_CODE_PAUSE = 0x46,
401 CEC_USER_CONTROL_CODE_RECORD = 0x47,
402 CEC_USER_CONTROL_CODE_REWIND = 0x48,
403 CEC_USER_CONTROL_CODE_FAST_FORWARD = 0x49,
404 CEC_USER_CONTROL_CODE_EJECT = 0x4A,
405 CEC_USER_CONTROL_CODE_FORWARD = 0x4B,
406 CEC_USER_CONTROL_CODE_BACKWARD = 0x4C,
407 CEC_USER_CONTROL_CODE_STOP_RECORD = 0x4D,
408 CEC_USER_CONTROL_CODE_PAUSE_RECORD = 0x4E,
409 CEC_USER_CONTROL_CODE_ANGLE = 0x50,
410 CEC_USER_CONTROL_CODE_SUB_PICTURE = 0x51,
411 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND = 0x52,
412 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE = 0x53,
413 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING = 0x54,
414 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION = 0x55,
415 CEC_USER_CONTROL_CODE_PLAY_FUNCTION = 0x60,
416 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION = 0x61,
417 CEC_USER_CONTROL_CODE_RECORD_FUNCTION = 0x62,
418 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION = 0x63,
419 CEC_USER_CONTROL_CODE_STOP_FUNCTION = 0x64,
420 CEC_USER_CONTROL_CODE_MUTE_FUNCTION = 0x65,
421 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION = 0x66,
422 CEC_USER_CONTROL_CODE_TUNE_FUNCTION = 0x67,
423 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION = 0x68,
424 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION = 0x69,
425 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION = 0x6A,
426 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION = 0x6B,
427 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION = 0x6C,
428 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION = 0x6D,
429 CEC_USER_CONTROL_CODE_F1_BLUE = 0x71,
430 CEC_USER_CONTROL_CODE_F2_RED = 0X72,
431 CEC_USER_CONTROL_CODE_F3_GREEN = 0x73,
432 CEC_USER_CONTROL_CODE_F4_YELLOW = 0x74,
433 CEC_USER_CONTROL_CODE_F5 = 0x75,
434 CEC_USER_CONTROL_CODE_DATA = 0x76,
435 CEC_USER_CONTROL_CODE_MAX = 0x76,
436 CEC_USER_CONTROL_CODE_UNKNOWN
437} cec_user_control_code;
438
e36035ad
LOK
439typedef enum cec_an_user_control_code
440{
441 CEC_AN_USER_CONTROL_CODE_RETURN = 0x91
442} cec_an_user_control_code;
443
acec5f48
LOK
444typedef enum cec_logical_address
445{
446 CECDEVICE_UNKNOWN = -1, //not a valid logical address
447 CECDEVICE_TV,
448 CECDEVICE_RECORDINGDEVICE1,
449 CECDEVICE_RECORDINGDEVICE2,
450 CECDEVICE_TUNER1,
451 CECDEVICE_PLAYBACKDEVICE1,
452 CECDEVICE_AUDIOSYSTEM,
453 CECDEVICE_TUNER2,
454 CECDEVICE_TUNER3,
455 CECDEVICE_PLAYBACKDEVICE2,
456 CECDEVICE_RECORDINGDEVICE3,
457 CECDEVICE_TUNER4,
458 CECDEVICE_PLAYBACKDEVICE3,
459 CECDEVICE_RESERVED1,
460 CECDEVICE_RESERVED2,
461 CECDEVICE_FREEUSE,
462 CECDEVICE_UNREGISTERED = 15,
463 CECDEVICE_BROADCAST = 15
464} cec_logical_address;
465
466typedef enum cec_opcode
467{
468 CEC_OPCODE_ACTIVE_SOURCE = 0x82,
469 CEC_OPCODE_IMAGE_VIEW_ON = 0x04,
470 CEC_OPCODE_TEXT_VIEW_ON = 0x0D,
471 CEC_OPCODE_INACTIVE_SOURCE = 0x9D,
472 CEC_OPCODE_REQUEST_ACTIVE_SOURCE = 0x85,
473 CEC_OPCODE_ROUTING_CHANGE = 0x80,
474 CEC_OPCODE_ROUTING_INFORMATION = 0x81,
475 CEC_OPCODE_SET_STREAM_PATH = 0x86,
476 CEC_OPCODE_STANDBY = 0x36,
477 CEC_OPCODE_RECORD_OFF = 0x0B,
478 CEC_OPCODE_RECORD_ON = 0x09,
479 CEC_OPCODE_RECORD_STATUS = 0x0A,
480 CEC_OPCODE_RECORD_TV_SCREEN = 0x0F,
481 CEC_OPCODE_CLEAR_ANALOGUE_TIMER = 0x33,
482 CEC_OPCODE_CLEAR_DIGITAL_TIMER = 0x99,
483 CEC_OPCODE_CLEAR_EXTERNAL_TIMER = 0xA1,
484 CEC_OPCODE_SET_ANALOGUE_TIMER = 0x34,
485 CEC_OPCODE_SET_DIGITAL_TIMER = 0x97,
486 CEC_OPCODE_SET_EXTERNAL_TIMER = 0xA2,
487 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE = 0x67,
488 CEC_OPCODE_TIMER_CLEARED_STATUS = 0x43,
489 CEC_OPCODE_TIMER_STATUS = 0x35,
490 CEC_OPCODE_CEC_VERSION = 0x9E,
491 CEC_OPCODE_GET_CEC_VERSION = 0x9F,
492 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS = 0x83,
493 CEC_OPCODE_GET_MENU_LANGUAGE = 0x91,
494 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS = 0x84,
495 CEC_OPCODE_SET_MENU_LANGUAGE = 0x32,
496 CEC_OPCODE_DECK_CONTROL = 0x42,
497 CEC_OPCODE_DECK_STATUS = 0x1B,
498 CEC_OPCODE_GIVE_DECK_STATUS = 0x1A,
499 CEC_OPCODE_PLAY = 0x41,
500 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS = 0x08,
501 CEC_OPCODE_SELECT_ANALOGUE_SERVICE = 0x92,
502 CEC_OPCODE_SELECT_DIGITAL_SERVICE = 0x93,
503 CEC_OPCODE_TUNER_DEVICE_STATUS = 0x07,
504 CEC_OPCODE_TUNER_STEP_DECREMENT = 0x06,
505 CEC_OPCODE_TUNER_STEP_INCREMENT = 0x05,
506 CEC_OPCODE_DEVICE_VENDOR_ID = 0x87,
507 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID = 0x8C,
508 CEC_OPCODE_VENDOR_COMMAND = 0x89,
509 CEC_OPCODE_VENDOR_COMMAND_WITH_ID = 0xA0,
510 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN = 0x8A,
511 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP = 0x8B,
512 CEC_OPCODE_SET_OSD_STRING = 0x64,
513 CEC_OPCODE_GIVE_OSD_NAME = 0x46,
514 CEC_OPCODE_SET_OSD_NAME = 0x47,
515 CEC_OPCODE_MENU_REQUEST = 0x8D,
516 CEC_OPCODE_MENU_STATUS = 0x8E,
517 CEC_OPCODE_USER_CONTROL_PRESSED = 0x44,
518 CEC_OPCODE_USER_CONTROL_RELEASE = 0x45,
519 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS = 0x8F,
520 CEC_OPCODE_REPORT_POWER_STATUS = 0x90,
521 CEC_OPCODE_FEATURE_ABORT = 0x00,
522 CEC_OPCODE_ABORT = 0xFF,
523 CEC_OPCODE_GIVE_AUDIO_STATUS = 0x71,
524 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS = 0x7D,
525 CEC_OPCODE_REPORT_AUDIO_STATUS = 0x7A,
526 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE = 0x72,
527 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST = 0x70,
528 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS = 0x7E,
529 CEC_OPCODE_SET_AUDIO_RATE = 0x9A
530} cec_opcode;
531
532typedef enum cec_log_level
533{
941c58b9
LOK
534 CEC_LOG_ERROR = 1,
535 CEC_LOG_WARNING = 2,
536 CEC_LOG_NOTICE = 4,
537 CEC_LOG_TRAFFIC = 8,
538 CEC_LOG_DEBUG = 16,
539 CEC_LOG_ALL = 31
acec5f48
LOK
540} cec_log_level;
541
a3269a0a
LOK
542typedef struct cec_menu_language
543{
544 char language[4];
545 cec_logical_address device;
546} cec_menu_language;
547
acec5f48
LOK
548typedef struct cec_log_message
549{
550 char message[1024];
551 cec_log_level level;
552 int64_t time;
553} cec_log_message;
554
555typedef struct cec_keypress
556{
557 cec_user_control_code keycode;
558 unsigned int duration;
559} cec_keypress;
560
561typedef struct cec_adapter
562{
563 char path[1024];
564 char comm[1024];
565} cec_adapter;
566
567typedef enum cec_adapter_messagecode
568{
569 MSGCODE_NOTHING = 0,
570 MSGCODE_PING,
571 MSGCODE_TIMEOUT_ERROR,
572 MSGCODE_HIGH_ERROR,
573 MSGCODE_LOW_ERROR,
574 MSGCODE_FRAME_START,
575 MSGCODE_FRAME_DATA,
576 MSGCODE_RECEIVE_FAILED,
577 MSGCODE_COMMAND_ACCEPTED,
578 MSGCODE_COMMAND_REJECTED,
579 MSGCODE_SET_ACK_MASK,
580 MSGCODE_TRANSMIT,
581 MSGCODE_TRANSMIT_EOM,
582 MSGCODE_TRANSMIT_IDLETIME,
583 MSGCODE_TRANSMIT_ACK_POLARITY,
584 MSGCODE_TRANSMIT_LINE_TIMEOUT,
585 MSGCODE_TRANSMIT_SUCCEEDED,
586 MSGCODE_TRANSMIT_FAILED_LINE,
587 MSGCODE_TRANSMIT_FAILED_ACK,
588 MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA,
589 MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE,
590 MSGCODE_FIRMWARE_VERSION,
591 MSGCODE_START_BOOTLOADER,
592 MSGCODE_FRAME_EOM = 0x80,
593 MSGCODE_FRAME_ACK = 0x40,
594} cec_adapter_messagecode;
595
596typedef struct cec_datapacket
597{
598 uint8_t data[100];
599 uint8_t size;
600
601#ifdef __cplusplus
60a245d1
LOK
602 cec_datapacket &operator =(const struct cec_datapacket &packet)
603 {
604 clear();
605 for (uint8_t iPtr = 0; iPtr < packet.size; iPtr++)
606 push_back(packet[iPtr]);
607
608 return *this;
609 }
610
acec5f48
LOK
611 bool empty(void) const { return size == 0; }
612 bool full(void) const { return size == 100; }
613 uint8_t operator[](uint8_t pos) const { return pos < size ? data[pos] : 0; }
614 uint8_t at(uint8_t pos) const { return pos < size ? data[pos] : 0; }
615
616 void shift(uint8_t iShiftBy)
617 {
618 if (iShiftBy >= size)
619 {
620 clear();
621 }
622 else
623 {
624 for (uint8_t iPtr = 0; iPtr < size; iPtr++)
625 data[iPtr] = (iPtr + iShiftBy < size) ? data[iPtr + iShiftBy] : 0;
626 size = (uint8_t) (size - iShiftBy);
627 }
628 }
629
630 void push_back(uint8_t add)
631 {
632 if (size < 100)
633 data[size++] = add;
634 }
635
636 void clear(void)
637 {
638 memset(data, 0, sizeof(data));
639 size = 0;
640 }
641#endif
642
643} cec_datapacket;
644
acec5f48
LOK
645typedef struct cec_command
646{
647 cec_logical_address initiator;
648 cec_logical_address destination;
02ee2c68
LOK
649 int8_t ack;
650 int8_t eom;
acec5f48
LOK
651 cec_opcode opcode;
652 cec_datapacket parameters;
02ee2c68 653 int8_t opcode_set;
1f0e9e0f 654 int32_t transmit_timeout;
acec5f48
LOK
655
656#ifdef __cplusplus
60a245d1
LOK
657 cec_command &operator =(const struct cec_command &command)
658 {
659 initiator = command.initiator;
660 destination = command.destination;
661 ack = command.ack;
662 eom = command.eom;
663 opcode = command.opcode;
664 opcode_set = command.opcode_set;
665 transmit_timeout = command.transmit_timeout;
666 parameters = command.parameters;
667
668 return *this;
669 }
670
acec5f48
LOK
671 static void format(cec_command &command, cec_logical_address initiator, cec_logical_address destination, cec_opcode opcode)
672 {
673 command.clear();
1f0e9e0f
LOK
674 command.initiator = initiator;
675 command.destination = destination;
676 command.opcode = opcode;
677 command.opcode_set = 1;
acec5f48
LOK
678 }
679
680 void push_back(uint8_t data)
681 {
b2da2768
LOK
682 if (initiator == CECDEVICE_UNKNOWN && destination == CECDEVICE_UNKNOWN)
683 {
684 initiator = (cec_logical_address) (data >> 4);
685 destination = (cec_logical_address) (data & 0xF);
686 }
687 else if (!opcode_set)
acec5f48 688 {
02ee2c68 689 opcode_set = 1;
acec5f48
LOK
690 opcode = (cec_opcode) data;
691 }
692 else
693 parameters.push_back(data);
694 }
695
696 void clear(void)
697 {
1f0e9e0f
LOK
698 initiator = CECDEVICE_UNKNOWN;
699 destination = CECDEVICE_UNKNOWN;
700 ack = 0;
701 eom = 0;
702 opcode_set = 0;
703 opcode = CEC_OPCODE_FEATURE_ABORT;
704 transmit_timeout = 1000;
acec5f48
LOK
705 parameters.clear();
706 };
707#endif
708} cec_command;
709
710typedef enum cec_vendor_id
711{
bb5b4874
LOK
712 CEC_VENDOR_SAMSUNG = 0x00F0,
713 CEC_VENDOR_LG = 0xE091,
714 CEC_VENDOR_PANASONIC = 0x8045,
e6e63f5d 715 CEC_VENDOR_PIONEER = 0xE036,
bb5b4874 716 CEC_VENDOR_UNKNOWN = 0
0500da96
LOK
717} cec_vendor_id;
718
719typedef struct cec_vendor
720{
721 const char *AsString(void) const
722 {
723 switch (vendor)
724 {
725 case CEC_VENDOR_SAMSUNG:
726 return "Samsung";
727 case CEC_VENDOR_LG:
bb5b4874
LOK
728 return "LG";
729 case CEC_VENDOR_PANASONIC:
730 return "Panasonic";
e6e63f5d
LOK
731 case CEC_VENDOR_PIONEER:
732 return "Pioneer";
0500da96
LOK
733 default:
734 return "Unknown";
735 }
736 }
737
738 cec_vendor_id vendor;
739} cec_vendor;
acec5f48 740
2492216a 741//default physical address 1.0.0.0, HDMI port 1
acec5f48
LOK
742#define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
743#define MSGSTART 0xFF
744#define MSGEND 0xFE
745#define MSGESC 0xFD
746#define ESCOFFSET 3
eafd9bed
LOK
747#define CEC_BUTTON_TIMEOUT 500
748
d75be19b
LOK
749#define CEC_MIN_LIB_VERSION 1
750#define CEC_LIB_VERSION_MAJOR 1
751#define CEC_LIB_VERSION_MINOR 0
acec5f48
LOK
752
753#ifdef __cplusplus
754};
755};
756#endif
757
758#endif /* CECTYPES_H_ */