cec: add GetDevicePhysicalAddress()/cec_get_device_physical_address()
[deb_libcec.git] / src / lib / CECProcessor.h
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 #include <string>
35 #include <cectypes.h>
36 #include "AdapterCommunication.h"
37 #include "platform/threads.h"
38 #include "util/buffer.h"
39 #include "util/StdString.h"
40
41 class CSerialPort;
42
43 namespace CEC
44 {
45 class CLibCEC;
46 class CAdapterCommunication;
47 class CCECBusDevice;
48
49 class CCECProcessor : public CThread
50 {
51 public:
52 CCECProcessor(CLibCEC *controller, const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
53 CCECProcessor(CLibCEC *controller, const char *strDeviceName, const cec_device_type_list &types);
54 virtual ~CCECProcessor(void);
55
56 virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
57 virtual void *Process(void);
58
59 virtual bool IsMonitoring(void) const { return m_bMonitor; }
60 virtual CCECBusDevice * GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bRefresh = false) const;
61 virtual CCECBusDevice * GetDeviceByType(cec_device_type type) const;
62 virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress);
63 virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language);
64 virtual const std::string & GetDeviceName(void) { return m_strDeviceName; }
65 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
66 virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress);
67 virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress);
68 virtual cec_logical_address GetLogicalAddress(void) const { return m_logicalAddresses.primary; }
69 virtual cec_logical_addresses GetLogicalAddresses(void) const { return m_logicalAddresses; }
70 virtual cec_logical_addresses GetActiveDevices(void);
71 virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iAddress);
72 virtual bool HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
73 virtual bool IsActiveDevice(cec_logical_address address);
74 virtual bool IsActiveDeviceType(cec_device_type type);
75 virtual uint16_t GetPhysicalAddress(void) const;
76 virtual uint64_t GetLastTransmission(void) const { return m_iLastTransmission; }
77 virtual bool IsStarted(void) const { return m_bStarted; }
78
79 virtual bool SetActiveView(void);
80 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
81 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
82 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
83 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
84 virtual bool TransmitInactiveSource(void);
85 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
86 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
87 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress);
88 virtual bool SetStreamPath(uint16_t iStreamPath);
89 virtual bool SwitchMonitoring(bool bEnable);
90 virtual bool PollDevice(cec_logical_address iAddress);
91 virtual uint8_t VolumeUp(void);
92 virtual uint8_t VolumeDown(void);
93 virtual uint8_t MuteAudio(void);
94 virtual bool TransmitKeypress(cec_logical_address iDestination, cec_user_control_code key);
95 virtual bool TransmitKeyRelease(cec_logical_address iDestination);
96 virtual bool EnablePhysicalAddressDetection(void) { return false; };
97 void SetStandardLineTimeout(uint8_t iTimeout);
98 void SetRetryLineTimeout(uint8_t iTimeout);
99
100 bool SetLineTimeout(uint8_t iTimeout);
101
102 const char *ToString(const cec_menu_state state);
103 const char *ToString(const cec_version version);
104 const char *ToString(const cec_power_status status);
105 const char *ToString(const cec_logical_address address);
106 const char *ToString(const cec_deck_control_mode mode);
107 const char *ToString(const cec_deck_info status);
108 const char *ToString(const cec_opcode opcode);
109 const char *ToString(const cec_system_audio_status mode);
110 const char *ToString(const cec_audio_status status);
111 const char *ToString(const cec_vendor_id vendor);
112
113 virtual bool Transmit(const cec_command &data);
114 virtual bool Transmit(CCECAdapterMessage *output);
115 virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
116
117 virtual void SetCurrentButton(cec_user_control_code iButtonCode);
118 virtual void AddCommand(const cec_command &command);
119 virtual void AddKey(cec_keypress &key);
120 virtual void AddKey(void);
121 virtual void AddLog(cec_log_level level, const CStdString &strMessage);
122
123 virtual bool FindLogicalAddresses(void);
124 virtual bool SetAckMask(uint16_t iMask);
125
126 virtual bool StartBootloader(void);
127 virtual bool PingAdapter(void);
128
129 CCECBusDevice *m_busDevices[16];
130 CMutex m_transmitMutex;
131
132 private:
133 void ScanCECBus(void);
134 bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
135 bool TryLogicalAddress(cec_logical_address address);
136 bool FindLogicalAddressRecordingDevice(void);
137 bool FindLogicalAddressTuner(void);
138 bool FindLogicalAddressPlaybackDevice(void);
139 bool FindLogicalAddressAudioSystem(void);
140
141 void LogOutput(const cec_command &data);
142 bool WaitForTransmitSucceeded(CCECAdapterMessage *message);
143 bool ParseMessage(const CCECAdapterMessage &msg);
144 void ParseCommand(cec_command &command);
145
146 bool m_bStarted;
147 uint8_t m_iHDMIPort;
148 cec_logical_address m_iBaseDevice;
149 cec_command m_currentframe;
150 cec_logical_addresses m_logicalAddresses;
151 cec_logical_address m_lastInitiator;
152 std::string m_strDeviceName;
153 cec_device_type_list m_types;
154 CMutex m_mutex;
155 CCondition m_startCondition;
156 CAdapterCommunication* m_communication;
157 CLibCEC* m_controller;
158 bool m_bMonitor;
159 CecBuffer<cec_command> m_commandBuffer;
160 cec_keypress m_previousKey;
161 CThread * m_busScan;
162 uint8_t m_iLineTimeout;
163 uint8_t m_iStandardLineTimeout;
164 uint8_t m_iRetryLineTimeout;
165 uint64_t m_iLastTransmission;
166 };
167
168 class CCECBusScan : public CThread
169 {
170 public:
171 CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
172 virtual ~CCECBusScan(void) { StopThread(true); }
173 virtual void *Process(void);
174
175 private:
176 void WaitUntilIdle(void);
177
178 CCECProcessor *m_processor;
179 };
180 };