3 * This file is part of the libCEC(R) library.
5 * libCEC(R) is Copyright (C) 2011-2012 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(_WIN32) || defined(_WIN64)
41 #define CEC_CDECL __cdecl
46 #if !defined(DECLSPEC)
47 #if defined(_WIN32) || defined(_WIN64)
49 #if defined DLL_EXPORT
50 #define DECLSPEC __declspec(dllexport)
52 #define DECLSPEC __declspec(dllimport)
64 //default physical address 1.0.0.0, HDMI port 1
65 #define CEC_DEFAULT_PHYSICAL_ADDRESS 0x1000
66 #define CEC_DEFAULT_HDMI_PORT 1
67 #define CEC_DEFAULT_BASE_DEVICE 0
72 #define CEC_BUTTON_TIMEOUT 500
73 #define CEC_POWER_STATE_REFRESH_TIME 30000
74 #define CEC_FW_VERSION_UNKNOWN 0xFFFF
76 #define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
77 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
78 #define CEC_DEFAULT_TRANSMIT_WAIT 2000
79 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
81 #define CEC_MIN_LIB_VERSION 1
82 #define CEC_LIB_VERSION_MAJOR 1
83 #define CEC_LIB_VERSION_MINOR 4
85 typedef enum cec_abort_reason
87 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
= 0,
88 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
= 1,
89 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
= 2,
90 CEC_ABORT_REASON_INVALID_OPERAND
= 3,
91 CEC_ABORT_REASON_REFUSED
= 4
94 typedef enum cec_analogue_broadcast_type
96 CEC_ANALOGUE_BROADCAST_TYPE_CABLE
= 0x00,
97 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE
= 0x01,
98 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL
= 0x02
99 } cec_analogue_broadcast_type
;
101 typedef enum cec_audio_rate
103 CEC_AUDIO_RATE_RATE_CONTROL_OFF
= 0,
104 CEC_AUDIO_RATE_STANDARD_RATE_100
= 1,
105 CEC_AUDIO_RATE_FAST_RATE_MAX_101
= 2,
106 CEC_AUDIO_RATE_SLOW_RATE_MIN_99
= 3,
107 CEC_AUDIO_RATE_STANDARD_RATE_100_0
= 4,
108 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1
= 5,
109 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9
= 6
112 typedef enum cec_audio_status
114 CEC_AUDIO_MUTE_STATUS_MASK
= 0x80,
115 CEC_AUDIO_VOLUME_STATUS_MASK
= 0x7F,
116 CEC_AUDIO_VOLUME_MIN
= 0x00,
117 CEC_AUDIO_VOLUME_MAX
= 0x64,
118 CEC_AUDIO_VOLUME_STATUS_UNKNOWN
= 0x7F
121 typedef enum cec_boolean
127 typedef enum cec_version
129 CEC_VERSION_UNKNOWN
= 0x00,
130 CEC_VERSION_1_2
= 0x01,
131 CEC_VERSION_1_2A
= 0x02,
132 CEC_VERSION_1_3
= 0x03,
133 CEC_VERSION_1_3A
= 0x04,
134 CEC_VERSION_1_4
= 0x05
137 typedef enum cec_channel_identifier
139 CEC_CHANNEL_NUMBER_FORMAT_MASK
= 0xFC000000,
140 CEC_1_PART_CHANNEL_NUMBER
= 0x04000000,
141 CEC_2_PART_CHANNEL_NUMBER
= 0x08000000,
142 CEC_MAJOR_CHANNEL_NUMBER_MASK
= 0x3FF0000,
143 CEC_MINOR_CHANNEL_NUMBER_MASK
= 0xFFFF
144 } cec_channel_identifier
;
146 typedef enum cec_deck_control_mode
148 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND
= 1,
149 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND
= 2,
150 CEC_DECK_CONTROL_MODE_STOP
= 3,
151 CEC_DECK_CONTROL_MODE_EJECT
= 4
152 } cec_deck_control_mode
;
154 typedef enum cec_deck_info
156 CEC_DECK_INFO_PLAY
= 0x11,
157 CEC_DECK_INFO_RECORD
= 0x12,
158 CEC_DECK_INFO_PLAY_REVERSE
= 0x13,
159 CEC_DECK_INFO_STILL
= 0x14,
160 CEC_DECK_INFO_SLOW
= 0x15,
161 CEC_DECK_INFO_SLOW_REVERSE
= 0x16,
162 CEC_DECK_INFO_FAST_FORWARD
= 0x17,
163 CEC_DECK_INFO_FAST_REVERSE
= 0x18,
164 CEC_DECK_INFO_NO_MEDIA
= 0x19,
165 CEC_DECK_INFO_STOP
= 0x1A,
166 CEC_DECK_INFO_SKIP_FORWARD_WIND
= 0x1B,
167 CEC_DECK_INFO_SKIP_REVERSE_REWIND
= 0x1C,
168 CEC_DECK_INFO_INDEX_SEARCH_FORWARD
= 0x1D,
169 CEC_DECK_INFO_INDEX_SEARCH_REVERSE
= 0x1E,
170 CEC_DECK_INFO_OTHER_STATUS
= 0x1F,
171 CEC_DECK_INFO_OTHER_STATUS_LG
= 0x20
174 typedef enum cec_device_type
176 CEC_DEVICE_TYPE_TV
= 0,
177 CEC_DEVICE_TYPE_RECORDING_DEVICE
= 1,
178 CEC_DEVICE_TYPE_RESERVED
= 2,
179 CEC_DEVICE_TYPE_TUNER
= 3,
180 CEC_DEVICE_TYPE_PLAYBACK_DEVICE
= 4,
181 CEC_DEVICE_TYPE_AUDIO_SYSTEM
= 5
184 typedef enum cec_display_control
186 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME
= 0x00,
187 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED
= 0x40,
188 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE
= 0x80,
189 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE
= 0xC0
190 } cec_display_control
;
192 typedef enum cec_external_source_specifier
194 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG
= 4,
195 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS
= 5
196 } cec_external_source_specifier
;
198 typedef enum cec_menu_request_type
200 CEC_MENU_REQUEST_TYPE_ACTIVATE
= 0,
201 CEC_MENU_REQUEST_TYPE_DEACTIVATE
= 1,
202 CEC_MENU_REQUEST_TYPE_QUERY
= 2
203 } cec_menu_request_type
;
205 typedef enum cec_menu_state
207 CEC_MENU_STATE_ACTIVATED
= 0,
208 CEC_MENU_STATE_DEACTIVATED
= 1
211 typedef enum cec_play_mode
213 CEC_PLAY_MODE_PLAY_FORWARD
= 0x24,
214 CEC_PLAY_MODE_PLAY_REVERSE
= 0x20,
215 CEC_PLAY_MODE_PLAY_STILL
= 0x25,
216 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED
= 0x05,
217 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED
= 0x06,
218 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED
= 0x07,
219 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED
= 0x09,
220 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED
= 0x0A,
221 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED
= 0x0B,
222 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED
= 0x15,
223 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED
= 0x16,
224 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED
= 0x17,
225 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED
= 0x19,
226 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED
= 0x1A,
227 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED
= 0x1B
230 typedef enum cec_power_status
232 CEC_POWER_STATUS_ON
= 0x00,
233 CEC_POWER_STATUS_STANDBY
= 0x01,
234 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON
= 0x02,
235 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY
= 0x03,
236 CEC_POWER_STATUS_UNKNOWN
= 0x99
239 typedef enum cec_record_source_type
241 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE
= 1,
242 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE
= 2,
243 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE
= 3,
244 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS
= 4,
245 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS
= 5
246 } cec_record_source_type
;
248 typedef enum cec_record_status_info
250 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE
= 0x01,
251 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE
= 0x02,
252 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE
= 0x03,
253 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT
= 0x04,
254 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE
= 0x05,
255 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE
= 0x06,
256 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE
= 0x07,
257 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER
= 0x09,
258 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS
= 0x0A,
259 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED
= 0x0B,
260 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS
= 0x0C,
261 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE
= 0x0D,
262 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED
= 0x0E,
263 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA
= 0x10,
264 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING
= 0x11,
265 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING
= 0x12,
266 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED
= 0x13,
267 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL
= 0x14,
268 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM
= 0x15,
269 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE
= 0x16,
270 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON
= 0x17,
271 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY
= 0x1A,
272 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED
= 0x1B,
273 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON
= 0x1F
274 } cec_record_status_info
;
276 typedef enum cec_recording_sequence
278 CEC_RECORDING_SEQUENCE_SUNDAY
= 0x01,
279 CEC_RECORDING_SEQUENCE_MONDAY
= 0x02,
280 CEC_RECORDING_SEQUENCE_TUESDAY
= 0x04,
281 CEC_RECORDING_SEQUENCE_WEDNESDAY
= 0x08,
282 CEC_RECORDING_SEQUENCE_THURSDAY
= 0x10,
283 CEC_RECORDING_SEQUENCE_FRIDAY
= 0x20,
284 CEC_RECORDING_SEQUENCE_SATURDAY
= 0x40,
285 CEC_RECORDING_SEQUENCE_ONCE_ONLY
= 0x00
286 } cec_recording_sequence
;
288 typedef enum cec_status_request
290 CEC_STATUS_REQUEST_ON
= 1,
291 CEC_STATUS_REQUEST_OFF
= 2,
292 CEC_STATUS_REQUEST_ONCE
= 3
293 } cec_status_request
;
295 typedef enum cec_system_audio_status
297 CEC_SYSTEM_AUDIO_STATUS_OFF
= 0,
298 CEC_SYSTEM_AUDIO_STATUS_ON
= 1
299 } cec_system_audio_status
;
301 typedef enum cec_timer_cleared_status_data
303 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING
= 0x00,
304 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING
= 0x01,
305 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE
= 0x02,
306 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED
= 0x80
307 } cec_timer_cleared_status_data
;
309 typedef enum cec_timer_overlap_warning
311 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP
= 0,
312 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP
= 1
313 } cec_timer_overlap_warning
;
315 typedef enum cec_media_info
317 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED
= 0x00,
318 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED
= 0x01,
319 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT
= 0x02,
320 CEC_MEDIA_INFO_FUTURE_USE
= 0x03
323 typedef enum cec_programmed_indicator
325 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED
= 0,
326 CEC_PROGRAMMED_INDICATOR_PROGRAMMED
= 1
327 } cec_programmed_indicator
;
329 typedef enum cec_programmed_info
331 CEC_PROGRAMMED_INFO_FUTURE_USE
= 0x0,
332 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x08,
333 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x09,
334 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE
= 0x0B,
335 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE
= 0x0A
336 } cec_programmed_info
;
338 typedef enum cec_not_programmed_error_info
340 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE
= 0x0,
341 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE
= 0x01,
342 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE
= 0x02,
343 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR
= 0x03,
344 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER
= 0x04,
345 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS
= 0x05,
346 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED
= 0x06,
347 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS
= 0x07,
348 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION
= 0x08,
349 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON
= 0x09,
350 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE
= 0x0A,
351 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START
= 0x0B,
352 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END
= 0x0D,
353 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED
= 0x0E
354 } cec_not_programmed_error_info
;
356 typedef enum cec_recording_flag
358 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING
= 0,
359 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING
= 1
360 } cec_recording_flag
;
362 typedef enum cec_tuner_display_info
364 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER
= 0,
365 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER
= 1,
366 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER
= 2
367 } cec_tuner_display_info
;
369 typedef enum cec_broadcast_system
371 CEC_BROADCAST_SYSTEM_PAL_B_G
= 0,
372 CEC_BROADCAST_SYSTEM_SECAM_L1
= 1,
373 CEC_BROADCAST_SYSTEM_PAL_M
= 2,
374 CEC_BROADCAST_SYSTEM_NTSC_M
= 3,
375 CEC_BROADCAST_SYSTEM_PAL_I
= 4,
376 CEC_BROADCAST_SYSTEM_SECAM_DK
= 5,
377 CEC_BROADCAST_SYSTEM_SECAM_B_G
= 6,
378 CEC_BROADCAST_SYSTEM_SECAM_L2
= 7,
379 CEC_BROADCAST_SYSTEM_PAL_DK
= 8,
380 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM
= 30
381 } cec_broadcast_system
;
383 typedef enum cec_user_control_code
385 CEC_USER_CONTROL_CODE_SELECT
= 0x00,
386 CEC_USER_CONTROL_CODE_UP
= 0x01,
387 CEC_USER_CONTROL_CODE_DOWN
= 0x02,
388 CEC_USER_CONTROL_CODE_LEFT
= 0x03,
389 CEC_USER_CONTROL_CODE_RIGHT
= 0x04,
390 CEC_USER_CONTROL_CODE_RIGHT_UP
= 0x05,
391 CEC_USER_CONTROL_CODE_RIGHT_DOWN
= 0x06,
392 CEC_USER_CONTROL_CODE_LEFT_UP
= 0x07,
393 CEC_USER_CONTROL_CODE_LEFT_DOWN
= 0x08,
394 CEC_USER_CONTROL_CODE_ROOT_MENU
= 0x09,
395 CEC_USER_CONTROL_CODE_SETUP_MENU
= 0x0A,
396 CEC_USER_CONTROL_CODE_CONTENTS_MENU
= 0x0B,
397 CEC_USER_CONTROL_CODE_FAVORITE_MENU
= 0x0C,
398 CEC_USER_CONTROL_CODE_EXIT
= 0x0D,
399 CEC_USER_CONTROL_CODE_NUMBER0
= 0x20,
400 CEC_USER_CONTROL_CODE_NUMBER1
= 0x21,
401 CEC_USER_CONTROL_CODE_NUMBER2
= 0x22,
402 CEC_USER_CONTROL_CODE_NUMBER3
= 0x23,
403 CEC_USER_CONTROL_CODE_NUMBER4
= 0x24,
404 CEC_USER_CONTROL_CODE_NUMBER5
= 0x25,
405 CEC_USER_CONTROL_CODE_NUMBER6
= 0x26,
406 CEC_USER_CONTROL_CODE_NUMBER7
= 0x27,
407 CEC_USER_CONTROL_CODE_NUMBER8
= 0x28,
408 CEC_USER_CONTROL_CODE_NUMBER9
= 0x29,
409 CEC_USER_CONTROL_CODE_DOT
= 0x2A,
410 CEC_USER_CONTROL_CODE_ENTER
= 0x2B,
411 CEC_USER_CONTROL_CODE_CLEAR
= 0x2C,
412 CEC_USER_CONTROL_CODE_NEXT_FAVORITE
= 0x2F,
413 CEC_USER_CONTROL_CODE_CHANNEL_UP
= 0x30,
414 CEC_USER_CONTROL_CODE_CHANNEL_DOWN
= 0x31,
415 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL
= 0x32,
416 CEC_USER_CONTROL_CODE_SOUND_SELECT
= 0x33,
417 CEC_USER_CONTROL_CODE_INPUT_SELECT
= 0x34,
418 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION
= 0x35,
419 CEC_USER_CONTROL_CODE_HELP
= 0x36,
420 CEC_USER_CONTROL_CODE_PAGE_UP
= 0x37,
421 CEC_USER_CONTROL_CODE_PAGE_DOWN
= 0x38,
422 CEC_USER_CONTROL_CODE_POWER
= 0x40,
423 CEC_USER_CONTROL_CODE_VOLUME_UP
= 0x41,
424 CEC_USER_CONTROL_CODE_VOLUME_DOWN
= 0x42,
425 CEC_USER_CONTROL_CODE_MUTE
= 0x43,
426 CEC_USER_CONTROL_CODE_PLAY
= 0x44,
427 CEC_USER_CONTROL_CODE_STOP
= 0x45,
428 CEC_USER_CONTROL_CODE_PAUSE
= 0x46,
429 CEC_USER_CONTROL_CODE_RECORD
= 0x47,
430 CEC_USER_CONTROL_CODE_REWIND
= 0x48,
431 CEC_USER_CONTROL_CODE_FAST_FORWARD
= 0x49,
432 CEC_USER_CONTROL_CODE_EJECT
= 0x4A,
433 CEC_USER_CONTROL_CODE_FORWARD
= 0x4B,
434 CEC_USER_CONTROL_CODE_BACKWARD
= 0x4C,
435 CEC_USER_CONTROL_CODE_STOP_RECORD
= 0x4D,
436 CEC_USER_CONTROL_CODE_PAUSE_RECORD
= 0x4E,
437 CEC_USER_CONTROL_CODE_ANGLE
= 0x50,
438 CEC_USER_CONTROL_CODE_SUB_PICTURE
= 0x51,
439 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND
= 0x52,
440 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE
= 0x53,
441 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING
= 0x54,
442 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION
= 0x55,
443 CEC_USER_CONTROL_CODE_PLAY_FUNCTION
= 0x60,
444 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION
= 0x61,
445 CEC_USER_CONTROL_CODE_RECORD_FUNCTION
= 0x62,
446 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION
= 0x63,
447 CEC_USER_CONTROL_CODE_STOP_FUNCTION
= 0x64,
448 CEC_USER_CONTROL_CODE_MUTE_FUNCTION
= 0x65,
449 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION
= 0x66,
450 CEC_USER_CONTROL_CODE_TUNE_FUNCTION
= 0x67,
451 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION
= 0x68,
452 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION
= 0x69,
453 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION
= 0x6A,
454 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION
= 0x6B,
455 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION
= 0x6C,
456 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION
= 0x6D,
457 CEC_USER_CONTROL_CODE_F1_BLUE
= 0x71,
458 CEC_USER_CONTROL_CODE_F2_RED
= 0X72,
459 CEC_USER_CONTROL_CODE_F3_GREEN
= 0x73,
460 CEC_USER_CONTROL_CODE_F4_YELLOW
= 0x74,
461 CEC_USER_CONTROL_CODE_F5
= 0x75,
462 CEC_USER_CONTROL_CODE_DATA
= 0x76,
463 CEC_USER_CONTROL_CODE_MAX
= 0x76,
464 CEC_USER_CONTROL_CODE_UNKNOWN
465 } cec_user_control_code
;
467 typedef enum cec_an_user_control_code
469 CEC_AN_USER_CONTROL_CODE_RETURN
= 0x91
470 } cec_an_user_control_code
;
472 typedef enum cec_logical_address
474 CECDEVICE_UNKNOWN
= -1, //not a valid logical address
476 CECDEVICE_RECORDINGDEVICE1
= 1,
477 CECDEVICE_RECORDINGDEVICE2
= 2,
478 CECDEVICE_TUNER1
= 3,
479 CECDEVICE_PLAYBACKDEVICE1
= 4,
480 CECDEVICE_AUDIOSYSTEM
= 5,
481 CECDEVICE_TUNER2
= 6,
482 CECDEVICE_TUNER3
= 7,
483 CECDEVICE_PLAYBACKDEVICE2
= 8,
484 CECDEVICE_RECORDINGDEVICE3
= 9,
485 CECDEVICE_TUNER4
= 10,
486 CECDEVICE_PLAYBACKDEVICE3
= 11,
487 CECDEVICE_RESERVED1
= 12,
488 CECDEVICE_RESERVED2
= 13,
489 CECDEVICE_FREEUSE
= 14,
490 CECDEVICE_UNREGISTERED
= 15,
491 CECDEVICE_BROADCAST
= 15
492 } cec_logical_address
;
494 typedef enum cec_opcode
496 CEC_OPCODE_ACTIVE_SOURCE
= 0x82,
497 CEC_OPCODE_IMAGE_VIEW_ON
= 0x04,
498 CEC_OPCODE_TEXT_VIEW_ON
= 0x0D,
499 CEC_OPCODE_INACTIVE_SOURCE
= 0x9D,
500 CEC_OPCODE_REQUEST_ACTIVE_SOURCE
= 0x85,
501 CEC_OPCODE_ROUTING_CHANGE
= 0x80,
502 CEC_OPCODE_ROUTING_INFORMATION
= 0x81,
503 CEC_OPCODE_SET_STREAM_PATH
= 0x86,
504 CEC_OPCODE_STANDBY
= 0x36,
505 CEC_OPCODE_RECORD_OFF
= 0x0B,
506 CEC_OPCODE_RECORD_ON
= 0x09,
507 CEC_OPCODE_RECORD_STATUS
= 0x0A,
508 CEC_OPCODE_RECORD_TV_SCREEN
= 0x0F,
509 CEC_OPCODE_CLEAR_ANALOGUE_TIMER
= 0x33,
510 CEC_OPCODE_CLEAR_DIGITAL_TIMER
= 0x99,
511 CEC_OPCODE_CLEAR_EXTERNAL_TIMER
= 0xA1,
512 CEC_OPCODE_SET_ANALOGUE_TIMER
= 0x34,
513 CEC_OPCODE_SET_DIGITAL_TIMER
= 0x97,
514 CEC_OPCODE_SET_EXTERNAL_TIMER
= 0xA2,
515 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE
= 0x67,
516 CEC_OPCODE_TIMER_CLEARED_STATUS
= 0x43,
517 CEC_OPCODE_TIMER_STATUS
= 0x35,
518 CEC_OPCODE_CEC_VERSION
= 0x9E,
519 CEC_OPCODE_GET_CEC_VERSION
= 0x9F,
520 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
= 0x83,
521 CEC_OPCODE_GET_MENU_LANGUAGE
= 0x91,
522 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
= 0x84,
523 CEC_OPCODE_SET_MENU_LANGUAGE
= 0x32,
524 CEC_OPCODE_DECK_CONTROL
= 0x42,
525 CEC_OPCODE_DECK_STATUS
= 0x1B,
526 CEC_OPCODE_GIVE_DECK_STATUS
= 0x1A,
527 CEC_OPCODE_PLAY
= 0x41,
528 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
= 0x08,
529 CEC_OPCODE_SELECT_ANALOGUE_SERVICE
= 0x92,
530 CEC_OPCODE_SELECT_DIGITAL_SERVICE
= 0x93,
531 CEC_OPCODE_TUNER_DEVICE_STATUS
= 0x07,
532 CEC_OPCODE_TUNER_STEP_DECREMENT
= 0x06,
533 CEC_OPCODE_TUNER_STEP_INCREMENT
= 0x05,
534 CEC_OPCODE_DEVICE_VENDOR_ID
= 0x87,
535 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
= 0x8C,
536 CEC_OPCODE_VENDOR_COMMAND
= 0x89,
537 CEC_OPCODE_VENDOR_COMMAND_WITH_ID
= 0xA0,
538 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
= 0x8A,
539 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
= 0x8B,
540 CEC_OPCODE_SET_OSD_STRING
= 0x64,
541 CEC_OPCODE_GIVE_OSD_NAME
= 0x46,
542 CEC_OPCODE_SET_OSD_NAME
= 0x47,
543 CEC_OPCODE_MENU_REQUEST
= 0x8D,
544 CEC_OPCODE_MENU_STATUS
= 0x8E,
545 CEC_OPCODE_USER_CONTROL_PRESSED
= 0x44,
546 CEC_OPCODE_USER_CONTROL_RELEASE
= 0x45,
547 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
= 0x8F,
548 CEC_OPCODE_REPORT_POWER_STATUS
= 0x90,
549 CEC_OPCODE_FEATURE_ABORT
= 0x00,
550 CEC_OPCODE_ABORT
= 0xFF,
551 CEC_OPCODE_GIVE_AUDIO_STATUS
= 0x71,
552 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
= 0x7D,
553 CEC_OPCODE_REPORT_AUDIO_STATUS
= 0x7A,
554 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
= 0x72,
555 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
= 0x70,
556 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
= 0x7E,
557 CEC_OPCODE_SET_AUDIO_RATE
= 0x9A,
558 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
559 CEC_OPCODE_NONE
= 0xFD
562 typedef enum cec_log_level
572 typedef enum cec_adapter_messagecode
576 MSGCODE_TIMEOUT_ERROR
,
581 MSGCODE_RECEIVE_FAILED
,
582 MSGCODE_COMMAND_ACCEPTED
,
583 MSGCODE_COMMAND_REJECTED
,
584 MSGCODE_SET_ACK_MASK
,
586 MSGCODE_TRANSMIT_EOM
,
587 MSGCODE_TRANSMIT_IDLETIME
,
588 MSGCODE_TRANSMIT_ACK_POLARITY
,
589 MSGCODE_TRANSMIT_LINE_TIMEOUT
,
590 MSGCODE_TRANSMIT_SUCCEEDED
,
591 MSGCODE_TRANSMIT_FAILED_LINE
,
592 MSGCODE_TRANSMIT_FAILED_ACK
,
593 MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
,
594 MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
,
595 MSGCODE_FIRMWARE_VERSION
,
596 MSGCODE_START_BOOTLOADER
,
597 MSGCODE_SET_POWERSTATE
,
598 MSGCODE_SET_CONTROLLED
,
599 MSGCODE_FRAME_EOM
= 0x80,
600 MSGCODE_FRAME_ACK
= 0x40,
601 } cec_adapter_messagecode
;
603 typedef enum cec_bus_device_status
605 CEC_DEVICE_STATUS_UNKNOWN
,
606 CEC_DEVICE_STATUS_PRESENT
,
607 CEC_DEVICE_STATUS_NOT_PRESENT
,
608 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
609 } cec_bus_device_status
;
611 typedef enum cec_vendor_id
613 CEC_VENDOR_SAMSUNG
= 0x0000F0,
614 CEC_VENDOR_LG
= 0x00E091,
615 CEC_VENDOR_PANASONIC
= 0x008045,
616 CEC_VENDOR_PIONEER
= 0x00E036,
617 CEC_VENDOR_ONKYO
= 0x0009B0,
618 CEC_VENDOR_YAMAHA
= 0x00A0DE,
619 CEC_VENDOR_PHILIPS
= 0x00903E,
620 CEC_VENDOR_SONY
= 0x080046,
621 CEC_VENDOR_UNKNOWN
= 0
624 typedef struct cec_menu_language
627 cec_logical_address device
;
630 typedef struct cec_osd_name
633 cec_logical_address device
;
636 typedef struct cec_log_message
643 typedef struct cec_keypress
645 cec_user_control_code keycode
;
646 unsigned int duration
;
649 typedef struct cec_adapter
655 typedef struct cec_datapacket
661 cec_datapacket
&operator =(const struct cec_datapacket
&packet
)
664 for (uint8_t iPtr
= 0; iPtr
< packet
.size
; iPtr
++)
665 PushBack(packet
[iPtr
]);
670 bool IsEmpty(void) const { return size
== 0; }
671 bool IsFull(void) const { return size
== 100; }
672 uint8_t operator[](uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
673 uint8_t At(uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
675 void Shift(uint8_t iShiftBy
)
677 if (iShiftBy
>= size
)
683 for (uint8_t iPtr
= 0; iPtr
< size
; iPtr
++)
684 data
[iPtr
] = (iPtr
+ iShiftBy
< size
) ? data
[iPtr
+ iShiftBy
] : 0;
685 size
= (uint8_t) (size
- iShiftBy
);
689 void PushBack(uint8_t add
)
697 memset(data
, 0, sizeof(data
));
704 typedef struct cec_command
706 cec_logical_address initiator
;
707 cec_logical_address destination
;
711 cec_datapacket parameters
;
713 int32_t transmit_timeout
;
716 cec_command
&operator =(const struct cec_command
&command
)
718 initiator
= command
.initiator
;
719 destination
= command
.destination
;
722 opcode
= command
.opcode
;
723 opcode_set
= command
.opcode_set
;
724 transmit_timeout
= command
.transmit_timeout
;
725 parameters
= command
.parameters
;
730 static void Format(cec_command
&command
, cec_logical_address initiator
, cec_logical_address destination
, cec_opcode opcode
, int32_t timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
)
733 command
.initiator
= initiator
;
734 command
.destination
= destination
;
735 command
.transmit_timeout
= timeout
;
736 if (opcode
!= CEC_OPCODE_NONE
)
738 command
.opcode
= opcode
;
739 command
.opcode_set
= 1;
743 void PushBack(uint8_t data
)
745 if (initiator
== CECDEVICE_UNKNOWN
&& destination
== CECDEVICE_UNKNOWN
)
747 initiator
= (cec_logical_address
) (data
>> 4);
748 destination
= (cec_logical_address
) (data
& 0xF);
750 else if (!opcode_set
)
753 opcode
= (cec_opcode
) data
;
756 parameters
.PushBack(data
);
761 initiator
= CECDEVICE_UNKNOWN
;
762 destination
= CECDEVICE_UNKNOWN
;
766 opcode
= CEC_OPCODE_FEATURE_ABORT
;
767 transmit_timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
;
773 typedef struct cec_device_type_list
775 cec_device_type types
[5];
781 void clear(void) { Clear(); }
785 void add(const cec_device_type type
) { Add(type
); }
789 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
790 types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
793 void Add(const cec_device_type type
)
795 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
797 if (types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
805 bool IsSet(cec_device_type type
)
808 for (unsigned int iPtr
= 0; !bReturn
&& iPtr
< 5; iPtr
++)
810 if (types
[iPtr
] == type
)
819 for (unsigned int iPtr
= 0; bReturn
&& iPtr
< 5; iPtr
++)
821 if (types
[iPtr
] != CEC_DEVICE_TYPE_RESERVED
)
827 cec_device_type
operator[](uint8_t pos
) const { return pos
< 5 ? types
[pos
] : CEC_DEVICE_TYPE_RESERVED
; }
829 } cec_device_type_list
;
831 typedef struct cec_logical_addresses
833 cec_logical_address primary
;
839 primary
= CECDEVICE_UNKNOWN
;
840 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
844 bool IsEmpty(void) const
846 return primary
== CECDEVICE_UNKNOWN
;
849 uint16_t AckMask(void) const
852 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
853 if (addresses
[iPtr
] == 1)
858 void Set(cec_logical_address address
)
860 if (primary
== CECDEVICE_UNKNOWN
)
863 addresses
[(int) address
] = 1;
866 void Unset(cec_logical_address address
)
868 if (primary
== address
)
869 primary
= CECDEVICE_UNKNOWN
;
871 addresses
[(int) address
] = 0;
874 bool IsSet(cec_logical_address address
) const { return addresses
[(int) address
] == 1; }
875 bool operator[](uint8_t pos
) const { return pos
< 16 ? IsSet((cec_logical_address
) pos
) : false; }
877 } cec_logical_addresses
;
879 typedef int (CEC_CDECL
* CBCecLogMessageType
)(void *param
, const CEC::cec_log_message
&);
880 typedef int (CEC_CDECL
* CBCecKeyPressType
)(void *param
, const cec_keypress
&);
881 typedef int (CEC_CDECL
* CBCecCommandType
)(void *param
, const cec_command
&);
883 typedef struct ICECCallbacks
886 * @brief Transfer a log message from libCEC to the client.
887 * @param message The message to transfer.
888 * @return 1 when ok, 0 otherwise.
890 CBCecLogMessageType CBCecLogMessage
;
893 * @brief Transfer a keypress from libCEC to the client.
894 * @param key The keypress to transfer.
895 * @return 1 when ok, 0 otherwise.
897 CBCecKeyPressType CBCecKeyPress
;
900 * @brief Transfer a CEC command from libCEC to the client.
901 * @param command The command to transfer.
902 * @return 1 when ok, 0 otherwise.
904 CBCecCommandType CBCecCommand
;
908 #elif defined(__GNUC__)
909 #define UNUSED(x) UNUSED_ ## x __attribute__((unused))
910 #elif defined(__LCLINT__)
911 #define UNUSED(x) /*@unused@*/ x
921 #endif /* CECTYPES_H_ */