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_FW_BUILD_UNKNOWN 0
76 #define CEC_CONNECT_TRIES 3
78 #define CEC_PHYSICAL_ADDRESS_TV 0
79 #define CEC_MIN_PHYSICAL_ADDRESS 0x1000
80 #define CEC_MAX_PHYSICAL_ADDRESS 0xFFFE
81 #define CEC_INVALID_PHYSICAL_ADDRESS 0xFFFF
83 #define CEC_MIN_VENDORID 1
84 #define CEC_MAX_VENDORID 0xFFFFFE
85 #define CEC_INVALID_VENDORID 0xFFFFFF
87 #define CEC_MIN_HDMI_PORTNUMBER 1
88 #define CEC_MAX_HDMI_PORTNUMBER 15
89 #define CEC_HDMI_PORTNUMBER_NONE 0
91 #define CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE 1
92 #define CEC_DEFAULT_SETTING_ACTIVATE_SOURCE 1
93 #define CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN 1
94 #define CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER 1
95 #define CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY 1
96 #define CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY 0
97 #define CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE 1
98 #define CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY 1
99 #define CEC_DEFAULT_DEVICE_LANGUAGE "eng"
100 #define CEC_DEFAULT_SETTING_AUTODETECT_ADDRESS 0
101 #define CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM 0
102 #define CEC_DEFAULT_SETTING_CEC_VERSION 0x05
104 #define CEC_DEFAULT_TRANSMIT_RETRY_WAIT 500
105 #define CEC_DEFAULT_TRANSMIT_TIMEOUT 1000
106 #define CEC_DEFAULT_TRANSMIT_WAIT 1000
107 #define CEC_DEFAULT_TRANSMIT_RETRIES 1
109 #define CEC_DEFAULT_CONNECT_TIMEOUT 10000
110 #define CEC_DEFAULT_CONNECT_RETRY_WAIT 1000
111 #define CEC_SERIAL_DEFAULT_BAUDRATE 38400
112 #define CEC_CLEAR_INPUT_DEFAULT_WAIT 1000
114 #define CEC_ACTIVE_SOURCE_SWITCH_RETRY_TIME_MS 5000
115 #define CEC_FORWARD_STANDBY_MIN_INTERVAL 10000
117 #define CEC_RPI_VIRTUAL_PATH "Raspberry Pi"
118 #define CEC_RPI_VIRTUAL_COM "RPI"
120 #define CEC_MIN_LIB_VERSION 1
121 #define CEC_LIB_VERSION_MAJOR 1
122 #define CEC_LIB_VERSION_MAJOR_STR "1"
123 #define CEC_LIB_VERSION_MINOR 9
125 typedef enum cec_abort_reason
127 CEC_ABORT_REASON_UNRECOGNIZED_OPCODE
= 0,
128 CEC_ABORT_REASON_NOT_IN_CORRECT_MODE_TO_RESPOND
= 1,
129 CEC_ABORT_REASON_CANNOT_PROVIDE_SOURCE
= 2,
130 CEC_ABORT_REASON_INVALID_OPERAND
= 3,
131 CEC_ABORT_REASON_REFUSED
= 4
134 typedef enum cec_analogue_broadcast_type
136 CEC_ANALOGUE_BROADCAST_TYPE_CABLE
= 0x00,
137 CEC_ANALOGUE_BROADCAST_TYPE_SATELLITE
= 0x01,
138 CEC_ANALOGUE_BROADCAST_TYPE_TERRESTIAL
= 0x02
139 } cec_analogue_broadcast_type
;
141 typedef enum cec_audio_rate
143 CEC_AUDIO_RATE_RATE_CONTROL_OFF
= 0,
144 CEC_AUDIO_RATE_STANDARD_RATE_100
= 1,
145 CEC_AUDIO_RATE_FAST_RATE_MAX_101
= 2,
146 CEC_AUDIO_RATE_SLOW_RATE_MIN_99
= 3,
147 CEC_AUDIO_RATE_STANDARD_RATE_100_0
= 4,
148 CEC_AUDIO_RATE_FAST_RATE_MAX_100_1
= 5,
149 CEC_AUDIO_RATE_SLOW_RATE_MIN_99_9
= 6
152 typedef enum cec_audio_status
154 CEC_AUDIO_MUTE_STATUS_MASK
= 0x80,
155 CEC_AUDIO_VOLUME_STATUS_MASK
= 0x7F,
156 CEC_AUDIO_VOLUME_MIN
= 0x00,
157 CEC_AUDIO_VOLUME_MAX
= 0x64,
158 CEC_AUDIO_VOLUME_STATUS_UNKNOWN
= 0x7F
161 typedef enum cec_boolean
167 typedef enum cec_version
169 CEC_VERSION_UNKNOWN
= 0x00,
170 CEC_VERSION_1_2
= 0x01,
171 CEC_VERSION_1_2A
= 0x02,
172 CEC_VERSION_1_3
= 0x03,
173 CEC_VERSION_1_3A
= 0x04,
174 CEC_VERSION_1_4
= 0x05
177 typedef enum cec_channel_identifier
179 CEC_CHANNEL_NUMBER_FORMAT_MASK
= 0xFC000000,
180 CEC_1_PART_CHANNEL_NUMBER
= 0x04000000,
181 CEC_2_PART_CHANNEL_NUMBER
= 0x08000000,
182 CEC_MAJOR_CHANNEL_NUMBER_MASK
= 0x3FF0000,
183 CEC_MINOR_CHANNEL_NUMBER_MASK
= 0xFFFF
184 } cec_channel_identifier
;
186 typedef enum cec_deck_control_mode
188 CEC_DECK_CONTROL_MODE_SKIP_FORWARD_WIND
= 1,
189 CEC_DECK_CONTROL_MODE_SKIP_REVERSE_REWIND
= 2,
190 CEC_DECK_CONTROL_MODE_STOP
= 3,
191 CEC_DECK_CONTROL_MODE_EJECT
= 4
192 } cec_deck_control_mode
;
194 typedef enum cec_deck_info
196 CEC_DECK_INFO_PLAY
= 0x11,
197 CEC_DECK_INFO_RECORD
= 0x12,
198 CEC_DECK_INFO_PLAY_REVERSE
= 0x13,
199 CEC_DECK_INFO_STILL
= 0x14,
200 CEC_DECK_INFO_SLOW
= 0x15,
201 CEC_DECK_INFO_SLOW_REVERSE
= 0x16,
202 CEC_DECK_INFO_FAST_FORWARD
= 0x17,
203 CEC_DECK_INFO_FAST_REVERSE
= 0x18,
204 CEC_DECK_INFO_NO_MEDIA
= 0x19,
205 CEC_DECK_INFO_STOP
= 0x1A,
206 CEC_DECK_INFO_SKIP_FORWARD_WIND
= 0x1B,
207 CEC_DECK_INFO_SKIP_REVERSE_REWIND
= 0x1C,
208 CEC_DECK_INFO_INDEX_SEARCH_FORWARD
= 0x1D,
209 CEC_DECK_INFO_INDEX_SEARCH_REVERSE
= 0x1E,
210 CEC_DECK_INFO_OTHER_STATUS
= 0x1F,
211 CEC_DECK_INFO_OTHER_STATUS_LG
= 0x20
214 typedef enum cec_device_type
216 CEC_DEVICE_TYPE_TV
= 0,
217 CEC_DEVICE_TYPE_RECORDING_DEVICE
= 1,
218 CEC_DEVICE_TYPE_RESERVED
= 2,
219 CEC_DEVICE_TYPE_TUNER
= 3,
220 CEC_DEVICE_TYPE_PLAYBACK_DEVICE
= 4,
221 CEC_DEVICE_TYPE_AUDIO_SYSTEM
= 5
224 typedef enum cec_display_control
226 CEC_DISPLAY_CONTROL_DISPLAY_FOR_DEFAULT_TIME
= 0x00,
227 CEC_DISPLAY_CONTROL_DISPLAY_UNTIL_CLEARED
= 0x40,
228 CEC_DISPLAY_CONTROL_CLEAR_PREVIOUS_MESSAGE
= 0x80,
229 CEC_DISPLAY_CONTROL_RESERVED_FOR_FUTURE_USE
= 0xC0
230 } cec_display_control
;
232 typedef enum cec_external_source_specifier
234 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PLUG
= 4,
235 CEC_EXTERNAL_SOURCE_SPECIFIER_EXTERNAL_PHYSICAL_ADDRESS
= 5
236 } cec_external_source_specifier
;
238 typedef enum cec_menu_request_type
240 CEC_MENU_REQUEST_TYPE_ACTIVATE
= 0,
241 CEC_MENU_REQUEST_TYPE_DEACTIVATE
= 1,
242 CEC_MENU_REQUEST_TYPE_QUERY
= 2
243 } cec_menu_request_type
;
245 typedef enum cec_menu_state
247 CEC_MENU_STATE_ACTIVATED
= 0,
248 CEC_MENU_STATE_DEACTIVATED
= 1
251 typedef enum cec_play_mode
253 CEC_PLAY_MODE_PLAY_FORWARD
= 0x24,
254 CEC_PLAY_MODE_PLAY_REVERSE
= 0x20,
255 CEC_PLAY_MODE_PLAY_STILL
= 0x25,
256 CEC_PLAY_MODE_FAST_FORWARD_MIN_SPEED
= 0x05,
257 CEC_PLAY_MODE_FAST_FORWARD_MEDIUM_SPEED
= 0x06,
258 CEC_PLAY_MODE_FAST_FORWARD_MAX_SPEED
= 0x07,
259 CEC_PLAY_MODE_FAST_REVERSE_MIN_SPEED
= 0x09,
260 CEC_PLAY_MODE_FAST_REVERSE_MEDIUM_SPEED
= 0x0A,
261 CEC_PLAY_MODE_FAST_REVERSE_MAX_SPEED
= 0x0B,
262 CEC_PLAY_MODE_SLOW_FORWARD_MIN_SPEED
= 0x15,
263 CEC_PLAY_MODE_SLOW_FORWARD_MEDIUM_SPEED
= 0x16,
264 CEC_PLAY_MODE_SLOW_FORWARD_MAX_SPEED
= 0x17,
265 CEC_PLAY_MODE_SLOW_REVERSE_MIN_SPEED
= 0x19,
266 CEC_PLAY_MODE_SLOW_REVERSE_MEDIUM_SPEED
= 0x1A,
267 CEC_PLAY_MODE_SLOW_REVERSE_MAX_SPEED
= 0x1B
270 typedef enum cec_power_status
272 CEC_POWER_STATUS_ON
= 0x00,
273 CEC_POWER_STATUS_STANDBY
= 0x01,
274 CEC_POWER_STATUS_IN_TRANSITION_STANDBY_TO_ON
= 0x02,
275 CEC_POWER_STATUS_IN_TRANSITION_ON_TO_STANDBY
= 0x03,
276 CEC_POWER_STATUS_UNKNOWN
= 0x99
279 typedef enum cec_record_source_type
281 CEC_RECORD_SOURCE_TYPE_OWN_SOURCE
= 1,
282 CEC_RECORD_SOURCE_TYPE_DIGITAL_SERVICE
= 2,
283 CEC_RECORD_SOURCE_TYPE_ANALOGUE_SERVICE
= 3,
284 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PLUS
= 4,
285 CEC_RECORD_SOURCE_TYPE_EXTERNAL_PHYSICAL_ADDRESS
= 5
286 } cec_record_source_type
;
288 typedef enum cec_record_status_info
290 CEC_RECORD_STATUS_INFO_RECORDING_CURRENTLY_SELECTED_SOURCE
= 0x01,
291 CEC_RECORD_STATUS_INFO_RECORDING_DIGITAL_SERVICE
= 0x02,
292 CEC_RECORD_STATUS_INFO_RECORDING_ANALOGUE_SERVICE
= 0x03,
293 CEC_RECORD_STATUS_INFO_RECORDING_EXTERNAL_INPUT
= 0x04,
294 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_DIGITAL_SERVICE
= 0x05,
295 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_RECORD_ANALOGUE_SERVICE
= 0x06,
296 CEC_RECORD_STATUS_INFO_NO_RECORDING_UNABLE_TO_SELECT_REQUIRED_SERVICE
= 0x07,
297 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_PLUG_NUMBER
= 0x09,
298 CEC_RECORD_STATUS_INFO_NO_RECORDING_INVALID_EXTERNAL_ADDRESS
= 0x0A,
299 CEC_RECORD_STATUS_INFO_NO_RECORDING_CA_SYSTEM_NOT_SUPPORTED
= 0x0B,
300 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_OR_INSUFFICIENT_ENTITLEMENTS
= 0x0C,
301 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ALLOWED_TO_COPY_SOURCE
= 0x0D,
302 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_FURTHER_COPIES_ALLOWED
= 0x0E,
303 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_MEDIA
= 0x10,
304 CEC_RECORD_STATUS_INFO_NO_RECORDING_PLAYING
= 0x11,
305 CEC_RECORD_STATUS_INFO_NO_RECORDING_ALREADY_RECORDING
= 0x12,
306 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROTECTED
= 0x13,
307 CEC_RECORD_STATUS_INFO_NO_RECORDING_NO_SOURCE_SIGNAL
= 0x14,
308 CEC_RECORD_STATUS_INFO_NO_RECORDING_MEDIA_PROBLEM
= 0x15,
309 CEC_RECORD_STATUS_INFO_NO_RECORDING_NOT_ENOUGH_SPACE_AVAILABLE
= 0x16,
310 CEC_RECORD_STATUS_INFO_NO_RECORDING_PARENTAL_LOCK_ON
= 0x17,
311 CEC_RECORD_STATUS_INFO_RECORDING_TERMINATED_NORMALLY
= 0x1A,
312 CEC_RECORD_STATUS_INFO_RECORDING_HAS_ALREADY_TERMINATED
= 0x1B,
313 CEC_RECORD_STATUS_INFO_NO_RECORDING_OTHER_REASON
= 0x1F
314 } cec_record_status_info
;
316 typedef enum cec_recording_sequence
318 CEC_RECORDING_SEQUENCE_SUNDAY
= 0x01,
319 CEC_RECORDING_SEQUENCE_MONDAY
= 0x02,
320 CEC_RECORDING_SEQUENCE_TUESDAY
= 0x04,
321 CEC_RECORDING_SEQUENCE_WEDNESDAY
= 0x08,
322 CEC_RECORDING_SEQUENCE_THURSDAY
= 0x10,
323 CEC_RECORDING_SEQUENCE_FRIDAY
= 0x20,
324 CEC_RECORDING_SEQUENCE_SATURDAY
= 0x40,
325 CEC_RECORDING_SEQUENCE_ONCE_ONLY
= 0x00
326 } cec_recording_sequence
;
328 typedef enum cec_status_request
330 CEC_STATUS_REQUEST_ON
= 1,
331 CEC_STATUS_REQUEST_OFF
= 2,
332 CEC_STATUS_REQUEST_ONCE
= 3
333 } cec_status_request
;
335 typedef enum cec_system_audio_status
337 CEC_SYSTEM_AUDIO_STATUS_OFF
= 0,
338 CEC_SYSTEM_AUDIO_STATUS_ON
= 1
339 } cec_system_audio_status
;
341 typedef enum cec_timer_cleared_status_data
343 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_RECORDING
= 0x00,
344 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_MATCHING
= 0x01,
345 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_NOT_CLEARED_NO_INF0_AVAILABLE
= 0x02,
346 CEC_TIMER_CLEARED_STATUS_DATA_TIMER_CLEARED
= 0x80
347 } cec_timer_cleared_status_data
;
349 typedef enum cec_timer_overlap_warning
351 CEC_TIMER_OVERLAP_WARNING_NO_OVERLAP
= 0,
352 CEC_TIMER_OVERLAP_WARNING_TIMER_BLOCKS_OVERLAP
= 1
353 } cec_timer_overlap_warning
;
355 typedef enum cec_media_info
357 CEC_MEDIA_INFO_MEDIA_PRESENT_AND_NOT_PROTECTED
= 0x00,
358 CEC_MEDIA_INFO_MEDIA_PRESENT_BUT_PROTECTED
= 0x01,
359 CEC_MEDIA_INFO_MEDIA_NOT_PRESENT
= 0x02,
360 CEC_MEDIA_INFO_FUTURE_USE
= 0x03
363 typedef enum cec_programmed_indicator
365 CEC_PROGRAMMED_INDICATOR_NOT_PROGRAMMED
= 0,
366 CEC_PROGRAMMED_INDICATOR_PROGRAMMED
= 1
367 } cec_programmed_indicator
;
369 typedef enum cec_programmed_info
371 CEC_PROGRAMMED_INFO_FUTURE_USE
= 0x0,
372 CEC_PROGRAMMED_INFO_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x08,
373 CEC_PROGRAMMED_INFO_NOT_ENOUGH_SPACE_AVAILABLE_FOR_RECORDING
= 0x09,
374 CEC_PROGRAMMED_INFO_MAY_NOT_BE_ENOUGH_SPACE_AVAILABLE
= 0x0B,
375 CEC_PROGRAMMED_INFO_NO_MEDIA_INFO_AVAILABLE
= 0x0A
376 } cec_programmed_info
;
378 typedef enum cec_not_programmed_error_info
380 CEC_NOT_PROGRAMMED_ERROR_INFO_FUTURE_USE
= 0x0,
381 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_FREE_TIMER_AVAILABLE
= 0x01,
382 CEC_NOT_PROGRAMMED_ERROR_INFO_DATE_OUT_OF_RANGE
= 0x02,
383 CEC_NOT_PROGRAMMED_ERROR_INFO_RECORDING_SEQUENCE_ERROR
= 0x03,
384 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PLUG_NUMBER
= 0x04,
385 CEC_NOT_PROGRAMMED_ERROR_INFO_INVALID_EXTERNAL_PHYSICAL_ADDRESS
= 0x05,
386 CEC_NOT_PROGRAMMED_ERROR_INFO_CA_SYSTEM_NOT_SUPPORTED
= 0x06,
387 CEC_NOT_PROGRAMMED_ERROR_INFO_NO_OR_INSUFFICIENT_CA_ENTITLEMENTS
= 0x07,
388 CEC_NOT_PROGRAMMED_ERROR_INFO_DOES_NOT_SUPPORT_RESOLUTION
= 0x08,
389 CEC_NOT_PROGRAMMED_ERROR_INFO_PARENTAL_LOCK_ON
= 0x09,
390 CEC_NOT_PROGRAMMED_ERROR_INFO_CLOCK_FAILURE
= 0x0A,
391 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_START
= 0x0B,
392 CEC_NOT_PROGRAMMED_ERROR_INFO_RESERVED_FOR_FUTURE_USE_END
= 0x0D,
393 CEC_NOT_PROGRAMMED_ERROR_INFO_DUPLICATE_ALREADY_PROGRAMMED
= 0x0E
394 } cec_not_programmed_error_info
;
396 typedef enum cec_recording_flag
398 CEC_RECORDING_FLAG_NOT_BEING_USED_FOR_RECORDING
= 0,
399 CEC_RECORDING_FLAG_BEING_USED_FOR_RECORDING
= 1
400 } cec_recording_flag
;
402 typedef enum cec_tuner_display_info
404 CEC_TUNER_DISPLAY_INFO_DISPLAYING_DIGITAL_TUNER
= 0,
405 CEC_TUNER_DISPLAY_INFO_NOT_DISPLAYING_TUNER
= 1,
406 CEC_TUNER_DISPLAY_INFO_DISPLAYING_ANALOGUE_TUNER
= 2
407 } cec_tuner_display_info
;
409 typedef enum cec_broadcast_system
411 CEC_BROADCAST_SYSTEM_PAL_B_G
= 0,
412 CEC_BROADCAST_SYSTEM_SECAM_L1
= 1,
413 CEC_BROADCAST_SYSTEM_PAL_M
= 2,
414 CEC_BROADCAST_SYSTEM_NTSC_M
= 3,
415 CEC_BROADCAST_SYSTEM_PAL_I
= 4,
416 CEC_BROADCAST_SYSTEM_SECAM_DK
= 5,
417 CEC_BROADCAST_SYSTEM_SECAM_B_G
= 6,
418 CEC_BROADCAST_SYSTEM_SECAM_L2
= 7,
419 CEC_BROADCAST_SYSTEM_PAL_DK
= 8,
420 CEC_BROADCAST_SYSTEM_OTHER_SYSTEM
= 30
421 } cec_broadcast_system
;
423 typedef enum cec_user_control_code
425 CEC_USER_CONTROL_CODE_SELECT
= 0x00,
426 CEC_USER_CONTROL_CODE_UP
= 0x01,
427 CEC_USER_CONTROL_CODE_DOWN
= 0x02,
428 CEC_USER_CONTROL_CODE_LEFT
= 0x03,
429 CEC_USER_CONTROL_CODE_RIGHT
= 0x04,
430 CEC_USER_CONTROL_CODE_RIGHT_UP
= 0x05,
431 CEC_USER_CONTROL_CODE_RIGHT_DOWN
= 0x06,
432 CEC_USER_CONTROL_CODE_LEFT_UP
= 0x07,
433 CEC_USER_CONTROL_CODE_LEFT_DOWN
= 0x08,
434 CEC_USER_CONTROL_CODE_ROOT_MENU
= 0x09,
435 CEC_USER_CONTROL_CODE_SETUP_MENU
= 0x0A,
436 CEC_USER_CONTROL_CODE_CONTENTS_MENU
= 0x0B,
437 CEC_USER_CONTROL_CODE_FAVORITE_MENU
= 0x0C,
438 CEC_USER_CONTROL_CODE_EXIT
= 0x0D,
439 CEC_USER_CONTROL_CODE_NUMBER0
= 0x20,
440 CEC_USER_CONTROL_CODE_NUMBER1
= 0x21,
441 CEC_USER_CONTROL_CODE_NUMBER2
= 0x22,
442 CEC_USER_CONTROL_CODE_NUMBER3
= 0x23,
443 CEC_USER_CONTROL_CODE_NUMBER4
= 0x24,
444 CEC_USER_CONTROL_CODE_NUMBER5
= 0x25,
445 CEC_USER_CONTROL_CODE_NUMBER6
= 0x26,
446 CEC_USER_CONTROL_CODE_NUMBER7
= 0x27,
447 CEC_USER_CONTROL_CODE_NUMBER8
= 0x28,
448 CEC_USER_CONTROL_CODE_NUMBER9
= 0x29,
449 CEC_USER_CONTROL_CODE_DOT
= 0x2A,
450 CEC_USER_CONTROL_CODE_ENTER
= 0x2B,
451 CEC_USER_CONTROL_CODE_CLEAR
= 0x2C,
452 CEC_USER_CONTROL_CODE_NEXT_FAVORITE
= 0x2F,
453 CEC_USER_CONTROL_CODE_CHANNEL_UP
= 0x30,
454 CEC_USER_CONTROL_CODE_CHANNEL_DOWN
= 0x31,
455 CEC_USER_CONTROL_CODE_PREVIOUS_CHANNEL
= 0x32,
456 CEC_USER_CONTROL_CODE_SOUND_SELECT
= 0x33,
457 CEC_USER_CONTROL_CODE_INPUT_SELECT
= 0x34,
458 CEC_USER_CONTROL_CODE_DISPLAY_INFORMATION
= 0x35,
459 CEC_USER_CONTROL_CODE_HELP
= 0x36,
460 CEC_USER_CONTROL_CODE_PAGE_UP
= 0x37,
461 CEC_USER_CONTROL_CODE_PAGE_DOWN
= 0x38,
462 CEC_USER_CONTROL_CODE_POWER
= 0x40,
463 CEC_USER_CONTROL_CODE_VOLUME_UP
= 0x41,
464 CEC_USER_CONTROL_CODE_VOLUME_DOWN
= 0x42,
465 CEC_USER_CONTROL_CODE_MUTE
= 0x43,
466 CEC_USER_CONTROL_CODE_PLAY
= 0x44,
467 CEC_USER_CONTROL_CODE_STOP
= 0x45,
468 CEC_USER_CONTROL_CODE_PAUSE
= 0x46,
469 CEC_USER_CONTROL_CODE_RECORD
= 0x47,
470 CEC_USER_CONTROL_CODE_REWIND
= 0x48,
471 CEC_USER_CONTROL_CODE_FAST_FORWARD
= 0x49,
472 CEC_USER_CONTROL_CODE_EJECT
= 0x4A,
473 CEC_USER_CONTROL_CODE_FORWARD
= 0x4B,
474 CEC_USER_CONTROL_CODE_BACKWARD
= 0x4C,
475 CEC_USER_CONTROL_CODE_STOP_RECORD
= 0x4D,
476 CEC_USER_CONTROL_CODE_PAUSE_RECORD
= 0x4E,
477 CEC_USER_CONTROL_CODE_ANGLE
= 0x50,
478 CEC_USER_CONTROL_CODE_SUB_PICTURE
= 0x51,
479 CEC_USER_CONTROL_CODE_VIDEO_ON_DEMAND
= 0x52,
480 CEC_USER_CONTROL_CODE_ELECTRONIC_PROGRAM_GUIDE
= 0x53,
481 CEC_USER_CONTROL_CODE_TIMER_PROGRAMMING
= 0x54,
482 CEC_USER_CONTROL_CODE_INITIAL_CONFIGURATION
= 0x55,
483 CEC_USER_CONTROL_CODE_PLAY_FUNCTION
= 0x60,
484 CEC_USER_CONTROL_CODE_PAUSE_PLAY_FUNCTION
= 0x61,
485 CEC_USER_CONTROL_CODE_RECORD_FUNCTION
= 0x62,
486 CEC_USER_CONTROL_CODE_PAUSE_RECORD_FUNCTION
= 0x63,
487 CEC_USER_CONTROL_CODE_STOP_FUNCTION
= 0x64,
488 CEC_USER_CONTROL_CODE_MUTE_FUNCTION
= 0x65,
489 CEC_USER_CONTROL_CODE_RESTORE_VOLUME_FUNCTION
= 0x66,
490 CEC_USER_CONTROL_CODE_TUNE_FUNCTION
= 0x67,
491 CEC_USER_CONTROL_CODE_SELECT_MEDIA_FUNCTION
= 0x68,
492 CEC_USER_CONTROL_CODE_SELECT_AV_INPUT_FUNCTION
= 0x69,
493 CEC_USER_CONTROL_CODE_SELECT_AUDIO_INPUT_FUNCTION
= 0x6A,
494 CEC_USER_CONTROL_CODE_POWER_TOGGLE_FUNCTION
= 0x6B,
495 CEC_USER_CONTROL_CODE_POWER_OFF_FUNCTION
= 0x6C,
496 CEC_USER_CONTROL_CODE_POWER_ON_FUNCTION
= 0x6D,
497 CEC_USER_CONTROL_CODE_F1_BLUE
= 0x71,
498 CEC_USER_CONTROL_CODE_F2_RED
= 0X72,
499 CEC_USER_CONTROL_CODE_F3_GREEN
= 0x73,
500 CEC_USER_CONTROL_CODE_F4_YELLOW
= 0x74,
501 CEC_USER_CONTROL_CODE_F5
= 0x75,
502 CEC_USER_CONTROL_CODE_DATA
= 0x76,
503 CEC_USER_CONTROL_CODE_AN_RETURN
= 0x91,
504 CEC_USER_CONTROL_CODE_AN_CHANNELS_LIST
= 0x96,
505 CEC_USER_CONTROL_CODE_MAX
= 0x96,
506 CEC_USER_CONTROL_CODE_UNKNOWN
507 } cec_user_control_code
;
509 typedef enum cec_logical_address
511 CECDEVICE_UNKNOWN
= -1, //not a valid logical address
513 CECDEVICE_RECORDINGDEVICE1
= 1,
514 CECDEVICE_RECORDINGDEVICE2
= 2,
515 CECDEVICE_TUNER1
= 3,
516 CECDEVICE_PLAYBACKDEVICE1
= 4,
517 CECDEVICE_AUDIOSYSTEM
= 5,
518 CECDEVICE_TUNER2
= 6,
519 CECDEVICE_TUNER3
= 7,
520 CECDEVICE_PLAYBACKDEVICE2
= 8,
521 CECDEVICE_RECORDINGDEVICE3
= 9,
522 CECDEVICE_TUNER4
= 10,
523 CECDEVICE_PLAYBACKDEVICE3
= 11,
524 CECDEVICE_RESERVED1
= 12,
525 CECDEVICE_RESERVED2
= 13,
526 CECDEVICE_FREEUSE
= 14,
527 CECDEVICE_UNREGISTERED
= 15,
528 CECDEVICE_BROADCAST
= 15
529 } cec_logical_address
;
531 typedef enum cec_opcode
533 CEC_OPCODE_ACTIVE_SOURCE
= 0x82,
534 CEC_OPCODE_IMAGE_VIEW_ON
= 0x04,
535 CEC_OPCODE_TEXT_VIEW_ON
= 0x0D,
536 CEC_OPCODE_INACTIVE_SOURCE
= 0x9D,
537 CEC_OPCODE_REQUEST_ACTIVE_SOURCE
= 0x85,
538 CEC_OPCODE_ROUTING_CHANGE
= 0x80,
539 CEC_OPCODE_ROUTING_INFORMATION
= 0x81,
540 CEC_OPCODE_SET_STREAM_PATH
= 0x86,
541 CEC_OPCODE_STANDBY
= 0x36,
542 CEC_OPCODE_RECORD_OFF
= 0x0B,
543 CEC_OPCODE_RECORD_ON
= 0x09,
544 CEC_OPCODE_RECORD_STATUS
= 0x0A,
545 CEC_OPCODE_RECORD_TV_SCREEN
= 0x0F,
546 CEC_OPCODE_CLEAR_ANALOGUE_TIMER
= 0x33,
547 CEC_OPCODE_CLEAR_DIGITAL_TIMER
= 0x99,
548 CEC_OPCODE_CLEAR_EXTERNAL_TIMER
= 0xA1,
549 CEC_OPCODE_SET_ANALOGUE_TIMER
= 0x34,
550 CEC_OPCODE_SET_DIGITAL_TIMER
= 0x97,
551 CEC_OPCODE_SET_EXTERNAL_TIMER
= 0xA2,
552 CEC_OPCODE_SET_TIMER_PROGRAM_TITLE
= 0x67,
553 CEC_OPCODE_TIMER_CLEARED_STATUS
= 0x43,
554 CEC_OPCODE_TIMER_STATUS
= 0x35,
555 CEC_OPCODE_CEC_VERSION
= 0x9E,
556 CEC_OPCODE_GET_CEC_VERSION
= 0x9F,
557 CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
= 0x83,
558 CEC_OPCODE_GET_MENU_LANGUAGE
= 0x91,
559 CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
= 0x84,
560 CEC_OPCODE_SET_MENU_LANGUAGE
= 0x32,
561 CEC_OPCODE_DECK_CONTROL
= 0x42,
562 CEC_OPCODE_DECK_STATUS
= 0x1B,
563 CEC_OPCODE_GIVE_DECK_STATUS
= 0x1A,
564 CEC_OPCODE_PLAY
= 0x41,
565 CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
= 0x08,
566 CEC_OPCODE_SELECT_ANALOGUE_SERVICE
= 0x92,
567 CEC_OPCODE_SELECT_DIGITAL_SERVICE
= 0x93,
568 CEC_OPCODE_TUNER_DEVICE_STATUS
= 0x07,
569 CEC_OPCODE_TUNER_STEP_DECREMENT
= 0x06,
570 CEC_OPCODE_TUNER_STEP_INCREMENT
= 0x05,
571 CEC_OPCODE_DEVICE_VENDOR_ID
= 0x87,
572 CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
= 0x8C,
573 CEC_OPCODE_VENDOR_COMMAND
= 0x89,
574 CEC_OPCODE_VENDOR_COMMAND_WITH_ID
= 0xA0,
575 CEC_OPCODE_VENDOR_REMOTE_BUTTON_DOWN
= 0x8A,
576 CEC_OPCODE_VENDOR_REMOTE_BUTTON_UP
= 0x8B,
577 CEC_OPCODE_SET_OSD_STRING
= 0x64,
578 CEC_OPCODE_GIVE_OSD_NAME
= 0x46,
579 CEC_OPCODE_SET_OSD_NAME
= 0x47,
580 CEC_OPCODE_MENU_REQUEST
= 0x8D,
581 CEC_OPCODE_MENU_STATUS
= 0x8E,
582 CEC_OPCODE_USER_CONTROL_PRESSED
= 0x44,
583 CEC_OPCODE_USER_CONTROL_RELEASE
= 0x45,
584 CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
= 0x8F,
585 CEC_OPCODE_REPORT_POWER_STATUS
= 0x90,
586 CEC_OPCODE_FEATURE_ABORT
= 0x00,
587 CEC_OPCODE_ABORT
= 0xFF,
588 CEC_OPCODE_GIVE_AUDIO_STATUS
= 0x71,
589 CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
= 0x7D,
590 CEC_OPCODE_REPORT_AUDIO_STATUS
= 0x7A,
591 CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
= 0x72,
592 CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
= 0x70,
593 CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
= 0x7E,
594 CEC_OPCODE_SET_AUDIO_RATE
= 0x9A,
597 CEC_OPCODE_START_ARC
= 0xC0,
598 CEC_OPCODE_REPORT_ARC_STARTED
= 0xC1,
599 CEC_OPCODE_REPORT_ARC_ENDED
= 0xC2,
600 CEC_OPCODE_REQUEST_ARC_START
= 0xC3,
601 CEC_OPCODE_REQUEST_ARC_END
= 0xC4,
602 CEC_OPCODE_END_ARC
= 0xC5,
603 CEC_OPCODE_CDC
= 0xF8,
604 /* when this opcode is set, no opcode will be sent to the device. this is one of the reserved numbers */
605 CEC_OPCODE_NONE
= 0xFD
608 typedef enum cec_log_level
618 typedef enum cec_bus_device_status
620 CEC_DEVICE_STATUS_UNKNOWN
,
621 CEC_DEVICE_STATUS_PRESENT
,
622 CEC_DEVICE_STATUS_NOT_PRESENT
,
623 CEC_DEVICE_STATUS_HANDLED_BY_LIBCEC
624 } cec_bus_device_status
;
626 typedef enum cec_vendor_id
628 CEC_VENDOR_SAMSUNG
= 0x0000F0,
629 CEC_VENDOR_LG
= 0x00E091,
630 CEC_VENDOR_PANASONIC
= 0x008045,
631 CEC_VENDOR_PIONEER
= 0x00E036,
632 CEC_VENDOR_ONKYO
= 0x0009B0,
633 CEC_VENDOR_YAMAHA
= 0x00A0DE,
634 CEC_VENDOR_PHILIPS
= 0x00903E,
635 CEC_VENDOR_SONY
= 0x080046,
636 CEC_VENDOR_TOSHIBA
= 0x000039,
637 CEC_VENDOR_AKAI
= 0x0020C7,
638 CEC_VENDOR_AOC
= 0x002467,
639 CEC_VENDOR_BENQ
= 0x8065E9,
640 CEC_VENDOR_DAEWOO
= 0x009053,
641 CEC_VENDOR_GRUNDIG
= 0x00D0D5,
642 CEC_VENDOR_MEDION
= 0x000CB8,
643 CEC_VENDOR_SHARP
= 0x08001F,
644 CEC_VENDOR_VIZIO
= 0x6B746D,
645 CEC_VENDOR_BROADCOM
= 0x18C086,
646 CEC_VENDOR_LOEWE
= 0x000982,
648 CEC_VENDOR_UNKNOWN
= 0
651 typedef enum cec_adapter_type
653 ADAPTERTYPE_UNKNOWN
= 0,
654 ADAPTERTYPE_P8_EXTERNAL
= 0x1,
655 ADAPTERTYPE_P8_DAUGHTERBOARD
= 0x2,
656 ADAPTERTYPE_RPI
= 0x100
659 typedef struct cec_menu_language
661 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 */
662 cec_logical_address device
; /**< the logical address of the device */
665 typedef struct cec_osd_name
667 char name
[14]; /**< the name of the device */
668 cec_logical_address device
; /**< the logical address of the device */
671 typedef struct cec_log_message
673 char message
[1024]; /**< the actual message */
674 cec_log_level level
; /**< log level of the message */
675 int64_t time
; /**< the timestamp of this message */
678 typedef struct cec_keypress
680 cec_user_control_code keycode
; /**< the keycode */
681 unsigned int duration
; /**< the duration of the keypress */
684 typedef struct cec_adapter
686 char path
[1024]; /**< the path to the com port */
687 char comm
[1024]; /**< the name of the com port */
690 typedef struct cec_datapacket
692 uint8_t data
[100]; /**< the actual data */
693 uint8_t size
; /**< the size of the data */
696 cec_datapacket
&operator =(const struct cec_datapacket
&packet
)
699 for (uint8_t iPtr
= 0; iPtr
< packet
.size
; iPtr
++)
700 PushBack(packet
[iPtr
]);
705 bool IsEmpty(void) const { return size
== 0; } /**< @return True when this packet is empty, false otherwise. */
706 bool IsFull(void) const { return size
== 100; } /**< @return True when this packet is false, false otherwise. */
709 * @brief Get the byte at the requested position.
710 * @param pos The position.
711 * @return The byte, or 0 when out of bounds.
713 uint8_t operator[](uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
715 * @brief Get the byte at the requested position.
716 * @param pos The position.
717 * @return The byte, or 0 when out of bounds.
719 uint8_t At(uint8_t pos
) const { return pos
< size
? data
[pos
] : 0; }
722 * @brief Shift the contents of this packet.
723 * @param iShiftBy The number of positions to shift.
725 void Shift(uint8_t iShiftBy
)
727 if (iShiftBy
>= size
)
733 for (uint8_t iPtr
= 0; iPtr
< size
; iPtr
++)
734 data
[iPtr
] = (iPtr
+ iShiftBy
< size
) ? data
[iPtr
+ iShiftBy
] : 0;
735 size
= (uint8_t) (size
- iShiftBy
);
740 * @brief Push a byte to the end of this packet.
741 * @param add The byte to add.
743 void PushBack(uint8_t add
)
750 * @brief Clear this packet.
754 memset(data
, 0, sizeof(data
));
761 typedef struct cec_command
763 cec_logical_address initiator
; /**< the logical address of the initiator of this message */
764 cec_logical_address destination
; /**< the logical address of the destination of this message */
765 int8_t ack
; /**< 1 when the ACK bit is set, 0 otherwise */
766 int8_t eom
; /**< 1 when the EOM bit is set, 0 otherwise */
767 cec_opcode opcode
; /**< the opcode of this message */
768 cec_datapacket parameters
; /**< the parameters attached to this message */
769 int8_t opcode_set
; /**< 1 when an opcode is set, 0 otherwise (POLL message) */
770 int32_t transmit_timeout
; /**< the timeout to use in ms */
773 // @todo re-add in v2.0 (breaks ABI)
779 cec_command
&operator =(const struct cec_command
&command
)
781 initiator
= command
.initiator
;
782 destination
= command
.destination
;
785 opcode
= command
.opcode
;
786 opcode_set
= command
.opcode_set
;
787 transmit_timeout
= command
.transmit_timeout
;
788 parameters
= command
.parameters
;
794 * @brief Formats a cec_command.
795 * @param command The command to format.
796 * @param initiator The logical address of the initiator.
797 * @param destination The logical addres of the destination.
798 * @param opcode The opcode of the command.
799 * @param timeout The transmission timeout.
801 static void Format(cec_command
&command
, cec_logical_address initiator
, cec_logical_address destination
, cec_opcode opcode
, int32_t timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
)
804 command
.initiator
= initiator
;
805 command
.destination
= destination
;
806 command
.transmit_timeout
= timeout
;
807 if (opcode
!= CEC_OPCODE_NONE
)
809 command
.opcode
= opcode
;
810 command
.opcode_set
= 1;
815 * @brief Push a byte to the back of this command.
816 * @param data The byte to push.
818 void PushBack(uint8_t data
)
820 if (initiator
== CECDEVICE_UNKNOWN
&& destination
== CECDEVICE_UNKNOWN
)
822 initiator
= (cec_logical_address
) (data
>> 4);
823 destination
= (cec_logical_address
) (data
& 0xF);
825 else if (!opcode_set
)
828 opcode
= (cec_opcode
) data
;
831 parameters
.PushBack(data
);
835 * @brief Clear this command, resetting everything to the default values.
839 initiator
= CECDEVICE_UNKNOWN
;
840 destination
= CECDEVICE_UNKNOWN
;
844 opcode
= CEC_OPCODE_FEATURE_ABORT
;
845 transmit_timeout
= CEC_DEFAULT_TRANSMIT_TIMEOUT
;
849 static cec_opcode
GetResponseOpcode(cec_opcode opcode
)
853 case CEC_OPCODE_REQUEST_ACTIVE_SOURCE
:
854 return CEC_OPCODE_ACTIVE_SOURCE
;
855 case CEC_OPCODE_GET_CEC_VERSION
:
856 return CEC_OPCODE_CEC_VERSION
;
857 case CEC_OPCODE_GIVE_PHYSICAL_ADDRESS
:
858 return CEC_OPCODE_REPORT_PHYSICAL_ADDRESS
;
859 case CEC_OPCODE_GET_MENU_LANGUAGE
:
860 return CEC_OPCODE_SET_MENU_LANGUAGE
;
861 case CEC_OPCODE_GIVE_DECK_STATUS
:
862 return CEC_OPCODE_DECK_STATUS
;
863 case CEC_OPCODE_GIVE_TUNER_DEVICE_STATUS
:
864 return CEC_OPCODE_TUNER_DEVICE_STATUS
;
865 case CEC_OPCODE_GIVE_DEVICE_VENDOR_ID
:
866 return CEC_OPCODE_DEVICE_VENDOR_ID
;
867 case CEC_OPCODE_GIVE_OSD_NAME
:
868 return CEC_OPCODE_SET_OSD_NAME
;
869 case CEC_OPCODE_MENU_REQUEST
:
870 return CEC_OPCODE_MENU_STATUS
;
871 case CEC_OPCODE_GIVE_DEVICE_POWER_STATUS
:
872 return CEC_OPCODE_REPORT_POWER_STATUS
;
873 case CEC_OPCODE_GIVE_AUDIO_STATUS
:
874 return CEC_OPCODE_REPORT_AUDIO_STATUS
;
875 case CEC_OPCODE_GIVE_SYSTEM_AUDIO_MODE_STATUS
:
876 return CEC_OPCODE_SYSTEM_AUDIO_MODE_STATUS
;
877 case CEC_OPCODE_SYSTEM_AUDIO_MODE_REQUEST
:
878 return CEC_OPCODE_SET_SYSTEM_AUDIO_MODE
;
883 return CEC_OPCODE_NONE
;
886 void PushArray(size_t len
, uint8_t *data
)
888 for (size_t iPtr
= 0; iPtr
< len
; iPtr
++)
889 PushBack(data
[iPtr
]);
894 typedef struct cec_device_type_list
896 cec_device_type types
[5]; /**< the list of device types */
900 * @deprecated Use Clear() instead.
901 * @brief Clear this list.
903 void clear(void) { Clear(); }
905 * @deprecated Use Add() instead.
906 * @brief Add a type to this list.
907 * @param type The type to add.
909 void add(const cec_device_type type
) { Add(type
); }
912 * @brief Clear this list.
916 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
917 types
[iPtr
] = CEC_DEVICE_TYPE_RESERVED
;
921 * @brief Add a type to this list.
922 * @param type The type to add.
924 void Add(const cec_device_type type
)
926 for (unsigned int iPtr
= 0; iPtr
< 5; iPtr
++)
928 if (types
[iPtr
] == CEC_DEVICE_TYPE_RESERVED
)
937 * @brief Check whether a type is set in this list.
938 * @param type The type to check.
939 * @return True when set, false otherwise.
941 bool IsSet(cec_device_type type
)
944 for (unsigned int iPtr
= 0; !bReturn
&& iPtr
< 5; iPtr
++)
946 if (types
[iPtr
] == type
)
953 * @return True when this list is empty, false otherwise.
958 for (unsigned int iPtr
= 0; bReturn
&& iPtr
< 5; iPtr
++)
960 if (types
[iPtr
] != CEC_DEVICE_TYPE_RESERVED
)
967 * @brief Get the type at the requested position.
968 * @param pos The position.
969 * @return The type, or CEC_DEVICE_TYPE_RESERVED when out of bounds.
971 cec_device_type
operator[](uint8_t pos
) const { return pos
< 5 ? types
[pos
] : CEC_DEVICE_TYPE_RESERVED
; }
973 bool operator==(const cec_device_type_list
&other
) const
976 for (uint8_t iPtr
= 0; iPtr
< 5; iPtr
++)
977 bEqual
&= (types
[iPtr
] == other
[iPtr
]);
981 bool operator!=(const cec_device_type_list
&other
) const
983 return !(*this == other
);
986 } cec_device_type_list
;
988 typedef struct cec_logical_addresses
990 cec_logical_address primary
; /**< the primary logical address to use */
991 int addresses
[16]; /**< the list of addresses */
995 * @brief Clear this list.
999 primary
= CECDEVICE_UNREGISTERED
;
1000 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
1001 addresses
[iPtr
] = 0;
1005 * @return True when empty, false otherwise.
1007 bool IsEmpty(void) const
1009 return primary
== CECDEVICE_UNREGISTERED
;
1013 * @brief Calculate the ack-mask for this list, the mask to use when determining whether to send an ack message or not.
1014 * @return The ack-mask.
1016 uint16_t AckMask(void) const
1019 for (unsigned int iPtr
= 0; iPtr
< 16; iPtr
++)
1020 if (addresses
[iPtr
] == 1)
1021 mask
|= 0x1 << iPtr
;
1026 * @brief Mark a logical address as 'set'
1027 * @param address The logical address to add to this list.
1029 void Set(cec_logical_address address
)
1031 if (primary
== CECDEVICE_UNREGISTERED
)
1034 addresses
[(int) address
] = 1;
1038 * @brief Mark a logical address as 'unset'
1039 * @param address The logical address to remove from this list.
1041 void Unset(const cec_logical_address address
)
1043 if (primary
== address
)
1044 primary
= CECDEVICE_UNREGISTERED
;
1046 addresses
[(int) address
] = 0;
1050 * @brief Check whether an address is set in this list.
1051 * @param address The address to check.
1052 * @return True when set, false otherwise.
1054 bool IsSet(cec_logical_address address
) const { return addresses
[(int) address
] == 1; }
1057 * @brief Check whether an address is set in this list.
1058 * @param pos The address to check.
1059 * @return True when set, false otherwise.
1061 bool operator[](uint8_t pos
) const { return pos
< 16 ? IsSet((cec_logical_address
) pos
) : false; }
1063 bool operator==(const cec_logical_addresses
&other
) const
1066 for (uint8_t iPtr
= 0; iPtr
< 16; iPtr
++)
1067 bEqual
&= ((addresses
[(int)iPtr
] == 1) == other
[iPtr
]);
1071 bool operator!=(const cec_logical_addresses
&other
) const
1073 return !(*this == other
);
1076 } cec_logical_addresses
;
1078 typedef enum libcec_alert
1080 CEC_ALERT_SERVICE_DEVICE
,
1081 CEC_ALERT_CONNECTION_LOST
,
1082 CEC_ALERT_PERMISSION_ERROR
,
1086 typedef enum libcec_parameter_type
1088 CEC_PARAMETER_TYPE_STRING
,
1089 CEC_PARAMETER_TYPE_UNKOWN
1090 } libcec_parameter_type
;
1092 typedef struct libcec_parameter
1094 libcec_parameter_type paramType
; /**< the type of this parameter */
1095 void* paramData
; /**< the value of this parameter */
1098 typedef struct libcec_configuration libcec_configuration
;
1100 typedef int (CEC_CDECL
* CBCecLogMessageType
)(void *param
, const cec_log_message
&);
1101 typedef int (CEC_CDECL
* CBCecKeyPressType
)(void *param
, const cec_keypress
&);
1102 typedef int (CEC_CDECL
* CBCecCommandType
)(void *param
, const cec_command
&);
1103 typedef int (CEC_CDECL
* CBCecConfigurationChangedType
)(void *param
, const libcec_configuration
&);
1104 typedef int (CEC_CDECL
* CBCecAlertType
)(void *param
, const libcec_alert
, const libcec_parameter
&);
1105 typedef int (CEC_CDECL
* CBCecMenuStateChangedType
)(void *param
, const cec_menu_state
);
1106 typedef void (CEC_CDECL
* CBCecSourceActivatedType
)(void *param
, const cec_logical_address
, const uint8_t);
1108 typedef struct ICECCallbacks
1111 * @brief Transfer a log message from libCEC to the client.
1112 * @param message The message to transfer.
1113 * @return 1 when ok, 0 otherwise.
1115 CBCecLogMessageType CBCecLogMessage
;
1118 * @brief Transfer a keypress from libCEC to the client.
1119 * @param key The keypress to transfer.
1120 * @return 1 when ok, 0 otherwise.
1122 CBCecKeyPressType CBCecKeyPress
;
1125 * @brief Transfer a CEC command from libCEC to the client.
1126 * @param command The command to transfer.
1127 * @return 1 when ok, 0 otherwise.
1129 CBCecCommandType CBCecCommand
;
1132 * @brief Transfer a changed configuration from libCEC to the client
1133 * @param configuration The configuration to transfer
1134 * @return 1 when ok, 0 otherwise
1136 CBCecConfigurationChangedType CBCecConfigurationChanged
;
1139 * @brief Transfer a libcec alert message from libCEC to the client
1140 * @param alert The alert type transfer.
1141 * @param data Misc. additional information.
1142 * @return 1 when ok, 0 otherwise
1144 CBCecAlertType CBCecAlert
;
1147 * @brief Transfer a menu state change to the client.
1148 * Transfer a menu state change to the client. If the command returns 1, then the change will be processed by
1149 * the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',
1150 * @warning CEC does not allow the player to suppress the menu state change on the TV, so the menu on the TV will always be displayed, whatever the return value of this method is.
1151 * so keypresses are always routed.
1152 * @param newVal The new value.
1153 * @return 1 when libCEC should use this new value, 0 otherwise.
1155 CBCecMenuStateChangedType CBCecMenuStateChanged
;
1158 * @brief Called when a source that's handled by this client is activated.
1159 * @param logicalAddress The address that was just activated.
1160 * @param bActivated 1 when activated, 0 when deactivated.
1162 CBCecSourceActivatedType CBCecSourceActivated
;
1165 // @todo re-add in v2.0 (breaks ABI)
1166 // ICECCallbacks(void) { Clear(); }
1167 //~ICECCallbacks(void) { Clear(); };
1171 CBCecLogMessage
= NULL
;
1172 CBCecKeyPress
= NULL
;
1173 CBCecCommand
= NULL
;
1174 CBCecConfigurationChanged
= NULL
;
1176 CBCecMenuStateChanged
= NULL
;
1177 CBCecSourceActivated
= NULL
;
1182 typedef enum cec_client_version
1184 CEC_CLIENT_VERSION_PRE_1_5
= 0,
1185 CEC_CLIENT_VERSION_1_5_0
= 0x1500,
1186 CEC_CLIENT_VERSION_1_5_1
= 0x1501,
1187 CEC_CLIENT_VERSION_1_5_2
= 0x1502,
1188 CEC_CLIENT_VERSION_1_5_3
= 0x1503,
1189 CEC_CLIENT_VERSION_1_6_0
= 0x1600,
1190 CEC_CLIENT_VERSION_1_6_1
= 0x1601,
1191 CEC_CLIENT_VERSION_1_6_2
= 0x1602,
1192 CEC_CLIENT_VERSION_1_6_3
= 0x1603,
1193 CEC_CLIENT_VERSION_1_7_0
= 0x1700,
1194 CEC_CLIENT_VERSION_1_7_1
= 0x1701,
1195 CEC_CLIENT_VERSION_1_7_2
= 0x1702,
1196 CEC_CLIENT_VERSION_1_8_0
= 0x1800,
1197 CEC_CLIENT_VERSION_1_8_1
= 0x1801,
1198 CEC_CLIENT_VERSION_1_8_2
= 0x1802,
1199 CEC_CLIENT_VERSION_1_9_0
= 0x1900
1200 } cec_client_version
;
1202 typedef enum cec_server_version
1204 CEC_SERVER_VERSION_PRE_1_5
= 0,
1205 CEC_SERVER_VERSION_1_5_0
= 0x1500,
1206 CEC_SERVER_VERSION_1_5_1
= 0x1501,
1207 CEC_SERVER_VERSION_1_5_2
= 0x1502,
1208 CEC_SERVER_VERSION_1_5_3
= 0x1503,
1209 CEC_SERVER_VERSION_1_6_0
= 0x1600,
1210 CEC_SERVER_VERSION_1_6_1
= 0x1601,
1211 CEC_SERVER_VERSION_1_6_2
= 0x1602,
1212 CEC_SERVER_VERSION_1_6_3
= 0x1603,
1213 CEC_SERVER_VERSION_1_7_0
= 0x1700,
1214 CEC_SERVER_VERSION_1_7_1
= 0x1701,
1215 CEC_SERVER_VERSION_1_7_2
= 0x1702,
1216 CEC_SERVER_VERSION_1_8_0
= 0x1800,
1217 CEC_SERVER_VERSION_1_8_1
= 0x1801,
1218 CEC_SERVER_VERSION_1_8_2
= 0x1802,
1219 CEC_SERVER_VERSION_1_9_0
= 0x1900
1220 } cec_server_version
;
1222 struct libcec_configuration
1224 uint32_t clientVersion
; /*!< the version of the client that is connecting */
1225 char strDeviceName
[13]; /*!< how to name the device on the CEC bus */
1226 cec_device_type_list deviceTypes
; /*!< the CEC device types to emulate */
1227 uint8_t bAutodetectAddress
; /*!< (read only) set to 1 by libCEC when the physical address was autodetected */
1228 uint16_t iPhysicalAddress
; /*!< the physical address of the CEC adapter. only used when bAutodetectAddress = 0 or when the adapter doesn't support autodetection */
1229 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 */
1230 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 */
1231 uint64_t tvVendor
; /*!< override the vendor ID of the TV. leave this untouched to autodetect */
1232 cec_logical_addresses wakeDevices
; /*!< wake these CEC devices when initialising libCEC or when calling PowerOnDevices() without any parameter */
1233 cec_logical_addresses powerOffDevices
; /*!< power off these devices when calling StandbyDevices() without any parameter */
1235 uint32_t serverVersion
; /*!< the version number of the server. read-only */
1237 // player specific settings
1238 uint8_t bGetSettingsFromROM
; /*!< true to get the settings from the ROM (if set, and a v2 ROM is present), false to use these settings. */
1239 uint8_t bUseTVMenuLanguage
; /*!< use the menu language of the TV in the player application */
1240 uint8_t bActivateSource
; /*!< make libCEC the active source on the bus when starting the player application */
1241 uint8_t bPowerOffScreensaver
; /*!< put devices in standby mode when activating the screensaver */
1242 uint8_t bPowerOffOnStandby
; /*!< put this PC in standby mode when the TV is switched off. only used when bShutdownOnStandby = 0 */
1243 uint8_t bSendInactiveSource
; /*!< send an 'inactive source' message when stopping the player. added in 1.5.1 */
1245 void * callbackParam
; /*!< the object to pass along with a call of the callback methods. NULL to ignore */
1246 ICECCallbacks
* callbacks
; /*!< the callback methods to use. set this to NULL when not using callbacks */
1248 cec_logical_addresses logicalAddresses
; /*!< (read-only) the current logical addresses. added in 1.5.3 */
1249 uint16_t iFirmwareVersion
; /*!< (read-only) the firmware version of the adapter. added in 1.6.0 */
1250 uint8_t bPowerOffDevicesOnStandby
; /*!< put devices in standby when the PC/player is put in standby. added in 1.6.0 */
1251 uint8_t bShutdownOnStandby
; /*!< shutdown this PC when the TV is switched off. only used when bPowerOffOnStandby = 0. added in 1.6.0 */
1252 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/ added in 1.6.2 */
1253 uint32_t iFirmwareBuildDate
; /*!< (read-only) the build date of the firmware, in seconds since epoch. if not available, this value will be set to 0. added in 1.6.2 */
1254 uint8_t bMonitorOnly
; /*!< won't allocate a CCECClient when starting the connection when set (same as monitor mode). added in 1.6.3 */
1255 cec_version cecVersion
; /*!< CEC spec version to use by libCEC. defaults to v1.4. added in 1.8.0 */
1256 cec_adapter_type adapterType
; /*!< type of the CEC adapter that we're connected to. added in 1.8.2 */
1259 // @todo re-add in v2.0 (breaks ABI)
1260 // libcec_configuration(void) { Clear(); }
1261 //~libcec_configuration(void) { Clear(); }
1263 bool operator==(const libcec_configuration
&other
) const
1265 return ( clientVersion
== other
.clientVersion
&&
1266 !strncmp(strDeviceName
, other
.strDeviceName
, 13) &&
1267 deviceTypes
== other
.deviceTypes
&&
1268 bAutodetectAddress
== other
.bAutodetectAddress
&&
1269 iPhysicalAddress
== other
.iPhysicalAddress
&&
1270 baseDevice
== other
.baseDevice
&&
1271 iHDMIPort
== other
.iHDMIPort
&&
1272 tvVendor
== other
.tvVendor
&&
1273 wakeDevices
== other
.wakeDevices
&&
1274 powerOffDevices
== other
.powerOffDevices
&&
1275 serverVersion
== other
.serverVersion
&&
1276 bGetSettingsFromROM
== other
.bGetSettingsFromROM
&&
1277 bUseTVMenuLanguage
== other
.bUseTVMenuLanguage
&&
1278 bActivateSource
== other
.bActivateSource
&&
1279 bPowerOffScreensaver
== other
.bPowerOffScreensaver
&&
1280 bPowerOffOnStandby
== other
.bPowerOffOnStandby
&&
1281 bSendInactiveSource
== other
.bSendInactiveSource
&&
1283 (other
.clientVersion
< CEC_CLIENT_VERSION_1_5_3
|| logicalAddresses
== other
.logicalAddresses
) &&
1285 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_0
|| iFirmwareVersion
== other
.iFirmwareVersion
) &&
1286 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_0
|| bPowerOffDevicesOnStandby
== other
.bPowerOffDevicesOnStandby
) &&
1287 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_0
|| bShutdownOnStandby
== other
.bShutdownOnStandby
) &&
1289 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_2
|| !strncmp(strDeviceLanguage
, other
.strDeviceLanguage
, 3)) &&
1290 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_2
|| iFirmwareBuildDate
== other
.iFirmwareBuildDate
) &&
1292 (other
.clientVersion
< CEC_CLIENT_VERSION_1_6_3
|| bMonitorOnly
== other
.bMonitorOnly
) &&
1294 (other
.clientVersion
< CEC_CLIENT_VERSION_1_8_0
|| cecVersion
== other
.cecVersion
) &&
1296 (other
.clientVersion
< CEC_CLIENT_VERSION_1_8_2
|| adapterType
== other
.adapterType
));
1299 bool operator!=(const libcec_configuration
&other
) const
1301 return !(*this == other
);
1305 * @brief Reset this configution struct to the default values.
1309 iPhysicalAddress
= CEC_PHYSICAL_ADDRESS_TV
;
1310 baseDevice
= (cec_logical_address
)CEC_DEFAULT_BASE_DEVICE
;
1311 iHDMIPort
= CEC_DEFAULT_HDMI_PORT
;
1312 tvVendor
= (uint64_t)CEC_VENDOR_UNKNOWN
;
1313 clientVersion
= (uint32_t)CEC_CLIENT_VERSION_PRE_1_5
;
1314 serverVersion
= (uint32_t)CEC_SERVER_VERSION_PRE_1_5
;
1315 bAutodetectAddress
= 0;
1316 bGetSettingsFromROM
= CEC_DEFAULT_SETTING_GET_SETTINGS_FROM_ROM
;
1317 bUseTVMenuLanguage
= CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE
;
1318 bActivateSource
= CEC_DEFAULT_SETTING_ACTIVATE_SOURCE
;
1319 bPowerOffScreensaver
= CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER
;
1320 bPowerOffOnStandby
= CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY
;
1321 bShutdownOnStandby
= CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY
;
1322 bSendInactiveSource
= CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE
;
1323 iFirmwareVersion
= CEC_FW_VERSION_UNKNOWN
;
1324 bPowerOffDevicesOnStandby
= CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY
;
1325 memcpy(strDeviceLanguage
, CEC_DEFAULT_DEVICE_LANGUAGE
, 3);
1326 iFirmwareBuildDate
= CEC_FW_BUILD_UNKNOWN
;
1328 cecVersion
= (cec_version
)CEC_DEFAULT_SETTING_CEC_VERSION
;
1329 adapterType
= ADAPTERTYPE_UNKNOWN
;
1331 memset(strDeviceName
, 0, 13);
1332 deviceTypes
.clear();
1333 logicalAddresses
.Clear();
1334 wakeDevices
.Clear();
1335 powerOffDevices
.Clear();
1337 #if CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1
1338 powerOffDevices
.Set(CECDEVICE_BROADCAST
);
1340 #if CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1
1341 wakeDevices
.Set(CECDEVICE_TV
);
1344 callbackParam
= NULL
;
1355 #endif /* CECTYPES_H_ */