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
  40   /**
  41    * @brief Constructor
  42    */
  43   VectorAnimationRendererPlugin()
  44   {
  45   }
  46
  47   /**
  48    * @brief Destructor
  49    */
  50   virtual ~VectorAnimationRendererPlugin()
  51   {
  52   }
  53
  54   /**
  55    * @brief Finalizes the renderer. It will be called in the main thread.
  56    */
  57   virtual void Finalize() = 0;
  58
  59   /**
  60    * @brief Loads the animation file.
  61    *
  62    * @param[in] url The url of the vector animation file
  63    * @return True if loading success, false otherwise.
  64    */
  65   virtual bool Load(const std::string& url) = 0;
  66
  67   /**
  68    * @brief Sets the renderer used to display the result image.
  69    *
  70    * @param[in] renderer The renderer used to display the result image
  71    */
  72   virtual void SetRenderer(Renderer renderer) = 0;
  73
  74   /**
  75    * @brief Sets the target image size.
  76    *
  77    * @param[in] width The target image width
  78    * @param[in] height The target image height
  79    */
  80   virtual void SetSize(uint32_t width, uint32_t height) = 0;
  81
  82   /**
  83    * @brief Renders the content to the target buffer synchronously.
  84    *
  85    * @param[in] frameNumber The frame number to be rendered
  86    * @return True if the rendering success, false otherwise.
  87    */
  88   virtual bool Render(uint32_t frameNumber) = 0;
  89
  90   /**
  91    * @brief Gets the total number of frames of the file.
  92    *
  93    * @return The total number of frames
  94    */
  95   virtual uint32_t GetTotalFrameNumber() const = 0;
  96
  97   /**
  98    * @brief Gets the frame rate of the file.
  99    *
 100    * @return The frame rate of the file
 101    */
 102   virtual float GetFrameRate() const = 0;
 103
 104   /**
 105    * @brief Gets the default size of the file.
 106    *
 107    * @param[out] width The default width of the file
 108    * @param[out] height The default height of the file
 109    */
 110   virtual void GetDefaultSize(uint32_t& width, uint32_t& height) const = 0;
 111
 112   /**
 113    * @brief Gets the layer information of all the child layers.
 114    *
 115    * @param[out] map The layer information
 116    */
 117   virtual void GetLayerInfo(Property::Map& map) const = 0;
 118
 119   /**
 120    * @brief Gets the start frame and the end frame number of the composition marker.
 121    *
 122    * @param[in] marker The composition marker of the file
 123    * @param[out] startFrame The start frame number of the specified marker
 124    * @param[out] endFrame The end frame number of the specified marker
 125    * @return True if the marker is found in the file, false otherwise.
 126    *
 127    * @note https://helpx.adobe.com/after-effects/using/layer-markers-composition-markers.html
 128    * Markers exported from AfterEffect are used to describe a segment of an animation {comment/tag , startFrame, endFrame}
 129    * Marker can be use to devide a resource in to separate animations by tagging the segment with comment string,
 130    * start frame and duration of that segment.
 131    */
 132   virtual bool GetMarkerInfo(const std::string& marker, uint32_t& startFrame, uint32_t& endFrame) const = 0;
 133
 134   /**
 135    * @brief Invalidates the rendered buffer.
 136    * @note The upload completed signal will be emitted again.
 137    */
 138   virtual void InvalidateBuffer() = 0;
 139
 140   /**
 141    * @brief Connect to this signal to be notified when the texture upload is completed.
 142    *
 143    * @return The signal to connect to.
 144    */
 145   virtual UploadCompletedSignalType& UploadCompletedSignal() = 0;
 146
 147   /**
 148    * @brief Function pointer called in adaptor to create a plugin instance.
 149    */
 150   using CreateVectorAnimationRendererFunction = VectorAnimationRendererPlugin* (*)();
 151 };
 152
 153 } // namespace Dali
 154
 155 #endif // DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H