dali-toolkit/internal/visuals/animated-image/fixed-image-cache.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_FIXED_IMAGE_CACHE_H
   2 #define DALI_TOOLKIT_INTERNAL_FIXED_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-toolkit/internal/visuals/animated-image/image-cache.h>
  22 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal
  29 {
  30
  31 class FixedImageCache : public ImageCache, public TextureUploadObserver
  32 {
  33 public:
  34   /**
  35    * Constructor.
  36    * @param[in] textureManager The texture manager
  37    * @param[in] urlList List of urls to cache
  38    * @param[in] observer FrameReady observer
  39    * @param[in] batchSize The size of a batch to load
  40    *
  41    * This will start loading textures immediately, according to the
  42    * batch and cache sizes. The cache is as large as the number of urls.
  43    */
  44   FixedImageCache( TextureManager&                 textureManager,
  45                    UrlList&                        urlList,
  46                    ImageCache::FrameReadyObserver& observer,
  47                    unsigned int                    batchSize );
  48
  49   ~FixedImageCache() override;
  50
  51   /**
  52    * Get the Nth frame. If it's not ready, this will trigger the
  53    * sending of FrameReady() when the image becomes ready.
  54    */
  55   TextureSet Frame( uint32_t frameIndex ) override;
  56
  57   /**
  58    * Get the first frame. If it's not ready, this will trigger the
  59    * sending of FrameReady() when the image becomes ready.
  60    */
  61   TextureSet FirstFrame() override;
  62
  63   /**
  64    * Get the next frame. If it's not ready, this will trigger the
  65    * sending of FrameReady() when the image becomes ready.
  66    */
  67   TextureSet NextFrame() override;
  68
  69   /**
  70    * Get the interval of Nth frame.
  71    */
  72   uint32_t GetFrameInterval( uint32_t frameIndex ) const override;
  73
  74   /**
  75    * Get the current rendered frame index.
  76    * If there isn't any loaded frame, returns -1.
  77    */
  78   int32_t GetCurrentFrameIndex() const override;
  79
  80   /**
  81    * Get total frame count of the animated image file.
  82    */
  83   int32_t GetTotalFrameCount() const override;
  84
  85 private:
  86   /**
  87    * @return true if the front frame is ready
  88    */
  89   bool IsFrontReady() const;
  90
  91   /**
  92    * Load the next batch of images
  93    */
  94   void LoadBatch();
  95
  96   /**
  97    * Find the matching image frame, and set it to ready
  98    */
  99   void SetImageFrameReady( TextureManager::TextureId textureId );
 100
 101   /**
 102    * Get the texture set of the front frame.
 103    * @return the texture set
 104    */
 105   TextureSet GetFrontTextureSet() const;
 106
 107   /**
 108    * Check if the front frame has become ready - if so, inform observer
 109    * @param[in] wasReady Readiness before call.
 110    */
 111   void CheckFrontFrame( bool wasReady );
 112
 113 protected:
 114   void UploadComplete(
 115     bool           loadSuccess,
 116     int32_t        textureId,
 117     TextureSet     textureSet,
 118     bool           useAtlasing,
 119     const Vector4& atlasRect,
 120     bool           premultiplied ) override;
 121
 122   void LoadComplete(
 123     bool loadSuccess,
 124     Devel::PixelBuffer pixelBuffer,
 125     const VisualUrl& url,
 126     bool preMultiplied ) override;
 127
 128 private:
 129   std::vector<UrlStore>& mImageUrls;
 130   std::vector<bool> mReadyFlags;
 131   unsigned int      mFront;
 132 };
 133
 134 } //namespace Internal
 135 } //namespace Toolkit
 136 } //namespace Dali
 137
 138 #endif // DALI_TOOLKIT_INTERNAL_FIXED_IMAGE_CACHE_H