From b59a9ec8b0a8f83b96f2df55b371a74bb1236851 Mon Sep 17 00:00:00 2001 From: Ray Zhang Date: Thu, 25 Apr 2019 19:19:38 +0800 Subject: [PATCH] commonsys-intf: display: Add SmoMo interface Add SmoMo interface header which defines display smooth motion functions. CRs-Fixed: 2400590 Change-Id: I0c2cc434a648202471c221f85ec6d48a0a314ee2 --- config/display-product-system.mk | 3 +- include/smomo_interface.h | 140 +++++++++++++++++++++++++++++++ 2 files changed, 142 insertions(+), 1 deletion(-) create mode 100644 include/smomo_interface.h diff --git a/config/display-product-system.mk b/config/display-product-system.mk index 7a2511c0..b18399d2 100644 --- a/config/display-product-system.mk +++ b/config/display-product-system.mk @@ -7,5 +7,6 @@ PRODUCT_PACKAGES += libdisplayconfig \ vendor.display.config@1.2 \ vendor.display.config@1.3 \ vendor.display.config@1.4 \ - vendor.display.config@1.5 + vendor.display.config@1.5 \ + libsmomo.qti diff --git a/include/smomo_interface.h b/include/smomo_interface.h new file mode 100644 index 00000000..ac785750 --- /dev/null +++ b/include/smomo_interface.h @@ -0,0 +1,140 @@ +/* +* Copyright (c) 2019, The Linux Foundation. All rights reserved. +* +* Redistribution and use in source and binary forms, with or without modification, are permitted +* provided that the following conditions are met: +* * Redistributions of source code must retain the above copyright notice, this list of +* conditions and the following disclaimer. +* * Redistributions in binary form must reproduce the above copyright notice, this list of +* conditions and the following disclaimer in the documentation and/or other materials provided +* with the distribution. +* * Neither the name of The Linux Foundation nor the names of its contributors may be used to +* endorse or promote products derived from this software without specific prior written +* permission. +* +* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +* NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; +* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +/*! @file smomo.h + @brief Interface file for SmoMo which defines the public interface exposed to SmoMo clients. + + @details SmoMo clients use these interfaces to feed SmoMo required info like frame rate, refresh + rate, these info are used to update SmoMo internal state. +*/ + +#ifndef __SMOMO_INTERFACE_H__ +#define __SMOMO_INTERFACE_H__ + +#include + +#include +#include + +namespace smomo { + +typedef int64_t nsecs_t; + +/*! @brief This structure defines the layer stats required by SmoMo. + + @sa SmomoIntf::updateSmomoState +*/ +struct SmomoLayerStats { + std::string name; // layer full name + int32_t id; // layer ID +}; + +/*! @brief This structure defines the buffer stats required by SmoMo. + + @sa SmomoIntf::CollectLayerStats + @sa SmomoIntf::ShouldPresentNow +*/ +struct SmomoBufferStats { + int32_t id; // layer ID + int32_t queued_frames; // queued frame count of this layer + bool auto_timestamp; // whether timestamp was generated automatically + nsecs_t timestamp; // layer buffer's timestamp +}; + +/*! @brief SmoMo interface implemented by SmoMo library. + + @details This class declares prototype for SmoMo public interfaces which must be + implemented by SmoMo library. SmoMo clients will use these methods to feed required + info to SmoMo implementation. +*/ +class SmomoIntf { + public: + virtual ~SmomoIntf() = default; + + /*! @brief Update SmoMo internal state. + + @details This function is called once per each composition so that required layer info are feed + to SmoMo, the SmoMo uses these info to update its internal state. + + @param[in] layers \link SmomoLayerStats \endlink + @param[in] refresh_rate current display refresh rate + + @return \link void \endlink + */ + virtual void UpdateSmomoState(const std::vector &layers, + float refresh_rate) = 0; + + /*! @brief Collect layer buffer stats. + + @details This function is called once new buffer is ready for this layer. It's used to collect + layer's buffer stats for SmoMo. + + @param[in] \link SmomoBufferStats \endlink + + @return \link void \endlink + */ + virtual void CollectLayerStats(const SmomoBufferStats &buffer_stats) = 0; + + /*! @brief Is this layer buffer ready to present. + + @details This function is called by SmoMo clients used to check whether this layer buffer is + due to present. + + @param[in] \link SmomoBufferStats \endlink + @param[in] next_vsync_time When next VSYNC arrives + + @return \link bool \endlink + */ + virtual bool ShouldPresentNow(const SmomoBufferStats &buffer_stats, + const nsecs_t next_vsync_time) = 0; + + /*! @brief Change refresh rate callback type definition. + */ + using ChangeRefreshRateCallback = std::function; + + /*! @brief Set the callback used by SmoMo to change display refresh rate. + + @details This function is called by SmoMo clients used to set the refresh rate callback. + + @param[in] callback \link ChangeRefreshRateCallback \endlink + + @return \link void \endlink + */ + virtual void SetChangeRefreshRateCallback( + const ChangeRefreshRateCallback& callback) = 0; + + /*! @brief Set the refersh rates supported by display. + + @details This function is called to tell SmoMo what refresh rates this display can suport. + + @param[in] refresh_rates The refresh rates list supported by the display + + @return \link void \endlink + */ + virtual void SetDisplayRefreshRates(const std::vector &refresh_rates) = 0; +}; + +} // namespace smomo + +#endif // __SMOMO_INTERFACE_H__