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
75 #define CEC_CONNECT_TRIES 3
77 #define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE 1
78 #define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE 1
79 #define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN 1
80 #define CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER 1
81 #define CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY 1
82 #define CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY 0
83 #define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE 1
84 #define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1
85 #define CEC_DEFAULT_DEVICE_LANGUAGE "eng"
87 #define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
88 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
89 #define CEC_DEFAULT_TRANSMIT_WAIT 2000
90 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
92 #define CEC_MIN_LIB_VERSION 1
93 #define CEC_LIB_VERSION_MAJOR 1
94 #define CEC_LIB_VERSION_MINOR 6
96 typedef enum cec_abort_reason
98 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
= 0,
99 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
= 1,
100 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
= 2,
101 CEC_ABORT_REASON_INVALID_OPERAND
= 3,
102 CEC_ABORT_REASON_REFUSED
= 4
105 typedef enum cec_analogue_broadcast_type
107 CEC_ANALOGUE_BROADCAST_TYPE_CABLE
= 0x00,
108 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE
= 0x01,
109 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL
= 0x02
110 } cec_analogue_broadcast_type
;
112 typedef enum cec_audio_rate
114 CEC_AUDIO_RATE_RATE_CONTROL_OFF
= 0,
115 CEC_AUDIO_RATE_STANDARD_RATE_100
= 1,
116 CEC_AUDIO_RATE_FAST_RATE_MAX_101
= 2,
117 CEC_AUDIO_RATE_SLOW_RATE_MIN_99
= 3,
118 CEC_AUDIO_RATE_STANDARD_RATE_100_0
= 4,
119 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1
= 5,
120 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9
= 6
123 typedef enum cec_audio_status
125 CEC_AUDIO_MUTE_STATUS_MASK
= 0x80,
126 CEC_AUDIO_VOLUME_STATUS_MASK
= 0x7F,
127 CEC_AUDIO_VOLUME_MIN
= 0x00,
128 CEC_AUDIO_VOLUME_MAX
= 0x64,
129 CEC_AUDIO_VOLUME_STATUS_UNKNOWN
= 0x7F
132 typedef enum cec_boolean
138 typedef enum cec_version
140 CEC_VERSION_UNKNOWN
= 0x00,
141 CEC_VERSION_1_2
= 0x01,
142 CEC_VERSION_1_2A
= 0x02,
143 CEC_VERSION_1_3
= 0x03,
144 CEC_VERSION_1_3A
= 0x04,
145 CEC_VERSION_1_4
= 0x05
148 typedef enum cec_channel_identifier
150 CEC_CHANNEL_NUMBER_FORMAT_MASK
= 0xFC000000,
151 CEC_1_PART_CHANNEL_NUMBER
= 0x04000000,
152 CEC_2_PART_CHANNEL_NUMBER
= 0x08000000,
153 CEC_MAJOR_CHANNEL_NUMBER_MASK
= 0x3FF0000,
154 CEC_MINOR_CHANNEL_NUMBER_MASK
= 0xFFFF
155 } cec_channel_identifier
;
157 typedef enum cec_deck_control_mode
159 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND
= 1,
160 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND
= 2,
161 CEC_DECK_CONTROL_MODE_STOP
= 3,
162 CEC_DECK_CONTROL_MODE_EJECT
= 4
163 } cec_deck_control_mode
;
165 typedef enum cec_deck_info
167 CEC_DECK_INFO_PLAY
= 0x11,
168 CEC_DECK_INFO_RECORD
= 0x12,
169 CEC_DECK_INFO_PLAY_REVERSE
= 0x13,
170 CEC_DECK_INFO_STILL
= 0x14,
171 CEC_DECK_INFO_SLOW
= 0x15,
172 CEC_DECK_INFO_SLOW_REVERSE
= 0x16,
173 CEC_DECK_INFO_FAST_FORWARD
= 0x17,
174 CEC_DECK_INFO_FAST_REVERSE
= 0x18,
175 CEC_DECK_INFO_NO_MEDIA
= 0x19,
176 CEC_DECK_INFO_STOP
= 0x1A,
177 CEC_DECK_INFO_SKIP_FORWARD_WIND
= 0x1B,
178 CEC_DECK_INFO_SKIP_REVERSE_REWIND
= 0x1C,
179 CEC_DECK_INFO_INDEX_SEARCH_FORWARD
= 0x1D,
180 CEC_DECK_INFO_INDEX_SEARCH_REVERSE
= 0x1E,
181 CEC_DECK_INFO_OTHER_STATUS
= 0x1F,
182 CEC_DECK_INFO_OTHER_STATUS_LG
= 0x20
185 typedef enum cec_device_type
187 CEC_DEVICE_TYPE_TV
= 0,
188 CEC_DEVICE_TYPE_RECORDING_DEVICE
= 1,
189 CEC_DEVICE_TYPE_RESERVED
= 2,
190 CEC_DEVICE_TYPE_TUNER
= 3,
191 CEC_DEVICE_TYPE_PLAYBACK_DEVICE
= 4,
192 CEC_DEVICE_TYPE_AUDIO_SYSTEM
= 5
195 typedef enum cec_display_control
197 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME
= 0x00,
198 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED
= 0x40,
199 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE
= 0x80,
200 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE
= 0xC0
201 } cec_display_control
;
203 typedef enum cec_external_source_specifier
205 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG
= 4,
206 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS
= 5
207 } cec_external_source_specifier
;
209 typedef enum cec_menu_request_type
211 CEC_MENU_REQUEST_TYPE_ACTIVATE
= 0,
212 CEC_MENU_REQUEST_TYPE_DEACTIVATE
= 1,
213 CEC_MENU_REQUEST_TYPE_QUERY
= 2
214 } cec_menu_request_type
;
216 typedef enum cec_menu_state
218 CEC_MENU_STATE_ACTIVATED
= 0,
219 CEC_MENU_STATE_DEACTIVATED
= 1
222 typedef enum cec_play_mode
224 CEC_PLAY_MODE_PLAY_FORWARD
= 0x24,
225 CEC_PLAY_MODE_PLAY_REVERSE
= 0x20,
226 CEC_PLAY_MODE_PLAY_STILL
= 0x25,
227 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED
= 0x05,
228 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED
= 0x06,
229 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED
= 0x07,
230 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED
= 0x09,
231 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED
= 0x0A,
232 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED
= 0x0B,
233 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED
= 0x15,
234 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED
= 0x16,
235 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED
= 0x17,
236 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED
= 0x19,
237 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED
= 0x1A,
238 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED
= 0x1B
241 typedef enum cec_power_status
243 CEC_POWER_STATUS_ON
= 0x00,
244 CEC_POWER_STATUS_STANDBY
= 0x01,
245 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON
= 0x02,
246 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY
= 0x03,
247 CEC_POWER_STATUS_UNKNOWN
= 0x99
250 typedef enum cec_record_source_type
252 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE
= 1,
253 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE
= 2,
254 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE
= 3,
255 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS
= 4,
256 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS
= 5
257 } cec_record_source_type
;
259 typedef enum cec_record_status_info
261 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE
= 0x01,
262 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE
= 0x02,
263 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE
= 0x03,
264 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT
= 0x04,
265 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE
= 0x05,
266 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE
= 0x06,
267 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE
= 0x07,
268 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER
= 0x09,
269 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS
= 0x0A,
270 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED
= 0x0B,
271 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS
= 0x0C,
272 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE
= 0x0D,
273 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED
= 0x0E,
274 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA
= 0x10,
275 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING
= 0x11,
276 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING
= 0x12,
277 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED
= 0x13,
278 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL
= 0x14,
279 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM
= 0x15,
280 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE
= 0x16,
281 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON
= 0x17,
282 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY
= 0x1A,
283 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED
= 0x1B,
284 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON
= 0x1F
285 } cec_record_status_info
;
287 typedef enum cec_recording_sequence
289 CEC_RECORDING_SEQUENCE_SUNDAY
= 0x01,
290 CEC_RECORDING_SEQUENCE_MONDAY
= 0x02,
291 CEC_RECORDING_SEQUENCE_TUESDAY
= 0x04,
292 CEC_RECORDING_SEQUENCE_WEDNESDAY
= 0x08,
293 CEC_RECORDING_SEQUENCE_THURSDAY
= 0x10,
294 CEC_RECORDING_SEQUENCE_FRIDAY
= 0x20,
295 CEC_RECORDING_SEQUENCE_SATURDAY
= 0x40,
296 CEC_RECORDING_SEQUENCE_ONCE_ONLY
= 0x00
297 } cec_recording_sequence
;
299 typedef enum cec_status_request
301 CEC_STATUS_REQUEST_ON
= 1,
302 CEC_STATUS_REQUEST_OFF
= 2,
303 CEC_STATUS_REQUEST_ONCE
= 3
304 } cec_status_request
;
306 typedef enum cec_system_audio_status
308 CEC_SYSTEM_AUDIO_STATUS_OFF
= 0,
309 CEC_SYSTEM_AUDIO_STATUS_ON
= 1
310 } cec_system_audio_status
;
312 typedef enum cec_timer_cleared_status_data
314 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING
= 0x00,
315 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING
= 0x01,
316 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE
= 0x02,
317 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED
= 0x80
318 } cec_timer_cleared_status_data
;
320 typedef enum cec_timer_overlap_warning
322 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP
= 0,
323 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP
= 1
324 } cec_timer_overlap_warning
;
326 typedef enum cec_media_info
328 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED
= 0x00,
329 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED
= 0x01,
330 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT
= 0x02,
331 CEC_MEDIA_INFO_FUTURE_USE
= 0x03
334 typedef enum cec_programmed_indicator
336 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED
= 0,
337 CEC_PROGRAMMED_INDICATOR_PROGRAMMED
= 1
338 } cec_programmed_indicator
;
340 typedef enum cec_programmed_info
342 CEC_PROGRAMMED_INFO_FUTURE_USE
= 0x0,
343 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x08,
344 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x09,
345 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE
= 0x0B,
346 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE
= 0x0A
347 } cec_programmed_info
;
349 typedef enum cec_not_programmed_error_info
351 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE
= 0x0,
352 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE
= 0x01,
353 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE
= 0x02,
354 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR
= 0x03,
355 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER
= 0x04,
356 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS
= 0x05,
357 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED
= 0x06,
358 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS
= 0x07,
359 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION
= 0x08,
360 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON
= 0x09,
361 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE
= 0x0A,
362 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START
= 0x0B,
363 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END
= 0x0D,
364 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED
= 0x0E
365 } cec_not_programmed_error_info
;
367 typedef enum cec_recording_flag
369 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING
= 0,
370 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING
= 1
371 } cec_recording_flag
;
373 typedef enum cec_tuner_display_info
375 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER
= 0,
376 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER
= 1,
377 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER
= 2
378 } cec_tuner_display_info
;
380 typedef enum cec_broadcast_system
382 CEC_BROADCAST_SYSTEM_PAL_B_G
= 0,
383 CEC_BROADCAST_SYSTEM_SECAM_L1
= 1,
384 CEC_BROADCAST_SYSTEM_PAL_M
= 2,
385 CEC_BROADCAST_SYSTEM_NTSC_M
= 3,
386 CEC_BROADCAST_SYSTEM_PAL_I
= 4,
387 CEC_BROADCAST_SYSTEM_SECAM_DK
= 5,
388 CEC_BROADCAST_SYSTEM_SECAM_B_G
= 6,
389 CEC_BROADCAST_SYSTEM_SECAM_L2
= 7,
390 CEC_BROADCAST_SYSTEM_PAL_DK
= 8,
391 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM
= 30
392 } cec_broadcast_system
;
394 typedef enum cec_user_control_code
396 CEC_USER_CONTROL_CODE_SELECT
= 0x00,
397 CEC_USER_CONTROL_CODE_UP
= 0x01,
398 CEC_USER_CONTROL_CODE_DOWN
= 0x02,
399 CEC_USER_CONTROL_CODE_LEFT
= 0x03,
400 CEC_USER_CONTROL_CODE_RIGHT
= 0x04,
401 CEC_USER_CONTROL_CODE_RIGHT_UP
= 0x05,
402 CEC_USER_CONTROL_CODE_RIGHT_DOWN
= 0x06,
403 CEC_USER_CONTROL_CODE_LEFT_UP
= 0x07,
404 CEC_USER_CONTROL_CODE_LEFT_DOWN
= 0x08,
405 CEC_USER_CONTROL_CODE_ROOT_MENU
= 0x09,
406 CEC_USER_CONTROL_CODE_SETUP_MENU
= 0x0A,
407 CEC_USER_CONTROL_CODE_CONTENTS_MENU
= 0x0B,
408 CEC_USER_CONTROL_CODE_FAVORITE_MENU
= 0x0C,
409 CEC_USER_CONTROL_CODE_EXIT
= 0x0D,
410 CEC_USER_CONTROL_CODE_NUMBER0
= 0x20,
411 CEC_USER_CONTROL_CODE_NUMBER1
= 0x21,
412 CEC_USER_CONTROL_CODE_NUMBER2
= 0x22,
413 CEC_USER_CONTROL_CODE_NUMBER3
= 0x23,
414 CEC_USER_CONTROL_CODE_NUMBER4
= 0x24,
415 CEC_USER_CONTROL_CODE_NUMBER5
= 0x25,
416 CEC_USER_CONTROL_CODE_NUMBER6
= 0x26,
417 CEC_USER_CONTROL_CODE_NUMBER7
= 0x27,
418 CEC_USER_CONTROL_CODE_NUMBER8
= 0x28,
419 CEC_USER_CONTROL_CODE_NUMBER9
= 0x29,
420 CEC_USER_CONTROL_CODE_DOT
= 0x2A,
421 CEC_USER_CONTROL_CODE_ENTER
= 0x2B,
422 CEC_USER_CONTROL_CODE_CLEAR
= 0x2C,
423 CEC_USER_CONTROL_CODE_NEXT_FAVORITE
= 0x2F,
424 CEC_USER_CONTROL_CODE_CHANNEL_UP
= 0x30,
425 CEC_USER_CONTROL_CODE_CHANNEL_DOWN
= 0x31,
426 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL
= 0x32,
427 CEC_USER_CONTROL_CODE_SOUND_SELECT
= 0x33,
428 CEC_USER_CONTROL_CODE_INPUT_SELECT
= 0x34,
429 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION
= 0x35,
430 CEC_USER_CONTROL_CODE_HELP
= 0x36,
431 CEC_USER_CONTROL_CODE_PAGE_UP
= 0x37,
432 CEC_USER_CONTROL_CODE_PAGE_DOWN
= 0x38,
433 CEC_USER_CONTROL_CODE_POWER
= 0x40,
434 CEC_USER_CONTROL_CODE_VOLUME_UP
= 0x41,
435 CEC_USER_CONTROL_CODE_VOLUME_DOWN
= 0x42,
436 CEC_USER_CONTROL_CODE_MUTE
= 0x43,
437 CEC_USER_CONTROL_CODE_PLAY
= 0x44,
438 CEC_USER_CONTROL_CODE_STOP
= 0x45,
439 CEC_USER_CONTROL_CODE_PAUSE
= 0x46,
440 CEC_USER_CONTROL_CODE_RECORD
= 0x47,
441 CEC_USER_CONTROL_CODE_REWIND
= 0x48,
442 CEC_USER_CONTROL_CODE_FAST_FORWARD
= 0x49,
443 CEC_USER_CONTROL_CODE_EJECT
= 0x4A,
444 CEC_USER_CONTROL_CODE_FORWARD
= 0x4B,
445 CEC_USER_CONTROL_CODE_BACKWARD
= 0x4C,
446 CEC_USER_CONTROL_CODE_STOP_RECORD
= 0x4D,
447 CEC_USER_CONTROL_CODE_PAUSE_RECORD
= 0x4E,
448 CEC_USER_CONTROL_CODE_ANGLE
= 0x50,
449 CEC_USER_CONTROL_CODE_SUB_PICTURE
= 0x51,
450 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND
= 0x52,
451 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE
= 0x53,
452 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING
= 0x54,
453 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION
= 0x55,
454 CEC_USER_CONTROL_CODE_PLAY_FUNCTION
= 0x60,
455 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION
= 0x61,
456 CEC_USER_CONTROL_CODE_RECORD_FUNCTION
= 0x62,
457 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION
= 0x63,
458 CEC_USER_CONTROL_CODE_STOP_FUNCTION
= 0x64,
459 CEC_USER_CONTROL_CODE_MUTE_FUNCTION
= 0x65,
460 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION
= 0x66,
461 CEC_USER_CONTROL_CODE_TUNE_FUNCTION
= 0x67,
462 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION
= 0x68,
463 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION
= 0x69,
464 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION
= 0x6A,
465 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION
= 0x6B,
466 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION
= 0x6C,
467 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION
= 0x6D,
468 CEC_USER_CONTROL_CODE_F1_BLUE
= 0x71,
469 CEC_USER_CONTROL_CODE_F2_RED
= 0X72,
470 CEC_USER_CONTROL_CODE_F3_GREEN
= 0x73,
471 CEC_USER_CONTROL_CODE_F4_YELLOW
= 0x74,
472 CEC_USER_CONTROL_CODE_F5
= 0x75,
473 CEC_USER_CONTROL_CODE_DATA
= 0x76,
474 CEC_USER_CONTROL_CODE_AN_RETURN
= 0x91,
475 CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST
= 0x96,
476 CEC_USER_CONTROL_CODE_MAX
= 0x96,
477 CEC_USER_CONTROL_CODE_UNKNOWN
478 } cec_user_control_code
;
480 typedef enum cec_logical_address
482 CECDEVICE_UNKNOWN
= -1, //not a valid logical address
484 CECDEVICE_RECORDINGDEVICE1
= 1,
485 CECDEVICE_RECORDINGDEVICE2
= 2,
486 CECDEVICE_TUNER1
= 3,
487 CECDEVICE_PLAYBACKDEVICE1
= 4,
488 CECDEVICE_AUDIOSYSTEM
= 5,
489 CECDEVICE_TUNER2
= 6,
490 CECDEVICE_TUNER3
= 7,
491 CECDEVICE_PLAYBACKDEVICE2
= 8,
492 CECDEVICE_RECORDINGDEVICE3
= 9,
493 CECDEVICE_TUNER4
= 10,
494 CECDEVICE_PLAYBACKDEVICE3
= 11,
495 CECDEVICE_RESERVED1
= 12,
496 CECDEVICE_RESERVED2
= 13,
497 CECDEVICE_FREEUSE
= 14,
498 CECDEVICE_UNREGISTERED
= 15,
499 CECDEVICE_BROADCAST
= 15
500 } cec_logical_address
;
502 typedef enum cec_opcode
504 CEC_OPCODE_ACTIVE_SOURCE
= 0x82,
505 CEC_OPCODE_IMAGE_VIEW_ON
= 0x04,
506 CEC_OPCODE_TEXT_VIEW_ON
= 0x0D,
507 CEC_OPCODE_INACTIVE_SOURCE
= 0x9D,
508 CEC_OPCODE_REQUEST_ACTIVE_SOURCE
= 0x85,
509 CEC_OPCODE_ROUTING_CHANGE
= 0x80,
510 CEC_OPCODE_ROUTING_INFORMATION
= 0x81,
511 CEC_OPCODE_SET_STREAM_PATH
= 0x86,
512 CEC_OPCODE_STANDBY
= 0x36,
513 CEC_OPCODE_RECORD_OFF
= 0x0B,
514 CEC_OPCODE_RECORD_ON
= 0x09,
515 CEC_OPCODE_RECORD_STATUS
= 0x0A,
516 CEC_OPCODE_RECORD_TV_SCREEN
= 0x0F,
517 CEC_OPCODE_CLEAR_ANALOGUE_TIMER
= 0x33,
518 CEC_OPCODE_CLEAR_DIGITAL_TIMER
= 0x99,
519 CEC_OPCODE_CLEAR_EXTERNAL_TIMER
= 0xA1,
520 CEC_OPCODE_SET_ANALOGUE_TIMER
= 0x34,
521 CEC_OPCODE_SET_DIGITAL_TIMER
= 0x97,
522 CEC_OPCODE_SET_EXTERNAL_TIMER
= 0xA2,
523 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE
= 0x67,
524 CEC_OPCODE_TIMER_CLEARED_STATUS
= 0x43,
525 CEC_OPCODE_TIMER_STATUS
= 0x35,
526 CEC_OPCODE_CEC_VERSION
= 0x9E,
527 CEC_OPCODE_GET_CEC_VERSION
= 0x9F,
528 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
= 0x83,
529 CEC_OPCODE_GET_MENU_LANGUAGE
= 0x91,
530 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
= 0x84,
531 CEC_OPCODE_SET_MENU_LANGUAGE
= 0x32,
532 CEC_OPCODE_DECK_CONTROL
= 0x42,
533 CEC_OPCODE_DECK_STATUS
= 0x1B,
534 CEC_OPCODE_GIVE_DECK_STATUS
= 0x1A,
535 CEC_OPCODE_PLAY
= 0x41,
536 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
= 0x08,
537 CEC_OPCODE_SELECT_ANALOGUE_SERVICE
= 0x92,
538 CEC_OPCODE_SELECT_DIGITAL_SERVICE
= 0x93,
539 CEC_OPCODE_TUNER_DEVICE_STATUS
= 0x07,
540 CEC_OPCODE_TUNER_STEP_DECREMENT
= 0x06,
541 CEC_OPCODE_TUNER_STEP_INCREMENT
= 0x05,
542 CEC_OPCODE_DEVICE_VENDOR_ID
= 0x87,
543 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
= 0x8C,
544 CEC_OPCODE_VENDOR_COMMAND
= 0x89,
545 CEC_OPCODE_VENDOR_COMMAND_WITH_ID
= 0xA0,
546 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
= 0x8A,
547 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
= 0x8B,
548 CEC_OPCODE_SET_OSD_STRING
= 0x64,
549 CEC_OPCODE_GIVE_OSD_NAME
= 0x46,
550 CEC_OPCODE_SET_OSD_NAME
= 0x47,
551 CEC_OPCODE_MENU_REQUEST
= 0x8D,
552 CEC_OPCODE_MENU_STATUS
= 0x8E,
553 CEC_OPCODE_USER_CONTROL_PRESSED
= 0x44,
554 CEC_OPCODE_USER_CONTROL_RELEASE
= 0x45,
555 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
= 0x8F,
556 CEC_OPCODE_REPORT_POWER_STATUS
= 0x90,
557 CEC_OPCODE_FEATURE_ABORT
= 0x00,
558 CEC_OPCODE_ABORT
= 0xFF,
559 CEC_OPCODE_GIVE_AUDIO_STATUS
= 0x71,
560 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
= 0x7D,
561 CEC_OPCODE_REPORT_AUDIO_STATUS
= 0x7A,
562 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
= 0x72,
563 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
= 0x70,
564 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
= 0x7E,
565 CEC_OPCODE_SET_AUDIO_RATE
= 0x9A,
566 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
567 CEC_OPCODE_NONE
= 0xFD
570 typedef enum cec_log_level
580 typedef enum cec_adapter_messagecode
584 MSGCODE_TIMEOUT_ERROR
,
589 MSGCODE_RECEIVE_FAILED
,
590 MSGCODE_COMMAND_ACCEPTED
,
591 MSGCODE_COMMAND_REJECTED
,
592 MSGCODE_SET_ACK_MASK
,
594 MSGCODE_TRANSMIT_EOM
,
595 MSGCODE_TRANSMIT_IDLETIME
,
596 MSGCODE_TRANSMIT_ACK_POLARITY
,
597 MSGCODE_TRANSMIT_LINE_TIMEOUT
,
598 MSGCODE_TRANSMIT_SUCCEEDED
,
599 MSGCODE_TRANSMIT_FAILED_LINE
,
600 MSGCODE_TRANSMIT_FAILED_ACK
,
601 MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA
,
602 MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE
,
603 MSGCODE_FIRMWARE_VERSION
,
604 MSGCODE_START_BOOTLOADER
,
605 MSGCODE_SET_POWERSTATE
,
606 MSGCODE_SET_CONTROLLED
,
607 MSGCODE_GET_AUTO_ENABLED
,
608 MSGCODE_SET_AUTO_ENABLED
,
609 MSGCODE_GET_DEFAULT_LOGICAL_ADDRESS
,
610 MSGCODE_SET_DEFAULT_LOGICAL_ADDRESS
,
611 MSGCODE_GET_LOGICAL_ADDRESS_MASK
,
612 MSGCODE_SET_LOGICAL_ADDRESS_MASK
,
613 MSGCODE_GET_PHYSICAL_ADDRESS
,
614 MSGCODE_SET_PHYSICAL_ADDRESS
,
615 MSGCODE_GET_DEVICE_TYPE
,
616 MSGCODE_SET_DEVICE_TYPE
,
617 MSGCODE_GET_HDMI_VERSION
,
618 MSGCODE_SET_HDMI_VERSION
,
619 MSGCODE_GET_OSD_NAME
,
620 MSGCODE_SET_OSD_NAME
,
621 MSGCODE_WRITE_EEPROM
,
622 MSGCODE_FRAME_EOM
= 0x80,
623 MSGCODE_FRAME_ACK
= 0x40,
624 } cec_adapter_messagecode
;
626 typedef enum cec_bus_device_status
628 CEC_DEVICE_STATUS_UNKNOWN
,
629 CEC_DEVICE_STATUS_PRESENT
,
630 CEC_DEVICE_STATUS_NOT_PRESENT
,
631 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
632 } cec_bus_device_status
;
634 typedef enum cec_vendor_id
636 CEC_VENDOR_SAMSUNG
= 0x0000F0,
637 CEC_VENDOR_LG
= 0x00E091,
638 CEC_VENDOR_PANASONIC
= 0x008045,
639 CEC_VENDOR_PIONEER
= 0x00E036,
640 CEC_VENDOR_ONKYO
= 0x0009B0,
641 CEC_VENDOR_YAMAHA
= 0x00A0DE,
642 CEC_VENDOR_PHILIPS
= 0x00903E,
643 CEC_VENDOR_SONY
= 0x080046,
644 CEC_VENDOR_TOSHIBA
= 0x000039,
645 CEC_VENDOR_UNKNOWN
= 0
648 typedef struct cec_menu_language
650 char language
[4]; /**< the iso language code. @bug the language code is only 3 chars long, not 4. will be changed in v2.0, because changing it now would break backwards compat */
651 cec_logical_address device
; /**< the logical address of the device */
654 typedef struct cec_osd_name
656 char name
[14]; /**< the name of the device */
657 cec_logical_address device
; /**< the logical address of the device */
660 typedef struct cec_log_message
662 char message
[1024]; /**< the actual message */
663 cec_log_level level
; /**< log level of the message */
664 int64_t time
; /**< the timestamp of this message */
667 typedef struct cec_keypress
669 cec_user_control_code keycode
; /**< the keycode */
670 unsigned int duration
; /**< the duration of the keypress */
673 typedef struct cec_adapter
675 char path
[1024]; /**< the path to the com port */
676 char comm
[1024]; /**< the name of the com port */
679 typedef struct cec_datapacket
681 uint8_t data
[100]; /**< the actual data */
682 uint8_t size
; /**< the size of the data */
685 cec_datapacket
&operator =(const struct cec_datapacket
&packet
)
688 for (uint8_t iPtr
= 0; iPtr
< packet
.size
; iPtr
++)
689 PushBack(packet
[iPtr
]);
694 bool IsEmpty(void) const { return size
== 0; } /**< @return True when this packet is empty, false otherwise. */
695 bool IsFull(void) const { return size
== 100; } /**< @return True when this packet is false, false otherwise. */
698 * @brief Get the byte at the requested position.
699 * @param pos The position.
700 * @return The byte, or 0 when out of bounds.
702 uint8_t operator[](uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
704 * @brief Get the byte at the requested position.
705 * @param pos The position.
706 * @return The byte, or 0 when out of bounds.
708 uint8_t At(uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
711 * @brief Shift the contents of this packet.
712 * @param iShiftBy The number of positions to shift.
714 void Shift(uint8_t iShiftBy
)
716 if (iShiftBy
>= size
)
722 for (uint8_t iPtr
= 0; iPtr
< size
; iPtr
++)
723 data
[iPtr
] = (iPtr
+ iShiftBy
< size
) ? data
[iPtr
+ iShiftBy
] : 0;
724 size
= (uint8_t) (size
- iShiftBy
);
729 * @brief Push a byte to the end of this packet.
730 * @param add The byte to add.
732 void PushBack(uint8_t add
)
739 * @brief Clear this packet.
743 memset(data
, 0, sizeof(data
));
750 typedef struct cec_command
752 cec_logical_address initiator
; /**< the logical address of the initiator of this message */
753 cec_logical_address destination
; /**< the logical address of the destination of this message */
754 int8_t ack
; /**< 1 when the ACK bit is set, 0 otherwise */
755 int8_t eom
; /**< 1 when the EOM bit is set, 0 otherwise */
756 cec_opcode opcode
; /**< the opcode of this message */
757 cec_datapacket parameters
; /**< the parameters attached to this message */
758 int8_t opcode_set
; /**< 1 when an opcode is set, 0 otherwise (POLL message) */
759 int32_t transmit_timeout
; /**< the timeout to use in ms */
762 cec_command
&operator =(const struct cec_command
&command
)
764 initiator
= command
.initiator
;
765 destination
= command
.destination
;
768 opcode
= command
.opcode
;
769 opcode_set
= command
.opcode_set
;
770 transmit_timeout
= command
.transmit_timeout
;
771 parameters
= command
.parameters
;
777 * @brief Formats a cec_command.
778 * @param command The command to format.
779 * @param initiator The logical address of the initiator.
780 * @param destination The logical addres of the destination.
781 * @param opcode The opcode of the command.
782 * @param timeout The transmission timeout.
784 static void Format(cec_command
&command
, cec_logical_address initiator
, cec_logical_address destination
, cec_opcode opcode
, int32_t timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
)
787 command
.initiator
= initiator
;
788 command
.destination
= destination
;
789 command
.transmit_timeout
= timeout
;
790 if (opcode
!= CEC_OPCODE_NONE
)
792 command
.opcode
= opcode
;
793 command
.opcode_set
= 1;
798 * @brief Push a byte to the back of this command.
799 * @param data The byte to push.
801 void PushBack(uint8_t data
)
803 if (initiator
== CECDEVICE_UNKNOWN
&& destination
== CECDEVICE_UNKNOWN
)
805 initiator
= (cec_logical_address
) (data
>> 4);
806 destination
= (cec_logical_address
) (data
& 0xF);
808 else if (!opcode_set
)
811 opcode
= (cec_opcode
) data
;
814 parameters
.PushBack(data
);
818 * @brief Clear this command, resetting everything to the default values.
822 initiator
= CECDEVICE_UNKNOWN
;
823 destination
= CECDEVICE_UNKNOWN
;
827 opcode
= CEC_OPCODE_FEATURE_ABORT
;
828 transmit_timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
;
834 typedef struct cec_device_type_list
836 cec_device_type types
[5]; /**< the list of device types */
840 * @deprecated Use Clear() instead.
841 * @brief Clear this list.
843 void clear(void) { Clear(); }
845 * @deprecated Use Add() instead.
846 * @brief Add a type to this list.
847 * @param type The type to add.
849 void add(const cec_device_type type
) { Add(type
); }
852 * @brief Clear this list.
856 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
857 types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
861 * @brief Add a type to this list.
862 * @param type The type to add.
864 void Add(const cec_device_type type
)
866 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
868 if (types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
877 * @brief Check whether a type is set in this list.
878 * @param type The type to check.
879 * @return True when set, false otherwise.
881 bool IsSet(cec_device_type type
)
884 for (unsigned int iPtr
= 0; !bReturn
&& iPtr
< 5; iPtr
++)
886 if (types
[iPtr
] == type
)
893 * @return True when this list is empty, false otherwise.
898 for (unsigned int iPtr
= 0; bReturn
&& iPtr
< 5; iPtr
++)
900 if (types
[iPtr
] != CEC_DEVICE_TYPE_RESERVED
)
907 * @brief Get the type at the requested position.
908 * @param pos The position.
909 * @return The type, or CEC_DEVICE_TYPE_RESERVED when out of bounds.
911 cec_device_type
operator[](uint8_t pos
) const { return pos
< 5 ? types
[pos
] : CEC_DEVICE_TYPE_RESERVED
; }
913 bool operator==(const cec_device_type_list
&other
) const
916 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
917 bEqual
&= (types
[iPtr
] == other
[iPtr
]);
921 bool operator!=(const cec_device_type_list
&other
) const
923 return !(*this == other
);
926 } cec_device_type_list
;
928 typedef struct cec_logical_addresses
930 cec_logical_address primary
; /**< the primary logical address to use */
931 int addresses
[16]; /**< the list of addresses */
935 * @brief Clear this list.
939 primary
= CECDEVICE_UNKNOWN
;
940 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
945 * @return True when empty, false otherwise.
947 bool IsEmpty(void) const
949 return primary
== CECDEVICE_UNKNOWN
;
953 * @brief Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.
954 * @return The ack-mask.
956 uint16_t AckMask(void) const
959 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
960 if (addresses
[iPtr
] == 1)
966 * @brief Mark a logical address as 'set'
967 * @param address The logical address to add to this list.
969 void Set(cec_logical_address address
)
971 if (primary
== CECDEVICE_UNKNOWN
)
974 addresses
[(int) address
] = 1;
978 * @brief Mark a logical address as 'unset'
979 * @param address The logical address to remove from this list.
981 void Unset(cec_logical_address address
)
983 if (primary
== address
)
984 primary
= CECDEVICE_UNKNOWN
;
986 addresses
[(int) address
] = 0;
990 * @brief Check whether an address is set in this list.
991 * @param address The address to check.
992 * @return True when set, false otherwise.
994 bool IsSet(cec_logical_address address
) const { return addresses
[(int) address
] == 1; }
997 * @brief Check whether an address is set in this list.
998 * @param pos The address to check.
999 * @return True when set, false otherwise.
1001 bool operator[](uint8_t pos
) const { return pos
< 16 ? IsSet((cec_logical_address
) pos
) : false; }
1003 bool operator==(const cec_logical_addresses
&other
) const
1006 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
1007 bEqual
&= ((addresses
[(int)iPtr
] == 1) == other
[iPtr
]);
1011 bool operator!=(const cec_logical_addresses
&other
) const
1013 return !(*this == other
);
1016 } cec_logical_addresses
;
1018 typedef enum libcec_alert
1020 CEC_ALERT_SERVICE_DEVICE
,
1021 CEC_ALERT_CONNECTION_LOST
1024 typedef enum libcec_parameter_type
1026 CEC_PARAMETER_TYPE_STRING
1027 } libcec_parameter_type
;
1029 struct libcec_parameter
1031 libcec_parameter_type paramType
; /**< the type of this parameter */
1032 void* paramData
; /**< the value of this parameter */
1035 struct libcec_configuration
;
1037 typedef int (CEC_CDECL
* CBCecLogMessageType
)(void *param
, const cec_log_message
&);
1038 typedef int (CEC_CDECL
* CBCecKeyPressType
)(void *param
, const cec_keypress
&);
1039 typedef int (CEC_CDECL
* CBCecCommandType
)(void *param
, const cec_command
&);
1040 typedef int (CEC_CDECL
* CBCecConfigurationChangedType
)(void *param
, const libcec_configuration
&);
1041 typedef int (CEC_CDECL
* CBCecAlertType
)(void *param
, const libcec_alert
, const libcec_parameter
&);
1042 typedef int (CEC_CDECL
* CBCecMenuStateChangedType
)(void *param
, const cec_menu_state newVal
);
1044 typedef struct ICECCallbacks
1047 * @brief Transfer a log message from libCEC to the client.
1048 * @param message The message to transfer.
1049 * @return 1 when ok, 0 otherwise.
1051 CBCecLogMessageType CBCecLogMessage
;
1054 * @brief Transfer a keypress from libCEC to the client.
1055 * @param key The keypress to transfer.
1056 * @return 1 when ok, 0 otherwise.
1058 CBCecKeyPressType CBCecKeyPress
;
1061 * @brief Transfer a CEC command from libCEC to the client.
1062 * @param command The command to transfer.
1063 * @return 1 when ok, 0 otherwise.
1065 CBCecCommandType CBCecCommand
;
1068 * @brief Transfer a changed configuration from libCEC to the client
1069 * @param configuration The configuration to transfer
1070 * @return 1 when ok, 0 otherwise
1072 CBCecConfigurationChangedType CBCecConfigurationChanged
;
1075 * @brief Transfer a libcec alert message from libCEC to the client
1076 * @param alert The alert type transfer.
1077 * @param data Misc. additional information.
1078 * @return 1 when ok, 0 otherwise
1080 CBCecAlertType CBCecAlert
;
1083 * @brief Transfer a menu state change to the client.
1084 * Transfer a menu state change to the client. If the command returns 1, then the change will be processed by
1085 * the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',
1086 * so keypresses are always routed.
1087 * @param newVal The new value.
1088 * @return 1 when this change should be processed by the CCECBusDevice, false otherwise.
1090 CBCecMenuStateChangedType CBCecMenuStateChanged
;
1093 ICECCallbacks(void) { Clear(); }
1094 ~ICECCallbacks(void) { Clear(); };
1098 CBCecLogMessage
= NULL
;
1099 CBCecKeyPress
= NULL
;
1100 CBCecCommand
= NULL
;
1101 CBCecConfigurationChanged
= NULL
;
1103 CBCecMenuStateChanged
= NULL
;
1108 typedef enum cec_client_version
1110 CEC_CLIENT_VERSION_PRE_1_5
= 0,
1111 CEC_CLIENT_VERSION_1_5_0
= 0x1500,
1112 CEC_CLIENT_VERSION_1_5_1
= 0x1501,
1113 CEC_CLIENT_VERSION_1_5_2
= 0x1502,
1114 CEC_CLIENT_VERSION_1_5_3
= 0x1503,
1115 CEC_CLIENT_VERSION_1_6_0
= 0x1600,
1116 CEC_CLIENT_VERSION_1_6_1
= 0x1601,
1117 CEC_CLIENT_VERSION_1_6_2
= 0x1602
1118 } cec_client_version
;
1120 typedef enum cec_server_version
1122 CEC_SERVER_VERSION_PRE_1_5
= 0,
1123 CEC_SERVER_VERSION_1_5_0
= 0x1500,
1124 CEC_SERVER_VERSION_1_5_1
= 0x1501,
1125 CEC_SERVER_VERSION_1_5_2
= 0x1502,
1126 CEC_SERVER_VERSION_1_5_3
= 0x1503,
1127 CEC_SERVER_VERSION_1_6_0
= 0x1600,
1128 CEC_SERVER_VERSION_1_6_1
= 0x1601
1129 } cec_server_version
;
1131 typedef struct libcec_configuration
1133 uint32_t clientVersion
; /*!< the version of the client that is connecting */
1134 char strDeviceName
[13]; /*!< how to name the device on the CEC bus */
1135 cec_device_type_list deviceTypes
; /*!< the CEC device types to emulate */
1136 uint8_t bAutodetectAddress
; /*!< try to autodetect the physical address when 1 */
1137 uint16_t iPhysicalAddress
; /*!< the physical address of the CEC adapter. only used when bAutodetectAddress = 0 or when the adapter doesn't support autodetection */
1138 cec_logical_address baseDevice
; /*!< the logical address of the device to which the adapter is connected. only used when iPhysicalAddress = 0 and bAutodetectAddress = 0 or when the adapter doesn't support autodetection */
1139 uint8_t iHDMIPort
; /*!< the HDMI port to which the adapter is connected. only used when iPhysicalAddress = 0 and bAutodetectAddress = 0 or when the adapter doesn't support autodetection */
1140 uint64_t tvVendor
; /*!< override the vendor ID of the TV. leave this untouched to autodetect */
1141 cec_logical_addresses wakeDevices
; /*!< wake these CEC devices when initialising libCEC or when calling PowerOnDevices() without any parameter */
1142 cec_logical_addresses powerOffDevices
; /*!< power off these devices when calling StandbyDevices() without any parameter */
1144 uint32_t serverVersion
; /*!< the version number of the server. read-only */
1146 // player specific settings
1147 uint8_t bGetSettingsFromROM
; /*!< true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings. */
1148 uint8_t bUseTVMenuLanguage
; /*!< use the menu language of the TV in the player application */
1149 uint8_t bActivateSource
; /*!< make libCEC the active source on the bus when starting the player application */
1150 uint8_t bPowerOffScreensaver
; /*!< put devices in standby mode when activating the screensaver */
1151 uint8_t bPowerOffOnStandby
; /*!< put this PC in standby mode when the TV is switched off. only used when bShutdownOnStandby = 0 */
1152 uint8_t bSendInactiveSource
; /*!< send an 'inactive source' message when stopping the player. added in 1.5.1 */
1154 void * callbackParam
; /*!< the object to pass along with a call of the callback methods. NULL to ignore */
1155 ICECCallbacks
* callbacks
; /*!< the callback methods to use. set this to NULL when not using callbacks */
1157 cec_logical_addresses logicalAddresses
; /*!< the current logical addresses. read-only. added in 1.5.3 */
1158 uint16_t iFirmwareVersion
; /*!< the firmware version of the adapter. added in 1.6.0 */
1159 uint8_t bPowerOffDevicesOnStandby
; /*!< put devices in standby when the PC/player is put in standby. added in 1.6.0 */
1160 uint8_t bShutdownOnStandby
; /*!< shutdown this PC when the TV is switched off. only used when bPowerOffOnStandby = 0. added in 1.6.0 */
1161 char strDeviceLanguage
[3]; /*!< the menu language used by the client. 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/ */
1164 libcec_configuration(void) { Clear(); }
1165 ~libcec_configuration(void) { Clear(); }
1168 * @brief Reset this configution struct to the default values.
1172 memset(strDeviceName
, 0, 13);
1173 deviceTypes
.clear();
1174 iPhysicalAddress
= 0;
1175 baseDevice
= (cec_logical_address
)CEC_DEFAULT_BASE_DEVICE
;
1176 iHDMIPort
= CEC_DEFAULT_HDMI_PORT
;
1177 tvVendor
= (uint64_t)CEC_VENDOR_UNKNOWN
;
1178 clientVersion
= (uint32_t)CEC_CLIENT_VERSION_PRE_1_5
;
1179 serverVersion
= (uint32_t)CEC_SERVER_VERSION_PRE_1_5
;
1180 wakeDevices
.Clear();
1181 powerOffDevices
.Clear();
1183 bAutodetectAddress
= 1;
1184 bGetSettingsFromROM
= 0;
1185 bUseTVMenuLanguage
= CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE
;
1186 bActivateSource
= CEC_DEFAULT_SETTING_ACTIVATE_SOURCE
;
1187 #if CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1
1188 powerOffDevices
.Set(CECDEVICE_BROADCAST
);
1190 #if CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1
1191 wakeDevices
.Set(CECDEVICE_TV
);
1193 bPowerOffScreensaver
= CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER
;
1194 bPowerOffOnStandby
= CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY
;
1195 bShutdownOnStandby
= CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY
;
1196 bSendInactiveSource
= CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE
;
1197 logicalAddresses
.Clear();
1198 iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
1199 bPowerOffDevicesOnStandby
= CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY
;
1200 memcpy(strDeviceLanguage
, CEC_DEFAULT_DEVICE_LANGUAGE
, 3);
1202 callbackParam
= NULL
;
1206 } libcec_configuration
;
1209 #elif defined(__GNUC__)
1210 #define UNUSED(x) UNUSED_ ## x __attribute__((unused))
1211 #elif defined(__LCLINT__)
1212 #define UNUSED(x) /*@unused@*/ x
1222 #endif /* CECTYPES_H_ */