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