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 "util/StdString.h"
  39 #include "platform/timeutils.h"
  40
  41 using namespace std;
  42 using namespace CEC;
  43
  44 CLibCEC::CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress /* = CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */) :
  45     m_bStarted(false),
  46     m_iCurrentButton(CEC_USER_CONTROL_CODE_UNKNOWN),
  47     m_buttontime(0)
  48 {
  49   m_comm = new CAdapterCommunication(this);
  50   m_cec = new CCECProcessor(this, m_comm, strDeviceName, iLogicalAddress, iPhysicalAddress);
  51 }
  52
  53 CLibCEC::~CLibCEC(void)
  54 {
  55   Close();
  56   delete m_cec;
  57   m_cec = NULL;
  58
  59   delete m_comm;
  60   m_comm = NULL;
  61
  62   m_logBuffer.Clear();
  63   m_keyBuffer.Clear();
  64   m_commandBuffer.Clear();
  65 }
  66
  67 bool CLibCEC::Open(const char *strPort, uint32_t iTimeoutMs /* = 10000 */)
  68 {
  69   if (!m_comm)
  70   {
  71     AddLog(CEC_LOG_ERROR, "no comm port");
  72     return false;
  73   }
  74
  75   if (m_comm->IsOpen())
  76   {
  77     AddLog(CEC_LOG_ERROR, "connection already open");
  78     return false;
  79   }
  80
  81   if (!m_comm->Open(strPort, 38400, iTimeoutMs))
  82   {
  83     AddLog(CEC_LOG_ERROR, "could not open a connection");
  84     return false;
  85   }
  86
  87   if (!m_cec->Start())
  88   {
  89     AddLog(CEC_LOG_ERROR, "could not start CEC communications");
  90     return false;
  91   }
  92
  93   m_bStarted = true;
  94   return true;
  95 }
  96
  97 void CLibCEC::Close(void)
  98 {
  99   if (m_comm)
 100     m_comm->Close();
 101   if (m_cec)
 102     m_cec->StopThread();
 103   m_bStarted = false;
 104 }
 105
 106 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
 107 {
 108   CStdString strDebug;
 109   if (strDevicePath)
 110     strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
 111   else
 112     strDebug.Format("trying to autodetect all CEC adapters");
 113   AddLog(CEC_LOG_DEBUG, strDebug);
 114
 115   return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
 116 }
 117
 118 bool CLibCEC::PingAdapter(void)
 119 {
 120   return m_comm ? m_comm->PingAdapter() : false;
 121 }
 122
 123 bool CLibCEC::StartBootloader(void)
 124 {
 125   return m_comm ? m_comm->StartBootloader() : false;
 126 }
 127
 128 int8_t CLibCEC::GetMinVersion(void)
 129 {
 130   return CEC_MIN_VERSION;
 131 }
 132
 133 int8_t CLibCEC::GetLibVersion(void)
 134 {
 135   return CEC_LIB_VERSION;
 136 }
 137
 138 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
 139 {
 140   return (m_logBuffer.Pop(*message));
 141 }
 142
 143 bool CLibCEC::GetNextKeypress(cec_keypress *key)
 144 {
 145   return m_keyBuffer.Pop(*key);
 146 }
 147
 148 bool CLibCEC::GetNextCommand(cec_command *command)
 149 {
 150   return m_commandBuffer.Pop(*command);
 151 }
 152
 153 bool CLibCEC::Transmit(const cec_frame &data, bool bWaitForAck /* = true */)
 154 {
 155   return m_cec ? m_cec->Transmit(data, bWaitForAck) : false;
 156 }
 157
 158 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
 159 {
 160   return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
 161 }
 162
 163 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
 164 {
 165   return m_cec ? m_cec->PowerOnDevices(address) : false;
 166 }
 167
 168 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
 169 {
 170   return m_cec ? m_cec->StandbyDevices(address) : false;
 171 }
 172
 173 bool CLibCEC::SetActiveView(void)
 174 {
 175   return m_cec ? m_cec->SetActiveView() : false;
 176 }
 177
 178 bool CLibCEC::SetInactiveView(void)
 179 {
 180   return m_cec ? m_cec->SetInactiveView() : false;
 181 }
 182
 183 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
 184 {
 185   if (m_bStarted)
 186   {
 187     cec_log_message message;
 188     message.level = level;
 189     snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
 190     m_logBuffer.Push(message);
 191   }
 192 }
 193
 194 void CLibCEC::AddKey(void)
 195 {
 196   if (m_bStarted && m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
 197   {
 198     cec_keypress key;
 199
 200     key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
 201     key.keycode = m_iCurrentButton;
 202     m_keyBuffer.Push(key);
 203     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 204     m_buttontime = 0;
 205   }
 206 }
 207
 208 void CLibCEC::AddCommand(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_frame *parameters)
 209 {
 210   if (!m_bStarted)
 211     return;
 212
 213   cec_command command;
 214   command.clear();
 215
 216   command.source       = source;
 217   command.destination  = destination;
 218   command.opcode       = opcode;
 219   if (parameters)
 220     command.parameters = *parameters;
 221   if (m_commandBuffer.Push(command))
 222   {
 223     CStdString strDebug;
 224     strDebug.Format("stored command '%d' in the command buffer. buffer size = %d", opcode, m_commandBuffer.Size());
 225     AddLog(CEC_LOG_DEBUG, strDebug);
 226   }
 227   else
 228   {
 229     AddLog(CEC_LOG_WARNING, "command buffer is full");
 230   }
 231 }
 232
 233 void CLibCEC::CheckKeypressTimeout(void)
 234 {
 235   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
 236   {
 237     AddKey();
 238     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 239   }
 240 }
 241
 242 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
 243 {
 244   m_iCurrentButton = iButtonCode;
 245   m_buttontime = GetTimeMs();
 246 }
 247
 248 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 249 {
 250   return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
 251 }
 252
 253 void CECDestroy(CEC::ICECAdapter *instance)
 254 {
 255   CLibCEC *lib = static_cast< CLibCEC* > (instance);
 256   if (lib)
 257     delete lib;
 258 }