added missing hardy rules and source version
[deb_libcec.git] / 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-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 class CCECClient;
43
44 class CLibCEC : public ICECAdapter
45 {
46 public:
47 CLibCEC(const char *strDeviceName, cec_device_type_list types, uint16_t iPhysicalAddress = 0);
48 CLibCEC(libcec_configuration *configuration);
49 virtual ~CLibCEC(void);
50
51 /*!
52 * ICECAdapter implementation
53 */
54 //@{
55 bool Open(const char *strPort, uint32_t iTimeout = CEC_DEFAULT_CONNECT_TIMEOUT);
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);
61
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; };
65
66 bool GetNextLogMessage(cec_log_message *message);
67 bool GetNextKeypress(cec_keypress *key);
68 bool GetNextCommand(cec_command *command);
69
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);
73
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);
99 cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
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);
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);
123 const char *ToString(const cec_client_version version);
124 const char *ToString(const cec_server_version version);
125 const char *ToString(const cec_device_type type);
126
127 static cec_device_type GetType(cec_logical_address address);
128 static uint16_t GetMaskForType(cec_logical_address address);
129 static uint16_t GetMaskForType(cec_device_type type);
130
131 bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
132 //@}
133
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
140 void CheckKeypressTimeout(void);
141 void Alert(const libcec_alert type, const libcec_parameter &param);
142 static CLibCEC *GetInstance(void); //UNUSED
143 static void SetInstance(CLibCEC *instance); //UNUSED
144
145 static bool IsValidPhysicalAddress(uint16_t iPhysicalAddress);
146 CCECClient *RegisterClient(libcec_configuration &configuration);
147 void UnregisterClients(void);
148 std::vector<CCECClient *> GetClients(void) { return m_clients; };
149
150 CCECProcessor * m_cec;
151
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;
165 std::vector<CCECClient *> m_clients;
166 };
167 };