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