cec: added GetDeviceMenuLanguage()/cec_get_device_menu_language()
[deb_libcec.git] / src / lib / LibCEC.cpp
1 /*
2 * This file is part of the libCEC(R) library.
3 *
4 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
5 * libCEC(R) is an original work, containing original code.
6 *
7 * libCEC(R) is a trademark of Pulse-Eight Limited.
8 *
9 * This program is dual-licensed; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 *
23 *
24 * Alternatively, you can license this library under a commercial license,
25 * please contact Pulse-Eight Licensing for more information.
26 *
27 * For more information contact:
28 * Pulse-Eight Licensing <license@pulse-eight.com>
29 * http://www.pulse-eight.com/
30 * http://www.pulse-eight.net/
31 */
32
33 #include "LibCEC.h"
34
35 #include "AdapterCommunication.h"
36 #include "AdapterDetection.h"
37 #include "CECProcessor.h"
38 #include "devices/CECBusDevice.h"
39 #include "util/StdString.h"
40 #include "platform/timeutils.h"
41
42 using namespace std;
43 using namespace CEC;
44
45 CLibCEC::CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */) :
46 m_iStartTime(GetTimeMs()),
47 m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
48 m_buttontime(0)
49 {
50 m_comm = new CAdapterCommunication(this);
51 m_cec = new CCECProcessor(this, m_comm, strDeviceName, iLogicalAddress, iPhysicalAddress);
52 }
53
54 CLibCEC::~CLibCEC(void)
55 {
56 Close();
57 delete m_cec;
58 m_cec = NULL;
59
60 delete m_comm;
61 m_comm = NULL;
62
63 m_logBuffer.Clear();
64 m_keyBuffer.Clear();
65 m_commandBuffer.Clear();
66 }
67
68 bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
69 {
70 if (!m_comm)
71 {
72 AddLog(CEC_LOG_ERROR, "no comm port");
73 return false;
74 }
75
76 if (m_comm->IsOpen())
77 {
78 AddLog(CEC_LOG_ERROR, "connection already open");
79 return false;
80 }
81
82 int64_t iNow = GetTimeMs();
83 int64_t iTarget = iNow + iTimeoutMs;
84
85 bool bOpened(false);
86 while (!bOpened && iNow < iTarget)
87 {
88 bOpened = m_comm->Open(strPort, 38400, iTimeoutMs);
89 iNow = GetTimeMs();
90 }
91
92 if (!bOpened)
93 {
94 AddLog(CEC_LOG_ERROR, "could not open a connection");
95 return false;
96 }
97
98 if (!m_cec->Start())
99 {
100 AddLog(CEC_LOG_ERROR, "could not start CEC communications");
101 return false;
102 }
103
104 return true;
105 }
106
107 void CLibCEC::Close(void)
108 {
109 if (m_cec)
110 m_cec->StopThread();
111 if (m_comm)
112 m_comm->Close();
113 }
114
115 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
116 {
117 CStdString strDebug;
118 if (strDevicePath)
119 strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
120 else
121 strDebug.Format("trying to autodetect all CEC adapters");
122 AddLog(CEC_LOG_DEBUG, strDebug);
123
124 return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
125 }
126
127 bool CLibCEC::PingAdapter(void)
128 {
129 return m_comm ? m_comm->PingAdapter() : false;
130 }
131
132 bool CLibCEC::StartBootloader(void)
133 {
134 return m_comm ? m_comm->StartBootloader() : false;
135 }
136
137 int8_t CLibCEC::GetMinVersion(void)
138 {
139 return CEC_MIN_VERSION;
140 }
141
142 int8_t CLibCEC::GetLibVersion(void)
143 {
144 return CEC_LIB_VERSION;
145 }
146
147 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
148 {
149 return (m_logBuffer.Pop(*message));
150 }
151
152 bool CLibCEC::GetNextKeypress(cec_keypress *key)
153 {
154 return m_keyBuffer.Pop(*key);
155 }
156
157 bool CLibCEC::GetNextCommand(cec_command *command)
158 {
159 return m_commandBuffer.Pop(*command);
160 }
161
162 bool CLibCEC::Transmit(const cec_command &data)
163 {
164 return m_cec ? m_cec->Transmit(data) : false;
165 }
166
167 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
168 {
169 return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
170 }
171
172 bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress)
173 {
174 return m_cec ? m_cec->SetPhysicalAddress(iPhysicalAddress) : false;
175 }
176
177 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
178 {
179 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->PowerOn() : false;
180 }
181
182 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
183 {
184 return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->Standby() : false;
185 }
186
187 bool CLibCEC::SetActiveView(void)
188 {
189 return m_cec ? m_cec->SetActiveView() : false;
190 }
191
192 bool CLibCEC::SetInactiveView(void)
193 {
194 return m_cec ? m_cec->SetInactiveView() : false;
195 }
196
197 bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
198 {
199 return m_cec && iLogicalAddress >= CECDEVICE_TV && iLogicalAddress <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)iLogicalAddress]->SetOSDString(duration, strMessage) : false;
200 }
201
202 bool CLibCEC::SwitchMonitoring(bool bEnable)
203 {
204 return m_cec ? m_cec->SwitchMonitoring(bEnable) : false;
205 }
206
207 cec_version CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress)
208 {
209 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
210 return m_cec->GetDeviceCecVersion(iAddress);
211 return CEC_VERSION_UNKNOWN;
212 }
213
214 bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
215 {
216 if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
217 return m_cec->GetDeviceMenuLanguage(iAddress, language);
218 return false;
219 }
220
221 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
222 {
223 if (m_cec)
224 {
225 cec_log_message message;
226 message.level = level;
227 message.time = GetTimeMs() - m_iStartTime;
228 snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
229 m_logBuffer.Push(message);
230 }
231 }
232
233 void CLibCEC::AddKey(void)
234 {
235 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
236 {
237 cec_keypress key;
238
239 key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
240 key.keycode = m_iCurrentButton;
241 m_keyBuffer.Push(key);
242 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
243 m_buttontime = 0;
244 }
245 }
246
247 void CLibCEC::AddCommand(const cec_command &command)
248 {
249 if (m_commandBuffer.Push(command))
250 {
251 CStdString strDebug;
252 strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", command.opcode, m_commandBuffer.Size());
253 AddLog(CEC_LOG_DEBUG, strDebug);
254 }
255 else
256 {
257 AddLog(CEC_LOG_WARNING, "command buffer is full");
258 }
259 }
260
261 void CLibCEC::CheckKeypressTimeout(void)
262 {
263 if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
264 {
265 AddKey();
266 m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
267 }
268 }
269
270 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
271 {
272 m_iCurrentButton = iButtonCode;
273 m_buttontime = GetTimeMs();
274
275 /* push keypress to the keybuffer with 0 duration.
276 push another press to the keybuffer with the duration set when the button is released */
277 cec_keypress key;
278 key.duration = 0;
279 key.keycode = m_iCurrentButton;
280 m_keyBuffer.Push(key);
281 }
282
283 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
284 {
285 return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
286 }
287
288 void CECDestroy(CEC::ICECAdapter *instance)
289 {
290 CLibCEC *lib = static_cast< CLibCEC* > (instance);
291 if (lib)
292 delete lib;
293 }