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_iStartTime(GetTimeMs()),
  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   return true;
  94 }
  95
  96 void CLibCEC::Close(void)
  97 {
  98   if (m_cec)
  99     m_cec->StopThread();
 100   if (m_comm)
 101     m_comm->Close();
 102 }
 103
 104 int8_t CLibCEC::FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath /* = NULL */)
 105 {
 106   CStdString strDebug;
 107   if (strDevicePath)
 108     strDebug.Format("trying to autodetect the com port for device path '%s'", strDevicePath);
 109   else
 110     strDebug.Format("trying to autodetect all CEC adapters");
 111   AddLog(CEC_LOG_DEBUG, strDebug);
 112
 113   return CAdapterDetection::FindAdapters(deviceList, iBufSize, strDevicePath);
 114 }
 115
 116 bool CLibCEC::PingAdapter(void)
 117 {
 118   return m_comm ? m_comm->PingAdapter() : false;
 119 }
 120
 121 bool CLibCEC::StartBootloader(void)
 122 {
 123   return m_comm ? m_comm->StartBootloader() : false;
 124 }
 125
 126 int8_t CLibCEC::GetMinVersion(void)
 127 {
 128   return CEC_MIN_VERSION;
 129 }
 130
 131 int8_t CLibCEC::GetLibVersion(void)
 132 {
 133   return CEC_LIB_VERSION;
 134 }
 135
 136 bool CLibCEC::GetNextLogMessage(cec_log_message *message)
 137 {
 138   return (m_logBuffer.Pop(*message));
 139 }
 140
 141 bool CLibCEC::GetNextKeypress(cec_keypress *key)
 142 {
 143   return m_keyBuffer.Pop(*key);
 144 }
 145
 146 bool CLibCEC::GetNextCommand(cec_command *command)
 147 {
 148   return m_commandBuffer.Pop(*command);
 149 }
 150
 151 bool CLibCEC::Transmit(const cec_frame &data, bool bWaitForAck /* = true */)
 152 {
 153   return m_cec ? m_cec->Transmit(data, bWaitForAck) : false;
 154 }
 155
 156 bool CLibCEC::SetLogicalAddress(cec_logical_address iLogicalAddress)
 157 {
 158   return m_cec ? m_cec->SetLogicalAddress(iLogicalAddress) : false;
 159 }
 160
 161 bool CLibCEC::PowerOnDevices(cec_logical_address address /* = CECDEVICE_TV */)
 162 {
 163   return m_cec ? m_cec->PowerOnDevices(address) : false;
 164 }
 165
 166 bool CLibCEC::StandbyDevices(cec_logical_address address /* = CECDEVICE_BROADCAST */)
 167 {
 168   return m_cec ? m_cec->StandbyDevices(address) : false;
 169 }
 170
 171 bool CLibCEC::SetActiveView(void)
 172 {
 173   return m_cec ? m_cec->SetActiveView() : false;
 174 }
 175
 176 bool CLibCEC::SetInactiveView(void)
 177 {
 178   return m_cec ? m_cec->SetInactiveView() : false;
 179 }
 180
 181 void CLibCEC::AddLog(cec_log_level level, const string &strMessage)
 182 {
 183   if (m_cec)
 184   {
 185     cec_log_message message;
 186     message.level = level;
 187     message.time = GetTimeMs() - m_iStartTime;
 188     snprintf(message.message, sizeof(message.message), "%s", strMessage.c_str());
 189     m_logBuffer.Push(message);
 190   }
 191 }
 192
 193 void CLibCEC::AddKey(void)
 194 {
 195   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN)
 196   {
 197     cec_keypress key;
 198
 199     key.duration = (unsigned int) (GetTimeMs() - m_buttontime);
 200     key.keycode = m_iCurrentButton;
 201     m_keyBuffer.Push(key);
 202     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 203     m_buttontime = 0;
 204   }
 205 }
 206
 207 void CLibCEC::AddCommand(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_frame *parameters)
 208 {
 209   cec_command command;
 210   command.clear();
 211
 212   command.source       = source;
 213   command.destination  = destination;
 214   command.opcode       = opcode;
 215   if (parameters)
 216     command.parameters = parameters->packet;
 217   if (m_commandBuffer.Push(command))
 218   {
 219     CStdString strDebug;
 220     strDebug.Format("stored command '%2x' in the command buffer. buffer size = %d", opcode, m_commandBuffer.Size());
 221     AddLog(CEC_LOG_DEBUG, strDebug);
 222   }
 223   else
 224   {
 225     AddLog(CEC_LOG_WARNING, "command buffer is full");
 226   }
 227 }
 228
 229 void CLibCEC::CheckKeypressTimeout(void)
 230 {
 231   if (m_iCurrentButton != CEC_USER_CONTROL_CODE_UNKNOWN && GetTimeMs() - m_buttontime > CEC_BUTTON_TIMEOUT)
 232   {
 233     AddKey();
 234     m_iCurrentButton = CEC_USER_CONTROL_CODE_UNKNOWN;
 235   }
 236 }
 237
 238 void CLibCEC::SetCurrentButton(cec_user_control_code iButtonCode)
 239 {
 240   m_iCurrentButton = iButtonCode;
 241   m_buttontime = GetTimeMs();
 242 }
 243
 244 void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress /*= CEC::CECDEVICE_PLAYBACKDEVICE1 */, uint16_t iPhysicalAddress /* = CEC_DEFAULT_PHYSICAL_ADDRESS */)
 245 {
 246   return static_cast< void* > (new CLibCEC(strDeviceName, iLogicalAddress, iPhysicalAddress));
 247 }
 248
 249 void CECDestroy(CEC::ICECAdapter *instance)
 250 {
 251   CLibCEC *lib = static_cast< CLibCEC* > (instance);
 252   if (lib)
 253     delete lib;
 254 }