updated changelog
[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-2013 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 "cec.h"
36 #include "platform/util/buffer.h"
37 #include "CECTypeUtils.h"
38
39 namespace CEC
40 {
41 class CAdapterCommunication;
42 class CCECProcessor;
43 class CCECClient;
44
45 class CLibCEC : public ICECAdapter
46 {
47 public:
48 CLibCEC(void);
49 virtual ~CLibCEC(void);
50
51 bool Open(const char *strPort, uint32_t iTimeout = CEC_DEFAULT_CONNECT_TIMEOUT);
52 void Close(void);
53 bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
54 int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
55 int8_t DetectAdapters(cec_adapter_descriptor *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL);
56 bool PingAdapter(void);
57 bool StartBootloader(void);
58
59 bool Transmit(const cec_command &data);
60 bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1);
61 bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
62
63 bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV);
64 bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST);
65 bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
66 bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
67 bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
68 bool SetInactiveView(void);
69 bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
70 bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
71 bool SwitchMonitoring(bool bEnable);
72 cec_version GetDeviceCecVersion(cec_logical_address iAddress);
73 bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
74 uint64_t GetDeviceVendorId(cec_logical_address iAddress);
75 uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
76 cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
77 bool PollDevice(cec_logical_address iAddress);
78 cec_logical_addresses GetActiveDevices(void);
79 bool IsActiveDevice(cec_logical_address iAddress);
80 bool IsActiveDeviceType(cec_device_type type);
81 bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort = CEC_DEFAULT_HDMI_PORT);
82 uint8_t VolumeUp(bool bSendRelease = true);
83 uint8_t VolumeDown(bool bSendRelease = true);
84 uint8_t MuteAudio(bool bSendRelease = true);
85 bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key, bool bWait = true);
86 bool SendKeyRelease(cec_logical_address iDestination, bool bWait = true);
87 cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
88 cec_logical_address GetActiveSource(void);
89 bool IsActiveSource(cec_logical_address iAddress);
90 bool SetStreamPath(cec_logical_address iAddress);
91 bool SetStreamPath(uint16_t iPhysicalAddress);
92 cec_logical_addresses GetLogicalAddresses(void);
93 bool GetCurrentConfiguration(libcec_configuration *configuration);
94 bool SetConfiguration(const libcec_configuration *configuration);
95 bool CanPersistConfiguration(void);
96 bool PersistConfiguration(libcec_configuration *configuration);
97 void RescanActiveDevices(void);
98 bool IsLibCECActiveSource(void);
99
100 const char *ToString(const cec_menu_state state) { return CCECTypeUtils::ToString(state); }
101 const char *ToString(const cec_version version) { return CCECTypeUtils::ToString(version); }
102 const char *ToString(const cec_power_status status) { return CCECTypeUtils::ToString(status); }
103 const char *ToString(const cec_logical_address address) { return CCECTypeUtils::ToString(address); }
104 const char *ToString(const cec_deck_control_mode mode) { return CCECTypeUtils::ToString(mode); }
105 const char *ToString(const cec_deck_info status) { return CCECTypeUtils::ToString(status); }
106 const char *ToString(const cec_opcode opcode) { return CCECTypeUtils::ToString(opcode); }
107 const char *ToString(const cec_system_audio_status mode) { return CCECTypeUtils::ToString(mode); }
108 const char *ToString(const cec_audio_status status) { return CCECTypeUtils::ToString(status); }
109 const char *ToString(const cec_vendor_id vendor) { return CCECTypeUtils::ToString(vendor); }
110 const char *ToString(const cec_client_version version) { return CCECTypeUtils::ToString(version); }
111 const char *ToString(const cec_server_version version) { return CCECTypeUtils::ToString(version); }
112 const char *ToString(const cec_device_type type) { return CCECTypeUtils::ToString(type); }
113 const char *ToString(const cec_user_control_code key) { return CCECTypeUtils::ToString(key); }
114 const char *ToString(const cec_adapter_type type) { return CCECTypeUtils::ToString(type); }
115
116 static cec_device_type GetType(cec_logical_address address);
117 static uint16_t GetMaskForType(cec_logical_address address);
118 static uint16_t GetMaskForType(cec_device_type type);
119
120 bool GetDeviceInformation(const char *strPort, libcec_configuration *config, uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT);
121
122 void AddLog(const cec_log_level level, const char *strFormat, ...);
123 void AddCommand(const cec_command &command);
124 void CheckKeypressTimeout(void);
125 void Alert(const libcec_alert type, const libcec_parameter &param);
126
127 static bool IsValidPhysicalAddress(uint16_t iPhysicalAddress);
128 CCECClient *RegisterClient(libcec_configuration &configuration);
129 void UnregisterClients(void);
130 std::vector<CCECClient *> GetClients(void) { return m_clients; };
131 const char *GetLibInfo(void);
132 void InitVideoStandalone(void);
133 uint16_t GetAdapterVendorId(void) const;
134 uint16_t GetAdapterProductId(void) const;
135
136 uint8_t AudioToggleMute(void);
137 uint8_t AudioMute(void);
138 uint8_t AudioUnmute(void);
139 uint8_t AudioStatus(void);
140
141 CCECProcessor * m_cec;
142
143 protected:
144 int64_t m_iStartTime;
145 PLATFORM::CMutex m_mutex;
146 CCECClient * m_client;
147 std::vector<CCECClient *> m_clients;
148 };
149 };