dali/devel-api/adaptor-framework/vector-animation-renderer-plugin.h

   1 #ifndef DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
   2 #define DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/rendering/renderer.h>
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/devel-api/adaptor-framework/vector-animation-renderer.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * VectorAnimationRendererPlugin is an abstract interface, used by dali-adaptor to render a vector animation.
  32  * A concrete implementation must be created for each platform and provided as a dynamic library which
  33  * will be loaded at run time by the adaptor.
  34  */
  35 class VectorAnimationRendererPlugin
  36 {
  37 public:
  38   using UploadCompletedSignalType = Dali::VectorAnimationRenderer::UploadCompletedSignalType;
  39   using VectorProperty            = Dali::VectorAnimationRenderer::VectorProperty;
  40
  41   /**
  42    * @brief Constructor
  43    */
  44   VectorAnimationRendererPlugin()
  45   {
  46   }
  47
  48   /**
  49    * @brief Destructor
  50    */
  51   virtual ~VectorAnimationRendererPlugin()
  52   {
  53   }
  54
  55   /**
  56    * @brief Finalizes the renderer. It will be called in the main thread.
  57    */
  58   virtual void Finalize() = 0;
  59
  60   /**
  61    * @brief Loads the animation file.
  62    *
  63    * @param[in] url The url of the vector animation file
  64    * @return True if loading success, false otherwise.
  65    */
  66   virtual bool Load(const std::string& url) = 0;
  67
  68   /**
  69    * @brief Sets the renderer used to display the result image.
  70    *
  71    * @param[in] renderer The renderer used to display the result image
  72    */
  73   virtual void SetRenderer(Renderer renderer) = 0;
  74
  75   /**
  76    * @brief Sets the target image size.
  77    *
  78    * @param[in] width The target image width
  79    * @param[in] height The target image height
  80    */
  81   virtual void SetSize(uint32_t width, uint32_t height) = 0;
  82
  83   /**
  84    * @brief Renders the content to the target buffer synchronously.
  85    *
  86    * @param[in] frameNumber The frame number to be rendered
  87    * @return True if the rendering success, false otherwise.
  88    */
  89   virtual bool Render(uint32_t frameNumber) = 0;
  90
  91   /**
  92    * @brief Gets the total number of frames of the file.
  93    *
  94    * @return The total number of frames
  95    */
  96   virtual uint32_t GetTotalFrameNumber() const = 0;
  97
  98   /**
  99    * @brief Gets the frame rate of the file.
 100    *
 101    * @return The frame rate of the file
 102    */
 103   virtual float GetFrameRate() const = 0;
 104
 105   /**
 106    * @brief Gets the default size of the file.
 107    *
 108    * @param[out] width The default width of the file
 109    * @param[out] height The default height of the file
 110    */
 111   virtual void GetDefaultSize(uint32_t& width, uint32_t& height) const = 0;
 112
 113   /**
 114    * @brief Gets the layer information of all the child layers.
 115    *
 116    * @param[out] map The layer information
 117    */
 118   virtual void GetLayerInfo(Property::Map& map) const = 0;
 119
 120   /**
 121    * @brief Gets the start frame and the end frame number of the composition marker.
 122    *
 123    * @param[in] marker The composition marker of the file
 124    * @param[out] startFrame The start frame number of the specified marker
 125    * @param[out] endFrame The end frame number of the specified marker
 126    * @return True if the marker is found in the file, false otherwise.
 127    *
 128    * @note https://helpx.adobe.com/after-effects/using/layer-markers-composition-markers.html
 129    * Markers exported from AfterEffect are used to describe a segment of an animation {comment/tag , startFrame, endFrame}
 130    * Marker can be use to devide a resource in to separate animations by tagging the segment with comment string,
 131    * start frame and duration of that segment.
 132    */
 133   virtual bool GetMarkerInfo(const std::string& marker, uint32_t& startFrame, uint32_t& endFrame) const = 0;
 134
 135   /**
 136    * @brief Invalidates the rendered buffer.
 137    * @note The upload completed signal will be emitted again.
 138    */
 139   virtual void InvalidateBuffer() = 0;
 140
 141   /**
 142    * @brief Sets property value for the specified keyPath. This keyPath can resolve to multiple contents.
 143    * In that case, the callback's value will apply to all of them.
 144    *
 145    * @param[in] keyPath The key path used to target a specific content or a set of contents that will be updated.
 146    * @param[in] property The property to set.
 147    * @param[in] callback The callback what gets called every time the animation is rendered.
 148    * @param[in] id The Id to specify the callback. It should be unique and will be passed when the callback is called.
 149    *
 150    * @note A callback of the following type may be used:
 151    * id  The id to specify the callback.
 152    * property The property that represent what you are trying to change.
 153    * frameNumber The current frame number.
 154    * It returns a Property::Value to set according to the property type.
 155    *
 156    * @code
 157    *   Property::Value MyFunction(int32_t id, VectorProperty property, uint32_t frameNumber);
 158    * @endcode
 159    *
 160    * The keypath should conatin object names separated by (.) and can handle globe(**) or wildchar(*).
 161    * Ownership of the callback is passed onto this class.
 162    */
 163   virtual void AddPropertyValueCallback(const std::string& keyPath, VectorProperty property, CallbackBase* callback, int32_t id) = 0;
 164
 165   /**
 166    * @brief Connect to this signal to be notified when the texture upload is completed.
 167    *
 168    * @return The signal to connect to.
 169    */
 170   virtual UploadCompletedSignalType& UploadCompletedSignal() = 0;
 171
 172   /**
 173    * @brief Function pointer called in adaptor to create a plugin instance.
 174    */
 175   using CreateVectorAnimationRendererFunction = VectorAnimationRendererPlugin* (*)();
 176 };
 177
 178 } // namespace Dali
 179
 180 #endif // DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H