src/lib/implementations/CECCommandHandler.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited.  All rights reserved.
   6  * libCEC(R) is an original work, containing original code.
   7  *
   8  * libCEC(R) is a trademark of Pulse-Eight Limited.
   9  *
  10  * This program is dual-licensed; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  *
  25  * Alternatively, you can license this library under a commercial license,
  26  * please contact Pulse-Eight Licensing for more information.
  27  *
  28  * For more information contact:
  29  * Pulse-Eight Licensing       <license@pulse-eight.com>
  30  *     http://www.pulse-eight.com/
  31  *     http://www.pulse-eight.net/
  32  */
  33
  34 #include <vector>
  35 #include <string>
  36 #include "lib/platform/threads/mutex.h"
  37
  38 namespace CEC
  39 {
  40   #define COMMAND_HANDLED 0xFF
  41
  42   class CCECProcessor;
  43   class CCECBusDevice;
  44
  45   class CCECCommandHandler
  46   {
  47     friend class CCECBusDevice;
  48
  49   public:
  50     CCECCommandHandler(CCECBusDevice *busDevice,
  51                        int32_t iTransmitTimeout = CEC_DEFAULT_TRANSMIT_TIMEOUT,
  52                        int32_t iTransmitWait = CEC_DEFAULT_TRANSMIT_WAIT,
  53                        int8_t iTransmitRetries = CEC_DEFAULT_TRANSMIT_RETRIES,
  54                        int64_t iActiveSourcePending = 0);
  55     virtual ~CCECCommandHandler(void) {};
  56
  57     virtual bool HandleCommand(const cec_command &command);
  58     virtual cec_vendor_id GetVendorId(void) { return m_vendorId; };
  59     virtual void SetVendorId(cec_vendor_id vendorId) { m_vendorId = vendorId; }
  60     static bool HasSpecificHandler(cec_vendor_id vendorId) { return vendorId == CEC_VENDOR_LG || vendorId == CEC_VENDOR_SAMSUNG || vendorId == CEC_VENDOR_PANASONIC || vendorId == CEC_VENDOR_PHILIPS;}
  61
  62     virtual bool InitHandler(void) { return true; }
  63     virtual bool ActivateSource(bool bTransmitDelayedCommandsOnly = false);
  64     virtual uint8_t GetTransmitRetries(void) const { return m_iTransmitRetries; }
  65
  66     virtual bool PowerOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
  67     virtual bool TransmitImageViewOn(const cec_logical_address iInitiator, const cec_logical_address iDestination);
  68     virtual bool TransmitStandby(const cec_logical_address iInitiator, const cec_logical_address iDestination);
  69     virtual bool TransmitRequestActiveSource(const cec_logical_address iInitiator, bool bWaitForResponse = true);
  70     virtual bool TransmitRequestCecVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  71     virtual bool TransmitRequestMenuLanguage(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  72     virtual bool TransmitRequestOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  73     virtual bool TransmitRequestAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  74     virtual bool TransmitRequestPhysicalAddress(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  75     virtual bool TransmitRequestPowerStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  76     virtual bool TransmitRequestVendorId(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWaitForResponse = true);
  77     virtual bool TransmitActiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, bool bIsReply);
  78     virtual bool TransmitCECVersion(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_version cecVersion, bool bIsReply);
  79     virtual bool TransmitInactiveSource(const cec_logical_address iInitiator, uint16_t iPhysicalAddress);
  80     virtual bool TransmitMenuState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_menu_state menuState, bool bIsReply);
  81     virtual bool TransmitOSDName(const cec_logical_address iInitiator, const cec_logical_address iDestination, std::string strDeviceName, bool bIsReply);
  82     virtual bool TransmitOSDString(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_display_control duration, const char *strMessage, bool bIsReply);
  83     virtual bool TransmitPhysicalAddress(const cec_logical_address iInitiator, uint16_t iPhysicalAddress, cec_device_type type, bool bIsReply);
  84     virtual bool TransmitSetMenuLanguage(const cec_logical_address iInitiator, const char lang[4], bool bIsReply);
  85     virtual bool TransmitPoll(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bIsReply);
  86     virtual bool TransmitPowerState(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_power_status state, bool bIsReply);
  87     virtual bool TransmitVendorID(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint64_t iVendorId, bool bIsReply);
  88     virtual bool TransmitAudioStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, uint8_t state, bool bIsReply);
  89     virtual bool TransmitSetSystemAudioMode(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state, bool bIsReply);
  90     virtual bool TransmitSystemAudioModeStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_system_audio_status state, bool bIsReply);
  91     virtual bool TransmitDeckStatus(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_deck_info state, bool bIsReply);
  92     virtual bool TransmitKeypress(const cec_logical_address iInitiator, const cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
  93     virtual bool TransmitKeyRelease(const cec_logical_address iInitiator, const cec_logical_address iDestination, bool bWait = true);
  94     virtual bool TransmitSetStreamPath(uint16_t iStreamPath, bool bIsReply);
  95     virtual bool SendDeckStatusUpdateOnActiveSource(void) const { return m_bOPTSendDeckStatusUpdateOnActiveSource; };
  96
  97     virtual void ScheduleActivateSource(uint64_t iDelay);
  98
  99     virtual bool SupportsDeviceType(const cec_device_type UNUSED(type)) const { return true; };
 100     virtual cec_device_type GetReplacementDeviceType(const cec_device_type type) const { return type; }
 101     virtual bool ActiveSourcePending(void) const { return m_iActiveSourcePending != 0; }
 102
 103   protected:
 104     virtual int HandleActiveSource(const cec_command &command);
 105     virtual int HandleDeckControl(const cec_command &command);
 106     virtual int HandleDeviceCecVersion(const cec_command &command);
 107     virtual int HandleDeviceVendorCommandWithId(const cec_command &command);
 108     virtual int HandleDeviceVendorId(const cec_command &command);
 109     virtual int HandleFeatureAbort(const cec_command &command);
 110     virtual int HandleGetCecVersion(const cec_command &command);
 111     virtual int HandleGiveAudioStatus(const cec_command &command);
 112     virtual int HandleGiveDeckStatus(const cec_command &command);
 113     virtual int HandleGiveDevicePowerStatus(const cec_command &command);
 114     virtual int HandleGiveDeviceVendorId(const cec_command &command);
 115     virtual int HandleGiveOSDName(const cec_command &command);
 116     virtual int HandleGivePhysicalAddress(const cec_command &command);
 117     virtual int HandleGiveMenuLanguage(const cec_command &command);
 118     virtual int HandleGiveSystemAudioModeStatus(const cec_command &command);
 119     virtual int HandleImageViewOn(const cec_command &command);
 120     virtual int HandleMenuRequest(const cec_command &command);
 121     virtual bool HandlePoll(const cec_command &command);
 122     virtual int HandleReportAudioStatus(const cec_command &command);
 123     virtual int HandleReportPhysicalAddress(const cec_command &command);
 124     virtual int HandleReportPowerStatus(const cec_command &command);
 125     virtual int HandleRequestActiveSource(const cec_command &command);
 126     virtual int HandleRoutingChange(const cec_command &command);
 127     virtual int HandleRoutingInformation(const cec_command &command);
 128     virtual int HandleSetMenuLanguage(const cec_command &command);
 129     virtual int HandleSetOSDName(const cec_command &command);
 130     virtual int HandleSetStreamPath(const cec_command &command);
 131     virtual int HandleSystemAudioModeRequest(const cec_command &command);
 132     virtual int HandleStandby(const cec_command &command);
 133     virtual int HandleSystemAudioModeStatus(const cec_command &command);
 134     virtual int HandleSetSystemAudioMode(const cec_command &command);
 135     virtual int HandleTextViewOn(const cec_command &command);
 136     virtual int HandleUserControlPressed(const cec_command &command);
 137     virtual int HandleUserControlRelease(const cec_command &command);
 138     virtual int HandleVendorCommand(const cec_command &command);
 139     virtual int HandleVendorRemoteButtonDown(const cec_command& command);
 140     virtual int HandleVendorRemoteButtonUp(const cec_command & UNUSED(command)) { return COMMAND_HANDLED; }
 141     virtual void UnhandledCommand(const cec_command &command, const cec_abort_reason reason);
 142
 143     virtual void VendorPreActivateSourceHook(void) {};
 144
 145     virtual size_t GetMyDevices(std::vector<CCECBusDevice *> &devices) const;
 146     virtual CCECBusDevice *GetDevice(cec_logical_address iLogicalAddress) const;
 147     virtual CCECBusDevice *GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress) const;
 148
 149     virtual bool SetVendorId(const cec_command &command);
 150     virtual void SetPhysicalAddress(cec_logical_address iAddress, uint16_t iNewAddress);
 151
 152     virtual bool Transmit(cec_command &command, bool bSuppressWait, bool bIsReply);
 153
 154     virtual bool SourceSwitchAllowed(void) { return true; }
 155
 156     CCECBusDevice *  m_busDevice;
 157     CCECProcessor *  m_processor;
 158     int32_t          m_iTransmitTimeout;
 159     int32_t          m_iTransmitWait;
 160     int8_t           m_iTransmitRetries;
 161     bool            m_bHandlerInited;
 162     bool            m_bOPTSendDeckStatusUpdateOnActiveSource;
 163     cec_vendor_id    m_vendorId;
 164     int64_t          m_iActiveSourcePending;
 165     PLATFORM::CMutex m_mutex;
 166     int64_t          m_iPowerStatusRequested;
 167   };
 168 };