3 * This file is part of the libCEC(R) library.
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
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.
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.
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.
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
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/
40 #if !defined(DECLSPEC)
41 #if defined(_WIN32) || defined(_WIN64)
43 #if defined DLL_EXPORT
44 #define DECLSPEC __declspec(dllexport)
46 #define DECLSPEC __declspec(dllimport)
58 //default physical address 1.0.0.0, HDMI port 1
59 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
64 #define CEC_BUTTON_TIMEOUT 500
66 #define CEC_MIN_LIB_VERSION 1
67 #define CEC_LIB_VERSION_MAJOR 1
68 #define CEC_LIB_VERSION_MINOR 2
70 typedef enum cec_abort_reason
72 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
= 0,
73 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
= 1,
74 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
= 2,
75 CEC_ABORT_REASON_INVALID_OPERAND
= 3,
76 CEC_ABORT_REASON_REFUSED
= 4
79 typedef enum cec_analogue_broadcast_type
81 CEC_ANALOGUE_BROADCAST_TYPE_CABLE
= 0x00,
82 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE
= 0x01,
83 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL
= 0x02
84 } cec_analogue_broadcast_type
;
86 typedef enum cec_audio_rate
88 CEC_AUDIO_RATE_RATE_CONTROL_OFF
= 0,
89 CEC_AUDIO_RATE_STANDARD_RATE_100
= 1,
90 CEC_AUDIO_RATE_FAST_RATE_MAX_101
= 2,
91 CEC_AUDIO_RATE_SLOW_RATE_MIN_99
= 3,
92 CEC_AUDIO_RATE_STANDARD_RATE_100_0
= 4,
93 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1
= 5,
94 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9
= 6
97 typedef enum cec_audio_status
99 CEC_AUDIO_MUTE_STATUS_MASK
= 0x80,
100 CEC_AUDIO_VOLUME_STATUS_MASK
= 0x7F,
101 CEC_AUDIO_VOLUME_MIN
= 0x00,
102 CEC_AUDIO_VOLUME_MAX
= 0x64,
103 CEC_AUDIO_VOLUME_STATUS_UNKNOWN
= 0x7F
106 typedef enum cec_boolean
112 typedef enum cec_version
114 CEC_VERSION_UNKNOWN
= 0x00,
115 CEC_VERSION_1_2
= 0x01,
116 CEC_VERSION_1_2A
= 0x02,
117 CEC_VERSION_1_3
= 0x03,
118 CEC_VERSION_1_3A
= 0x04,
119 CEC_VERSION_1_4
= 0x05
122 typedef enum cec_channel_identifier
124 CEC_CHANNEL_NUMBER_FORMAT_MASK
= 0xFC000000,
125 CEC_1_PART_CHANNEL_NUMBER
= 0x04000000,
126 CEC_2_PART_CHANNEL_NUMBER
= 0x08000000,
127 CEC_MAJOR_CHANNEL_NUMBER_MASK
= 0x3FF0000,
128 CEC_MINOR_CHANNEL_NUMBER_MASK
= 0xFFFF
129 } cec_channel_identifier
;
131 typedef enum cec_deck_control_mode
133 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND
= 1,
134 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND
= 2,
135 CEC_DECK_CONTROL_MODE_STOP
= 3,
136 CEC_DECK_CONTROL_MODE_EJECT
= 4
137 } cec_deck_control_mode
;
139 typedef enum cec_deck_info
141 CEC_DECK_INFO_PLAY
= 0x11,
142 CEC_DECK_INFO_RECORD
= 0x12,
143 CEC_DECK_INFO_PLAY_REVERSE
= 0x13,
144 CEC_DECK_INFO_STILL
= 0x14,
145 CEC_DECK_INFO_SLOW
= 0x15,
146 CEC_DECK_INFO_SLOW_REVERSE
= 0x16,
147 CEC_DECK_INFO_FAST_FORWARD
= 0x17,
148 CEC_DECK_INFO_FAST_REVERSE
= 0x18,
149 CEC_DECK_INFO_NO_MEDIA
= 0x19,
150 CEC_DECK_INFO_STOP
= 0x1A,
151 CEC_DECK_INFO_SKIP_FORWARD_WIND
= 0x1B,
152 CEC_DECK_INFO_SKIP_REVERSE_REWIND
= 0x1C,
153 CEC_DECK_INFO_INDEX_SEARCH_FORWARD
= 0x1D,
154 CEC_DECK_INFO_INDEX_SEARCH_REVERSE
= 0x1E,
155 CEC_DECK_INFO_OTHER_STATUS
= 0x1F
158 typedef enum cec_device_type
160 CEC_DEVICE_TYPE_TV
= 0,
161 CEC_DEVICE_TYPE_RECORDING_DEVICE
= 1,
162 CEC_DEVICE_TYPE_RESERVED
= 2,
163 CEC_DEVICE_TYPE_TUNER
= 3,
164 CEC_DEVICE_TYPE_PLAYBACK_DEVICE
= 4,
165 CEC_DEVICE_TYPE_AUDIO_SYSTEM
= 5
168 typedef enum cec_display_control
170 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME
= 0x00,
171 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED
= 0x40,
172 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE
= 0x80,
173 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE
= 0xC0
174 } cec_display_control
;
176 typedef enum cec_external_source_specifier
178 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG
= 4,
179 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS
= 5
180 } cec_external_source_specifier
;
182 typedef enum cec_menu_request_type
184 CEC_MENU_REQUEST_TYPE_ACTIVATE
= 0,
185 CEC_MENU_REQUEST_TYPE_DEACTIVATE
= 1,
186 CEC_MENU_REQUEST_TYPE_QUERY
= 2
187 } cec_menu_request_type
;
189 typedef enum cec_menu_state
191 CEC_MENU_STATE_ACTIVATED
= 0,
192 CEC_MENU_STATE_DEACTIVATED
= 1
195 typedef enum cec_play_mode
197 CEC_PLAY_MODE_PLAY_FORWARD
= 0x24,
198 CEC_PLAY_MODE_PLAY_REVERSE
= 0x20,
199 CEC_PLAY_MODE_PLAY_STILL
= 0x25,
200 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED
= 0x05,
201 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED
= 0x06,
202 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED
= 0x07,
203 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED
= 0x09,
204 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED
= 0x0A,
205 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED
= 0x0B,
206 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED
= 0x15,
207 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED
= 0x16,
208 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED
= 0x17,
209 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED
= 0x19,
210 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED
= 0x1A,
211 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED
= 0x1B
214 typedef enum cec_power_status
216 CEC_POWER_STATUS_ON
= 0x00,
217 CEC_POWER_STATUS_STANDBY
= 0x01,
218 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON
= 0x02,
219 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY
= 0x03,
220 CEC_POWER_STATUS_UNKNOWN
= 0x99
223 typedef enum cec_record_source_type
225 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE
= 1,
226 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE
= 2,
227 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE
= 3,
228 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS
= 4,
229 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS
= 5
230 } cec_record_source_type
;
232 typedef enum cec_record_status_info
234 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE
= 0x01,
235 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE
= 0x02,
236 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE
= 0x03,
237 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT
= 0x04,
238 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE
= 0x05,
239 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE
= 0x06,
240 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE
= 0x07,
241 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER
= 0x09,
242 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS
= 0x0A,
243 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED
= 0x0B,
244 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS
= 0x0C,
245 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE
= 0x0D,
246 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED
= 0x0E,
247 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA
= 0x10,
248 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING
= 0x11,
249 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING
= 0x12,
250 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED
= 0x13,
251 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL
= 0x14,
252 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM
= 0x15,
253 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE
= 0x16,
254 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON
= 0x17,
255 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY
= 0x1A,
256 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED
= 0x1B,
257 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON
= 0x1F
258 } cec_record_status_info
;
260 typedef enum cec_recording_sequence
262 CEC_RECORDING_SEQUENCE_SUNDAY
= 0x01,
263 CEC_RECORDING_SEQUENCE_MONDAY
= 0x02,
264 CEC_RECORDING_SEQUENCE_TUESDAY
= 0x04,
265 CEC_RECORDING_SEQUENCE_WEDNESDAY
= 0x08,
266 CEC_RECORDING_SEQUENCE_THURSDAY
= 0x10,
267 CEC_RECORDING_SEQUENCE_FRIDAY
= 0x20,
268 CEC_RECORDING_SEQUENCE_SATURDAY
= 0x40,
269 CEC_RECORDING_SEQUENCE_ONCE_ONLY
= 0x00
270 } cec_recording_sequence
;
272 typedef enum cec_status_request
274 CEC_STATUS_REQUEST_ON
= 1,
275 CEC_STATUS_REQUEST_OFF
= 2,
276 CEC_STATUS_REQUEST_ONCE
= 3
277 } cec_status_request
;
279 typedef enum cec_system_audio_status
281 CEC_SYSTEM_AUDIO_STATUS_OFF
= 0,
282 CEC_SYSTEM_AUDIO_STATUS_ON
= 1
283 } cec_system_audio_status
;
285 typedef enum cec_timer_cleared_status_data
287 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING
= 0x00,
288 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING
= 0x01,
289 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE
= 0x02,
290 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED
= 0x80
291 } cec_timer_cleared_status_data
;
293 typedef enum cec_timer_overlap_warning
295 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP
= 0,
296 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP
= 1
297 } cec_timer_overlap_warning
;
299 typedef enum cec_media_info
301 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED
= 0x00,
302 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED
= 0x01,
303 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT
= 0x02,
304 CEC_MEDIA_INFO_FUTURE_USE
= 0x03
307 typedef enum cec_programmed_indicator
309 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED
= 0,
310 CEC_PROGRAMMED_INDICATOR_PROGRAMMED
= 1
311 } cec_programmed_indicator
;
313 typedef enum cec_programmed_info
315 CEC_PROGRAMMED_INFO_FUTURE_USE
= 0x0,
316 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x08,
317 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x09,
318 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE
= 0x0B,
319 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE
= 0x0A
320 } cec_programmed_info
;
322 typedef enum cec_not_programmed_error_info
324 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE
= 0x0,
325 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE
= 0x01,
326 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE
= 0x02,
327 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR
= 0x03,
328 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER
= 0x04,
329 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS
= 0x05,
330 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED
= 0x06,
331 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS
= 0x07,
332 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION
= 0x08,
333 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON
= 0x09,
334 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE
= 0x0A,
335 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START
= 0x0B,
336 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END
= 0x0D,
337 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED
= 0x0E
338 } cec_not_programmed_error_info
;
340 typedef enum cec_recording_flag
342 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING
= 0,
343 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING
= 1
344 } cec_recording_flag
;
346 typedef enum cec_tuner_display_info
348 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER
= 0,
349 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER
= 1,
350 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER
= 2
351 } cec_tuner_display_info
;
353 typedef enum cec_broadcast_system
355 CEC_BROADCAST_SYSTEM_PAL_B_G
= 0,
356 CEC_BROADCAST_SYSTEM_SECAM_L1
= 1,
357 CEC_BROADCAST_SYSTEM_PAL_M
= 2,
358 CEC_BROADCAST_SYSTEM_NTSC_M
= 3,
359 CEC_BROADCAST_SYSTEM_PAL_I
= 4,
360 CEC_BROADCAST_SYSTEM_SECAM_DK
= 5,
361 CEC_BROADCAST_SYSTEM_SECAM_B_G
= 6,
362 CEC_BROADCAST_SYSTEM_SECAM_L2
= 7,
363 CEC_BROADCAST_SYSTEM_PAL_DK
= 8,
364 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM
= 30
365 } cec_broadcast_system
;
367 typedef enum cec_user_control_code
369 CEC_USER_CONTROL_CODE_SELECT
= 0x00,
370 CEC_USER_CONTROL_CODE_UP
= 0x01,
371 CEC_USER_CONTROL_CODE_DOWN
= 0x02,
372 CEC_USER_CONTROL_CODE_LEFT
= 0x03,
373 CEC_USER_CONTROL_CODE_RIGHT
= 0x04,
374 CEC_USER_CONTROL_CODE_RIGHT_UP
= 0x05,
375 CEC_USER_CONTROL_CODE_RIGHT_DOWN
= 0x06,
376 CEC_USER_CONTROL_CODE_LEFT_UP
= 0x07,
377 CEC_USER_CONTROL_CODE_LEFT_DOWN
= 0x08,
378 CEC_USER_CONTROL_CODE_ROOT_MENU
= 0x09,
379 CEC_USER_CONTROL_CODE_SETUP_MENU
= 0x0A,
380 CEC_USER_CONTROL_CODE_CONTENTS_MENU
= 0x0B,
381 CEC_USER_CONTROL_CODE_FAVORITE_MENU
= 0x0C,
382 CEC_USER_CONTROL_CODE_EXIT
= 0x0D,
383 CEC_USER_CONTROL_CODE_NUMBER0
= 0x20,
384 CEC_USER_CONTROL_CODE_NUMBER1
= 0x21,
385 CEC_USER_CONTROL_CODE_NUMBER2
= 0x22,
386 CEC_USER_CONTROL_CODE_NUMBER3
= 0x23,
387 CEC_USER_CONTROL_CODE_NUMBER4
= 0x24,
388 CEC_USER_CONTROL_CODE_NUMBER5
= 0x25,
389 CEC_USER_CONTROL_CODE_NUMBER6
= 0x26,
390 CEC_USER_CONTROL_CODE_NUMBER7
= 0x27,
391 CEC_USER_CONTROL_CODE_NUMBER8
= 0x28,
392 CEC_USER_CONTROL_CODE_NUMBER9
= 0x29,
393 CEC_USER_CONTROL_CODE_DOT
= 0x2A,
394 CEC_USER_CONTROL_CODE_ENTER
= 0x2B,
395 CEC_USER_CONTROL_CODE_CLEAR
= 0x2C,
396 CEC_USER_CONTROL_CODE_NEXT_FAVORITE
= 0x2F,
397 CEC_USER_CONTROL_CODE_CHANNEL_UP
= 0x30,
398 CEC_USER_CONTROL_CODE_CHANNEL_DOWN
= 0x31,
399 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL
= 0x32,
400 CEC_USER_CONTROL_CODE_SOUND_SELECT
= 0x33,
401 CEC_USER_CONTROL_CODE_INPUT_SELECT
= 0x34,
402 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION
= 0x35,
403 CEC_USER_CONTROL_CODE_HELP
= 0x36,
404 CEC_USER_CONTROL_CODE_PAGE_UP
= 0x37,
405 CEC_USER_CONTROL_CODE_PAGE_DOWN
= 0x38,
406 CEC_USER_CONTROL_CODE_POWER
= 0x40,
407 CEC_USER_CONTROL_CODE_VOLUME_UP
= 0x41,
408 CEC_USER_CONTROL_CODE_VOLUME_DOWN
= 0x42,
409 CEC_USER_CONTROL_CODE_MUTE
= 0x43,
410 CEC_USER_CONTROL_CODE_PLAY
= 0x44,
411 CEC_USER_CONTROL_CODE_STOP
= 0x45,
412 CEC_USER_CONTROL_CODE_PAUSE
= 0x46,
413 CEC_USER_CONTROL_CODE_RECORD
= 0x47,
414 CEC_USER_CONTROL_CODE_REWIND
= 0x48,
415 CEC_USER_CONTROL_CODE_FAST_FORWARD
= 0x49,
416 CEC_USER_CONTROL_CODE_EJECT
= 0x4A,
417 CEC_USER_CONTROL_CODE_FORWARD
= 0x4B,
418 CEC_USER_CONTROL_CODE_BACKWARD
= 0x4C,
419 CEC_USER_CONTROL_CODE_STOP_RECORD
= 0x4D,
420 CEC_USER_CONTROL_CODE_PAUSE_RECORD
= 0x4E,
421 CEC_USER_CONTROL_CODE_ANGLE
= 0x50,
422 CEC_USER_CONTROL_CODE_SUB_PICTURE
= 0x51,
423 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND
= 0x52,
424 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE
= 0x53,
425 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING
= 0x54,
426 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION
= 0x55,
427 CEC_USER_CONTROL_CODE_PLAY_FUNCTION
= 0x60,
428 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION
= 0x61,
429 CEC_USER_CONTROL_CODE_RECORD_FUNCTION
= 0x62,
430 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION
= 0x63,
431 CEC_USER_CONTROL_CODE_STOP_FUNCTION
= 0x64,
432 CEC_USER_CONTROL_CODE_MUTE_FUNCTION
= 0x65,
433 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION
= 0x66,
434 CEC_USER_CONTROL_CODE_TUNE_FUNCTION
= 0x67,
435 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION
= 0x68,
436 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION
= 0x69,
437 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION
= 0x6A,
438 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION
= 0x6B,
439 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION
= 0x6C,
440 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION
= 0x6D,
441 CEC_USER_CONTROL_CODE_F1_BLUE
= 0x71,
442 CEC_USER_CONTROL_CODE_F2_RED
= 0X72,
443 CEC_USER_CONTROL_CODE_F3_GREEN
= 0x73,
444 CEC_USER_CONTROL_CODE_F4_YELLOW
= 0x74,
445 CEC_USER_CONTROL_CODE_F5
= 0x75,
446 CEC_USER_CONTROL_CODE_DATA
= 0x76,
447 CEC_USER_CONTROL_CODE_MAX
= 0x76,
448 CEC_USER_CONTROL_CODE_UNKNOWN
449 } cec_user_control_code
;
451 typedef enum cec_an_user_control_code
453 CEC_AN_USER_CONTROL_CODE_RETURN
= 0x91
454 } cec_an_user_control_code
;
456 typedef enum cec_logical_address
458 CECDEVICE_UNKNOWN
= -1, //not a valid logical address
460 CECDEVICE_RECORDINGDEVICE1
= 1,
461 CECDEVICE_RECORDINGDEVICE2
= 2,
462 CECDEVICE_TUNER1
= 3,
463 CECDEVICE_PLAYBACKDEVICE1
= 4,
464 CECDEVICE_AUDIOSYSTEM
= 5,
465 CECDEVICE_TUNER2
= 6,
466 CECDEVICE_TUNER3
= 7,
467 CECDEVICE_PLAYBACKDEVICE2
= 8,
468 CECDEVICE_RECORDINGDEVICE3
= 9,
469 CECDEVICE_TUNER4
= 10,
470 CECDEVICE_PLAYBACKDEVICE3
= 11,
471 CECDEVICE_RESERVED1
= 12,
472 CECDEVICE_RESERVED2
= 13,
473 CECDEVICE_FREEUSE
= 14,
474 CECDEVICE_UNREGISTERED
= 15,
475 CECDEVICE_BROADCAST
= 15
476 } cec_logical_address
;
478 typedef enum cec_opcode
480 CEC_OPCODE_ACTIVE_SOURCE
= 0x82,
481 CEC_OPCODE_IMAGE_VIEW_ON
= 0x04,
482 CEC_OPCODE_TEXT_VIEW_ON
= 0x0D,
483 CEC_OPCODE_INACTIVE_SOURCE
= 0x9D,
484 CEC_OPCODE_REQUEST_ACTIVE_SOURCE
= 0x85,
485 CEC_OPCODE_ROUTING_CHANGE
= 0x80,
486 CEC_OPCODE_ROUTING_INFORMATION
= 0x81,
487 CEC_OPCODE_SET_STREAM_PATH
= 0x86,
488 CEC_OPCODE_STANDBY
= 0x36,
489 CEC_OPCODE_RECORD_OFF
= 0x0B,
490 CEC_OPCODE_RECORD_ON
= 0x09,
491 CEC_OPCODE_RECORD_STATUS
= 0x0A,
492 CEC_OPCODE_RECORD_TV_SCREEN
= 0x0F,
493 CEC_OPCODE_CLEAR_ANALOGUE_TIMER
= 0x33,
494 CEC_OPCODE_CLEAR_DIGITAL_TIMER
= 0x99,
495 CEC_OPCODE_CLEAR_EXTERNAL_TIMER
= 0xA1,
496 CEC_OPCODE_SET_ANALOGUE_TIMER
= 0x34,
497 CEC_OPCODE_SET_DIGITAL_TIMER
= 0x97,
498 CEC_OPCODE_SET_EXTERNAL_TIMER
= 0xA2,
499 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE
= 0x67,
500 CEC_OPCODE_TIMER_CLEARED_STATUS
= 0x43,
501 CEC_OPCODE_TIMER_STATUS
= 0x35,
502 CEC_OPCODE_CEC_VERSION
= 0x9E,
503 CEC_OPCODE_GET_CEC_VERSION
= 0x9F,
504 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
= 0x83,
505 CEC_OPCODE_GET_MENU_LANGUAGE
= 0x91,
506 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
= 0x84,
507 CEC_OPCODE_SET_MENU_LANGUAGE
= 0x32,
508 CEC_OPCODE_DECK_CONTROL
= 0x42,
509 CEC_OPCODE_DECK_STATUS
= 0x1B,
510 CEC_OPCODE_GIVE_DECK_STATUS
= 0x1A,
511 CEC_OPCODE_PLAY
= 0x41,
512 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
= 0x08,
513 CEC_OPCODE_SELECT_ANALOGUE_SERVICE
= 0x92,
514 CEC_OPCODE_SELECT_DIGITAL_SERVICE
= 0x93,
515 CEC_OPCODE_TUNER_DEVICE_STATUS
= 0x07,
516 CEC_OPCODE_TUNER_STEP_DECREMENT
= 0x06,
517 CEC_OPCODE_TUNER_STEP_INCREMENT
= 0x05,
518 CEC_OPCODE_DEVICE_VENDOR_ID
= 0x87,
519 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
= 0x8C,
520 CEC_OPCODE_VENDOR_COMMAND
= 0x89,
521 CEC_OPCODE_VENDOR_COMMAND_WITH_ID
= 0xA0,
522 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
= 0x8A,
523 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
= 0x8B,
524 CEC_OPCODE_SET_OSD_STRING
= 0x64,
525 CEC_OPCODE_GIVE_OSD_NAME
= 0x46,
526 CEC_OPCODE_SET_OSD_NAME
= 0x47,
527 CEC_OPCODE_MENU_REQUEST
= 0x8D,
528 CEC_OPCODE_MENU_STATUS
= 0x8E,
529 CEC_OPCODE_USER_CONTROL_PRESSED
= 0x44,
530 CEC_OPCODE_USER_CONTROL_RELEASE
= 0x45,
531 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
= 0x8F,
532 CEC_OPCODE_REPORT_POWER_STATUS
= 0x90,
533 CEC_OPCODE_FEATURE_ABORT
= 0x00,
534 CEC_OPCODE_ABORT
= 0xFF,
535 CEC_OPCODE_GIVE_AUDIO_STATUS
= 0x71,
536 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
= 0x7D,
537 CEC_OPCODE_REPORT_AUDIO_STATUS
= 0x7A,
538 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
= 0x72,
539 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
= 0x70,
540 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
= 0x7E,
541 CEC_OPCODE_SET_AUDIO_RATE
= 0x9A,
542 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
543 CEC_OPCODE_NONE
= 0xFD
546 typedef enum cec_log_level
556 typedef enum cec_adapter_messagecode
560 MSGCODE_TIMEOUT_ERROR
,
565 MSGCODE_RECEIVE_FAILED
,
566 MSGCODE_COMMAND_ACCEPTED
,
567 MSGCODE_COMMAND_REJECTED
,
568 MSGCODE_SET_ACK_MASK
,
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
;
585 typedef enum cec_vendor_id
587 CEC_VENDOR_SAMSUNG
= 0x00F0,
588 CEC_VENDOR_LG
= 0xE091,
589 CEC_VENDOR_PANASONIC
= 0x8045,
590 CEC_VENDOR_PIONEER
= 0xE036,
591 CEC_VENDOR_UNKNOWN
= 0
594 typedef struct cec_menu_language
597 cec_logical_address device
;
600 typedef struct cec_log_message
607 typedef struct cec_keypress
609 cec_user_control_code keycode
;
610 unsigned int duration
;
613 typedef struct cec_adapter
619 typedef struct cec_datapacket
625 cec_datapacket
&operator =(const struct cec_datapacket
&packet
)
628 for (uint8_t iPtr
= 0; iPtr
< packet
.size
; iPtr
++)
629 PushBack(packet
[iPtr
]);
634 bool IsEmpty(void) const { return size
== 0; }
635 bool IsFull(void) const { return size
== 100; }
636 uint8_t operator[](uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
637 uint8_t At(uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
639 void Shift(uint8_t iShiftBy
)
641 if (iShiftBy
>= size
)
647 for (uint8_t iPtr
= 0; iPtr
< size
; iPtr
++)
648 data
[iPtr
] = (iPtr
+ iShiftBy
< size
) ? data
[iPtr
+ iShiftBy
] : 0;
649 size
= (uint8_t) (size
- iShiftBy
);
653 void PushBack(uint8_t add
)
661 memset(data
, 0, sizeof(data
));
668 typedef struct cec_command
670 cec_logical_address initiator
;
671 cec_logical_address destination
;
675 cec_datapacket parameters
;
677 int32_t transmit_timeout
;
680 cec_command
&operator =(const struct cec_command
&command
)
682 initiator
= command
.initiator
;
683 destination
= command
.destination
;
686 opcode
= command
.opcode
;
687 opcode_set
= command
.opcode_set
;
688 transmit_timeout
= command
.transmit_timeout
;
689 parameters
= command
.parameters
;
694 static void Format(cec_command
&command
, cec_logical_address initiator
, cec_logical_address destination
, cec_opcode opcode
)
697 command
.initiator
= initiator
;
698 command
.destination
= destination
;
699 if (opcode
!= CEC_OPCODE_NONE
)
701 command
.opcode
= opcode
;
702 command
.opcode_set
= 1;
706 void PushBack(uint8_t data
)
708 if (initiator
== CECDEVICE_UNKNOWN
&& destination
== CECDEVICE_UNKNOWN
)
710 initiator
= (cec_logical_address
) (data
>> 4);
711 destination
= (cec_logical_address
) (data
& 0xF);
713 else if (!opcode_set
)
716 opcode
= (cec_opcode
) data
;
719 parameters
.PushBack(data
);
724 initiator
= CECDEVICE_UNKNOWN
;
725 destination
= CECDEVICE_UNKNOWN
;
729 opcode
= CEC_OPCODE_FEATURE_ABORT
;
730 transmit_timeout
= 1000;
736 typedef struct cec_device_type_list
738 cec_device_type types
[5];
744 void clear(void) { Clear(); }
748 void add(const cec_device_type type
) { Add(type
); }
752 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
753 types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
756 void Add(const cec_device_type type
)
758 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
760 if (types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
768 bool IsSet(cec_device_type type
)
771 for (unsigned int iPtr
= 0; !bReturn
&& iPtr
< 5; iPtr
++)
773 if (types
[iPtr
] == type
)
782 for (unsigned int iPtr
= 0; bReturn
&& iPtr
< 5; iPtr
++)
784 if (types
[iPtr
] != CEC_DEVICE_TYPE_RESERVED
)
790 cec_device_type
operator[](uint8_t pos
) const { return pos
< 5 ? types
[pos
] : CEC_DEVICE_TYPE_RESERVED
; }
792 } cec_device_type_list
;
794 typedef struct cec_logical_addresses
796 cec_logical_address primary
;
802 primary
= CECDEVICE_UNKNOWN
;
803 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
807 bool IsEmpty(void) const
809 return primary
== CECDEVICE_UNKNOWN
;
812 uint16_t AckMask(void) const
815 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
816 if (addresses
[iPtr
] == 1)
821 void Set(cec_logical_address address
)
823 if (primary
== CECDEVICE_UNKNOWN
)
826 addresses
[(int) address
] = 1;
829 void Unset(cec_logical_address address
)
831 if (primary
== address
)
832 primary
= CECDEVICE_UNKNOWN
;
834 addresses
[(int) address
] = 0;
837 bool IsSet(cec_logical_address address
) const { return addresses
[(int) address
] == 1; }
838 bool operator[](uint8_t pos
) const { return pos
< 16 ? IsSet((cec_logical_address
) pos
) : false; }
840 } cec_logical_addresses
;
847 #endif /* CECTYPES_H_ */