added changelog for v0.7
[deb_libcec.git] / include / cecc.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
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.
14 *
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.
19 *
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.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
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/
32 */
33
34 #ifndef CECEXPORTS_C_H_
35 #define CECEXPORTS_C_H_
36
37 #include <cectypes.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /*!
44 * @brief Load the CEC adapter library.
45 * @param strDeviceName How to present this device to other devices.
46 * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default.
47 * @param iPhysicalAddress The physical address of this device. 0x1000 by default.
48 * @return True when initialised, false otherwise.
49 */
50 #ifdef __cplusplus
51 extern DECLSPEC int cec_init(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
52 #else
53 extern DECLSPEC int cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
54 #endif
55
56 /*!
57 * @brief Unload the CEC adapter library.
58 */
59 extern DECLSPEC void cec_destroy(void);
60
61 /*!
62 * @brief Open a connection to the CEC adapter.
63 * @param strPort The path to the port.
64 * @param iTimeout Connection timeout in ms.
65 * @return True when connected, false otherwise.
66 */
67 extern DECLSPEC int cec_open(const char *strPort, uint32_t iTimeout);
68
69 /*!
70 * @brief Close the connection to the CEC adapter.
71 */
72 extern DECLSPEC void cec_close(void);
73
74 /*!
75 * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment.
76 * @param deviceList The vector to store device descriptors in.
77 * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
78 * @return The number of devices that were found, or -1 when an error occured.
79 */
80 #ifdef __cplusplus
81 extern DECLSPEC int8_t cec_find_adapters(CEC::cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
82 #else
83 extern DECLSPEC int8_t cec_find_adapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
84 #endif
85
86 /*!
87 * @brief Ping the CEC adapter.
88 * @return True when the ping was succesful, false otherwise.
89 */
90 extern DECLSPEC int cec_ping_adapters(void);
91
92 /*!
93 * @brief Start the bootloader of the CEC adapter.
94 * @return True when the command was sent succesfully, false otherwise.
95 */
96 extern DECLSPEC int cec_start_bootloader(void);
97
98 /*!
99 * @return Get the minimal version of libcec that this version of libcec can interface with.
100 */
101 extern DECLSPEC int8_t cec_get_min_version(void);
102
103 /*!
104 * @return Get the version of libcec.
105 */
106 extern DECLSPEC int8_t cec_get_lib_version(void);
107
108 /*!
109 * @brief Power on the connected CEC capable devices.
110 * @param address The logical address to power on.
111 * @return True when the command was sent succesfully, false otherwise.
112 */
113 #ifdef __cplusplus
114 extern DECLSPEC int cec_power_on_devices(CEC::cec_logical_address address = CEC::CECDEVICE_TV);
115 #else
116 extern DECLSPEC int cec_power_on_devices(cec_logical_address address = CECDEVICE_TV);
117 #endif
118
119 /*!
120 * @brief Put connected CEC capable devices in standby mode.
121 * @brief address The logical address of the device to put in standby.
122 * @return True when the command was sent succesfully, false otherwise.
123 */
124 #ifdef __cplusplus
125 extern DECLSPEC int cec_standby_devices(CEC::cec_logical_address address = CEC::CECDEVICE_BROADCAST);
126 #else
127 extern DECLSPEC int cec_standby_devices(cec_logical_address address = CECDEVICE_BROADCAST);
128 #endif
129
130 /*!
131 * @brief Broadcast a message that notifies connected CEC capable devices that this device is the active source.
132 * @return True when the command was sent succesfully, false otherwise.
133 */
134 extern DECLSPEC int cec_set_active_view(void);
135
136 /*!
137 * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source.
138 * @return True when the command was sent succesfully, false otherwise.
139 */
140 extern DECLSPEC int cec_set_inactive_view(void);
141
142 /*!
143 * @brief Get the next log message in the queue, if there is one.
144 * @param message The next message.
145 * @return True if a message was passed, false otherwise.
146 */
147 #ifdef __cplusplus
148 extern DECLSPEC int cec_get_next_log_message(CEC::cec_log_message *message);
149 #else
150 extern DECLSPEC int cec_get_next_log_message(cec_log_message *message);
151 #endif
152
153 /*!
154 * @brief Get the next keypress in the queue, if there is one.
155 * @param key The next keypress.
156 * @return True if a key was passed, false otherwise.
157 */
158 #ifdef __cplusplus
159 extern DECLSPEC int cec_get_next_keypress(CEC::cec_keypress *key);
160 #else
161 extern DECLSPEC int cec_get_next_keypress(cec_keypress *key);
162 #endif
163
164 /*!
165 * @brief Get the next CEC command that was received by the adapter.
166 * @param action The next command.
167 * @return True when a command was passed, false otherwise.
168 */
169 #ifdef __cplusplus
170 extern DECLSPEC int cec_get_next_command(CEC::cec_command *command);
171 #else
172 extern DECLSPEC int cec_get_next_command(cec_command *command);
173 #endif
174
175 /*!
176 * @brief Transmit a frame on the CEC line.
177 * @param data The frame to send.
178 * @param bWaitForAck Wait for an ACK message for 1 second after this frame has been sent.
179 * @return True when the data was sent and acked, false otherwise.
180 */
181 #ifdef __cplusplus
182 extern DECLSPEC int cec_transmit(const CEC::cec_command &data, int bWaitForAck = 1);
183 #else
184 extern DECLSPEC int cec_transmit(const cec_command &data, int bWaitForAck = 1);
185 #endif
186
187 /*!
188 * @brief Change the logical address of the CEC adapter.
189 * @param iLogicalAddress The CEC adapter's new logical address.
190 * @return True when the logical address was set successfully, false otherwise.
191 */
192 #ifdef __cplusplus
193 extern DECLSPEC int cec_set_logical_address(CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1);
194 #else
195 extern DECLSPEC int cec_set_logical_address(cec_logical_address myAddress, cec_logical_address targetAddress);
196 #endif
197
198 /*!
199 * @brief Change the physical address (HDMI port) of the CEC adapter.
200 * @param iPhysicalAddress The CEC adapter's new physical address.
201 * @brief True when the physical address was set successfully, false otherwise.
202 */
203 extern DECLSPEC int cec_set_physical_address(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
204
205 /*!
206 * @brief Display a message on the TV.
207 * @brief The message to display.
208 * @return True when the command was sent, false otherwise.
209 */
210 #ifdef __cplusplus
211 extern DECLSPEC int cec_set_osd_string(CEC::cec_logical_address iLogicalAddress, CEC::cec_display_control duration, const char *strMessage);
212 #else
213 extern DECLSPEC int cec_set_osd_string(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
214 #endif
215
216 #ifdef __cplusplus
217 };
218 #endif
219
220 #endif /* CECEXPORTS_C_H_ */