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_device_type_list types) :
  46     m_iStartTime(GetTimeMs()),
  47     m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
  48     m_buttontime(0),
  49     m_callbacks(NULL)
  50 {
  51   m_cec = new CCECProcessor(this, strDeviceName, types);
  52 }
  53
  54 CLibCEC::CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */) :
  55     m_iStartTime(GetTimeMs()),
  56     m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
  57     m_buttontime(0),
  58     m_callbacks(NULL)
  59 {
  60   m_cec = new CCECProcessor(this, strDeviceName, iLogicalAddress, iPhysicalAddress);
  61 }
  62
  63 CLibCEC::~CLibCEC(void)
  64 {
  65   Close();
  66   delete m_cec;
  67 }
  68
  69 bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
  70 {
  71   if (m_cec->IsRunning())
  72   {
  73     AddLog(CEC_LOG_ERROR, "connection already open");
  74     return false;
  75   }
  76
  77   if (!m_cec->Start(strPort, 38400, iTimeoutMs))
  78   {
  79     AddLog(CEC_LOG_ERROR, "could not start CEC communications");
  80     return false;
  81   }
  82
  83   return true;
  84 }
  85
  86 void CLibCEC::Close(void)
  87 {
  88   if (m_cec)
  89     m_cec->StopThread();
  90 }
  91
  92 bool CLibCEC::EnableCallbacks(ICECCallbacks *callbacks)
  93 {
  94   CLockObject lock(&m_mutex);
  95   if (m_cec)
  96     m_callbacks = callbacks;
  97   return false;
  98 }
  99
 100 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
 101 {
 102   CStdString strDebug;
 103   if (strDevicePath)
 104     strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
 105   else
 106     strDebug.Format("trying to autodetect all CEC adapters");
 107   AddLog(CEC_LOG_DEBUG, strDebug);
 108
 109   return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
 110 }
 111
 112 bool CLibCEC::PingAdapter(void)
 113 {
 114   return m_cec ? m_cec->PingAdapter() : false;
 115 }
 116
 117 bool CLibCEC::StartBootloader(void)
 118 {
 119   return m_cec ? m_cec->StartBootloader() : false;
 120 }
 121
 122 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
 123 {
 124   return (m_logBuffer.Pop(*message));
 125 }
 126
 127 bool CLibCEC::GetNextKeypress(cec_keypress *key)
 128 {
 129   return m_keyBuffer.Pop(*key);
 130 }
 131
 132 bool CLibCEC::GetNextCommand(cec_command *command)
 133 {
 134   return m_commandBuffer.Pop(*command);
 135 }
 136
 137 bool CLibCEC::Transmit(const cec_command &data)
 138 {
 139   return m_cec ? m_cec->Transmit(data) : false;
 140 }
 141
 142 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
 143 {
 144   return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
 145 }
 146
 147 bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 148 {
 149   return m_cec ? m_cec->SetPhysicalAddress(iPhysicalAddress) : false;
 150 }
 151
 152 bool CLibCEC::SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort /* = CEC_DEFAULT_HDMI_PORT */)
 153 {
 154   return m_cec ? m_cec->SetHDMIPort(iBaseDevice, iPort) : false;
 155 }
 156
 157 bool CLibCEC::EnablePhysicalAddressDetection(void)
 158 {
 159   return m_cec ? m_cec->EnablePhysicalAddressDetection() : false;
 160 }
 161
 162 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
 163 {
 164   return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->PowerOn() : false;
 165 }
 166
 167 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
 168 {
 169   return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->Standby() : false;
 170 }
 171
 172 bool CLibCEC::SetActiveSource(cec_device_type type /* = CEC_DEVICE_TYPE_RESERVED */)
 173 {
 174   return m_cec ? m_cec->SetActiveSource(type) : false;
 175 }
 176
 177 bool CLibCEC::SetActiveView(void)
 178 {
 179   return m_cec ? m_cec->SetActiveView() : false;
 180 }
 181
 182 bool CLibCEC::SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate /* = true */)
 183 {
 184   return m_cec ? m_cec->SetDeckControlMode(mode, bSendUpdate) : false;
 185 }
 186
 187 bool CLibCEC::SetDeckInfo(cec_deck_info info, bool bSendUpdate /* = true */)
 188 {
 189   return m_cec ? m_cec->SetDeckInfo(info, bSendUpdate) : false;
 190 }
 191
 192 bool CLibCEC::SetInactiveView(void)
 193 {
 194   return m_cec ? m_cec->TransmitInactiveSource() : false;
 195 }
 196
 197 bool CLibCEC::SetMenuState(cec_menu_state state, bool bSendUpdate /* = true */)
 198 {
 199   return m_cec ? m_cec->SetMenuState(state, bSendUpdate) : false;
 200 }
 201
 202 bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
 203 {
 204   return m_cec && iLogicalAddress >= CECDEVICE_TV && iLogicalAddress <= CECDEVICE_BROADCAST ?
 205       m_cec->m_busDevices[m_cec->GetLogicalAddress()]->TransmitOSDString(iLogicalAddress, duration, strMessage) :
 206       false;
 207 }
 208
 209 bool CLibCEC::SwitchMonitoring(bool bEnable)
 210 {
 211   return m_cec ? m_cec->SwitchMonitoring(bEnable) : false;
 212 }
 213
 214 cec_version CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress)
 215 {
 216   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 217     return m_cec->GetDeviceCecVersion(iAddress);
 218   return CEC_VERSION_UNKNOWN;
 219 }
 220
 221 bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
 222 {
 223   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 224     return m_cec->GetDeviceMenuLanguage(iAddress, language);
 225   return false;
 226 }
 227
 228 uint64_t CLibCEC::GetDeviceVendorId(cec_logical_address iAddress)
 229 {
 230   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 231     return m_cec->GetDeviceVendorId(iAddress);
 232   return 0;
 233 }
 234
 235 uint16_t CLibCEC::GetDevicePhysicalAddress(cec_logical_address iAddress)
 236 {
 237   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 238     return m_cec->GetDevicePhysicalAddress(iAddress);
 239   return 0;
 240 }
 241
 242 cec_logical_address CLibCEC::GetActiveSource(void)
 243 {
 244   return m_cec ? m_cec->GetActiveSource() : CECDEVICE_UNKNOWN;
 245 }
 246
 247 bool CLibCEC::IsActiveSource(cec_logical_address iAddress)
 248 {
 249   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 250     return m_cec->IsActiveSource(iAddress);
 251   return false;
 252 }
 253
 254 cec_power_status CLibCEC::GetDevicePowerStatus(cec_logical_address iAddress)
 255 {
 256   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 257     return m_cec->GetDevicePowerStatus(iAddress);
 258   return CEC_POWER_STATUS_UNKNOWN;
 259 }
 260
 261 bool CLibCEC::PollDevice(cec_logical_address iAddress)
 262 {
 263   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 264     return m_cec->PollDevice(iAddress);
 265   return false;
 266 }
 267
 268 cec_logical_addresses CLibCEC::GetActiveDevices(void)
 269 {
 270   cec_logical_addresses addresses;
 271   addresses.Clear();
 272   if (m_cec)
 273     addresses = m_cec->GetActiveDevices();
 274   return addresses;
 275 }
 276
 277 bool CLibCEC::IsActiveDevice(cec_logical_address iAddress)
 278 {
 279   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 280     return m_cec->IsPresentDevice(iAddress);
 281   return false;
 282 }
 283
 284 bool CLibCEC::IsActiveDeviceType(cec_device_type type)
 285 {
 286   if (m_cec && type >= CEC_DEVICE_TYPE_TV && type <= CEC_DEVICE_TYPE_AUDIO_SYSTEM)
 287     return m_cec->IsPresentDeviceType(type);
 288   return false;
 289 }
 290
 291 uint8_t CLibCEC::VolumeUp(bool bSendRelease /* = true */)
 292 {
 293   if (m_cec)
 294     return m_cec->VolumeUp(bSendRelease);
 295   return 0;
 296 }
 297
 298 uint8_t CLibCEC::VolumeDown(bool bSendRelease /* = true */)
 299 {
 300   if (m_cec)
 301     return m_cec->VolumeDown(bSendRelease);
 302   return 0;
 303 }
 304
 305
 306 uint8_t CLibCEC::MuteAudio(bool bSendRelease /* = true */)
 307 {
 308   if (m_cec)
 309     return m_cec->MuteAudio(bSendRelease);
 310   return 0;
 311 }
 312
 313 bool CLibCEC::SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait /* = true */)
 314 {
 315   if (m_cec)
 316     return m_cec->TransmitKeypress(iDestination, key, bWait);
 317   return false;
 318 }
 319
 320 bool CLibCEC::SendKeyRelease(cec_logical_address iDestination, bool bWait /* = true */)
 321 {
 322   if (m_cec)
 323     return m_cec->TransmitKeyRelease(iDestination, bWait);
 324   return false;
 325 }
 326
 327 cec_osd_name CLibCEC::GetDeviceOSDName(cec_logical_address iAddress)
 328 {
 329   cec_osd_name retVal;
 330   retVal.device = iAddress;
 331   retVal.name[0] = 0;
 332
 333   if (m_cec)
 334     retVal = m_cec->GetDeviceOSDName(iAddress);
 335
 336   return retVal;
 337 }
 338
 339 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
 340 {
 341   CLockObject lock(&m_mutex);
 342   if (m_cec)
 343   {
 344     cec_log_message message;
 345     message.level = level;
 346     message.time = GetTimeMs() - m_iStartTime;
 347     snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
 348
 349     if (m_callbacks)
 350       m_callbacks->CBCecLogMessage(message);
 351     else
 352       m_logBuffer.Push(message);
 353   }
 354 }
 355
 356 void CLibCEC::AddKey(cec_keypress &key)
 357 {
 358   CLockObject lock(&m_mutex);
 359   if (m_callbacks)
 360     m_callbacks->CBCecKeyPress(key);
 361   else
 362     m_keyBuffer.Push(key);
 363   m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 364   m_buttontime = 0;
 365 }
 366
 367 void CLibCEC::AddKey(void)
 368 {
 369   CLockObject lock(&m_mutex);
 370   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
 371   {
 372     cec_keypress key;
 373
 374     key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
 375     key.keycode = m_iCurrentButton;
 376
 377     if (m_callbacks)
 378       m_callbacks->CBCecKeyPress(key);
 379     else
 380       m_keyBuffer.Push(key);
 381     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 382   }
 383   m_buttontime = 0;
 384 }
 385
 386 void CLibCEC::AddCommand(const cec_command &command)
 387 {
 388   CLockObject lock(&m_mutex);
 389   if (m_callbacks)
 390   {
 391     m_callbacks->CBCecCommand(command);
 392   }
 393   else if (m_commandBuffer.Push(command))
 394   {
 395     CStdString strDebug;
 396     strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", command.opcode, m_commandBuffer.Size());
 397     AddLog(CEC_LOG_DEBUG, strDebug);
 398   }
 399   else
 400   {
 401     AddLog(CEC_LOG_WARNING, "command buffer is full");
 402   }
 403 }
 404
 405 void CLibCEC::CheckKeypressTimeout(void)
 406 {
 407   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
 408   {
 409     AddKey();
 410     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 411   }
 412 }
 413
 414 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
 415 {
 416   m_iCurrentButton = iButtonCode;
 417   m_buttontime = GetTimeMs();
 418
 419   /* push keypress to the keybuffer with 0 duration.
 420      push another press to the keybuffer with the duration set when the button is released */
 421   cec_keypress key;
 422   key.duration = 0;
 423   key.keycode = m_iCurrentButton;
 424   m_keyBuffer.Push(key);
 425 }
 426
 427 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 428 {
 429   return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
 430 }
 431
 432 void * CECInit(const char *strDeviceName, CEC::cec_device_type_list types)
 433 {
 434   return static_cast< void* > (new CLibCEC(strDeviceName, types));
 435 }
 436
 437 void CECDestroy(CEC::ICECAdapter *instance)
 438 {
 439   CLibCEC *lib = static_cast< CLibCEC* > (instance);
 440   if (lib)
 441     delete lib;
 442 }
 443
 444 const char *CLibCEC::ToString(const cec_menu_state state)
 445 {
 446   return m_cec->ToString(state);
 447 }
 448
 449 const char *CLibCEC::ToString(const cec_version version)
 450 {
 451   return m_cec->ToString(version);
 452 }
 453
 454 const char *CLibCEC::ToString(const cec_power_status status)
 455 {
 456   return m_cec->ToString(status);
 457 }
 458
 459 const char *CLibCEC::ToString(const cec_logical_address address)
 460 {
 461   return m_cec->ToString(address);
 462 }
 463
 464 const char *CLibCEC::ToString(const cec_deck_control_mode mode)
 465 {
 466   return m_cec->ToString(mode);
 467 }
 468
 469 const char *CLibCEC::ToString(const cec_deck_info status)
 470 {
 471   return m_cec->ToString(status);
 472 }
 473
 474 const char *CLibCEC::ToString(const cec_opcode opcode)
 475 {
 476   return m_cec->ToString(opcode);
 477 }
 478
 479 const char *CLibCEC::ToString(const cec_system_audio_status mode)
 480 {
 481   return m_cec->ToString(mode);
 482 }
 483
 484 const char *CLibCEC::ToString(const cec_audio_status status)
 485 {
 486   return m_cec->ToString(status);
 487 }
 488
 489 const char *CLibCEC::ToString(const cec_vendor_id vendor)
 490 {
 491   return m_cec->ToString(vendor);
 492 }