[deb_libcec.git] / src / lib / LibCEC.h

#pragma once
/*
 * This file is part of the libCEC(R) library.
 *
 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
 * libCEC(R) is an original work, containing original code.
 *
 * libCEC(R) is a trademark of Pulse-Eight Limited.
 *
 * This program is dual-licensed; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 * Alternatively, you can license this library under a commercial license,
 * please contact Pulse-Eight Licensing for more information.
 *
 * For more information contact:
 * Pulse-Eight Licensing       <license@pulse-eight.com>
 *     http://www.pulse-eight.com/
 *     http://www.pulse-eight.net/
 */

#include <string>
#include "../../include/cec.h"
#include "platform/util/buffer.h"

namespace CEC
{
  class CAdapterCommunication;
  class CCECProcessor;

  class CLibCEC : public ICECAdapter
  {
    public:
    /*!
     * ICECAdapter implementation
     */
    //@{
      CLibCEC(const char *strDeviceName, cec_device_type_list types, uint16_t iPhysicalAddress = 0);
      CLibCEC(libcec_configuration *configuration);
      virtual ~CLibCEC(void);

      virtual bool Open(const char *strPort, uint32_t iTimeout = 10000);
      virtual void Close(void);
      virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
      virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
      virtual bool PingAdapter(void);
      virtual bool StartBootloader(void);

      virtual int8_t GetMinLibVersion(void) const   { return CEC_MIN_LIB_VERSION; };
      virtual int8_t GetLibVersionMajor(void) const { return CEC_LIB_VERSION_MAJOR; };
      virtual int8_t GetLibVersionMinor(void) const { return CEC_LIB_VERSION_MINOR; };

      virtual bool GetNextLogMessage(cec_log_message *message);
      virtual bool GetNextKeypress(cec_keypress *key);
      virtual bool GetNextCommand(cec_command *command);

      virtual bool Transmit(const cec_command &data);
      virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
      virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);

      virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
      virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
      virtual bool SetActiveView(void);
      virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
      virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
      virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
      virtual bool SetInactiveView(void);
      virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
      virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
      virtual bool SwitchMonitoring(bool bEnable);
      virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
      virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
      virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
      virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
      virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
      virtual bool PollDevice(cec_logical_address iAddress);
      virtual cec_logical_addresses GetActiveDevices(void);
      virtual bool IsActiveDevice(cec_logical_address iAddress);
      virtual bool IsActiveDeviceType(cec_device_type type);
      virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
      virtual uint8_t VolumeUp(bool bSendRelease = true);
      virtual uint8_t VolumeDown(bool bSendRelease = true);
      virtual uint8_t MuteAudio(bool bSendRelease = true);
      virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
      virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = true);
      virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
      virtual bool EnablePhysicalAddressDetection(void);
      virtual cec_logical_address GetActiveSource(void);
      virtual bool IsActiveSource(cec_logical_address iAddress);
      virtual bool SetStreamPath(cec_logical_address iAddress);
      virtual bool SetStreamPath(uint16_t iPhysicalAddress);
      virtual cec_logical_addresses GetLogicalAddresses(void);
      virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
      virtual bool SetConfiguration(const libcec_configuration *configuration);
      virtual bool CanPersistConfiguration(void);
      virtual bool PersistConfiguration(libcec_configuration *configuration);
      virtual void RescanActiveDevices(void);
      virtual bool IsLibCECActiveSource(void);

      const char *ToString(const cec_menu_state state);
      const char *ToString(const cec_version version);
      const char *ToString(const cec_power_status status);
      const char *ToString(const cec_logical_address address);
      const char *ToString(const cec_deck_control_mode mode);
      const char *ToString(const cec_deck_info status);
      const char *ToString(const cec_opcode opcode);
      const char *ToString(const cec_system_audio_status mode);
      const char *ToString(const cec_audio_status status);
      const char *ToString(const cec_vendor_id vendor);
      const char *ToString(const cec_client_version version);
      const char *ToString(const cec_server_version version);

      static cec_device_type GetType(cec_logical_address address);
    //@}

      static void AddLog(const cec_log_level level, const char *strFormat, ...);
      static void AddKey(void);
      static void AddKey(const cec_keypress &key);
      static void AddCommand(const cec_command &command);
      static void ConfigurationChanged(const libcec_configuration &config);
      static void SetCurrentButton(cec_user_control_code iButtonCode);
      virtual void CheckKeypressTimeout(void);

      static CLibCEC *GetInstance(void);
      static void SetInstance(CLibCEC *instance);

      CCECProcessor *                         m_cec;
    protected:
      int64_t                                 m_iStartTime;
      cec_user_control_code                   m_iCurrentButton;
      int64_t                                 m_buttontime;
      PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer;
      PLATFORM::SyncedBuffer<cec_keypress>    m_keyBuffer;
      PLATFORM::SyncedBuffer<cec_command>     m_commandBuffer;
      ICECCallbacks *                         m_callbacks;
      void *                                  m_cbParam;
      PLATFORM::CMutex                        m_mutex;
  };
};
Commit	Line	Data
	1	#pragma once
	2	/*
	3	* This file is part of the libCEC(R) library.
	4	*
	5	* libCEC(R) is Copyright (C) 2011-2012 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 <string>
	35	#include "../../include/cec.h"
	36	#include "platform/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_device_type_list types, uint16_t iPhysicalAddress = 0);
	51	CLibCEC(libcec_configuration *configuration);
	52	virtual ~CLibCEC(void);
	53
	54	virtual bool Open(const char *strPort, uint32_t iTimeout = 10000);
	55	virtual void Close(void);
	56	virtual bool EnableCallbacks(void cbParam, ICECCallbacks callbacks);
	57	virtual int8_t FindAdapters(cec_adapter deviceList, uint8_t iBufSize, const char strDevicePath = NULL);
	58	virtual bool PingAdapter(void);
	59	virtual bool StartBootloader(void);
	60
	61	virtual int8_t GetMinLibVersion(void) const { return CEC_MIN_LIB_VERSION; };
	62	virtual int8_t GetLibVersionMajor(void) const { return CEC_LIB_VERSION_MAJOR; };
	63	virtual int8_t GetLibVersionMinor(void) const { return CEC_LIB_VERSION_MINOR; };
	64
	65	virtual bool GetNextLogMessage(cec_log_message *message);
	66	virtual bool GetNextKeypress(cec_keypress *key);
	67	virtual bool GetNextCommand(cec_command *command);
	68
	69	virtual bool Transmit(const cec_command &data);
	70	virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
	71	virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
	72
	73	virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
	74	virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
	75	virtual bool SetActiveView(void);
	76	virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
	77	virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
	78	virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
	79	virtual bool SetInactiveView(void);
	80	virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
	81	virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
	82	virtual bool SwitchMonitoring(bool bEnable);
	83	virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
	84	virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
	85	virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
	86	virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
	87	virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
	88	virtual bool PollDevice(cec_logical_address iAddress);
	89	virtual cec_logical_addresses GetActiveDevices(void);
	90	virtual bool IsActiveDevice(cec_logical_address iAddress);
	91	virtual bool IsActiveDeviceType(cec_device_type type);
	92	virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
	93	virtual uint8_t VolumeUp(bool bSendRelease = true);
	94	virtual uint8_t VolumeDown(bool bSendRelease = true);
	95	virtual uint8_t MuteAudio(bool bSendRelease = true);
	96	virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
	97	virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = true);
	98	virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
	99	virtual bool EnablePhysicalAddressDetection(void);
	100	virtual cec_logical_address GetActiveSource(void);
	101	virtual bool IsActiveSource(cec_logical_address iAddress);
	102	virtual bool SetStreamPath(cec_logical_address iAddress);
	103	virtual bool SetStreamPath(uint16_t iPhysicalAddress);
	104	virtual cec_logical_addresses GetLogicalAddresses(void);
	105	virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
	106	virtual bool SetConfiguration(const libcec_configuration *configuration);
	107	virtual bool CanPersistConfiguration(void);
	108	virtual bool PersistConfiguration(libcec_configuration *configuration);
	109	virtual void RescanActiveDevices(void);
	110	virtual bool IsLibCECActiveSource(void);
	111
	112	const char *ToString(const cec_menu_state state);
	113	const char *ToString(const cec_version version);
	114	const char *ToString(const cec_power_status status);
	115	const char *ToString(const cec_logical_address address);
	116	const char *ToString(const cec_deck_control_mode mode);
	117	const char *ToString(const cec_deck_info status);
	118	const char *ToString(const cec_opcode opcode);
	119	const char *ToString(const cec_system_audio_status mode);
	120	const char *ToString(const cec_audio_status status);
	121	const char *ToString(const cec_vendor_id vendor);
	122	const char *ToString(const cec_client_version version);
	123	const char *ToString(const cec_server_version version);
	124
	125	static cec_device_type GetType(cec_logical_address address);
	126	//@}
	127
	128	static void AddLog(const cec_log_level level, const char *strFormat, ...);
	129	static void AddKey(void);
	130	static void AddKey(const cec_keypress &key);
	131	static void AddCommand(const cec_command &command);
	132	static void ConfigurationChanged(const libcec_configuration &config);
	133	static void SetCurrentButton(cec_user_control_code iButtonCode);
	134	virtual void CheckKeypressTimeout(void);
	135
	136	static CLibCEC *GetInstance(void);
	137	static void SetInstance(CLibCEC *instance);
	138
	139	CCECProcessor * m_cec;
	140	protected:
	141	int64_t m_iStartTime;
	142	cec_user_control_code m_iCurrentButton;
	143	int64_t m_buttontime;
	144	PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer;
	145	PLATFORM::SyncedBuffer<cec_keypress> m_keyBuffer;
	146	PLATFORM::SyncedBuffer<cec_command> m_commandBuffer;
	147	ICECCallbacks * m_callbacks;
	148	void * m_cbParam;
	149	PLATFORM::CMutex m_mutex;
	150	};
	151	};