cec: refactor CEC read/write. keep a single lock for all writes, not one per device
[deb_libcec.git] / src / lib / CECProcessor.h
CommitLineData
abbca718
LOK
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
25701fa6 34#include <string>
761dcc45 35#include <cectypes.h>
220537f2 36#include "AdapterCommunication.h"
b9187cc6 37#include "platform/threads.h"
abbca718 38#include "util/buffer.h"
e9de9629 39#include "util/StdString.h"
abbca718
LOK
40
41class CSerialPort;
42
43namespace CEC
44{
2abe74eb 45 class CLibCEC;
828682d3 46 class CAdapterCommunication;
e9de9629 47 class CCECBusDevice;
a8f0bd18 48
2abe74eb 49 class CCECProcessor : public CThread
abbca718
LOK
50 {
51 public:
1113cb7d
LOK
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);
2abe74eb
LOK
54 virtual ~CCECProcessor(void);
55
1113cb7d 56 virtual bool Start(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
e41b06f9
LOK
57 virtual void *Process(void);
58
8747dd4f 59 virtual bool IsMonitoring(void) const { return m_bMonitor; }
16b1e052 60 virtual CCECBusDevice * GetDeviceByPhysicalAddress(uint16_t iPhysicalAddress, bool bRefresh = false) const;
a9232a79 61 virtual CCECBusDevice * GetDeviceByType(cec_device_type type) const;
8747dd4f
LOK
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; }
ed21be2a 65 virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress);
8747dd4f
LOK
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; }
6d858ba4 70 virtual cec_logical_addresses GetActiveDevices(void);
ab1469a0 71 virtual bool HasLogicalAddress(cec_logical_address address) const { return m_logicalAddresses.IsSet(address); }
6d858ba4
LOK
72 virtual bool IsActiveDevice(cec_logical_address address);
73 virtual bool IsActiveDeviceType(cec_device_type type);
8747dd4f 74 virtual uint16_t GetPhysicalAddress(void) const;
abbca718 75
abbca718 76 virtual bool SetActiveView(void);
18203d17 77 virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
1a6669b8 78 virtual bool SetActiveSource(cec_logical_address iAddress);
28fa6c97
LOK
79 virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true);
80 virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true);
d2f1c157 81 virtual bool SetHDMIPort(cec_logical_address iBaseDevice, uint8_t iPort, bool bForce = false);
ab27363d 82 virtual bool TransmitInactiveSource(void);
06bfd4d7 83 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress);
28fa6c97 84 virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true);
2492216a 85 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress);
8ac9c610 86 virtual bool SetStreamPath(uint16_t iStreamPath);
8b7e5ff6 87 virtual bool SwitchMonitoring(bool bEnable);
57f45e6c 88 virtual bool PollDevice(cec_logical_address iAddress);
8fa35473
LOK
89 virtual uint8_t VolumeUp(void);
90 virtual uint8_t VolumeDown(void);
91 virtual uint8_t MuteAudio(void);
92 virtual bool SendKeypress(cec_logical_address iDestination, cec_user_control_code key);
93 virtual bool SendKeyRelease(cec_logical_address iDestination);
2dbd78f8 94 virtual bool EnablePhysicalAddressDetection(void) { return false; };
dcd240b2
LOK
95 void SetStandardLineTimeout(uint8_t iTimeout);
96 void SetRetryLineTimeout(uint8_t iTimeout);
acec5f48 97
855a3a98
LOK
98 bool SetLineTimeout(uint8_t iTimeout);
99
03ae897d
LOK
100 const char *ToString(const cec_menu_state state);
101 const char *ToString(const cec_version version);
102 const char *ToString(const cec_power_status status);
103 const char *ToString(const cec_logical_address address);
104 const char *ToString(const cec_deck_control_mode mode);
105 const char *ToString(const cec_deck_info status);
106 const char *ToString(const cec_opcode opcode);
107 const char *ToString(const cec_system_audio_status mode);
108 const char *ToString(const cec_audio_status status);
109 const char *ToString(const cec_vendor_id vendor);
110
06bfd4d7 111 virtual bool Transmit(const cec_command &data);
28352a04 112 virtual bool Transmit(CCECAdapterMessage *output);
22b4e74a 113 virtual void TransmitAbort(cec_logical_address address, cec_opcode opcode, cec_abort_reason reason = CEC_ABORT_REASON_UNRECOGNIZED_OPCODE);
e9de9629
LOK
114
115 virtual void SetCurrentButton(cec_user_control_code iButtonCode);
116 virtual void AddCommand(const cec_command &command);
95ba7a09 117 virtual void AddKey(cec_keypress &key);
e9de9629
LOK
118 virtual void AddKey(void);
119 virtual void AddLog(cec_log_level level, const CStdString &strMessage);
acec5f48 120
f8513317 121 virtual bool FindLogicalAddresses(void);
93fff5c1 122 virtual bool SetAckMask(uint16_t iMask);
f8513317 123
1113cb7d
LOK
124 virtual bool StartBootloader(void);
125 virtual bool PingAdapter(void);
126
0f23c85c 127 CCECBusDevice *m_busDevices[16];
8fa35473 128 CMutex m_transmitMutex;
abbca718 129
e41b06f9 130 private:
95a73fa7 131 void ScanCECBus(void);
45b97de7 132 bool PhysicalAddressInUse(uint16_t iPhysicalAddress);
b58d9277
LOK
133 bool TryLogicalAddress(cec_logical_address address);
134 bool FindLogicalAddressRecordingDevice(void);
135 bool FindLogicalAddressTuner(void);
136 bool FindLogicalAddressPlaybackDevice(void);
137 bool FindLogicalAddressAudioSystem(void);
f8513317 138
9dee1670 139 void LogOutput(const cec_command &data);
82d1a9a1 140 bool WaitForTransmitSucceeded(CCECAdapterMessage *message);
0e7b6c54 141 bool ParseMessage(const CCECAdapterMessage &msg);
9dee1670 142 void ParseCommand(cec_command &command);
abbca718 143
f8513317 144 bool m_bStarted;
16b1e052 145 uint8_t m_iHDMIPort;
d2f1c157 146 cec_logical_address m_iBaseDevice;
e41b06f9 147 cec_command m_currentframe;
f8513317 148 cec_logical_addresses m_logicalAddresses;
855a3a98 149 cec_logical_address m_lastInitiator;
e41b06f9 150 std::string m_strDeviceName;
f8513317 151 cec_device_type_list m_types;
e41b06f9
LOK
152 CMutex m_mutex;
153 CCondition m_startCondition;
f8513317
LOK
154 CAdapterCommunication* m_communication;
155 CLibCEC* m_controller;
e41b06f9 156 bool m_bMonitor;
8747dd4f 157 CecBuffer<cec_command> m_commandBuffer;
a33794d8 158 cec_keypress m_previousKey;
7c63a480 159 CThread * m_busScan;
9902f4e8 160 uint8_t m_iLineTimeout;
dcd240b2
LOK
161 uint8_t m_iStandardLineTimeout;
162 uint8_t m_iRetryLineTimeout;
7c63a480
LOK
163 };
164
165 class CCECBusScan : public CThread
166 {
167 public:
168 CCECBusScan(CCECProcessor *processor) { m_processor = processor; }
169 virtual ~CCECBusScan(void) {}
170 virtual void *Process(void);
171
172 private:
173 CCECProcessor *m_processor;
abbca718
LOK
174 };
175};