adaptors/devel-api/adaptor-framework/gif-loading.h

   1 #ifndef __DALI_INTERNAL_GIF_LOADING_H__
   2 #define __DALI_INTERNAL_GIF_LOADING_H__
   3
   4 /*
   5  * Copyright (c) 2018 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 namespace Dali
  29 {
  30 class PixelData;
  31 typedef Dali::Uint16Pair ImageDimensions;
  32
  33 /**
  34  * Class to manage loading frames of an animated gif in small chunks. Lazy initializes only when
  35  * data is actually needed.
  36  * Note, once the GIF has loaded, the undecoded data will reside in memory until this object
  37  * is released. (This is to speed up frame loads, which would otherwise have to re-acquire the
  38  * data from disk)
  39  */
  40 class DALI_IMPORT_API GifLoading
  41 {
  42 public:
  43
  44   /**
  45    * Create a GifLoading with the given url and resourceType.
  46    * @param[in] url The url of the gif image to load
  47    * @param[in] isLocalResource The true or false whether this is a local resource.
  48    * @return A newly created GifLoading.
  49    */
  50   static std::unique_ptr<GifLoading> New( const std::string& url, bool isLocalResource );
  51
  52   /**
  53    * @brief Constructor
  54    *
  55    * Construct a Loader with the given URL
  56    * @param[in] url The url of the gif image to load
  57    * @param[in] isLocalResource The true or false whether this is a local resource.
  58    */
  59   GifLoading( const std::string& url, bool isLocalResource );
  60
  61   // Moveable but not copyable
  62
  63   GifLoading( const GifLoading& ) = delete;
  64   GifLoading& operator=( const GifLoading& ) = delete;
  65   GifLoading( GifLoading&& ) = default;
  66   GifLoading& operator=( GifLoading&& ) = default;
  67
  68   /**
  69    * @brief Destructor
  70    */
  71   ~GifLoading();
  72
  73   /**
  74    * @brief Load the next N Frames of the gif.
  75    *
  76    * @note This function will load the entire gif into memory if not already loaded.
  77    * @param[in] frameStartIndex The frame counter to start from. Will usually be the next frame
  78    * after the previous invocation of this method, or 0 to start.
  79    * @param[in] count The number of frames to load
  80    * @param[out] pixelData The vector in which to return the frame data
  81    * @return True if the frame data was successfully loaded
  82    */
  83   bool LoadNextNFrames( int frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData );
  84
  85   /**
  86    * @brief Load all frames of an animated gif file.
  87    *
  88    * @note This function will load the entire gif into memory if not already loaded.
  89    *
  90    * @param[out] pixelData The loaded pixel data for each frame.
  91    * @param[out] frameDelays The loaded delay time for each frame.
  92    *
  93    * @return True if the loading succeeded, false otherwise.
  94    */
  95   bool LoadAllFrames( std::vector<Dali::PixelData>& pixelData, Dali::Vector<uint32_t>& frameDelays );
  96
  97   /**
  98    * @brief Get the size of a gif image.
  99    *
 100    * @note This function will load the entire gif into memory if not already loaded.
 101    *
 102    * @return The width and height in pixels of the gif image.
 103    */
 104   ImageDimensions GetImageSize();
 105
 106   /**
 107    * @brief Get the number of frames in this gif.
 108    *
 109    * @note This function will load the entire gif into memory if not already loaded.
 110    */
 111   int GetImageCount();
 112
 113   /**
 114    * @brief Load the frame delay counts into the provided array.
 115    *
 116    * @note This function will load the entire gif into memory if not already loaded.
 117    * @param[in] frameDelays a vector to write the frame delays into
 118    * @return true if the frame delays were successfully loaded
 119    */
 120   bool LoadFrameDelays( Dali::Vector<uint32_t>& frameDelays );
 121
 122 private:
 123   struct Impl;
 124   Impl* mImpl;
 125 };
 126
 127 } // namespace Dali
 128
 129 #endif // __DALI_INTERNAL_GIF_LOADING_H__