[deb_libcec.git] / include / cec.h

#pragma once
/*
 * This file is part of the libCEC(R) library.
 *
 * libCEC(R) is Copyright (C) 2011 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/
 */

#ifndef CECEXPORTS_H_
#define CECEXPORTS_H_

#include <cectypes.h>

namespace CEC
{
  class ICECAdapter
  {
  public:
    virtual ~ICECAdapter() {};
    /*! @name Adapter methods */
    //@{
    /*!
     * @see cec_open
     */
    virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0;

    /*!
     * @see cec_close
     */
    virtual void Close(void) = 0;

    /*!
     * @see cec_find_adapters
     */
    virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0;

    /*!
     * @see cec_ping_adapters
     */
    virtual bool PingAdapter(void) = 0;

    /*!
     * @see cec_start_bootloader
     */
    virtual bool StartBootloader(void) = 0;
    //@}

    /*!
     * @see cec_get_min_version
     */
    virtual int8_t GetMinVersion(void) = 0;

    /*!
     * @see cec_get_lib_version
     */
    virtual int8_t GetLibVersion(void) = 0;

    /*!
     * @see cec_get_next_log_message
     */
    virtual bool GetNextLogMessage(cec_log_message *message) = 0;

    /*!
     * @see cec_get_next_keypress
     */
    virtual bool GetNextKeypress(cec_keypress *key) = 0;

    /*!
     * @see cec_get_next_command
     */
    virtual bool GetNextCommand(cec_command *command) = 0;

    /*!
     * @see cec_transmit
     */
    virtual bool Transmit(const cec_command &data, bool bWaitForAck = true) = 0;

    /*!
     * @see cec_set_logical_address
     */
    virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;

    /*!
     * @see cec_set_physical_address
     */
    virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;

    /*!
     * @see cec_power_on_devices
     */
    virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;

    /*!
     * @see cec_standby_devices
     */
    virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;

    /*!
     * @see cec_set_active_view
     */
    virtual bool SetActiveView(void) = 0;

    /*!
     * @see cec_set_inactive_view
     */
    virtual bool SetInactiveView(void) = 0;

    /*!
     * @see cec_set_osd_string
     */
    virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
  };
};

extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);

#endif /* CECEXPORTS_H_ */
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 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	#ifndef CECEXPORTS_H_
	35	#define CECEXPORTS_H_
	36
	37	#include <cectypes.h>
	38
	39	namespace CEC
	40	{
	41	class ICECAdapter
	42	{
	43	public:
	44	virtual ~ICECAdapter() {};
	45	/! @name Adapter methods /
	46	//@{
	47	/*!
	48	* @see cec_open
	49	*/
	50	virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0;
	51
	52	/*!
	53	* @see cec_close
	54	*/
	55	virtual void Close(void) = 0;
	56
	57	/*!
	58	* @see cec_find_adapters
	59	*/
	60	virtual int8_t FindAdapters(cec_adapter deviceList, uint8_t iBufSize, const char strDevicePath = NULL) = 0;
	61
	62	/*!
	63	* @see cec_ping_adapters
	64	*/
	65	virtual bool PingAdapter(void) = 0;
	66
	67	/*!
	68	* @see cec_start_bootloader
	69	*/
	70	virtual bool StartBootloader(void) = 0;
	71	//@}
	72
	73	/*!
	74	* @see cec_get_min_version
	75	*/
	76	virtual int8_t GetMinVersion(void) = 0;
	77
	78	/*!
	79	* @see cec_get_lib_version
	80	*/
	81	virtual int8_t GetLibVersion(void) = 0;
	82
	83	/*!
	84	* @see cec_get_next_log_message
	85	*/
	86	virtual bool GetNextLogMessage(cec_log_message *message) = 0;
	87
	88	/*!
	89	* @see cec_get_next_keypress
	90	*/
	91	virtual bool GetNextKeypress(cec_keypress *key) = 0;
	92
	93	/*!
	94	* @see cec_get_next_command
	95	*/
	96	virtual bool GetNextCommand(cec_command *command) = 0;
	97
	98	/*!
	99	* @see cec_transmit
	100	*/
	101	virtual bool Transmit(const cec_command &data, bool bWaitForAck = true) = 0;
	102
	103	/*!
	104	* @see cec_set_logical_address
	105	*/
	106	virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
	107
	108	/*!
	109	* @see cec_set_physical_address
	110	*/
	111	virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
	112
	113	/*!
	114	* @see cec_power_on_devices
	115	*/
	116	virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
	117
	118	/*!
	119	* @see cec_standby_devices
	120	*/
	121	virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
	122
	123	/*!
	124	* @see cec_set_active_view
	125	*/
	126	virtual bool SetActiveView(void) = 0;
	127
	128	/*!
	129	* @see cec_set_inactive_view
	130	*/
	131	virtual bool SetInactiveView(void) = 0;
	132
	133	/*!
	134	* @see cec_set_osd_string
	135	*/
	136	virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
	137	};
	138	};
	139
	140	extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
	141	extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
	142
	143	#endif /* CECEXPORTS_H_ */