dali-toolkit/internal/visuals/animated-image/rolling-gif-image-cache.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_ROLLING_GIF_IMAGE_CACHE_H
   2 #define DALI_TOOLKIT_INTERNAL_ROLLING_GIF_IMAGE_CACHE_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 <dali/devel-api/adaptor-framework/gif-loading.h>
  22 #include <dali/devel-api/common/circular-queue.h>
  23 #include <dali-toolkit/internal/visuals/animated-image/image-cache.h>
  24 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
  25
  26 namespace Dali
  27 {
  28 namespace Toolkit
  29 {
  30 namespace Internal
  31 {
  32
  33 /**
  34  * Class to manage a rolling cache of GIF images, where the cache size
  35  * is smaller than the total number of images.
  36  *
  37  * Frames are always ready, so the observer.FrameReady callback is never triggered;
  38  * the FirstFrame and NextFrame APIs will always return a texture.
  39  */
  40 class RollingGifImageCache : public ImageCache
  41 {
  42 public:
  43   /**
  44    * Constructor.
  45    * @param[in] textureManager The texture manager
  46    * @param[in] gifLoader The loaded gif image
  47    * @param[in] frameCount The number of frames in the gif
  48    * @param[in] observer FrameReady observer
  49    * @param[in] cacheSize The size of the cache
  50    * @param[in] batchSize The size of a batch to load
  51    *
  52    * This will start loading textures immediately, according to the
  53    * batch and cache sizes.
  54    */
  55   RollingGifImageCache( TextureManager&                 textureManager,
  56                         GifLoading&                     gifLoader,
  57                         uint32_t                        frameCount,
  58                         ImageCache::FrameReadyObserver& observer,
  59                         uint16_t                        cacheSize,
  60                         uint16_t                        batchSize );
  61
  62   /**
  63    * Destructor
  64    */
  65   virtual ~RollingGifImageCache();
  66
  67   /**
  68    * Get the Nth frame. If it's not ready, this will trigger the
  69    * sending of FrameReady() when the image becomes ready.
  70    */
  71   TextureSet Frame( uint32_t frameIndex ) override;
  72
  73   /**
  74    * Get the first frame. If it's not ready, this will trigger the
  75    * sending of FrameReady() when the image becomes ready.
  76    */
  77   TextureSet FirstFrame() override;
  78
  79   /**
  80    * Get the next frame. If it's not ready, this will trigger the
  81    * sending of FrameReady() when the image becomes ready.
  82    * This will trigger the loading of the next batch.
  83    */
  84   TextureSet NextFrame() override;
  85
  86 private:
  87   /**
  88    * @return true if the front frame is ready
  89    */
  90   bool IsFrontReady() const;
  91
  92   /**
  93    * Load the next batch of images
  94    */
  95   void LoadBatch();
  96
  97   /**
  98    * Get the texture set of the front frame.
  99    * @return the texture set
 100    */
 101   TextureSet GetFrontTextureSet() const;
 102
 103   /**
 104    * Get the texture id of the given index
 105    */
 106   TextureManager::TextureId GetCachedTextureId( int index ) const;
 107
 108 private:
 109   /**
 110    * Secondary class to hold readiness and index into url
 111    */
 112   struct ImageFrame
 113   {
 114     unsigned int mFrameNumber = 0u;
 115   };
 116
 117   GifLoading&               mGifLoading;
 118   uint32_t                  mFrameCount;
 119   int                       mFrameIndex;
 120   std::vector<UrlStore>     mImageUrls;
 121   uint16_t                  mCacheSize;
 122   CircularQueue<ImageFrame> mQueue;
 123 };
 124
 125 } // namespace Internal
 126 } // namespace Toolkit
 127 } // namespace Dali
 128
 129 #endif