src/lib/CECClient.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 "../../include/cectypes.h"
  35 #include "platform/threads/mutex.h"
  36 #include "platform/util/buffer.h"
  37
  38 #include "devices/CECBusDevice.h"
  39
  40 namespace CEC
  41 {
  42   class CCECProcessor;
  43
  44   class CCECClient
  45   {
  46     friend class CCECProcessor;
  47
  48   public:
  49     CCECClient(CCECProcessor *processor, const libcec_configuration &configuration);
  50     virtual ~CCECClient(void);
  51
  52     /*!
  53      * @return True when initialised and registered, false otherwise.
  54      */
  55     virtual bool IsInitialised(void);
  56
  57     /*!
  58      * @return True when registered in the processor, false otherwise.
  59      */
  60     virtual bool IsRegistered(void);
  61
  62     /*!
  63      * @return The primary logical address that this client is controlling.
  64      */
  65     virtual cec_logical_address GetPrimaryLogicalAdddress(void);
  66
  67     /*!
  68      * @return The primary device that this client is controlling, or NULL if none.
  69      */
  70     virtual CCECBusDevice *GetPrimaryDevice(void);
  71
  72     /*!
  73      * @return Get the playback device or recording device that this client is controlling, or NULL if none.
  74      */
  75     virtual CCECPlaybackDevice *GetPlaybackDevice(void);
  76
  77     /*!
  78      * @brief Change one of the device types that this client is controlling into another.
  79      * @param from The type to change.
  80      * @param to The new value.
  81      * @return True when changed, false otherwise.
  82      */
  83     virtual bool ChangeDeviceType(const cec_device_type from, const cec_device_type to);
  84
  85     /*!
  86      * @brief Get a device that this client is controlling, given it's type.
  87      * @param type The type of the device to get.
  88      * @return The requested device, or NULL if not found.
  89      */
  90     virtual CCECBusDevice *GetDeviceByType(const cec_device_type type) const;
  91
  92     /*!
  93      * @brief Reset the physical address from the configuration.
  94      */
  95     virtual void ResetPhysicalAddress(void);
  96
  97     /*!
  98      * @return A string that describes this client.
  99      */
 100     virtual CStdString GetConnectionInfo(void);
 101
 102     /*!
 103      * @return The current value of the TV vendor override setting.
 104      */
 105     virtual cec_vendor_id GetTVVendorOverride(void);
 106
 107     /*!
 108      * @return The current value of the OSD name setting.
 109      */
 110     virtual CStdString GetOSDName(void);
 111
 112     /*!
 113      * @return Get the current value of the wake device setting.
 114      */
 115     virtual cec_logical_addresses GetWakeDevices(void);
 116
 117     /*!
 118      * @return The version of this client.
 119      */
 120     virtual cec_client_version GetClientVersion(void);
 121
 122     /*!
 123      * @return The device types that this client is controlling.
 124      */
 125     virtual cec_device_type_list GetDeviceTypes(void);
 126
 127     // client-specific part of ICECAdapter
 128     virtual bool                  EnableCallbacks(void *cbParam, ICECCallbacks *callbacks);
 129     virtual bool                  PingAdapter(void);
 130     virtual bool                  GetNextLogMessage(cec_log_message *message); /**< @deprecated will be removed in v2.0 */
 131     virtual bool                  GetNextKeypress(cec_keypress *key);          /**< @deprecated will be removed in v2.0 */
 132     virtual bool                  GetNextCommand(cec_command *command);        /**< @deprecated will be removed in v2.0 */
 133     virtual bool                  Transmit(const cec_command &data);
 134     virtual bool                  SetLogicalAddress(const cec_logical_address iLogicalAddress);
 135     virtual bool                  SetPhysicalAddress(const uint16_t iPhysicalAddress);
 136     virtual bool                  SetHDMIPort(const cec_logical_address iBaseDevice, const uint8_t iPort, bool bForce = false);
 137     virtual bool                  SendPowerOnDevices(const cec_logical_address address = CECDEVICE_TV);
 138     virtual bool                  SendStandbyDevices(const cec_logical_address address = CECDEVICE_BROADCAST);
 139     virtual bool                  SendSetActiveSource(const cec_device_type type = CEC_DEVICE_TYPE_RESERVED);
 140     virtual bool                  SendSetDeckControlMode(const cec_deck_control_mode mode, bool bSendUpdate = true);
 141     virtual bool                  SendSetDeckInfo(const cec_deck_info info, bool bSendUpdate = true);
 142     virtual bool                  SendSetInactiveView(void);
 143     virtual bool                  SendSetMenuState(const cec_menu_state state, bool bSendUpdate = true);
 144     virtual bool                  SendSetOSDString(const cec_logical_address iLogicalAddress, const cec_display_control duration, const char *strMessage);
 145     virtual bool                  SwitchMonitoring(bool bEnable);
 146     virtual cec_version           GetDeviceCecVersion(const cec_logical_address iAddress);
 147     virtual bool                  GetDeviceMenuLanguage(const cec_logical_address iAddress, cec_menu_language &language);
 148     virtual uint64_t              GetDeviceVendorId(const cec_logical_address iAddress);
 149     virtual cec_power_status      GetDevicePowerStatus(const cec_logical_address iAddress);
 150     virtual uint16_t              GetDevicePhysicalAddress(const cec_logical_address iAddress);
 151     virtual bool                  PollDevice(const cec_logical_address iAddress);
 152     virtual cec_logical_addresses GetActiveDevices(void);
 153     virtual bool                  IsActiveDevice(const cec_logical_address iAddress);
 154     virtual bool                  IsActiveDeviceType(const cec_device_type type);
 155     virtual uint8_t               SendVolumeUp(bool bSendRelease = true);
 156     virtual uint8_t               SendVolumeDown(bool bSendRelease = true);
 157     virtual uint8_t               SendMuteAudio(void);
 158     virtual bool                  SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true);
 159     virtual bool                  SendKeyRelease(const cec_logical_address iDestination, bool bWait = true);
 160     virtual cec_osd_name          GetDeviceOSDName(const cec_logical_address iAddress);
 161     virtual cec_logical_address   GetActiveSource(void);
 162     virtual bool                  IsActiveSource(const cec_logical_address iAddress);
 163     virtual bool                  SetStreamPath(const cec_logical_address iAddress);
 164     virtual bool                  SetStreamPath(const uint16_t iPhysicalAddress);
 165     virtual cec_logical_addresses GetLogicalAddresses(void);
 166     virtual void                  RescanActiveDevices(void);
 167     virtual bool                  IsLibCECActiveSource(void);
 168
 169     // configuration
 170     virtual bool                  GetCurrentConfiguration(libcec_configuration &configuration);
 171     virtual bool                  SetConfiguration(const libcec_configuration &configuration);
 172     virtual bool                  CanPersistConfiguration(void);
 173     virtual bool                  PersistConfiguration(const libcec_configuration &configuration);
 174     virtual void                  SetPhysicalAddress(const libcec_configuration &configuration);
 175
 176     // callbacks
 177     virtual void                  AddCommand(const cec_command &command);
 178     virtual int                   MenuStateChanged(const cec_menu_state newState);
 179     virtual void                  Alert(const libcec_alert type, const libcec_parameter &param);
 180     virtual void                  AddLog(const cec_log_message &message);
 181     virtual void                  AddKey(void);
 182     virtual void                  AddKey(const cec_keypress &key);
 183     virtual void                  SetCurrentButton(const cec_user_control_code iButtonCode);
 184     virtual void                  CheckKeypressTimeout(void);
 185
 186   protected:
 187     /*!
 188      * @brief Register this client in the processor
 189      * @return True when registered, false otherwise.
 190      */
 191     virtual bool OnRegister(void);
 192
 193     /*!
 194      * @brief Called by the processor when this client is unregistered
 195      */
 196     virtual void OnUnregister(void) { SetRegistered(false); SetInitialised(false); }
 197
 198     /*!
 199      * @brief Set the registered state of this client.
 200      * @param bSetTo The new value.
 201      */
 202     virtual void SetRegistered(bool bSetTo);
 203
 204     /*!
 205      * @brief Set the initialised state of this client.
 206      * @param bSetTo The new value
 207      */
 208     virtual void SetInitialised(bool bSetTo);
 209
 210     /*!
 211      * @brief Change the TV vendor id override setting.
 212      * @param id The new value.
 213      */
 214     virtual void SetTVVendorOverride(const cec_vendor_id id);
 215
 216     /*!
 217      * @brief Change the OSD name of the primary device that this client is controlling.
 218      * @param strDeviceName The new value.
 219      */
 220     virtual void SetOSDName(const CStdString &strDeviceName);
 221
 222     /*!
 223      * @brief Change the value of the devices to wake.
 224      * @param addresses The new value.
 225      */
 226     virtual void SetWakeDevices(const cec_logical_addresses &addresses);
 227
 228     /*!
 229      * @brief Change the value of the client version setting.
 230      * @param version The new version setting.
 231      */
 232     virtual void SetClientVersion(const cec_client_version version);
 233
 234     /*!
 235      * @brief Change the device types that this client is controlling.
 236      * @param deviceTypes The new types.
 237      * @return True when the client needs to be re-registered to pick up the new setting, false otherwise.
 238      */
 239     virtual bool SetDeviceTypes(const cec_device_type_list &deviceTypes);
 240
 241     /*!
 242      * @return A pointer to the current configuration of this client.
 243      */
 244     virtual libcec_configuration *GetConfiguration(void) { return &m_configuration; }
 245
 246     /*!
 247      * @brief Called by the processor when registering this client to allocate the logical addresses.
 248      * @return True when the addresses for all types were allocated, false otherwise.
 249      */
 250     virtual bool AllocateLogicalAddresses(void);
 251
 252     /*!
 253      * @brief Try to allocate a logical address for a recording device controlled by this client.
 254      * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
 255      */
 256     virtual cec_logical_address AllocateLogicalAddressRecordingDevice(void);
 257
 258     /*!
 259      * @brief Try to allocate a logical address for a tuner controlled by this client.
 260      * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
 261      */
 262     virtual cec_logical_address AllocateLogicalAddressTuner(void);
 263
 264     /*!
 265      * @brief Try to allocate a logical address for a playback device controlled by this client.
 266      * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
 267      */
 268     virtual cec_logical_address AllocateLogicalAddressPlaybackDevice(void);
 269
 270     /*!
 271      * @brief Try to allocate a logical address for an audiosystem controlled by this client.
 272      * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated.
 273      */
 274     virtual cec_logical_address AllocateLogicalAddressAudioSystem(void);
 275
 276     /*!
 277      * @brief Change the physical address of the devices controlled by this client.
 278      * @param iPhysicalAddress The new physical address.
 279      * @return True when changed, false otherwise.
 280      */
 281     virtual bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress);
 282
 283     /*!
 284      * @brief Called when the configuration changed and needs to be sent back to the client.
 285      * @param config The new configuration.
 286      */
 287     virtual void ConfigurationChanged(const libcec_configuration &config);
 288
 289     /*!
 290      * @brief Try to autodetect the physical address.
 291      * @return True when autodetected (and set in m_configuration), false otherwise.
 292      */
 293     virtual bool AutodetectPhysicalAddress(void);
 294
 295     CCECProcessor *                         m_processor;      /**< a pointer to the processor */
 296     libcec_configuration                    m_configuration;  /**< the configuration of this client */
 297     bool                                    m_bInitialised;   /**< true when initialised, false otherwise */
 298     bool                                    m_bRegistered;    /**< true when registered in the processor, false otherwise */
 299     PLATFORM::CMutex                        m_mutex;          /**< mutex for changes to this instance */
 300     PLATFORM::CMutex                        m_logMutex;       /**< mutex that is held when sending a log message back to the client */
 301     cec_user_control_code                   m_iCurrentButton; /**< the control code of the button that's currently held down (if any) */
 302     int64_t                                 m_buttontime;     /**< the timestamp when the button was pressed (in seconds since epoch), or 0 if none was pressed. */
 303     PLATFORM::SyncedBuffer<cec_log_message> m_logBuffer;      /**< @deprecated will be removed in v2.0. buffer for log messages */
 304     PLATFORM::SyncedBuffer<cec_keypress>    m_keyBuffer;      /**< @deprecated will be removed in v2.0. buffer for keypresses */
 305     PLATFORM::SyncedBuffer<cec_command>     m_commandBuffer;  /**< @deprecated will be removed in v2.0. buffer for commands */
 306   };
 307 }