src/lib/implementations/VLCommandHandler.cpp

   1 /*
   2  * This file is part of the libCEC(R) library.
   3  *
   4  * libCEC(R) is Copyright (C) 2011-2013 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 "env.h"
  34 #include "VLCommandHandler.h"
  35
  36 #include "lib/devices/CECBusDevice.h"
  37 #include "lib/devices/CECPlaybackDevice.h"
  38 #include "lib/devices/CECTV.h"
  39 #include "lib/CECProcessor.h"
  40 #include "lib/LibCEC.h"
  41 #include "lib/CECClient.h"
  42
  43 #define VL_POWER_CHANGE 0x20
  44 #define VL_POWERED_UP   0x00
  45 #define VL_POWERED_DOWN 0x01
  46 #define VL_UNKNOWN1     0x06
  47
  48 using namespace CEC;
  49 using namespace PLATFORM;
  50
  51 #define LIB_CEC     m_busDevice->GetProcessor()->GetLib()
  52 #define ToString(p) LIB_CEC->ToString(p)
  53
  54 // wait this amount of ms before trying to switch sources after receiving the message from the TV that it's powered on
  55 #define SOURCE_SWITCH_DELAY_MS 3000
  56
  57 CVLCommandHandler::CVLCommandHandler(CCECBusDevice *busDevice,
  58                                      int32_t iTransmitTimeout /* = CEC_DEFAULT_TRANSMIT_TIMEOUT */,
  59                                      int32_t iTransmitWait /* = CEC_DEFAULT_TRANSMIT_WAIT */,
  60                                      int8_t iTransmitRetries /* = CEC_DEFAULT_TRANSMIT_RETRIES */,
  61                                      int64_t iActiveSourcePending /* = 0 */) :
  62     CCECCommandHandler(busDevice, iTransmitTimeout, iTransmitWait, iTransmitRetries, iActiveSourcePending),
  63     m_iPowerUpEventReceived(0),
  64     m_bCapabilitiesSent(false)
  65 {
  66   m_vendorId = CEC_VENDOR_PANASONIC;
  67 }
  68
  69 bool CVLCommandHandler::InitHandler(void)
  70 {
  71   CCECBusDevice *primary = m_processor->GetPrimaryDevice();
  72   if (primary && primary->GetLogicalAddress() != CECDEVICE_UNREGISTERED)
  73   {
  74     /* use the VL commandhandler for the primary device that is handled by libCEC */
  75     if (m_busDevice->GetLogicalAddress() == CECDEVICE_TV)
  76     {
  77       if (primary && m_busDevice->GetLogicalAddress() != primary->GetLogicalAddress())
  78       {
  79         libcec_configuration config;
  80         m_processor->GetPrimaryClient()->GetCurrentConfiguration(config);
  81         if (config.iDoubleTapTimeoutMs == 0)
  82         {
  83           config.iDoubleTapTimeoutMs = CEC_DOUBLE_TAP_TIMEOUT_MS;
  84           m_processor->GetPrimaryClient()->SetConfiguration(config);
  85         }
  86
  87         primary->SetVendorId(CEC_VENDOR_PANASONIC);
  88         primary->ReplaceHandler(false);
  89       }
  90
  91       if (primary->GetType() == CEC_DEVICE_TYPE_RECORDING_DEVICE)
  92         return m_processor->GetPrimaryClient()->ChangeDeviceType(CEC_DEVICE_TYPE_RECORDING_DEVICE, CEC_DEVICE_TYPE_PLAYBACK_DEVICE);
  93     }
  94   }
  95
  96   return CCECCommandHandler::InitHandler();
  97 }
  98
  99 int CVLCommandHandler::HandleDeviceVendorCommandWithId(const cec_command &command)
 100 {
 101   if (!m_processor->IsHandledByLibCEC(command.destination))
 102     return CEC_ABORT_REASON_INVALID_OPERAND;
 103
 104   if (command.parameters[0] != 0x00 ||
 105       command.parameters[1] != 0x80 ||
 106       command.parameters[2] != 0x45)
 107     return CEC_ABORT_REASON_INVALID_OPERAND;
 108
 109   if (command.initiator == CECDEVICE_TV &&
 110       command.parameters.At(3) == VL_UNKNOWN1)
 111   {
 112     // XXX this is also sent when the TV is powered off
 113     // TODO power up sends 06:05. check whether this is also sent on power off
 114 #if 0
 115     // set the power up event time
 116     {
 117       CLockObject lock(m_mutex);
 118       if (m_iPowerUpEventReceived == 0)
 119         m_iPowerUpEventReceived = GetTimeMs();
 120     }
 121     // mark the TV as powered on
 122     m_processor->GetTV()->SetPowerStatus(CEC_POWER_STATUS_ON);
 123 #endif
 124     return COMMAND_HANDLED;
 125   }
 126   else if (command.initiator == CECDEVICE_TV &&
 127       command.destination == CECDEVICE_BROADCAST &&
 128       command.parameters.At(3) == VL_POWER_CHANGE)
 129   {
 130     if (command.parameters.At(4) == VL_POWERED_UP)
 131     {
 132       // set the power up event time
 133       {
 134         CLockObject lock(m_mutex);
 135         if (m_iPowerUpEventReceived == 0)
 136           m_iPowerUpEventReceived = GetTimeMs();
 137       }
 138       // mark the TV as powered on
 139       m_processor->GetTV()->SetPowerStatus(CEC_POWER_STATUS_ON);
 140
 141       // send capabilties
 142       SendVendorCommandCapabilities(m_processor->GetLogicalAddress(), command.initiator);
 143
 144       // reactivate the source, so the tv switches channels
 145       if (m_processor->IsActiveSource(m_processor->GetLogicalAddress()))
 146         m_processor->GetDevice(m_processor->GetLogicalAddress())->TransmitActiveSource(false);
 147     }
 148     else if (command.parameters.At(4) == VL_POWERED_DOWN)
 149     {
 150       // reset the power up event time
 151       {
 152         CLockObject lock(m_mutex);
 153         m_iPowerUpEventReceived = 0;
 154       }
 155       // mark the TV as powered off
 156       m_processor->GetTV()->SetPowerStatus(CEC_POWER_STATUS_STANDBY);
 157     }
 158     else
 159       LIB_CEC->AddLog(CEC_LOG_DEBUG, "skipping unknown vendor command");
 160
 161     return COMMAND_HANDLED;
 162   }
 163
 164   return CCECCommandHandler::HandleDeviceVendorCommandWithId(command);
 165 }
 166
 167 bool CVLCommandHandler::PowerUpEventReceived(void)
 168 {
 169   bool bPowerUpEventReceived(true);
 170
 171   if (m_busDevice->GetLogicalAddress() != CECDEVICE_TV)
 172   {
 173     CCECBusDevice* tv = m_processor->GetTV();
 174     if (tv && tv->GetStatus() != CEC_DEVICE_STATUS_PRESENT)
 175       return true;
 176
 177     // get the status from the TV
 178     if (tv && tv->GetCurrentVendorId() == CEC_VENDOR_PANASONIC)
 179     {
 180       CVLCommandHandler *handler = static_cast<CVLCommandHandler *>(tv->GetHandler());
 181       bPowerUpEventReceived = handler ? handler->PowerUpEventReceived() : false;
 182       tv->MarkHandlerReady();
 183     }
 184   }
 185   else
 186   {
 187     // get the current status
 188     {
 189       CLockObject lock(m_mutex);
 190       bPowerUpEventReceived = m_iPowerUpEventReceived > 0 &&
 191                               GetTimeMs() - m_iPowerUpEventReceived > SOURCE_SWITCH_DELAY_MS;
 192     }
 193
 194     // if we didn't receive the event, check if the TV is already marked as powered on
 195     if (!bPowerUpEventReceived && m_busDevice->GetCurrentPowerStatus() == CEC_POWER_STATUS_ON)
 196     {
 197       CLockObject lock(m_mutex);
 198       m_iPowerUpEventReceived = GetTimeMs();
 199       bPowerUpEventReceived = true;
 200     }
 201   }
 202
 203   return bPowerUpEventReceived;
 204 }
 205
 206 int CVLCommandHandler::HandleStandby(const cec_command &command)
 207 {
 208   // reset the power up event time
 209   {
 210     CLockObject lock(m_mutex);
 211     m_iPowerUpEventReceived = 0;
 212     m_bCapabilitiesSent = false;
 213   }
 214
 215   return CCECCommandHandler::HandleStandby(command);
 216 }
 217
 218 void CVLCommandHandler::VendorPreActivateSourceHook(void)
 219 {
 220   bool bTransmit(false);
 221   {
 222     CLockObject lock(m_mutex);
 223     bTransmit = !m_bCapabilitiesSent;
 224   }
 225   if (bTransmit)
 226     SendVendorCommandCapabilities(m_processor->GetLogicalAddress(), CECDEVICE_TV);
 227 }
 228
 229 void CVLCommandHandler::SendVendorCommandCapabilities(const cec_logical_address initiator, const cec_logical_address destination)
 230 {
 231   if (PowerUpEventReceived())
 232   {
 233     cec_command response;
 234     cec_command::Format(response, initiator, destination, CEC_OPCODE_VENDOR_COMMAND);
 235     uint8_t iResponseData[] = {0x10, 0x02, 0xFF, 0xFF, 0x00, 0x05, 0x05, 0x45, 0x55, 0x5c, 0x58, 0x32};
 236     response.PushArray(12, iResponseData);
 237
 238     if (Transmit(response, false, true))
 239     {
 240       CLockObject lock(m_mutex);
 241       m_bCapabilitiesSent = true;
 242     }
 243   }
 244 }
 245
 246 int CVLCommandHandler::HandleVendorCommand(const cec_command &command)
 247 {
 248   // some vendor command voodoo that will enable more buttons on the remote
 249   if (command.parameters.size == 3 &&
 250       command.parameters[0] == 0x10 &&
 251       command.parameters[1] == 0x01 &&
 252       command.parameters[2] == 0x05 &&
 253       m_processor->IsHandledByLibCEC(command.destination))
 254   {
 255     SendVendorCommandCapabilities(m_processor->GetLogicalAddress(), command.initiator);
 256     return COMMAND_HANDLED;
 257   }
 258
 259   return CEC_ABORT_REASON_INVALID_OPERAND;
 260 }
 261
 262 bool CVLCommandHandler::SourceSwitchAllowed(void)
 263 {
 264   if (!PowerUpEventReceived())
 265     TransmitRequestPowerStatus(m_processor->GetPrimaryDevice()->GetLogicalAddress(), CECDEVICE_TV, false);
 266
 267   return PowerUpEventReceived();
 268 }
 269
 270 int CVLCommandHandler::HandleSystemAudioModeRequest(const cec_command &command)
 271 {
 272   if (command.initiator == CECDEVICE_TV)
 273   {
 274     // set the power up event time
 275     {
 276       CLockObject lock(m_mutex);
 277       if (m_iPowerUpEventReceived == 0)
 278         m_iPowerUpEventReceived = GetTimeMs();
 279     }
 280     // mark the TV as powered on
 281     m_processor->GetTV()->SetPowerStatus(CEC_POWER_STATUS_ON);
 282   }
 283
 284   return CCECCommandHandler::HandleSystemAudioModeRequest(command);
 285 }
 286
 287 int CVLCommandHandler::HandleReportPowerStatus(const cec_command &command)
 288 {
 289   if (command.initiator == m_busDevice->GetLogicalAddress() &&
 290       command.parameters.size == 1 &&
 291       (cec_power_status)command.parameters[0] == CEC_POWER_STATUS_ON)
 292   {
 293     CLockObject lock(m_mutex);
 294     if (m_iPowerUpEventReceived == 0)
 295       m_iPowerUpEventReceived = GetTimeMs();
 296   }
 297
 298   return CCECCommandHandler::HandleReportPowerStatus(command);
 299 }