src/lib/LibCEC.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011 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 "../../include/CECExports.h"
  35 #include "../../include/CECTypes.h"
  36 #include "util/buffer.h"
  37
  38 namespace CEC
  39 {
  40   class CAdapterCommunication;
  41   class CCECProcessor;
  42
  43   class CLibCEC : public ICECAdapter
  44   {
  45     public:
  46     /*!
  47      * ICECAdapter implementation
  48      */
  49     //@{
  50       CLibCEC(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
  51       virtual ~CLibCEC(void);
  52
  53       virtual bool Open(const char *strPort, int iTimeout = 10000);
  54       virtual void Close(void);
  55       virtual int  FindAdapters(std::vector<cec_adapter> &deviceList, const char *strDevicePath = NULL);
  56       virtual bool PingAdapter(void);
  57       virtual bool StartBootloader(void);
  58
  59       virtual int  GetMinVersion(void);
  60       virtual int  GetLibVersion(void);
  61
  62       virtual bool GetNextLogMessage(cec_log_message *message);
  63       virtual bool GetNextKeypress(cec_keypress *key);
  64       virtual bool GetNextCommand(cec_command *command);
  65
  66       virtual bool Transmit(const cec_frame &data, bool bWaitForAck = true);
  67       virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
  68
  69       virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
  70       virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
  71       virtual bool SetActiveView(void);
  72       virtual bool SetInactiveView(void);
  73     //@}
  74
  75       virtual void AddLog(cec_log_level level, const std::string &strMessage);
  76       virtual void AddKey(void);
  77       virtual void AddCommand(cec_logical_address source, cec_logical_address destination, cec_opcode opcode, cec_frame *parameters);
  78       virtual void CheckKeypressTimeout(void);
  79       virtual void SetCurrentButton(cec_user_control_code iButtonCode);
  80
  81     protected:
  82       cec_user_control_code      m_iCurrentButton;
  83       int64_t                    m_buttontime;
  84       CCECProcessor             *m_cec;
  85       CAdapterCommunication     *m_comm;
  86       CecBuffer<cec_log_message> m_logBuffer;
  87       CecBuffer<cec_keypress>    m_keyBuffer;
  88       CecBuffer<cec_command>     m_commandBuffer;
  89   };
  90 };