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

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 // CLASS HEADER
  18 #include "rolling-gif-image-cache.h"
  19
  20 // EXTERNAL HEADERS
  21
  22 // INTERNAL HEADERS
  23 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
  24 #include <dali-toolkit/internal/visuals/image-atlas-manager.h> // For ImageAtlasManagerPtr
  25 #include <dali/integration-api/debug.h>
  26
  27 namespace
  28 {
  29 #if defined(DEBUG_ENABLED)
  30 Debug::Filter* gAnimImgLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_ANIMATED_IMAGE");
  31
  32 #define LOG_CACHE                                                       \
  33   {                                                                     \
  34     std::ostringstream oss;                                             \
  35     oss<<"Size:"<<mQueue.Count()<<" [ ";                                \
  36     for(std::size_t _i=0; _i<mQueue.Count(); ++_i)                      \
  37     {                                                                   \
  38       oss<<_i<<                                                         \
  39         "={ frm#: " << mQueue[_i].mFrameNumber <<                        \
  40            " tex: " << mImageUrls[mQueue[_i].mFrameNumber].mTextureId<<"}, ";  \
  41     }                                                                   \
  42     oss<<" ]"<<std::endl;                                               \
  43     DALI_LOG_INFO(gAnimImgLogFilter,Debug::Concise,"%s",oss.str().c_str()); \
  44   }
  45
  46 #else
  47   #define LOG_CACHE
  48 #endif
  49
  50 const bool ENABLE_ORIENTATION_CORRECTION( true );
  51
  52 }
  53
  54 namespace Dali
  55 {
  56 namespace Toolkit
  57 {
  58 namespace Internal
  59 {
  60
  61 RollingGifImageCache::RollingGifImageCache(
  62   TextureManager& textureManager, GifLoading& gifLoading, uint32_t frameCount, ImageCache::FrameReadyObserver& observer,
  63   uint16_t cacheSize, uint16_t batchSize )
  64 : ImageCache( textureManager, observer, batchSize ),
  65   mGifLoading( gifLoading ),
  66   mFrameCount( frameCount ),
  67   mFrameIndex( 0 ),
  68   mCacheSize( cacheSize ),
  69   mQueue( cacheSize )
  70 {
  71   mImageUrls.resize( mFrameCount );
  72   LoadBatch();
  73 }
  74
  75 RollingGifImageCache::~RollingGifImageCache()
  76 {
  77   while( !mQueue.IsEmpty() )
  78   {
  79     ImageFrame imageFrame = mQueue.PopFront();
  80     Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
  81   }
  82 }
  83
  84 TextureSet RollingGifImageCache::FirstFrame()
  85 {
  86   return GetFrontTextureSet();
  87 }
  88
  89 TextureSet RollingGifImageCache::NextFrame()
  90 {
  91   TextureSet textureSet;
  92
  93   ImageFrame imageFrame = mQueue.PopFront();
  94   Dali::Toolkit::TextureManager::RemoveTexture( mImageUrls[ imageFrame.mFrameNumber ].mUrl );
  95   mImageUrls[ imageFrame.mFrameNumber ].mTextureId = TextureManager::INVALID_TEXTURE_ID;
  96
  97   LoadBatch();
  98
  99   return GetFrontTextureSet();
 100 }
 101
 102 bool RollingGifImageCache::IsFrontReady() const
 103 {
 104   return ( !mQueue.IsEmpty() );
 105 }
 106
 107 void RollingGifImageCache::LoadBatch()
 108 {
 109   // Try and load up to mBatchSize images, until the cache is filled.
 110   // Once the cache is filled, as frames progress, the old frame is
 111   // removed, and another frame is loaded
 112
 113   std::vector<Dali::PixelData> pixelDataList;
 114
 115   // Get the smallest number of frames we need to load
 116   int batchSize = std::min( std::size_t(mBatchSize), mCacheSize - mQueue.Count() );
 117   DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingGifImageCache::LoadBatch() mFrameIndex:%d  batchSize:%d\n", mFrameIndex, batchSize );
 118
 119   if( mGifLoading.LoadNextNFrames(  mFrameIndex, batchSize, pixelDataList) )
 120   {
 121     unsigned int pixelDataListCount = pixelDataList.size();
 122
 123     for( unsigned int i = 0; i < pixelDataListCount && !mQueue.IsFull(); ++i )
 124     {
 125       ImageFrame imageFrame;
 126
 127       // create the texture for uploading the pixel data
 128       Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
 129                                       pixelDataList[i].GetPixelFormat(),
 130                                       pixelDataList[i].GetWidth(),
 131                                       pixelDataList[i].GetHeight() );
 132
 133       texture.Upload( pixelDataList[i] );
 134
 135       mImageUrls[ mUrlIndex ].mUrl = Dali::Toolkit::TextureManager::AddTexture(texture);
 136       imageFrame.mFrameNumber = mUrlIndex;
 137
 138       ++mUrlIndex;
 139       mUrlIndex %= mImageUrls.size();
 140
 141       mQueue.PushBack( imageFrame );
 142
 143       bool synchronousLoading = false;
 144       bool atlasingStatus = false;
 145       bool loadingStatus = false;
 146       TextureManager::MaskingDataPointer maskInfo = nullptr;
 147       AtlasUploadObserver* atlasObserver = nullptr;
 148       ImageAtlasManagerPtr imageAtlasManager = nullptr;
 149       Vector4 textureRect;
 150       auto preMultiply = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
 151
 152       mTextureManager.LoadTexture(
 153         mImageUrls[ imageFrame.mFrameNumber ].mUrl, ImageDimensions(), FittingMode::SCALE_TO_FILL,
 154         SamplingMode::BOX_THEN_LINEAR, maskInfo,
 155         synchronousLoading, mImageUrls[ imageFrame.mFrameNumber ].mTextureId, textureRect,
 156         atlasingStatus, loadingStatus, Dali::WrapMode::Type::DEFAULT,
 157         Dali::WrapMode::Type::DEFAULT, NULL,
 158         atlasObserver, imageAtlasManager, ENABLE_ORIENTATION_CORRECTION, TextureManager::ReloadPolicy::CACHED, preMultiply );
 159     }
 160
 161     mFrameIndex += batchSize;
 162     mFrameIndex %= mFrameCount;
 163   }
 164
 165   LOG_CACHE;
 166 }
 167
 168 TextureSet RollingGifImageCache::GetFrontTextureSet() const
 169 {
 170   DALI_LOG_INFO( gAnimImgLogFilter, Debug::Concise, "RollingGifImageCache::GetFrontTextureSet() FrameNumber:%d\n", mQueue[ 0 ].mFrameNumber );
 171
 172   TextureManager::TextureId textureId = GetCachedTextureId( 0 );
 173   return mTextureManager.GetTextureSet( textureId );
 174 }
 175
 176 TextureManager::TextureId RollingGifImageCache::GetCachedTextureId( int index ) const
 177 {
 178   return mImageUrls[ mQueue[ index ].mFrameNumber ].mTextureId;
 179 }
 180
 181 } //namespace Internal
 182 } //namespace Toolkit
 183 } //namespace Dali