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