cec: simplified WaitForAck() call. no longer needs to be in a while loop
[deb_libcec.git] / src / lib / CECProcessor.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 "CECProcessor.h"
34
35 #include "AdapterCommunication.h"
36 #include "devices/CECBusDevice.h"
37 #include "LibCEC.h"
38 #include "util/StdString.h"
39 #include "platform/timeutils.h"
40
41 using namespace CEC;
42 using namespace std;
43
44 CCECProcessor::CCECProcessor(CLibCEC *controller, CAdapterCommunication *serComm, const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS*/) :
45 m_iLogicalAddress(iLogicalAddress),
46 m_strDeviceName(strDeviceName),
47 m_communication(serComm),
48 m_controller(controller),
49 m_bMonitor(false)
50 {
51 for (int iPtr = 0; iPtr < 16; iPtr++)
52 m_busDevices[iPtr] = new CCECBusDevice(this, (cec_logical_address) iPtr, iPtr == iLogicalAddress ? iPhysicalAddress : 0);
53 }
54
55 CCECProcessor::~CCECProcessor(void)
56 {
57 StopThread();
58 m_communication = NULL;
59 m_controller = NULL;
60 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
61 delete m_busDevices[iPtr];
62 }
63
64 bool CCECProcessor::Start(void)
65 {
66 if (!m_communication || !m_communication->IsOpen())
67 {
68 m_controller->AddLog(CEC_LOG_ERROR, "connection is closed");
69 return false;
70 }
71
72 if (!SetLogicalAddress(m_iLogicalAddress))
73 {
74 m_controller->AddLog(CEC_LOG_ERROR, "could not set the logical address");
75 return false;
76 }
77
78 if (CreateThread())
79 return true;
80 else
81 m_controller->AddLog(CEC_LOG_ERROR, "could not create a processor thread");
82
83 return false;
84 }
85
86 void *CCECProcessor::Process(void)
87 {
88 m_controller->AddLog(CEC_LOG_DEBUG, "processor thread started");
89
90 cec_command command;
91 CCECAdapterMessage msg;
92
93 while (!IsStopped())
94 {
95 bool bParseFrame(false);
96 command.clear();
97 msg.clear();
98
99 {
100 CLockObject lock(&m_mutex);
101 if (m_communication->IsOpen() && m_communication->Read(msg, 50))
102 bParseFrame = ParseMessage(msg);
103
104 bParseFrame &= !IsStopped();
105 if (bParseFrame)
106 command = m_currentframe;
107 }
108
109 if (bParseFrame)
110 ParseCommand(command);
111
112 m_controller->CheckKeypressTimeout();
113
114 for (unsigned int iDevicePtr = 0; iDevicePtr < 16; iDevicePtr++)
115 m_busDevices[iDevicePtr]->PollVendorId();
116
117 if (!IsStopped())
118 Sleep(5);
119 }
120
121 return NULL;
122 }
123
124 bool CCECProcessor::SetActiveView(void)
125 {
126 if (!IsRunning())
127 return false;
128
129 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
130 }
131
132 bool CCECProcessor::SetInactiveView(void)
133 {
134 if (!IsRunning())
135 return false;
136
137 return m_busDevices[m_iLogicalAddress]->BroadcastInactiveView();
138 }
139
140 void CCECProcessor::LogOutput(const cec_command &data)
141 {
142 CStdString strTx;
143 strTx.Format("<< %02x:%02x", ((uint8_t)data.initiator << 4) + (uint8_t)data.destination, (uint8_t)data.opcode);
144
145 for (uint8_t iPtr = 0; iPtr < data.parameters.size; iPtr++)
146 strTx.AppendFormat(":%02x", data.parameters[iPtr]);
147 m_controller->AddLog(CEC_LOG_TRAFFIC, strTx.c_str());
148 }
149
150 bool CCECProcessor::SetLogicalAddress(cec_logical_address iLogicalAddress)
151 {
152 CStdString strLog;
153 strLog.Format("<< setting logical address to %1x", iLogicalAddress);
154 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
155
156 m_iLogicalAddress = iLogicalAddress;
157 return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
158 }
159
160 bool CCECProcessor::SetPhysicalAddress(uint16_t iPhysicalAddress)
161 {
162 m_busDevices[m_iLogicalAddress]->SetPhysicalAddress(iPhysicalAddress);
163 return m_busDevices[m_iLogicalAddress]->BroadcastActiveView();
164 }
165
166 bool CCECProcessor::SwitchMonitoring(bool bEnable)
167 {
168 CStdString strLog;
169 strLog.Format("== %s monitoring mode ==", bEnable ? "enabling" : "disabling");
170 m_controller->AddLog(CEC_LOG_NOTICE, strLog.c_str());
171
172 m_bMonitor = bEnable;
173 if (bEnable)
174 return m_communication && m_communication->SetAckMask(0);
175 else
176 return m_communication && m_communication->SetAckMask(0x1 << (uint8_t)m_iLogicalAddress);
177 }
178
179 bool CCECProcessor::Transmit(const cec_command &data, bool bWaitForAck /* = true */)
180 {
181 bool bReturn(false);
182 LogOutput(data);
183
184 CCECAdapterMessage output(data);
185
186 CLockObject lock(&m_mutex);
187 if (!m_communication || !m_communication->Write(output))
188 return bReturn;
189
190 if (bWaitForAck)
191 {
192 bool bError(false);
193 if ((bReturn = WaitForAck(&bError, output.size(), 1000)) == false)
194 m_controller->AddLog(CEC_LOG_ERROR, "did not receive ack");
195 }
196 else
197 {
198 bReturn = true;
199 }
200
201 return bReturn;
202 }
203
204 void CCECProcessor::TransmitAbort(cec_logical_address address, cec_opcode opcode, ECecAbortReason reason /* = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE */)
205 {
206 m_controller->AddLog(CEC_LOG_DEBUG, "<< transmitting abort message");
207
208 cec_command command;
209 cec_command::format(command, m_iLogicalAddress, address, CEC_OPCODE_FEATURE_ABORT);
210 command.parameters.push_back((uint8_t)opcode);
211 command.parameters.push_back((uint8_t)reason);
212
213 Transmit(command);
214 }
215
216 bool CCECProcessor::WaitForAck(bool *bError, uint8_t iLength, uint32_t iTimeout /* = 1000 */)
217 {
218 bool bTransmitSucceeded = false;
219 uint8_t iPacketsLeft(iLength / 4);
220 *bError = false;
221
222 int64_t iNow = GetTimeMs();
223 int64_t iTargetTime = iNow + (uint64_t) iTimeout;
224
225 while (!bTransmitSucceeded && !*bError && (iTimeout == 0 || iNow < iTargetTime))
226 {
227 CCECAdapterMessage msg;
228
229 if (!m_communication->Read(msg, iTimeout > 0 ? (int32_t)(iTargetTime - iNow) : 1000))
230 {
231 iNow = GetTimeMs();
232 continue;
233 }
234
235 switch(msg.message())
236 {
237 case MSGCODE_TIMEOUT_ERROR:
238 case MSGCODE_HIGH_ERROR:
239 case MSGCODE_LOW_ERROR:
240 {
241 CStdString logStr;
242 if (msg.message() == MSGCODE_TIMEOUT_ERROR)
243 logStr = "MSGCODE_TIMEOUT";
244 else if (msg.message() == MSGCODE_HIGH_ERROR)
245 logStr = "MSGCODE_HIGH_ERROR";
246 else
247 logStr = "MSGCODE_LOW_ERROR";
248
249 int iLine = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
250 uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
251 logStr.AppendFormat(" line:%i", iLine);
252 logStr.AppendFormat(" time:%u", iTime);
253 m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
254 *bError = true;
255 }
256 break;
257 case MSGCODE_COMMAND_ACCEPTED:
258 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
259 iPacketsLeft--;
260 break;
261 case MSGCODE_TRANSMIT_SUCCEEDED:
262 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
263 bTransmitSucceeded = (iPacketsLeft == 0);
264 *bError = !bTransmitSucceeded;
265 break;
266 case MSGCODE_RECEIVE_FAILED:
267 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
268 *bError = true;
269 break;
270 case MSGCODE_COMMAND_REJECTED:
271 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
272 *bError = true;
273 break;
274 case MSGCODE_TRANSMIT_FAILED_LINE:
275 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
276 *bError = true;
277 break;
278 case MSGCODE_TRANSMIT_FAILED_ACK:
279 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
280 *bError = true;
281 break;
282 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
283 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
284 *bError = true;
285 break;
286 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
287 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
288 *bError = true;
289 break;
290 default:
291 m_frameBuffer.Push(msg);
292 break;
293 }
294
295 iNow = GetTimeMs();
296 }
297
298 return bTransmitSucceeded && !*bError;
299 }
300
301 bool CCECProcessor::ParseMessage(CCECAdapterMessage &msg)
302 {
303 bool bEom = false;
304
305 if (msg.empty())
306 return bEom;
307
308 CStdString logStr;
309
310 switch(msg.message())
311 {
312 case MSGCODE_NOTHING:
313 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_NOTHING");
314 break;
315 case MSGCODE_TIMEOUT_ERROR:
316 case MSGCODE_HIGH_ERROR:
317 case MSGCODE_LOW_ERROR:
318 {
319 if (msg.message() == MSGCODE_TIMEOUT_ERROR)
320 logStr = "MSGCODE_TIMEOUT";
321 else if (msg.message() == MSGCODE_HIGH_ERROR)
322 logStr = "MSGCODE_HIGH_ERROR";
323 else
324 logStr = "MSGCODE_LOW_ERROR";
325
326 int iLine = (msg.size() >= 3) ? (msg[1] << 8) | (msg[2]) : 0;
327 uint32_t iTime = (msg.size() >= 7) ? (msg[3] << 24) | (msg[4] << 16) | (msg[5] << 8) | (msg[6]) : 0;
328 logStr.AppendFormat(" line:%i", iLine);
329 logStr.AppendFormat(" time:%u", iTime);
330 m_controller->AddLog(CEC_LOG_WARNING, logStr.c_str());
331 }
332 break;
333 case MSGCODE_FRAME_START:
334 {
335 logStr = "MSGCODE_FRAME_START";
336 m_currentframe.clear();
337 if (msg.size() >= 2)
338 {
339 logStr.AppendFormat(" initiator:%u destination:%u ack:%s %s", msg.initiator(), msg.destination(), msg.ack() ? "high" : "low", msg.eom() ? "eom" : "");
340 m_currentframe.initiator = msg.initiator();
341 m_currentframe.destination = msg.destination();
342 m_currentframe.ack = msg.ack();
343 m_currentframe.eom = msg.eom();
344 }
345 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
346 }
347 break;
348 case MSGCODE_FRAME_DATA:
349 {
350 logStr = "MSGCODE_FRAME_DATA";
351 if (msg.size() >= 2)
352 {
353 uint8_t iData = msg[1];
354 logStr.AppendFormat(" %02x", iData);
355 m_currentframe.push_back(iData);
356 m_currentframe.eom = msg.eom();
357 }
358 m_controller->AddLog(CEC_LOG_DEBUG, logStr.c_str());
359
360 bEom = msg.eom();
361 }
362 break;
363 case MSGCODE_COMMAND_ACCEPTED:
364 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_COMMAND_ACCEPTED");
365 break;
366 case MSGCODE_TRANSMIT_SUCCEEDED:
367 m_controller->AddLog(CEC_LOG_DEBUG, "MSGCODE_TRANSMIT_SUCCEEDED");
368 break;
369 case MSGCODE_RECEIVE_FAILED:
370 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_RECEIVE_FAILED");
371 break;
372 case MSGCODE_COMMAND_REJECTED:
373 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_COMMAND_REJECTED");
374 break;
375 case MSGCODE_TRANSMIT_FAILED_LINE:
376 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_LINE");
377 break;
378 case MSGCODE_TRANSMIT_FAILED_ACK:
379 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_ACK");
380 break;
381 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA:
382 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA");
383 break;
384 case MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE:
385 m_controller->AddLog(CEC_LOG_WARNING, "MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE");
386 break;
387 default:
388 break;
389 }
390
391 return bEom;
392 }
393
394 void CCECProcessor::ParseCommand(cec_command &command)
395 {
396 CStdString dataStr;
397 dataStr.Format(">> %1x%1x:%02x", command.initiator, command.destination, command.opcode);
398 for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
399 dataStr.AppendFormat(":%02x", (unsigned int)command.parameters[iPtr]);
400 m_controller->AddLog(CEC_LOG_TRAFFIC, dataStr.c_str());
401
402 if (!m_bMonitor)
403 m_busDevices[(uint8_t)command.initiator]->HandleCommand(command);
404 }
405
406 uint16_t CCECProcessor::GetPhysicalAddress(void) const
407 {
408 return m_busDevices[m_iLogicalAddress]->GetPhysicalAddress();
409 }
410
411 void CCECProcessor::SetCurrentButton(cec_user_control_code iButtonCode)
412 {
413 m_controller->SetCurrentButton(iButtonCode);
414 }
415
416 void CCECProcessor::AddCommand(const cec_command &command)
417 {
418 m_controller->AddCommand(command);
419 }
420
421 void CCECProcessor::AddKey(void)
422 {
423 m_controller->AddKey();
424 }
425
426 void CCECProcessor::AddLog(cec_log_level level, const CStdString &strMessage)
427 {
428 m_controller->AddLog(level, strMessage);
429 }