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
60 #define CEC_DEFAULT_HDMI_PORT 1
61 #define CEC_DEFAULT_BASE_DEVICE 0
66 #define CEC_BUTTON_TIMEOUT 500
68 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
69 #define CEC_DEFAULT_TRANSMIT_WAIT 2000
70 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
72 #define CEC_MIN_LIB_VERSION 1
73 #define CEC_LIB_VERSION_MAJOR 1
74 #define CEC_LIB_VERSION_MINOR 3
76 typedef enum cec_abort_reason
78 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
= 0,
79 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
= 1,
80 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
= 2,
81 CEC_ABORT_REASON_INVALID_OPERAND
= 3,
82 CEC_ABORT_REASON_REFUSED
= 4
85 typedef enum cec_analogue_broadcast_type
87 CEC_ANALOGUE_BROADCAST_TYPE_CABLE
= 0x00,
88 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE
= 0x01,
89 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL
= 0x02
90 } cec_analogue_broadcast_type
;
92 typedef enum cec_audio_rate
94 CEC_AUDIO_RATE_RATE_CONTROL_OFF
= 0,
95 CEC_AUDIO_RATE_STANDARD_RATE_100
= 1,
96 CEC_AUDIO_RATE_FAST_RATE_MAX_101
= 2,
97 CEC_AUDIO_RATE_SLOW_RATE_MIN_99
= 3,
98 CEC_AUDIO_RATE_STANDARD_RATE_100_0
= 4,
99 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1
= 5,
100 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9
= 6
103 typedef enum cec_audio_status
105 CEC_AUDIO_MUTE_STATUS_MASK
= 0x80,
106 CEC_AUDIO_VOLUME_STATUS_MASK
= 0x7F,
107 CEC_AUDIO_VOLUME_MIN
= 0x00,
108 CEC_AUDIO_VOLUME_MAX
= 0x64,
109 CEC_AUDIO_VOLUME_STATUS_UNKNOWN
= 0x7F
112 typedef enum cec_boolean
118 typedef enum cec_version
120 CEC_VERSION_UNKNOWN
= 0x00,
121 CEC_VERSION_1_2
= 0x01,
122 CEC_VERSION_1_2A
= 0x02,
123 CEC_VERSION_1_3
= 0x03,
124 CEC_VERSION_1_3A
= 0x04,
125 CEC_VERSION_1_4
= 0x05
128 typedef enum cec_channel_identifier
130 CEC_CHANNEL_NUMBER_FORMAT_MASK
= 0xFC000000,
131 CEC_1_PART_CHANNEL_NUMBER
= 0x04000000,
132 CEC_2_PART_CHANNEL_NUMBER
= 0x08000000,
133 CEC_MAJOR_CHANNEL_NUMBER_MASK
= 0x3FF0000,
134 CEC_MINOR_CHANNEL_NUMBER_MASK
= 0xFFFF
135 } cec_channel_identifier
;
137 typedef enum cec_deck_control_mode
139 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND
= 1,
140 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND
= 2,
141 CEC_DECK_CONTROL_MODE_STOP
= 3,
142 CEC_DECK_CONTROL_MODE_EJECT
= 4
143 } cec_deck_control_mode
;
145 typedef enum cec_deck_info
147 CEC_DECK_INFO_PLAY
= 0x11,
148 CEC_DECK_INFO_RECORD
= 0x12,
149 CEC_DECK_INFO_PLAY_REVERSE
= 0x13,
150 CEC_DECK_INFO_STILL
= 0x14,
151 CEC_DECK_INFO_SLOW
= 0x15,
152 CEC_DECK_INFO_SLOW_REVERSE
= 0x16,
153 CEC_DECK_INFO_FAST_FORWARD
= 0x17,
154 CEC_DECK_INFO_FAST_REVERSE
= 0x18,
155 CEC_DECK_INFO_NO_MEDIA
= 0x19,
156 CEC_DECK_INFO_STOP
= 0x1A,
157 CEC_DECK_INFO_SKIP_FORWARD_WIND
= 0x1B,
158 CEC_DECK_INFO_SKIP_REVERSE_REWIND
= 0x1C,
159 CEC_DECK_INFO_INDEX_SEARCH_FORWARD
= 0x1D,
160 CEC_DECK_INFO_INDEX_SEARCH_REVERSE
= 0x1E,
161 CEC_DECK_INFO_OTHER_STATUS
= 0x1F,
162 CEC_DECK_INFO_OTHER_STATUS_LG
= 0x20
165 typedef enum cec_device_type
167 CEC_DEVICE_TYPE_TV
= 0,
168 CEC_DEVICE_TYPE_RECORDING_DEVICE
= 1,
169 CEC_DEVICE_TYPE_RESERVED
= 2,
170 CEC_DEVICE_TYPE_TUNER
= 3,
171 CEC_DEVICE_TYPE_PLAYBACK_DEVICE
= 4,
172 CEC_DEVICE_TYPE_AUDIO_SYSTEM
= 5
175 typedef enum cec_display_control
177 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME
= 0x00,
178 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED
= 0x40,
179 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE
= 0x80,
180 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE
= 0xC0
181 } cec_display_control
;
183 typedef enum cec_external_source_specifier
185 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG
= 4,
186 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS
= 5
187 } cec_external_source_specifier
;
189 typedef enum cec_menu_request_type
191 CEC_MENU_REQUEST_TYPE_ACTIVATE
= 0,
192 CEC_MENU_REQUEST_TYPE_DEACTIVATE
= 1,
193 CEC_MENU_REQUEST_TYPE_QUERY
= 2
194 } cec_menu_request_type
;
196 typedef enum cec_menu_state
198 CEC_MENU_STATE_ACTIVATED
= 0,
199 CEC_MENU_STATE_DEACTIVATED
= 1
202 typedef enum cec_play_mode
204 CEC_PLAY_MODE_PLAY_FORWARD
= 0x24,
205 CEC_PLAY_MODE_PLAY_REVERSE
= 0x20,
206 CEC_PLAY_MODE_PLAY_STILL
= 0x25,
207 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED
= 0x05,
208 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED
= 0x06,
209 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED
= 0x07,
210 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED
= 0x09,
211 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED
= 0x0A,
212 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED
= 0x0B,
213 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED
= 0x15,
214 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED
= 0x16,
215 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED
= 0x17,
216 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED
= 0x19,
217 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED
= 0x1A,
218 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED
= 0x1B
221 typedef enum cec_power_status
223 CEC_POWER_STATUS_ON
= 0x00,
224 CEC_POWER_STATUS_STANDBY
= 0x01,
225 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON
= 0x02,
226 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY
= 0x03,
227 CEC_POWER_STATUS_UNKNOWN
= 0x99
230 typedef enum cec_record_source_type
232 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE
= 1,
233 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE
= 2,
234 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE
= 3,
235 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS
= 4,
236 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS
= 5
237 } cec_record_source_type
;
239 typedef enum cec_record_status_info
241 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE
= 0x01,
242 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE
= 0x02,
243 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE
= 0x03,
244 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT
= 0x04,
245 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE
= 0x05,
246 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE
= 0x06,
247 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE
= 0x07,
248 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER
= 0x09,
249 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS
= 0x0A,
250 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED
= 0x0B,
251 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS
= 0x0C,
252 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE
= 0x0D,
253 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED
= 0x0E,
254 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA
= 0x10,
255 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING
= 0x11,
256 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING
= 0x12,
257 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED
= 0x13,
258 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL
= 0x14,
259 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM
= 0x15,
260 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE
= 0x16,
261 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON
= 0x17,
262 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY
= 0x1A,
263 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED
= 0x1B,
264 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON
= 0x1F
265 } cec_record_status_info
;
267 typedef enum cec_recording_sequence
269 CEC_RECORDING_SEQUENCE_SUNDAY
= 0x01,
270 CEC_RECORDING_SEQUENCE_MONDAY
= 0x02,
271 CEC_RECORDING_SEQUENCE_TUESDAY
= 0x04,
272 CEC_RECORDING_SEQUENCE_WEDNESDAY
= 0x08,
273 CEC_RECORDING_SEQUENCE_THURSDAY
= 0x10,
274 CEC_RECORDING_SEQUENCE_FRIDAY
= 0x20,
275 CEC_RECORDING_SEQUENCE_SATURDAY
= 0x40,
276 CEC_RECORDING_SEQUENCE_ONCE_ONLY
= 0x00
277 } cec_recording_sequence
;
279 typedef enum cec_status_request
281 CEC_STATUS_REQUEST_ON
= 1,
282 CEC_STATUS_REQUEST_OFF
= 2,
283 CEC_STATUS_REQUEST_ONCE
= 3
284 } cec_status_request
;
286 typedef enum cec_system_audio_status
288 CEC_SYSTEM_AUDIO_STATUS_OFF
= 0,
289 CEC_SYSTEM_AUDIO_STATUS_ON
= 1
290 } cec_system_audio_status
;
292 typedef enum cec_timer_cleared_status_data
294 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING
= 0x00,
295 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING
= 0x01,
296 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE
= 0x02,
297 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED
= 0x80
298 } cec_timer_cleared_status_data
;
300 typedef enum cec_timer_overlap_warning
302 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP
= 0,
303 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP
= 1
304 } cec_timer_overlap_warning
;
306 typedef enum cec_media_info
308 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED
= 0x00,
309 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED
= 0x01,
310 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT
= 0x02,
311 CEC_MEDIA_INFO_FUTURE_USE
= 0x03
314 typedef enum cec_programmed_indicator
316 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED
= 0,
317 CEC_PROGRAMMED_INDICATOR_PROGRAMMED
= 1
318 } cec_programmed_indicator
;
320 typedef enum cec_programmed_info
322 CEC_PROGRAMMED_INFO_FUTURE_USE
= 0x0,
323 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x08,
324 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x09,
325 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE
= 0x0B,
326 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE
= 0x0A
327 } cec_programmed_info
;
329 typedef enum cec_not_programmed_error_info
331 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE
= 0x0,
332 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE
= 0x01,
333 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE
= 0x02,
334 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR
= 0x03,
335 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER
= 0x04,
336 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS
= 0x05,
337 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED
= 0x06,
338 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS
= 0x07,
339 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION
= 0x08,
340 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON
= 0x09,
341 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE
= 0x0A,
342 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START
= 0x0B,
343 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END
= 0x0D,
344 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED
= 0x0E
345 } cec_not_programmed_error_info
;
347 typedef enum cec_recording_flag
349 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING
= 0,
350 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING
= 1
351 } cec_recording_flag
;
353 typedef enum cec_tuner_display_info
355 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER
= 0,
356 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER
= 1,
357 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER
= 2
358 } cec_tuner_display_info
;
360 typedef enum cec_broadcast_system
362 CEC_BROADCAST_SYSTEM_PAL_B_G
= 0,
363 CEC_BROADCAST_SYSTEM_SECAM_L1
= 1,
364 CEC_BROADCAST_SYSTEM_PAL_M
= 2,
365 CEC_BROADCAST_SYSTEM_NTSC_M
= 3,
366 CEC_BROADCAST_SYSTEM_PAL_I
= 4,
367 CEC_BROADCAST_SYSTEM_SECAM_DK
= 5,
368 CEC_BROADCAST_SYSTEM_SECAM_B_G
= 6,
369 CEC_BROADCAST_SYSTEM_SECAM_L2
= 7,
370 CEC_BROADCAST_SYSTEM_PAL_DK
= 8,
371 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM
= 30
372 } cec_broadcast_system
;
374 typedef enum cec_user_control_code
376 CEC_USER_CONTROL_CODE_SELECT
= 0x00,
377 CEC_USER_CONTROL_CODE_UP
= 0x01,
378 CEC_USER_CONTROL_CODE_DOWN
= 0x02,
379 CEC_USER_CONTROL_CODE_LEFT
= 0x03,
380 CEC_USER_CONTROL_CODE_RIGHT
= 0x04,
381 CEC_USER_CONTROL_CODE_RIGHT_UP
= 0x05,
382 CEC_USER_CONTROL_CODE_RIGHT_DOWN
= 0x06,
383 CEC_USER_CONTROL_CODE_LEFT_UP
= 0x07,
384 CEC_USER_CONTROL_CODE_LEFT_DOWN
= 0x08,
385 CEC_USER_CONTROL_CODE_ROOT_MENU
= 0x09,
386 CEC_USER_CONTROL_CODE_SETUP_MENU
= 0x0A,
387 CEC_USER_CONTROL_CODE_CONTENTS_MENU
= 0x0B,
388 CEC_USER_CONTROL_CODE_FAVORITE_MENU
= 0x0C,
389 CEC_USER_CONTROL_CODE_EXIT
= 0x0D,
390 CEC_USER_CONTROL_CODE_NUMBER0
= 0x20,
391 CEC_USER_CONTROL_CODE_NUMBER1
= 0x21,
392 CEC_USER_CONTROL_CODE_NUMBER2
= 0x22,
393 CEC_USER_CONTROL_CODE_NUMBER3
= 0x23,
394 CEC_USER_CONTROL_CODE_NUMBER4
= 0x24,
395 CEC_USER_CONTROL_CODE_NUMBER5
= 0x25,
396 CEC_USER_CONTROL_CODE_NUMBER6
= 0x26,
397 CEC_USER_CONTROL_CODE_NUMBER7
= 0x27,
398 CEC_USER_CONTROL_CODE_NUMBER8
= 0x28,
399 CEC_USER_CONTROL_CODE_NUMBER9
= 0x29,
400 CEC_USER_CONTROL_CODE_DOT
= 0x2A,
401 CEC_USER_CONTROL_CODE_ENTER
= 0x2B,
402 CEC_USER_CONTROL_CODE_CLEAR
= 0x2C,
403 CEC_USER_CONTROL_CODE_NEXT_FAVORITE
= 0x2F,
404 CEC_USER_CONTROL_CODE_CHANNEL_UP
= 0x30,
405 CEC_USER_CONTROL_CODE_CHANNEL_DOWN
= 0x31,
406 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL
= 0x32,
407 CEC_USER_CONTROL_CODE_SOUND_SELECT
= 0x33,
408 CEC_USER_CONTROL_CODE_INPUT_SELECT
= 0x34,
409 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION
= 0x35,
410 CEC_USER_CONTROL_CODE_HELP
= 0x36,
411 CEC_USER_CONTROL_CODE_PAGE_UP
= 0x37,
412 CEC_USER_CONTROL_CODE_PAGE_DOWN
= 0x38,
413 CEC_USER_CONTROL_CODE_POWER
= 0x40,
414 CEC_USER_CONTROL_CODE_VOLUME_UP
= 0x41,
415 CEC_USER_CONTROL_CODE_VOLUME_DOWN
= 0x42,
416 CEC_USER_CONTROL_CODE_MUTE
= 0x43,
417 CEC_USER_CONTROL_CODE_PLAY
= 0x44,
418 CEC_USER_CONTROL_CODE_STOP
= 0x45,
419 CEC_USER_CONTROL_CODE_PAUSE
= 0x46,
420 CEC_USER_CONTROL_CODE_RECORD
= 0x47,
421 CEC_USER_CONTROL_CODE_REWIND
= 0x48,
422 CEC_USER_CONTROL_CODE_FAST_FORWARD
= 0x49,
423 CEC_USER_CONTROL_CODE_EJECT
= 0x4A,
424 CEC_USER_CONTROL_CODE_FORWARD
= 0x4B,
425 CEC_USER_CONTROL_CODE_BACKWARD
= 0x4C,
426 CEC_USER_CONTROL_CODE_STOP_RECORD
= 0x4D,
427 CEC_USER_CONTROL_CODE_PAUSE_RECORD
= 0x4E,
428 CEC_USER_CONTROL_CODE_ANGLE
= 0x50,
429 CEC_USER_CONTROL_CODE_SUB_PICTURE
= 0x51,
430 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND
= 0x52,
431 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE
= 0x53,
432 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING
= 0x54,
433 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION
= 0x55,
434 CEC_USER_CONTROL_CODE_PLAY_FUNCTION
= 0x60,
435 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION
= 0x61,
436 CEC_USER_CONTROL_CODE_RECORD_FUNCTION
= 0x62,
437 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION
= 0x63,
438 CEC_USER_CONTROL_CODE_STOP_FUNCTION
= 0x64,
439 CEC_USER_CONTROL_CODE_MUTE_FUNCTION
= 0x65,
440 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION
= 0x66,
441 CEC_USER_CONTROL_CODE_TUNE_FUNCTION
= 0x67,
442 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION
= 0x68,
443 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION
= 0x69,
444 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION
= 0x6A,
445 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION
= 0x6B,
446 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION
= 0x6C,
447 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION
= 0x6D,
448 CEC_USER_CONTROL_CODE_F1_BLUE
= 0x71,
449 CEC_USER_CONTROL_CODE_F2_RED
= 0X72,
450 CEC_USER_CONTROL_CODE_F3_GREEN
= 0x73,
451 CEC_USER_CONTROL_CODE_F4_YELLOW
= 0x74,
452 CEC_USER_CONTROL_CODE_F5
= 0x75,
453 CEC_USER_CONTROL_CODE_DATA
= 0x76,
454 CEC_USER_CONTROL_CODE_MAX
= 0x76,
455 CEC_USER_CONTROL_CODE_UNKNOWN
456 } cec_user_control_code
;
458 typedef enum cec_an_user_control_code
460 CEC_AN_USER_CONTROL_CODE_RETURN
= 0x91
461 } cec_an_user_control_code
;
463 typedef enum cec_logical_address
465 CECDEVICE_UNKNOWN
= -1, //not a valid logical address
467 CECDEVICE_RECORDINGDEVICE1
= 1,
468 CECDEVICE_RECORDINGDEVICE2
= 2,
469 CECDEVICE_TUNER1
= 3,
470 CECDEVICE_PLAYBACKDEVICE1
= 4,
471 CECDEVICE_AUDIOSYSTEM
= 5,
472 CECDEVICE_TUNER2
= 6,
473 CECDEVICE_TUNER3
= 7,
474 CECDEVICE_PLAYBACKDEVICE2
= 8,
475 CECDEVICE_RECORDINGDEVICE3
= 9,
476 CECDEVICE_TUNER4
= 10,
477 CECDEVICE_PLAYBACKDEVICE3
= 11,
478 CECDEVICE_RESERVED1
= 12,
479 CECDEVICE_RESERVED2
= 13,
480 CECDEVICE_FREEUSE
= 14,
481 CECDEVICE_UNREGISTERED
= 15,
482 CECDEVICE_BROADCAST
= 15
483 } cec_logical_address
;
485 typedef enum cec_opcode
487 CEC_OPCODE_ACTIVE_SOURCE
= 0x82,
488 CEC_OPCODE_IMAGE_VIEW_ON
= 0x04,
489 CEC_OPCODE_TEXT_VIEW_ON
= 0x0D,
490 CEC_OPCODE_INACTIVE_SOURCE
= 0x9D,
491 CEC_OPCODE_REQUEST_ACTIVE_SOURCE
= 0x85,
492 CEC_OPCODE_ROUTING_CHANGE
= 0x80,
493 CEC_OPCODE_ROUTING_INFORMATION
= 0x81,
494 CEC_OPCODE_SET_STREAM_PATH
= 0x86,
495 CEC_OPCODE_STANDBY
= 0x36,
496 CEC_OPCODE_RECORD_OFF
= 0x0B,
497 CEC_OPCODE_RECORD_ON
= 0x09,
498 CEC_OPCODE_RECORD_STATUS
= 0x0A,
499 CEC_OPCODE_RECORD_TV_SCREEN
= 0x0F,
500 CEC_OPCODE_CLEAR_ANALOGUE_TIMER
= 0x33,
501 CEC_OPCODE_CLEAR_DIGITAL_TIMER
= 0x99,
502 CEC_OPCODE_CLEAR_EXTERNAL_TIMER
= 0xA1,
503 CEC_OPCODE_SET_ANALOGUE_TIMER
= 0x34,
504 CEC_OPCODE_SET_DIGITAL_TIMER
= 0x97,
505 CEC_OPCODE_SET_EXTERNAL_TIMER
= 0xA2,
506 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE
= 0x67,
507 CEC_OPCODE_TIMER_CLEARED_STATUS
= 0x43,
508 CEC_OPCODE_TIMER_STATUS
= 0x35,
509 CEC_OPCODE_CEC_VERSION
= 0x9E,
510 CEC_OPCODE_GET_CEC_VERSION
= 0x9F,
511 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
= 0x83,
512 CEC_OPCODE_GET_MENU_LANGUAGE
= 0x91,
513 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
= 0x84,
514 CEC_OPCODE_SET_MENU_LANGUAGE
= 0x32,
515 CEC_OPCODE_DECK_CONTROL
= 0x42,
516 CEC_OPCODE_DECK_STATUS
= 0x1B,
517 CEC_OPCODE_GIVE_DECK_STATUS
= 0x1A,
518 CEC_OPCODE_PLAY
= 0x41,
519 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
= 0x08,
520 CEC_OPCODE_SELECT_ANALOGUE_SERVICE
= 0x92,
521 CEC_OPCODE_SELECT_DIGITAL_SERVICE
= 0x93,
522 CEC_OPCODE_TUNER_DEVICE_STATUS
= 0x07,
523 CEC_OPCODE_TUNER_STEP_DECREMENT
= 0x06,
524 CEC_OPCODE_TUNER_STEP_INCREMENT
= 0x05,
525 CEC_OPCODE_DEVICE_VENDOR_ID
= 0x87,
526 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
= 0x8C,
527 CEC_OPCODE_VENDOR_COMMAND
= 0x89,
528 CEC_OPCODE_VENDOR_COMMAND_WITH_ID
= 0xA0,
529 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
= 0x8A,
530 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
= 0x8B,
531 CEC_OPCODE_SET_OSD_STRING
= 0x64,
532 CEC_OPCODE_GIVE_OSD_NAME
= 0x46,
533 CEC_OPCODE_SET_OSD_NAME
= 0x47,
534 CEC_OPCODE_MENU_REQUEST
= 0x8D,
535 CEC_OPCODE_MENU_STATUS
= 0x8E,
536 CEC_OPCODE_USER_CONTROL_PRESSED
= 0x44,
537 CEC_OPCODE_USER_CONTROL_RELEASE
= 0x45,
538 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
= 0x8F,
539 CEC_OPCODE_REPORT_POWER_STATUS
= 0x90,
540 CEC_OPCODE_FEATURE_ABORT
= 0x00,
541 CEC_OPCODE_ABORT
= 0xFF,
542 CEC_OPCODE_GIVE_AUDIO_STATUS
= 0x71,
543 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
= 0x7D,
544 CEC_OPCODE_REPORT_AUDIO_STATUS
= 0x7A,
545 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
= 0x72,
546 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
= 0x70,
547 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
= 0x7E,
548 CEC_OPCODE_SET_AUDIO_RATE
= 0x9A,
549 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
550 CEC_OPCODE_NONE
= 0xFD
553 typedef enum cec_log_level
563 typedef enum cec_adapter_messagecode
567 MSGCODE_TIMEOUT_ERROR
,
572 MSGCODE_RECEIVE_FAILED
,
573 MSGCODE_COMMAND_ACCEPTED
,
574 MSGCODE_COMMAND_REJECTED
,
575 MSGCODE_SET_ACK_MASK
,
577 MSGCODE_TRANSMIT_EOM
,
578 MSGCODE_TRANSMIT_IDLETIME
,
579 MSGCODE_TRANSMIT_ACK_POLARITY
,
580 MSGCODE_TRANSMIT_LINE_TIMEOUT
,
581 MSGCODE_TRANSMIT_SUCCEEDED
,
582 MSGCODE_TRANSMIT_FAILED_LINE
,
583 MSGCODE_TRANSMIT_FAILED_ACK
,
584 MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
,
585 MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
,
586 MSGCODE_FIRMWARE_VERSION
,
587 MSGCODE_START_BOOTLOADER
,
588 MSGCODE_FRAME_EOM
= 0x80,
589 MSGCODE_FRAME_ACK
= 0x40,
590 } cec_adapter_messagecode
;
592 typedef enum cec_bus_device_status
594 CEC_DEVICE_STATUS_UNKNOWN
,
595 CEC_DEVICE_STATUS_PRESENT
,
596 CEC_DEVICE_STATUS_NOT_PRESENT
,
597 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
598 } cec_bus_device_status
;
600 typedef enum cec_vendor_id
602 CEC_VENDOR_SAMSUNG
= 0x00F0,
603 CEC_VENDOR_LG
= 0xE091,
604 CEC_VENDOR_PANASONIC
= 0x8045,
605 CEC_VENDOR_PIONEER
= 0xE036,
606 CEC_VENDOR_ONKYO
= 0x09B0,
607 CEC_VENDOR_YAMAHA
= 0xA0DE,
608 CEC_VENDOR_PHILIPS
= 0x903E,
609 CEC_VENDOR_UNKNOWN
= 0
612 typedef struct cec_menu_language
615 cec_logical_address device
;
618 typedef struct cec_osd_name
621 cec_logical_address device
;
624 typedef struct cec_log_message
631 typedef struct cec_keypress
633 cec_user_control_code keycode
;
634 unsigned int duration
;
637 typedef struct cec_adapter
643 typedef struct cec_datapacket
649 cec_datapacket
&operator =(const struct cec_datapacket
&packet
)
652 for (uint8_t iPtr
= 0; iPtr
< packet
.size
; iPtr
++)
653 PushBack(packet
[iPtr
]);
658 bool IsEmpty(void) const { return size
== 0; }
659 bool IsFull(void) const { return size
== 100; }
660 uint8_t operator[](uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
661 uint8_t At(uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
663 void Shift(uint8_t iShiftBy
)
665 if (iShiftBy
>= size
)
671 for (uint8_t iPtr
= 0; iPtr
< size
; iPtr
++)
672 data
[iPtr
] = (iPtr
+ iShiftBy
< size
) ? data
[iPtr
+ iShiftBy
] : 0;
673 size
= (uint8_t) (size
- iShiftBy
);
677 void PushBack(uint8_t add
)
685 memset(data
, 0, sizeof(data
));
692 typedef struct cec_command
694 cec_logical_address initiator
;
695 cec_logical_address destination
;
699 cec_datapacket parameters
;
701 int32_t transmit_timeout
;
704 cec_command
&operator =(const struct cec_command
&command
)
706 initiator
= command
.initiator
;
707 destination
= command
.destination
;
710 opcode
= command
.opcode
;
711 opcode_set
= command
.opcode_set
;
712 transmit_timeout
= command
.transmit_timeout
;
713 parameters
= command
.parameters
;
718 static void Format(cec_command
&command
, cec_logical_address initiator
, cec_logical_address destination
, cec_opcode opcode
, int32_t timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
)
721 command
.initiator
= initiator
;
722 command
.destination
= destination
;
723 command
.transmit_timeout
= timeout
;
724 if (opcode
!= CEC_OPCODE_NONE
)
726 command
.opcode
= opcode
;
727 command
.opcode_set
= 1;
731 void PushBack(uint8_t data
)
733 if (initiator
== CECDEVICE_UNKNOWN
&& destination
== CECDEVICE_UNKNOWN
)
735 initiator
= (cec_logical_address
) (data
>> 4);
736 destination
= (cec_logical_address
) (data
& 0xF);
738 else if (!opcode_set
)
741 opcode
= (cec_opcode
) data
;
744 parameters
.PushBack(data
);
749 initiator
= CECDEVICE_UNKNOWN
;
750 destination
= CECDEVICE_UNKNOWN
;
754 opcode
= CEC_OPCODE_FEATURE_ABORT
;
755 transmit_timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
;
761 typedef struct cec_device_type_list
763 cec_device_type types
[5];
769 void clear(void) { Clear(); }
773 void add(const cec_device_type type
) { Add(type
); }
777 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
778 types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
781 void Add(const cec_device_type type
)
783 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
785 if (types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
793 bool IsSet(cec_device_type type
)
796 for (unsigned int iPtr
= 0; !bReturn
&& iPtr
< 5; iPtr
++)
798 if (types
[iPtr
] == type
)
807 for (unsigned int iPtr
= 0; bReturn
&& iPtr
< 5; iPtr
++)
809 if (types
[iPtr
] != CEC_DEVICE_TYPE_RESERVED
)
815 cec_device_type
operator[](uint8_t pos
) const { return pos
< 5 ? types
[pos
] : CEC_DEVICE_TYPE_RESERVED
; }
817 } cec_device_type_list
;
819 typedef struct cec_logical_addresses
821 cec_logical_address primary
;
827 primary
= CECDEVICE_UNKNOWN
;
828 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
832 bool IsEmpty(void) const
834 return primary
== CECDEVICE_UNKNOWN
;
837 uint16_t AckMask(void) const
840 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
841 if (addresses
[iPtr
] == 1)
846 void Set(cec_logical_address address
)
848 if (primary
== CECDEVICE_UNKNOWN
)
851 addresses
[(int) address
] = 1;
854 void Unset(cec_logical_address address
)
856 if (primary
== address
)
857 primary
= CECDEVICE_UNKNOWN
;
859 addresses
[(int) address
] = 0;
862 bool IsSet(cec_logical_address address
) const { return addresses
[(int) address
] == 1; }
863 bool operator[](uint8_t pos
) const { return pos
< 16 ? IsSet((cec_logical_address
) pos
) : false; }
865 } cec_logical_addresses
;
872 #endif /* CECTYPES_H_ */