dali/internal/imaging/common/webp-loading.h

   1 #ifndef DALI_INTERNAL_WEBP_LOADING_H
   2 #define DALI_INTERNAL_WEBP_LOADING_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  21 #include <cstdint>
  22 #include <memory>
  23 #include <dali/public-api/math/rect.h>
  24 #include <dali/public-api/common/dali-vector.h>
  25 #include <dali/public-api/common/vector-wrapper.h>
  26 #include <dali/public-api/math/uint-16-pair.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/public-api/dali-adaptor-common.h>
  30 #include <dali/internal/imaging/common/animated-image-loading-impl.h>
  31
  32 namespace Dali
  33 {
  34 class PixelData;
  35 typedef Dali::Uint16Pair ImageDimensions;
  36
  37 namespace Internal
  38 {
  39
  40 namespace Adaptor
  41 {
  42
  43 /**
  44  * Class to manage loading frames of an animated webp in small chunks. Lazy initializes only when
  45  * data is actually needed.
  46  * Note, once the WEBP has loaded, the undecoded data will reside in memory until this object
  47  * is released. (This is to speed up frame loads, which would otherwise have to re-acquire the
  48  * data from disk)
  49  */
  50 class WebPLoading: public Internal::Adaptor::AnimatedImageLoading
  51 {
  52 public:
  53
  54   /**
  55    * Create a WebPLoading with the given url and resourceType.
  56    * @param[in] url The url of the webp image to load
  57    * @param[in] isLocalResource The true or false whether this is a local resource.
  58    * @return A newly created WebPLoading.
  59    */
  60   static AnimatedImageLoadingPtr New( const std::string& url, bool isLocalResource );
  61
  62   /**
  63    * @brief Constructor
  64    *
  65    * Construct a Loader with the given URL
  66    * @param[in] url The url of the webp image to load
  67    * @param[in] isLocalResource The true or false whether this is a local resource.
  68    */
  69   WebPLoading( const std::string& url, bool isLocalResource );
  70
  71
  72   /**
  73    * @brief Destructor
  74    */
  75   ~WebPLoading() override;
  76
  77   /**
  78    * @brief Load the next N Frames of the webp.
  79    *
  80    * @note This function will load the entire webp into memory if not already loaded.
  81    * @param[in] frameStartIndex The frame counter to start from. Will usually be the next frame
  82    * after the previous invocation of this method, or 0 to start.
  83    * @param[in] count The number of frames to load
  84    * @param[out] pixelData The vector in which to return the frame data
  85    * @return True if the frame data was successfully loaded
  86    */
  87   bool LoadNextNFrames( uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData ) override;
  88
  89    /**
  90    * @brief Load the next Frame of the animated image.
  91    *
  92    * @note This function will load the entire animated image into memory if not already loaded.
  93    * @param[in] frameIndex The frame counter to load. Will usually be the next frame.
  94    * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
  95    */
  96
  97   Dali::Devel::PixelBuffer LoadFrame( uint32_t frameIndex ) override;
  98
  99   /**
 100    * @brief Get the size of a webp image.
 101    *
 102    * @return The width and height in pixels of the webp image.
 103    */
 104   ImageDimensions GetImageSize() const override;
 105
 106   /**
 107    * @brief Get the number of frames in this webp.
 108    */
 109   uint32_t GetImageCount() const override;
 110
 111   /**
 112    * @brief Get the frame interval of the frame index
 113    *
 114    * @note The frame is needed to be loaded before this function is called.
 115    *
 116    * @return The time interval of the frame(microsecond).
 117    */
 118   uint32_t GetFrameInterval( uint32_t frameIndex ) const override;
 119
 120   std::string GetUrl() const override;
 121
 122 private:
 123   struct Impl;
 124   Impl* mImpl;
 125 };
 126
 127 } // namespace Adaptor
 128
 129 } // namespace Internal
 130
 131 } // namespace Dali
 132
 133 #endif // DALI_INTERNAL_WEBP_LOADING_H