[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 CCECClient;

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

    /*!
     * ICECAdapter implementation
     */
    //@{
      bool Open(const char *strPort, uint32_t iTimeout = CEC_DEFAULT_CONNECT_TIMEOUT);
      void Close(void);
      bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
      int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
      bool PingAdapter(void);
      bool StartBootloader(void);

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

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

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

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

      static cec_device_type GetType(cec_logical_address address);
      static uint16_t GetMaskForType(cec_logical_address address);
      static uint16_t GetMaskForType(cec_device_type type);

      bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
    //@}

      void AddLog(const cec_log_level level, const char *strFormat, ...);
      static void AddKey(void) {}                                           //UNUSED
      static void AddKey(const cec_keypress &key);                          //UNUSED
      static void AddCommand(const cec_command &command);                   //UNUSED
      static void ConfigurationChanged(const libcec_configuration &config); //UNUSED
      static void SetCurrentButton(cec_user_control_code iButtonCode);      //UNUSED
      void CheckKeypressTimeout(void);
      void Alert(const libcec_alert type, const libcec_parameter &param);
      static CLibCEC *GetInstance(void);                                    //UNUSED
      static void SetInstance(CLibCEC *instance);                           //UNUSED

      static bool IsValidPhysicalAddress(uint16_t iPhysicalAddress);
      CCECClient *RegisterClient(libcec_configuration &configuration);
      void UnregisterClients(void);
      std::vector<CCECClient *> GetClients(void) { return m_clients; };

      CCECProcessor *           m_cec;

    protected:
      int64_t                                 m_iStartTime;
      cec_user_control_code                   m_iCurrentButton;             //UNUSED
      int64_t                                 m_buttontime;                 //UNUSED
      PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer;                  //UNUSED
      PLATFORM::SyncedBuffer<cec_keypress>    m_keyBuffer;                  //UNUSED
      PLATFORM::SyncedBuffer<cec_command>     m_commandBuffer;              //UNUSED
      ICECCallbacks *                         m_callbacks;                  //UNUSED
      void *                                  m_cbParam;                    //UNUSED
      PLATFORM::CMutex                        m_mutex;
      PLATFORM::CMutex                        m_logMutex;                   //UNUSED

      CCECClient *              m_client;
      std::vector<CCECClient *> m_clients;
  };
};
Commit	Line	Data
abbca718 LOK	1	#pragma once
	2	/*
	3	* This file is part of the libCEC(R) library.
	4	*
b492c10e	5	* libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
abbca718 LOK	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
25701fa6	34	#include <string>
4c9b9776	35	#include "../../include/cec.h"
ba65909d	36	#include "platform/util/buffer.h"
abbca718	37
abbca718 LOK	38	namespace CEC
abbca718 LOK	39	{
828682d3	40	class CAdapterCommunication;
2abe74eb	41	class CCECProcessor;
004b8382	42	class CCECClient;
a8f0bd18	43
2abe74eb	44	class CLibCEC : public ICECAdapter
abbca718 LOK	45	{
abbca718 LOK	46	public:
c30acafa LOK	47	CLibCEC(const char *strDeviceName, cec_device_type_list types, uint16_t iPhysicalAddress = 0);
c30acafa LOK	48	CLibCEC(libcec_configuration *configuration);
004b8382 LOK	49	virtual ~CLibCEC(void);
004b8382 LOK	50
abbca718	51	/*!
2abe74eb	52	* ICECAdapter implementation
abbca718 LOK	53	*/
abbca718 LOK	54	//@{
b32ffd87	55	bool Open(const char *strPort, uint32_t iTimeout = CEC_DEFAULT_CONNECT_TIMEOUT);
e186a843 LOK	56	void Close(void);
	57	bool EnableCallbacks(void cbParam, ICECCallbacks callbacks);
	58	int8_t FindAdapters(cec_adapter deviceList, uint8_t iBufSize, const char strDevicePath = NULL);
	59	bool PingAdapter(void);
	60	bool StartBootloader(void);
2abe74eb	61
e186a843 LOK	62	int8_t GetMinLibVersion(void) const { return CEC_MIN_LIB_VERSION; };
	63	int8_t GetLibVersionMajor(void) const { return CEC_LIB_VERSION_MAJOR; };
	64	int8_t GetLibVersionMinor(void) const { return CEC_LIB_VERSION_MINOR; };
2abe74eb	65
e186a843 LOK	66	bool GetNextLogMessage(cec_log_message *message);
	67	bool GetNextKeypress(cec_keypress *key);
	68	bool GetNextCommand(cec_command *command);
2abe74eb	69
e186a843 LOK	70	bool Transmit(const cec_command &data);
	71	bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
	72	bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
abbca718	73
e186a843 LOK	74	bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
	75	bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
	76	bool SetActiveView(void);
	77	bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
	78	bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
	79	bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
	80	bool SetInactiveView(void);
	81	bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
	82	bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
	83	bool SwitchMonitoring(bool bEnable);
	84	cec_version GetDeviceCecVersion(cec_logical_address iAddress);
	85	bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
	86	uint64_t GetDeviceVendorId(cec_logical_address iAddress);
	87	uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
	88	cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
	89	bool PollDevice(cec_logical_address iAddress);
	90	cec_logical_addresses GetActiveDevices(void);
	91	bool IsActiveDevice(cec_logical_address iAddress);
	92	bool IsActiveDeviceType(cec_device_type type);
	93	bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
	94	uint8_t VolumeUp(bool bSendRelease = true);
	95	uint8_t VolumeDown(bool bSendRelease = true);
	96	uint8_t MuteAudio(bool bSendRelease = true);
	97	bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
	98	bool SendKeyRelease(cec_logical_address iDestination, bool bWait = true);
c30acafa	99	cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
e186a843 LOK	100	bool EnablePhysicalAddressDetection(void);
	101	cec_logical_address GetActiveSource(void);
	102	bool IsActiveSource(cec_logical_address iAddress);
	103	bool SetStreamPath(cec_logical_address iAddress);
	104	bool SetStreamPath(uint16_t iPhysicalAddress);
	105	cec_logical_addresses GetLogicalAddresses(void);
	106	bool GetCurrentConfiguration(libcec_configuration *configuration);
	107	bool SetConfiguration(const libcec_configuration *configuration);
	108	bool CanPersistConfiguration(void);
	109	bool PersistConfiguration(libcec_configuration *configuration);
	110	void RescanActiveDevices(void);
	111	bool IsLibCECActiveSource(void);
03ae897d LOK	112
	113	const char *ToString(const cec_menu_state state);
	114	const char *ToString(const cec_version version);
	115	const char *ToString(const cec_power_status status);
	116	const char *ToString(const cec_logical_address address);
	117	const char *ToString(const cec_deck_control_mode mode);
	118	const char *ToString(const cec_deck_info status);
	119	const char *ToString(const cec_opcode opcode);
	120	const char *ToString(const cec_system_audio_status mode);
	121	const char *ToString(const cec_audio_status status);
	122	const char *ToString(const cec_vendor_id vendor);
caca2d81	123	const char *ToString(const cec_client_version version);
3efda01a	124	const char *ToString(const cec_server_version version);
a75e3a5a	125	const char *ToString(const cec_device_type type);
9878069e LOK	126
9878069e LOK	127	static cec_device_type GetType(cec_logical_address address);
209b7a5c LOK	128	static uint16_t GetMaskForType(cec_logical_address address);
209b7a5c LOK	129	static uint16_t GetMaskForType(cec_device_type type);
f80cd208	130
b32ffd87	131	bool GetDeviceInformation(const char strPort, libcec_configuration config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
2abe74eb	132	//@}
abbca718	133
c30acafa LOK	134	void AddLog(const cec_log_level level, const char *strFormat, ...);
	135	static void AddKey(void) {} //UNUSED
	136	static void AddKey(const cec_keypress &key); //UNUSED
	137	static void AddCommand(const cec_command &command); //UNUSED
	138	static void ConfigurationChanged(const libcec_configuration &config); //UNUSED
	139	static void SetCurrentButton(cec_user_control_code iButtonCode); //UNUSED
e186a843	140	void CheckKeypressTimeout(void);
004b8382	141	void Alert(const libcec_alert type, const libcec_parameter &param);
c30acafa LOK	142	static CLibCEC *GetInstance(void); //UNUSED
c30acafa LOK	143	static void SetInstance(CLibCEC *instance); //UNUSED
abbca718	144
c30acafa	145	static bool IsValidPhysicalAddress(uint16_t iPhysicalAddress);
c0152c09	146	CCECClient *RegisterClient(libcec_configuration &configuration);
004b8382	147	void UnregisterClients(void);
c0152c09	148	std::vector<CCECClient *> GetClients(void) { return m_clients; };
c30acafa	149
004b8382	150	CCECProcessor * m_cec;
004b8382	151
c30acafa LOK	152	protected:
	153	int64_t m_iStartTime;
	154	cec_user_control_code m_iCurrentButton; //UNUSED
	155	int64_t m_buttontime; //UNUSED
	156	PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer; //UNUSED
	157	PLATFORM::SyncedBuffer<cec_keypress> m_keyBuffer; //UNUSED
	158	PLATFORM::SyncedBuffer<cec_command> m_commandBuffer; //UNUSED
	159	ICECCallbacks * m_callbacks; //UNUSED
	160	void * m_cbParam; //UNUSED
	161	PLATFORM::CMutex m_mutex;
	162	PLATFORM::CMutex m_logMutex; //UNUSED
	163
	164	CCECClient * m_client;
004b8382	165	std::vector<CCECClient *> m_clients;
abbca718 LOK	166	};
abbca718 LOK	167	};