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   delete m_comm;
  59 }
  60
  61 bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
  62 {
  63   if (!m_comm)
  64   {
  65     AddLog(CEC_LOG_ERROR, "no comm port");
  66     return false;
  67   }
  68
  69   if (m_comm->IsOpen())
  70   {
  71     AddLog(CEC_LOG_ERROR, "connection already open");
  72     return false;
  73   }
  74
  75   int64_t iNow = GetTimeMs();
  76   int64_t iTarget = iNow + iTimeoutMs;
  77
  78   bool bOpened(false);
  79   while (!bOpened && iNow < iTarget)
  80   {
  81     bOpened = m_comm->Open(strPort, 38400, iTimeoutMs);
  82     iNow = GetTimeMs();
  83   }
  84
  85   if (!bOpened)
  86   {
  87     AddLog(CEC_LOG_ERROR, "could not open a connection");
  88     return false;
  89   }
  90
  91   if (!m_cec->Start())
  92   {
  93     AddLog(CEC_LOG_ERROR, "could not start CEC communications");
  94     return false;
  95   }
  96
  97   return true;
  98 }
  99
 100 void CLibCEC::Close(void)
 101 {
 102   if (m_cec)
 103     m_cec->StopThread();
 104   if (m_comm)
 105     m_comm->Close();
 106 }
 107
 108 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
 109 {
 110   CStdString strDebug;
 111   if (strDevicePath)
 112     strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
 113   else
 114     strDebug.Format("trying to autodetect all CEC adapters");
 115   AddLog(CEC_LOG_DEBUG, strDebug);
 116
 117   return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
 118 }
 119
 120 bool CLibCEC::PingAdapter(void)
 121 {
 122   return m_comm ? m_comm->PingAdapter() : false;
 123 }
 124
 125 bool CLibCEC::StartBootloader(void)
 126 {
 127   return m_comm ? m_comm->StartBootloader() : false;
 128 }
 129
 130 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
 131 {
 132   return (m_logBuffer.Pop(*message));
 133 }
 134
 135 bool CLibCEC::GetNextKeypress(cec_keypress *key)
 136 {
 137   return m_keyBuffer.Pop(*key);
 138 }
 139
 140 bool CLibCEC::GetNextCommand(cec_command *command)
 141 {
 142   return m_commandBuffer.Pop(*command);
 143 }
 144
 145 bool CLibCEC::Transmit(const cec_command &data)
 146 {
 147   return m_cec ? m_cec->Transmit(data) : false;
 148 }
 149
 150 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
 151 {
 152   return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
 153 }
 154
 155 bool CLibCEC::SetPhysicalAddress(uint16_t iPhysicalAddress)
 156 {
 157   return m_cec ? m_cec->SetPhysicalAddress(iPhysicalAddress) : false;
 158 }
 159
 160 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
 161 {
 162   return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->PowerOn() : false;
 163 }
 164
 165 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
 166 {
 167   return m_cec && address >= CECDEVICE_TV && address <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)address]->Standby() : false;
 168 }
 169
 170 bool CLibCEC::SetActiveView(void)
 171 {
 172   return m_cec ? m_cec->SetActiveView() : false;
 173 }
 174
 175 bool CLibCEC::SetInactiveView(void)
 176 {
 177   return m_cec ? m_cec->SetInactiveView() : false;
 178 }
 179
 180 bool CLibCEC::SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage)
 181 {
 182   return m_cec && iLogicalAddress >= CECDEVICE_TV && iLogicalAddress <= CECDEVICE_BROADCAST ? m_cec->m_busDevices[(uint8_t)iLogicalAddress]->SetOSDString(duration, strMessage) : false;
 183 }
 184
 185 bool CLibCEC::SwitchMonitoring(bool bEnable)
 186 {
 187   return m_cec ? m_cec->SwitchMonitoring(bEnable) : false;
 188 }
 189
 190 cec_version CLibCEC::GetDeviceCecVersion(cec_logical_address iAddress)
 191 {
 192   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 193     return m_cec->GetDeviceCecVersion(iAddress);
 194   return CEC_VERSION_UNKNOWN;
 195 }
 196
 197 bool CLibCEC::GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language)
 198 {
 199   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 200     return m_cec->GetDeviceMenuLanguage(iAddress, language);
 201   return false;
 202 }
 203
 204 uint64_t CLibCEC::GetDeviceVendorId(cec_logical_address iAddress)
 205 {
 206   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 207     return m_cec->GetDeviceVendorId(iAddress);
 208   return 0;
 209 }
 210
 211 cec_power_status CLibCEC::GetDevicePowerStatus(cec_logical_address iAddress)
 212 {
 213   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 214     return m_cec->GetDevicePowerStatus(iAddress);
 215   return CEC_POWER_STATUS_UNKNOWN;
 216 }
 217
 218 bool CLibCEC::PollDevice(cec_logical_address iAddress)
 219 {
 220   if (m_cec && iAddress >= CECDEVICE_TV && iAddress < CECDEVICE_BROADCAST)
 221     return m_cec->PollDevice(iAddress);
 222   return false;
 223 }
 224
 225 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
 226 {
 227   if (m_cec)
 228   {
 229     cec_log_message message;
 230     message.level = level;
 231     message.time = GetTimeMs() - m_iStartTime;
 232     snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
 233     m_logBuffer.Push(message);
 234   }
 235 }
 236
 237 void CLibCEC::AddKey(cec_keypress &key)
 238 {
 239   m_keyBuffer.Push(key);
 240   m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 241   m_buttontime = 0;
 242 }
 243
 244 void CLibCEC::AddKey(void)
 245 {
 246   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
 247   {
 248     cec_keypress key;
 249
 250     key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
 251     key.keycode = m_iCurrentButton;
 252     m_keyBuffer.Push(key);
 253     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 254   }
 255   m_buttontime = 0;
 256 }
 257
 258 void CLibCEC::AddCommand(const cec_command &command)
 259 {
 260   if (m_commandBuffer.Push(command))
 261   {
 262     CStdString strDebug;
 263     strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", command.opcode, m_commandBuffer.Size());
 264     AddLog(CEC_LOG_DEBUG, strDebug);
 265   }
 266   else
 267   {
 268     AddLog(CEC_LOG_WARNING, "command buffer is full");
 269   }
 270 }
 271
 272 void CLibCEC::CheckKeypressTimeout(void)
 273 {
 274   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
 275   {
 276     AddKey();
 277     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 278   }
 279 }
 280
 281 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
 282 {
 283   m_iCurrentButton = iButtonCode;
 284   m_buttontime = GetTimeMs();
 285
 286   /* push keypress to the keybuffer with 0 duration.
 287      push another press to the keybuffer with the duration set when the button is released */
 288   cec_keypress key;
 289   key.duration = 0;
 290   key.keycode = m_iCurrentButton;
 291   m_keyBuffer.Push(key);
 292 }
 293
 294 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 295 {
 296   return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
 297 }
 298
 299 void CECDestroy(CEC::ICECAdapter *instance)
 300 {
 301   CLibCEC *lib = static_cast< CLibCEC* > (instance);
 302   if (lib)
 303     delete lib;
 304 }