From: Lars Op den Kamp Date: Mon, 14 May 2012 17:59:03 +0000 (+0200) Subject: cec: documentation for the new CCECClient and made methods protected that are only... X-Git-Tag: upstream/2.2.0~1^2~28^2~8 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=679dfa075ef915793de454b2f803ce8fe09d30b4;p=deb_libcec.git cec: documentation for the new CCECClient and made methods protected that are only called by CCECProcessor --- diff --git a/src/lib/CECClient.h b/src/lib/CECClient.h index bd4099a..3d812f0 100644 --- a/src/lib/CECClient.h +++ b/src/lib/CECClient.h @@ -43,118 +43,265 @@ namespace CEC class CCECClient { + friend class CCECProcessor; + public: CCECClient(CCECProcessor *processor, const libcec_configuration &configuration); virtual ~CCECClient(void); - // methods for registration in CCECProcessor - bool OnRegister(void); - void OnUnregister(void) { SetRegistered(false); SetInitialised(false); } - bool IsInitialised(void); - void SetInitialised(bool bSetTo); - bool IsRegistered(void); - void SetRegistered(bool bSetTo); - cec_logical_address GetPrimaryLogicalAdddress(void); - - // device specific methods - CCECBusDevice * GetPrimaryDevice(void); - CCECPlaybackDevice * GetPlaybackDevice(void); - bool AllocateLogicalAddresses(void); - bool ChangeDeviceType(const cec_device_type from, const cec_device_type to); - CCECBusDevice * GetDeviceByType(const cec_device_type type) const; - void ResetPhysicalAddress(void); - CStdString GetConnectionInfo(void); - void SetTVVendorOverride(const cec_vendor_id id); - cec_vendor_id GetTVVendorOverride(void); - void SetOSDName(const CStdString &strDeviceName); - CStdString GetOSDName(void); - void SetWakeDevices(const cec_logical_addresses &addresses); - cec_logical_addresses GetWakeDevices(void); - bool AutodetectPhysicalAddress(void); - void SetClientVersion(const cec_client_version version); - cec_client_version GetClientVersion(void); - bool SetDeviceTypes(const cec_device_type_list &deviceTypes); - cec_device_type_list GetDeviceTypes(void); + /*! + * @return True when initialised and registered, false otherwise. + */ + virtual bool IsInitialised(void); + + /*! + * @return True when registered in the processor, false otherwise. + */ + virtual bool IsRegistered(void); + + /*! + * @return The primary logical address that this client is controlling. + */ + virtual cec_logical_address GetPrimaryLogicalAdddress(void); + + /*! + * @return The primary device that this client is controlling, or NULL if none. + */ + virtual CCECBusDevice *GetPrimaryDevice(void); + + /*! + * @return Get the playback device or recording device that this client is controlling, or NULL if none. + */ + virtual CCECPlaybackDevice *GetPlaybackDevice(void); + + /*! + * @brief Change one of the device types that this client is controlling into another. + * @param from The type to change. + * @param to The new value. + * @return True when changed, false otherwise. + */ + virtual bool ChangeDeviceType(const cec_device_type from, const cec_device_type to); + + /*! + * @brief Get a device that this client is controlling, given it's type. + * @param type The type of the device to get. + * @return The requested device, or NULL if not found. + */ + virtual CCECBusDevice *GetDeviceByType(const cec_device_type type) const; + + /*! + * @brief Reset the physical address from the configuration. + */ + virtual void ResetPhysicalAddress(void); + + /*! + * @return A string that describes this client. + */ + virtual CStdString GetConnectionInfo(void); + + /*! + * @return The current value of the TV vendor override setting. + */ + virtual cec_vendor_id GetTVVendorOverride(void); + + /*! + * @return The current value of the OSD name setting. + */ + virtual CStdString GetOSDName(void); + + /*! + * @return Get the current value of the wake device setting. + */ + virtual cec_logical_addresses GetWakeDevices(void); + + /*! + * @return The version of this client. + */ + virtual cec_client_version GetClientVersion(void); + + /*! + * @return The device types that this client is controlling. + */ + virtual cec_device_type_list GetDeviceTypes(void); // client-specific part of ICECAdapter - bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks); - bool PingAdapter(void); - bool GetNextLogMessage(cec_log_message *message); /**< @deprecated will be removed in v2.0 */ - bool GetNextKeypress(cec_keypress *key); /**< @deprecated will be removed in v2.0 */ - bool GetNextCommand(cec_command *command); /**< @deprecated will be removed in v2.0 */ - bool Transmit(const cec_command &data); - bool SetLogicalAddress(const cec_logical_address iLogicalAddress); - bool SetPhysicalAddress(const uint16_t iPhysicalAddress); - bool SetHDMIPort(const cec_logical_address iBaseDevice, const uint8_t iPort, bool bForce = false); - bool SendPowerOnDevices(const cec_logical_address address = CECDEVICE_TV); - bool SendStandbyDevices(const cec_logical_address address = CECDEVICE_BROADCAST); - bool SendSetActiveSource(const cec_device_type type = CEC_DEVICE_TYPE_RESERVED); - bool SendSetDeckControlMode(const cec_deck_control_mode mode, bool bSendUpdate = true); - bool SendSetDeckInfo(const cec_deck_info info, bool bSendUpdate = true); - bool SendSetInactiveView(void); - bool SendSetMenuState(const cec_menu_state state, bool bSendUpdate = true); - bool SendSetOSDString(const cec_logical_address iLogicalAddress, const cec_display_control duration, const char *strMessage); - bool SwitchMonitoring(bool bEnable); - cec_version GetDeviceCecVersion(const cec_logical_address iAddress); - bool GetDeviceMenuLanguage(const cec_logical_address iAddress, cec_menu_language &language); - uint64_t GetDeviceVendorId(const cec_logical_address iAddress); - cec_power_status GetDevicePowerStatus(const cec_logical_address iAddress); - uint16_t GetDevicePhysicalAddress(const cec_logical_address iAddress); - bool PollDevice(const cec_logical_address iAddress); - cec_logical_addresses GetActiveDevices(void); - bool IsActiveDevice(const cec_logical_address iAddress); - bool IsActiveDeviceType(const cec_device_type type); - uint8_t SendVolumeUp(bool bSendRelease = true); - uint8_t SendVolumeDown(bool bSendRelease = true); - uint8_t SendMuteAudio(void); - bool SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true); - bool SendKeyRelease(const cec_logical_address iDestination, bool bWait = true); - cec_osd_name GetDeviceOSDName(const cec_logical_address iAddress); - cec_logical_address GetActiveSource(void); - bool IsActiveSource(const cec_logical_address iAddress); - bool SetStreamPath(const cec_logical_address iAddress); - bool SetStreamPath(const uint16_t iPhysicalAddress); - cec_logical_addresses GetLogicalAddresses(void); - void RescanActiveDevices(void); - bool IsLibCECActiveSource(void); + virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks); + virtual bool PingAdapter(void); + virtual bool GetNextLogMessage(cec_log_message *message); /**< @deprecated will be removed in v2.0 */ + virtual bool GetNextKeypress(cec_keypress *key); /**< @deprecated will be removed in v2.0 */ + virtual bool GetNextCommand(cec_command *command); /**< @deprecated will be removed in v2.0 */ + virtual bool Transmit(const cec_command &data); + virtual bool SetLogicalAddress(const cec_logical_address iLogicalAddress); + virtual bool SetPhysicalAddress(const uint16_t iPhysicalAddress); + virtual bool SetHDMIPort(const cec_logical_address iBaseDevice, const uint8_t iPort, bool bForce = false); + virtual bool SendPowerOnDevices(const cec_logical_address address = CECDEVICE_TV); + virtual bool SendStandbyDevices(const cec_logical_address address = CECDEVICE_BROADCAST); + virtual bool SendSetActiveSource(const cec_device_type type = CEC_DEVICE_TYPE_RESERVED); + virtual bool SendSetDeckControlMode(const cec_deck_control_mode mode, bool bSendUpdate = true); + virtual bool SendSetDeckInfo(const cec_deck_info info, bool bSendUpdate = true); + virtual bool SendSetInactiveView(void); + virtual bool SendSetMenuState(const cec_menu_state state, bool bSendUpdate = true); + virtual bool SendSetOSDString(const cec_logical_address iLogicalAddress, const cec_display_control duration, const char *strMessage); + virtual bool SwitchMonitoring(bool bEnable); + virtual cec_version GetDeviceCecVersion(const cec_logical_address iAddress); + virtual bool GetDeviceMenuLanguage(const cec_logical_address iAddress, cec_menu_language &language); + virtual uint64_t GetDeviceVendorId(const cec_logical_address iAddress); + virtual cec_power_status GetDevicePowerStatus(const cec_logical_address iAddress); + virtual uint16_t GetDevicePhysicalAddress(const cec_logical_address iAddress); + virtual bool PollDevice(const cec_logical_address iAddress); + virtual cec_logical_addresses GetActiveDevices(void); + virtual bool IsActiveDevice(const cec_logical_address iAddress); + virtual bool IsActiveDeviceType(const cec_device_type type); + virtual uint8_t SendVolumeUp(bool bSendRelease = true); + virtual uint8_t SendVolumeDown(bool bSendRelease = true); + virtual uint8_t SendMuteAudio(void); + virtual bool SendKeypress(const cec_logical_address iDestination, const cec_user_control_code key, bool bWait = true); + virtual bool SendKeyRelease(const cec_logical_address iDestination, bool bWait = true); + virtual cec_osd_name GetDeviceOSDName(const cec_logical_address iAddress); + virtual cec_logical_address GetActiveSource(void); + virtual bool IsActiveSource(const cec_logical_address iAddress); + virtual bool SetStreamPath(const cec_logical_address iAddress); + virtual bool SetStreamPath(const uint16_t iPhysicalAddress); + virtual cec_logical_addresses GetLogicalAddresses(void); + virtual void RescanActiveDevices(void); + virtual bool IsLibCECActiveSource(void); // configuration - libcec_configuration *GetConfiguration(void) { return &m_configuration; } - bool GetCurrentConfiguration(libcec_configuration &configuration); - bool SetConfiguration(const libcec_configuration &configuration); - bool CanPersistConfiguration(void); - bool PersistConfiguration(const libcec_configuration &configuration); - void SetPhysicalAddress(const libcec_configuration &configuration); + virtual bool GetCurrentConfiguration(libcec_configuration &configuration); + virtual bool SetConfiguration(const libcec_configuration &configuration); + virtual bool CanPersistConfiguration(void); + virtual bool PersistConfiguration(const libcec_configuration &configuration); + virtual void SetPhysicalAddress(const libcec_configuration &configuration); // callbacks - void AddCommand(const cec_command &command); - int MenuStateChanged(const cec_menu_state newState); - void Alert(const libcec_alert type, const libcec_parameter ¶m); - void AddLog(const cec_log_message &message); - void AddKey(void); - void AddKey(const cec_keypress &key); - void SetCurrentButton(const cec_user_control_code iButtonCode); - void CheckKeypressTimeout(void); - void ConfigurationChanged(const libcec_configuration &config); + virtual void AddCommand(const cec_command &command); + virtual int MenuStateChanged(const cec_menu_state newState); + virtual void Alert(const libcec_alert type, const libcec_parameter ¶m); + virtual void AddLog(const cec_log_message &message); + virtual void AddKey(void); + virtual void AddKey(const cec_keypress &key); + virtual void SetCurrentButton(const cec_user_control_code iButtonCode); + virtual void CheckKeypressTimeout(void); protected: - cec_logical_address AllocateLogicalAddressRecordingDevice(void); - cec_logical_address AllocateLogicalAddressTuner(void); - cec_logical_address AllocateLogicalAddressPlaybackDevice(void); - cec_logical_address AllocateLogicalAddressAudioSystem(void); - - bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress); - - CCECProcessor * m_processor; - libcec_configuration m_configuration; - bool m_bInitialised; - bool m_bRegistered; - PLATFORM::CMutex m_mutex; - PLATFORM::SyncedBuffer m_logBuffer; - PLATFORM::CMutex m_logMutex; - PLATFORM::SyncedBuffer m_keyBuffer; - PLATFORM::SyncedBuffer m_commandBuffer; - cec_user_control_code m_iCurrentButton; - int64_t m_buttontime; + /*! + * @brief Register this client in the processor + * @return True when registered, false otherwise. + */ + virtual bool OnRegister(void); + + /*! + * @brief Called by the processor when this client is unregistered + */ + virtual void OnUnregister(void) { SetRegistered(false); SetInitialised(false); } + + /*! + * @brief Set the registered state of this client. + * @param bSetTo The new value. + */ + virtual void SetRegistered(bool bSetTo); + + /*! + * @brief Set the initialised state of this client. + * @param bSetTo The new value + */ + virtual void SetInitialised(bool bSetTo); + + /*! + * @brief Change the TV vendor id override setting. + * @param id The new value. + */ + virtual void SetTVVendorOverride(const cec_vendor_id id); + + /*! + * @brief Change the OSD name of the primary device that this client is controlling. + * @param strDeviceName The new value. + */ + virtual void SetOSDName(const CStdString &strDeviceName); + + /*! + * @brief Change the value of the devices to wake. + * @param addresses The new value. + */ + virtual void SetWakeDevices(const cec_logical_addresses &addresses); + + /*! + * @brief Change the value of the client version setting. + * @param version The new version setting. + */ + virtual void SetClientVersion(const cec_client_version version); + + /*! + * @brief Change the device types that this client is controlling. + * @param deviceTypes The new types. + * @return True when the client needs to be re-registered to pick up the new setting, false otherwise. + */ + virtual bool SetDeviceTypes(const cec_device_type_list &deviceTypes); + + /*! + * @return A pointer to the current configuration of this client. + */ + virtual libcec_configuration *GetConfiguration(void) { return &m_configuration; } + + /*! + * @brief Called by the processor when registering this client to allocate the logical addresses. + * @return True when the addresses for all types were allocated, false otherwise. + */ + virtual bool AllocateLogicalAddresses(void); + + /*! + * @brief Try to allocate a logical address for a recording device controlled by this client. + * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated. + */ + virtual cec_logical_address AllocateLogicalAddressRecordingDevice(void); + + /*! + * @brief Try to allocate a logical address for a tuner controlled by this client. + * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated. + */ + virtual cec_logical_address AllocateLogicalAddressTuner(void); + + /*! + * @brief Try to allocate a logical address for a playback device controlled by this client. + * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated. + */ + virtual cec_logical_address AllocateLogicalAddressPlaybackDevice(void); + + /*! + * @brief Try to allocate a logical address for an audiosystem controlled by this client. + * @return The logical address that was allocated, or CECDEVICE_UNKNOWN if none could be allocated. + */ + virtual cec_logical_address AllocateLogicalAddressAudioSystem(void); + + /*! + * @brief Change the physical address of the devices controlled by this client. + * @param iPhysicalAddress The new physical address. + * @return True when changed, false otherwise. + */ + virtual bool SetDevicePhysicalAddress(const uint16_t iPhysicalAddress); + + /*! + * @brief Called when the configuration changed and needs to be sent back to the client. + * @param config The new configuration. + */ + virtual void ConfigurationChanged(const libcec_configuration &config); + + /*! + * @brief Try to autodetect the physical address. + * @return True when autodetected (and set in m_configuration), false otherwise. + */ + virtual bool AutodetectPhysicalAddress(void); + + CCECProcessor * m_processor; /**< a pointer to the processor */ + libcec_configuration m_configuration; /**< the configuration of this client */ + bool m_bInitialised; /**< true when initialised, false otherwise */ + bool m_bRegistered; /**< true when registered in the processor, false otherwise */ + PLATFORM::CMutex m_mutex; /**< mutex for changes to this instance */ + PLATFORM::CMutex m_logMutex; /**< mutex that is held when sending a log message back to the client */ + cec_user_control_code m_iCurrentButton; /**< the control code of the button that's currently held down (if any) */ + int64_t m_buttontime; /**< the timestamp when the button was pressed (in seconds since epoch), or 0 if none was pressed. */ + PLATFORM::SyncedBuffer m_logBuffer; /**< @deprecated will be removed in v2.0. buffer for log messages */ + PLATFORM::SyncedBuffer m_keyBuffer; /**< @deprecated will be removed in v2.0. buffer for keypresses */ + PLATFORM::SyncedBuffer m_commandBuffer; /**< @deprecated will be removed in v2.0. buffer for commands */ }; }