updated changelog for 1.5.0
[deb_libcec.git] / src / lib / LibCEC.h
CommitLineData
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
38namespace CEC
39{
828682d3 40 class CAdapterCommunication;
2abe74eb 41 class CCECProcessor;
a8f0bd18 42
2abe74eb 43 class CLibCEC : public ICECAdapter
abbca718
LOK
44 {
45 public:
46 /*!
2abe74eb 47 * ICECAdapter implementation
abbca718
LOK
48 */
49 //@{
4f362964 50 CLibCEC(const char *strDeviceName, cec_device_type_list types, uint16_t iPhysicalAddress = 0);
3efda01a 51 CLibCEC(libcec_configuration *configuration);
2abe74eb 52 virtual ~CLibCEC(void);
abbca718 53
25701fa6 54 virtual bool Open(const char *strPort, uint32_t iTimeout = 10000);
5f39c4d8 55 virtual void Close(void);
547b390d 56 virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
25701fa6 57 virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
2abe74eb 58 virtual bool PingAdapter(void);
abbca718 59 virtual bool StartBootloader(void);
2abe74eb 60
3efda01a 61 virtual int8_t GetMinLibVersion(void) const { return CEC_MIN_LIB_VERSION; };
99e89a5b
LOK
62 virtual int8_t GetLibVersionMajor(void) const { return CEC_LIB_VERSION_MAJOR; };
63 virtual int8_t GetLibVersionMinor(void) const { return CEC_LIB_VERSION_MINOR; };
2abe74eb 64
abbca718
LOK
65 virtual bool GetNextLogMessage(cec_log_message *message);
66 virtual bool GetNextKeypress(cec_keypress *key);
825ddb96 67 virtual bool GetNextCommand(cec_command *command);
2abe74eb 68
8d84e2c0 69 virtual bool Transmit(const cec_command &data);
2492216a
LOK
70 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
71 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
abbca718 72
2abe74eb
LOK
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);
18203d17 76 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
28fa6c97
LOK
77 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
78 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
2abe74eb 79 virtual bool SetInactiveView(void);
28fa6c97 80 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
1969b140 81 virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
8b7e5ff6 82 virtual bool SwitchMonitoring(bool bEnable);
6a1c0009 83 virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
a3269a0a 84 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
44c74256 85 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
eab72c40 86 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
e55f3f70 87 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
57f45e6c 88 virtual bool PollDevice(cec_logical_address iAddress);
6d858ba4
LOK
89 virtual cec_logical_addresses GetActiveDevices(void);
90 virtual bool IsActiveDevice(cec_logical_address iAddress);
91 virtual bool IsActiveDeviceType(cec_device_type type);
d2f1c157 92 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
5c73f7f7
LOK
93 virtual uint8_t VolumeUp(bool bSendRelease = true);
94 virtual uint8_t VolumeDown(bool bSendRelease = true);
95 virtual uint8_t MuteAudio(bool bSendRelease = true);
4bec9d79
LOK
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);
f71a1df9 98 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
2dbd78f8 99 virtual bool EnablePhysicalAddressDetection(void);
b4b1b49b
LOK
100 virtual cec_logical_address GetActiveSource(void);
101 virtual bool IsActiveSource(cec_logical_address iAddress);
f42d3e0f
LOK
102 virtual bool SetStreamPath(cec_logical_address iAddress);
103 virtual bool SetStreamPath(uint16_t iPhysicalAddress);
80b72250 104 virtual cec_logical_addresses GetLogicalAddresses(void);
d40928b5 105 virtual bool GetCurrentConfiguration(libcec_configuration *configuration);
30b4aac0 106 virtual bool SetConfiguration(const libcec_configuration *configuration);
224ea877
LOK
107 virtual bool CanPersistConfiguration(void);
108 virtual bool PersistConfiguration(libcec_configuration *configuration);
3efda01a 109 virtual void RescanActiveDevices(void);
c9549d35 110 virtual bool IsLibCECActiveSource(void);
03ae897d
LOK
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);
caca2d81 122 const char *ToString(const cec_client_version version);
3efda01a 123 const char *ToString(const cec_server_version version);
2abe74eb 124 //@}
abbca718 125
32403cc3 126 static void AddLog(const cec_log_level level, const char *strFormat, ...);
02e7043e 127 static void AddKey(void);
32403cc3 128 static void AddKey(const cec_keypress &key);
02e7043e 129 static void AddCommand(const cec_command &command);
32403cc3 130 static void ConfigurationChanged(const libcec_configuration &config);
02e7043e 131 static void SetCurrentButton(cec_user_control_code iButtonCode);
2abe74eb 132 virtual void CheckKeypressTimeout(void);
abbca718 133
5477a250
LOK
134 static CLibCEC *GetInstance(void);
135 static void SetInstance(CLibCEC *instance);
136
2abe74eb 137 protected:
f00ff009
LOK
138 int64_t m_iStartTime;
139 cec_user_control_code m_iCurrentButton;
140 int64_t m_buttontime;
141 CCECProcessor * m_cec;
142 PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer;
143 PLATFORM::SyncedBuffer<cec_keypress> m_keyBuffer;
144 PLATFORM::SyncedBuffer<cec_command> m_commandBuffer;
145 ICECCallbacks * m_callbacks;
146 void * m_cbParam;
147 PLATFORM::CMutex m_mutex;
abbca718
LOK
148 };
149};