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 typedef enum cec_adapter_message_state
42 ADAPTER_MESSAGE_STATE_UNKNOWN
= 0, /**< the initial state */
43 ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT
, /**< waiting in the send queue of the adapter, or timed out */
44 ADAPTER_MESSAGE_STATE_SENT
, /**< sent and waiting on an ACK */
45 ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED
, /**< sent, but failed to ACK */
46 ADAPTER_MESSAGE_STATE_SENT_ACKED
, /**< sent, and ACK received */
47 ADAPTER_MESSAGE_STATE_INCOMING
, /**< received from another device */
48 ADAPTER_MESSAGE_STATE_ERROR
/**< an error occured */
49 } cec_adapter_message_state
;
51 class IAdapterCommunicationCallback
54 IAdapterCommunicationCallback(void) {}
55 virtual ~IAdapterCommunicationCallback(void) {}
58 * @brief Callback method for IAdapterCommunication, called when a new cec_command is received
59 * @param command The command that has been received
60 * @return True when it was handled by this listener, false otherwise.
62 virtual bool OnCommandReceived(const cec_command
&command
) = 0;
65 * @brief Callback method for IAdapterCommunication, called when a poll was received.
66 * @param initiator The initiator that sent the poll.
67 * @param destination The destination of the poll message.
69 virtual void HandlePoll(cec_logical_address initiator
, cec_logical_address destination
) = 0;
72 * @brief Callback method for IAdapterCommunication, called when a receive failed message was received.
73 * @param initiator The initiator that sent the receive failed message.
74 * @return True when this is an error, false otherwise.
76 virtual bool HandleReceiveFailed(cec_logical_address initiator
) = 0;
78 virtual CLibCEC
*GetLib(void) const = 0;
81 class IAdapterCommunication
85 * @param callback The callback struct. if set to NULL, the Read() method has to be used to read commands. if set, OnCommandReceived() will be called for each command that was received
87 IAdapterCommunication(IAdapterCommunicationCallback
*callback
) :
88 m_callback(callback
) {}
89 virtual ~IAdapterCommunication(void) {}
92 * @brief Open a connection to the CEC adapter
93 * @param iTimeoutMs Connection timeout in ms
94 * @param bSkipChecks Skips all initial checks of the adapter, and starts the reader/writer threads directly after connecting.
95 * @param bStartListening Start a listener thread when true. False to just open a connection, read the device info, and close the connection.
96 * @return True when connected, false otherwise
98 virtual bool Open(uint32_t iTimeoutMs
= CEC_DEFAULT_CONNECT_TIMEOUT
, bool bSkipChecks
= false, bool bStartListening
= true) = 0;
101 * @brief Close an open connection
103 virtual void Close(void) = 0;
106 * @return True when the connection is open, false otherwise
108 virtual bool IsOpen(void) = 0;
111 * @return The last error message, or an empty string if there was none
113 virtual std::string
GetError(void) const = 0;
116 * @brief Write a cec_command to the adapter
117 * @param data The command to write
118 * @param bRetry The command can be retried
119 * @param iLineTimeout The line timeout to be used
120 * @param bIsReply True when this message is a reply, false otherwise
121 * @return The last state of the transmitted command
123 virtual cec_adapter_message_state
Write(const cec_command
&data
, bool &bRetry
, uint8_t iLineTimeout
, bool bIsReply
) = 0;
126 * @brief Change the current line timeout on the CEC bus
127 * @param iTimeout The new timeout
128 * @return True when set, false otherwise
130 virtual bool SetLineTimeout(uint8_t iTimeout
) = 0;
133 * @brief Put the device in bootloader mode (which will disrupt CEC communication when it succeeds)
134 * @return True when the bootloader command has been sent, false otherwise.
136 virtual bool StartBootloader(void) = 0;
138 virtual bool SetLogicalAddresses(const cec_logical_addresses
&addresses
) = 0;
139 virtual cec_logical_addresses
GetLogicalAddresses(void) = 0;
142 * @brief Check whether the CEC adapter responds
143 * @return True when the ping was sent and acked, false otherwise.
145 virtual bool PingAdapter(void) = 0;
148 * @return The firmware version of this CEC adapter, or 0 if it's unknown.
150 virtual uint16_t GetFirmwareVersion(void) = 0;
153 * @return The build date in seconds since epoch, or 0 when no (valid) reply was received.
155 virtual uint32_t GetFirmwareBuildDate(void) = 0;
158 * @return True when this adapter is using the latest firmware build, or when the latest firmware build for this adapter type is unknown. False otherwise.
160 virtual bool IsRunningLatestFirmware(void) = 0;
163 * @return True when the control mode has been set, false otherwise.
165 virtual bool SetControlledMode(bool controlled
) = 0;
168 * @brief Persist the given configuration in adapter (if supported)
169 * @brief The configuration to store.
170 * @return True when the configuration was persisted, false otherwise.
172 virtual bool PersistConfiguration(const libcec_configuration
&configuration
) = 0;
175 * @brief Get the persisted configuration from the adapter (if supported)
176 * @param configuration The updated configuration.
177 * @return True when the configuration was updated, false otherwise.
179 virtual bool GetConfiguration(libcec_configuration
&configuration
) = 0;
182 * @return The name of the port
184 virtual std::string
GetPortName(void) = 0;
187 * @return The physical address, if the adapter supports this. 0 otherwise.
189 virtual uint16_t GetPhysicalAddress(void) = 0;
192 * @return The vendor id for this device
194 virtual cec_vendor_id
GetVendorId(void) = 0;
197 * @brief Checks whether a logical address is supported by the adapter.
198 * @param address The address to check.
199 * @return True when supported, false otherwise.
201 virtual bool SupportsSourceLogicalAddress(const cec_logical_address address
) = 0;
203 IAdapterCommunicationCallback
*m_callback
;