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

   1 /*
   2  * Copyright (c) 2022 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
  18 // CLASS HEADER
  19 #include <dali/internal/imaging/common/webp-loading.h>
  20
  21 // EXTERNAL INCLUDES
  22 #ifdef DALI_WEBP_AVAILABLE
  23 #include <webp/decode.h>
  24 #include <webp/demux.h>
  25
  26 #if WEBP_DEMUX_ABI_VERSION > 0x0101
  27 #define DALI_ANIMATED_WEBP_ENABLED 1
  28 #endif
  29
  30 #endif
  31 #include <dali/integration-api/debug.h>
  32 #include <dali/public-api/images/pixel-data.h>
  33
  34 #include <dali/devel-api/threading/mutex.h>
  35 #include <dali/internal/imaging/common/file-download.h>
  36 #include <dali/internal/system/common/file-reader.h>
  37 #include <fcntl.h>
  38 #include <sys/stat.h>
  39 #include <sys/types.h>
  40 #include <unistd.h>
  41 #include <cstring>
  42
  43 // INTERNAL INCLUDES
  44 #include <dali/devel-api/adaptor-framework/image-loading.h>
  45 #include <dali/internal/imaging/common/pixel-buffer-impl.h>
  46
  47 typedef uint8_t WebPByteType;
  48
  49 namespace Dali
  50 {
  51 namespace Internal
  52 {
  53 namespace Adaptor
  54 {
  55 namespace
  56 {
  57 #if defined(DEBUG_ENABLED)
  58 Debug::Filter* gWebPLoadingLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_GIF_LOADING");
  59 #endif
  60
  61 static constexpr int32_t INITIAL_INDEX               = -1;
  62 static constexpr size_t  MAXIMUM_DOWNLOAD_IMAGE_SIZE = 50 * 1024 * 1024;
  63
  64 } // namespace
  65
  66 struct WebPLoading::Impl
  67 {
  68 public:
  69   Impl(const std::string& url, bool isLocalResource)
  70   : mFile(nullptr),
  71     mUrl(url),
  72     mFrameCount(1u),
  73     mMutex(),
  74     mBuffer(nullptr),
  75     mBufferSize(0u),
  76     mImageSize(),
  77     mLoadSucceeded(false),
  78     mIsAnimatedImage(false),
  79     mIsLocalResource(isLocalResource)
  80   {
  81   }
  82
  83   Impl(FILE* const fp)
  84   : mFile(fp),
  85     mUrl(),
  86     mFrameCount(1u),
  87     mMutex(),
  88     mBuffer(nullptr),
  89     mBufferSize(0u),
  90     mImageSize(),
  91     mLoadSucceeded(false),
  92     mIsAnimatedImage(false),
  93     mIsLocalResource(true)
  94   {
  95   }
  96
  97   bool LoadWebPInformation()
  98   {
  99     // Block to do not load this file again.
 100     Mutex::ScopedLock lock(mMutex);
 101     if(DALI_UNLIKELY(mLoadSucceeded))
 102     {
 103       return mLoadSucceeded;
 104     }
 105
 106 #ifndef DALI_WEBP_AVAILABLE
 107     // If the system doesn't support webp, loading will be failed.
 108     mFrameCount    = 0u;
 109     mLoadSucceeded = false;
 110     return mLoadSucceeded;
 111 #endif
 112
 113     // mFrameCount will be 1 if the input image is non-animated image or animated image with single frame.
 114     if(DALI_LIKELY(ReadWebPInformation()))
 115     {
 116 #ifdef DALI_WEBP_AVAILABLE
 117       WebPDataInit(&mWebPData);
 118       mWebPData.size  = mBufferSize;
 119       mWebPData.bytes = mBuffer;
 120
 121       WebPDemuxer* demuxer = WebPDemux(&mWebPData);
 122       uint32_t flags = WebPDemuxGetI(demuxer, WEBP_FF_FORMAT_FLAGS);
 123       if(flags & ANIMATION_FLAG)
 124       {
 125         mIsAnimatedImage = true;
 126       }
 127
 128       if(!mIsAnimatedImage)
 129       {
 130         int32_t imageWidth, imageHeight;
 131         if(WebPGetInfo(mBuffer, mBufferSize, &imageWidth, &imageHeight))
 132         {
 133           mImageSize = ImageDimensions(imageWidth, imageHeight);
 134         }
 135       }
 136 #endif
 137 #ifdef DALI_ANIMATED_WEBP_ENABLED
 138       if(mIsAnimatedImage)
 139       {
 140         WebPAnimDecoderOptions webPAnimDecoderOptions;
 141         WebPAnimDecoderOptionsInit(&webPAnimDecoderOptions);
 142         webPAnimDecoderOptions.color_mode = MODE_RGBA;
 143         mWebPAnimDecoder                  = WebPAnimDecoderNew(&mWebPData, &webPAnimDecoderOptions);
 144         WebPAnimDecoderGetInfo(mWebPAnimDecoder, &mWebPAnimInfo);
 145         mTimeStamp.assign(mWebPAnimInfo.frame_count, 0);
 146         mFrameCount = mWebPAnimInfo.frame_count;
 147         mImageSize  = ImageDimensions(mWebPAnimInfo.canvas_width, mWebPAnimInfo.canvas_height);
 148       }
 149 #endif
 150       mLoadSucceeded = true;
 151     }
 152     else
 153     {
 154       mFrameCount    = 0u;
 155       mLoadSucceeded = false;
 156       DALI_LOG_ERROR("Image loading failed for: \"%s\".\n", mUrl.c_str());
 157     }
 158
 159     return mLoadSucceeded;
 160   }
 161
 162   bool ReadWebPInformation()
 163   {
 164     mBufferSize = 0;
 165
 166     FILE*                                           fp = mFile;
 167     std::unique_ptr<Internal::Platform::FileReader> fileReader;
 168     Dali::Vector<uint8_t>                           dataBuffer;
 169     if(fp == nullptr)
 170     {
 171       if(mIsLocalResource)
 172       {
 173         fileReader = std::make_unique<Internal::Platform::FileReader>(mUrl);
 174       }
 175       else
 176       {
 177         size_t dataSize;
 178         if(DALI_LIKELY(TizenPlatform::Network::DownloadRemoteFileIntoMemory(mUrl, dataBuffer, dataSize, MAXIMUM_DOWNLOAD_IMAGE_SIZE)))
 179         {
 180           mBufferSize = dataBuffer.Size();
 181           if(DALI_LIKELY(mBufferSize > 0U))
 182           {
 183             // Open a file handle on the memory buffer:
 184             fileReader = std::make_unique<Internal::Platform::FileReader>(dataBuffer, mBufferSize);
 185           }
 186         }
 187       }
 188
 189       if(fileReader)
 190       {
 191         fp = fileReader->GetFile();
 192       }
 193     }
 194
 195     if(DALI_LIKELY(fp != nullptr))
 196     {
 197       if(mBufferSize == 0)
 198       {
 199         if(DALI_UNLIKELY(fseek(fp, 0, SEEK_END) <= -1))
 200         {
 201           return false;
 202         }
 203         mBufferSize = ftell(fp);
 204       }
 205
 206       if(DALI_LIKELY(!fseek(fp, 0, SEEK_SET)))
 207       {
 208         mBuffer     = reinterpret_cast<WebPByteType*>(malloc(sizeof(WebPByteType) * mBufferSize));
 209         mBufferSize = fread(mBuffer, sizeof(WebPByteType), mBufferSize, fp);
 210         return true;
 211       }
 212     }
 213     return false;
 214   }
 215
 216   void ReleaseResource()
 217   {
 218 #ifdef DALI_WEBP_AVAILABLE
 219     if(&mWebPData != nullptr)
 220     {
 221       mWebPData.bytes = nullptr;
 222       WebPDataInit(&mWebPData);
 223     }
 224 #endif
 225 #ifdef DALI_ANIMATED_WEBP_ENABLED
 226     if(mIsAnimatedImage)
 227     {
 228       if(mWebPAnimDecoder != nullptr)
 229       {
 230         WebPAnimDecoderDelete(mWebPAnimDecoder);
 231         mWebPAnimDecoder = nullptr;
 232       }
 233     }
 234 #endif
 235     if(mBuffer != nullptr)
 236     {
 237       free((void*)mBuffer);
 238       mBuffer = nullptr;
 239     }
 240   }
 241
 242   // Moveable but not copyable
 243
 244   Impl(const Impl&) = delete;
 245   Impl& operator=(const Impl&) = delete;
 246   Impl(Impl&&)                 = default;
 247   Impl& operator=(Impl&&) = default;
 248
 249   ~Impl()
 250   {
 251     ReleaseResource();
 252   }
 253
 254   FILE*                 mFile;
 255   std::string           mUrl;
 256   std::vector<uint32_t> mTimeStamp;
 257   int32_t               mLatestLoadedFrame{INITIAL_INDEX};
 258   uint32_t              mFrameCount;
 259   Mutex                 mMutex;
 260   // For the case the system doesn't support DALI_ANIMATED_WEBP_ENABLED
 261   unsigned char*  mBuffer;
 262   uint32_t        mBufferSize;
 263   ImageDimensions mImageSize;
 264   bool            mLoadSucceeded;
 265   bool            mIsAnimatedImage;
 266   bool            mIsLocalResource;
 267
 268 #ifdef DALI_WEBP_AVAILABLE
 269   WebPData                 mWebPData{0};
 270 #endif
 271
 272 #ifdef DALI_ANIMATED_WEBP_ENABLED
 273   WebPAnimDecoder*         mWebPAnimDecoder{nullptr};
 274   WebPAnimInfo             mWebPAnimInfo{0};
 275   Dali::Devel::PixelBuffer mPreLoadedFrame{};
 276 #endif
 277 };
 278
 279 AnimatedImageLoadingPtr WebPLoading::New(const std::string& url, bool isLocalResource)
 280 {
 281 #ifndef DALI_ANIMATED_WEBP_ENABLED
 282   DALI_LOG_ERROR("The system does not support Animated WebP format.\n");
 283 #endif
 284   return AnimatedImageLoadingPtr(new WebPLoading(url, isLocalResource));
 285 }
 286
 287 AnimatedImageLoadingPtr WebPLoading::New(FILE* const fp)
 288 {
 289 #ifndef DALI_ANIMATED_WEBP_ENABLED
 290   DALI_LOG_ERROR("The system does not support Animated WebP format.\n");
 291 #endif
 292   return AnimatedImageLoadingPtr(new WebPLoading(fp));
 293 }
 294
 295 WebPLoading::WebPLoading(const std::string& url, bool isLocalResource)
 296 : mImpl(new WebPLoading::Impl(url, isLocalResource))
 297 {
 298 }
 299
 300 WebPLoading::WebPLoading(FILE* const fp)
 301 : mImpl(new WebPLoading::Impl(fp))
 302 {
 303 }
 304
 305 WebPLoading::~WebPLoading()
 306 {
 307   delete mImpl;
 308 }
 309
 310 Dali::Devel::PixelBuffer WebPLoading::LoadFrame(uint32_t frameIndex)
 311 {
 312   Dali::Devel::PixelBuffer pixelBuffer;
 313
 314   // If WebP file is still not loaded, Load the information.
 315   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 316   {
 317     if(DALI_UNLIKELY(!mImpl->LoadWebPInformation()))
 318     {
 319       mImpl->ReleaseResource();
 320       return pixelBuffer;
 321     }
 322   }
 323
 324   // WebPDecodeRGBA is faster than to use demux API for loading non-animated image.
 325   // If frame count is 1, use WebPDecodeRGBA api.
 326 #ifdef DALI_WEBP_AVAILABLE
 327   if(!mImpl->mIsAnimatedImage)
 328   {
 329     int32_t width, height;
 330     if(DALI_LIKELY(WebPGetInfo(mImpl->mBuffer, mImpl->mBufferSize, &width, &height)))
 331     {
 332       WebPBitstreamFeatures features;
 333       if(DALI_LIKELY(VP8_STATUS_NOT_ENOUGH_DATA != WebPGetFeatures(mImpl->mBuffer, mImpl->mBufferSize, &features)))
 334       {
 335         uint32_t channelNumber = (features.has_alpha) ? 4 : 3;
 336         uint8_t* frameBuffer   = nullptr;
 337         if(channelNumber == 4)
 338         {
 339           frameBuffer = WebPDecodeRGBA(mImpl->mBuffer, mImpl->mBufferSize, &width, &height);
 340         }
 341         else
 342         {
 343           frameBuffer = WebPDecodeRGB(mImpl->mBuffer, mImpl->mBufferSize, &width, &height);
 344         }
 345
 346         if(frameBuffer != nullptr)
 347         {
 348           Pixel::Format                     pixelFormat = (channelNumber == 4) ? Pixel::RGBA8888 : Pixel::RGB888;
 349           int32_t                           bufferSize  = width * height * Dali::Pixel::GetBytesPerPixel(pixelFormat);
 350           Internal::Adaptor::PixelBufferPtr internal =
 351             Internal::Adaptor::PixelBuffer::New(frameBuffer, bufferSize, width, height, width, pixelFormat);
 352           pixelBuffer = Devel::PixelBuffer(internal.Get());
 353         }
 354       }
 355     }
 356     // The single frame resource should be released after loading.
 357     mImpl->ReleaseResource();
 358   }
 359 #endif
 360
 361 #ifdef DALI_ANIMATED_WEBP_ENABLED
 362   if(mImpl->mIsAnimatedImage && mImpl->mBuffer != nullptr)
 363   {
 364     Mutex::ScopedLock lock(mImpl->mMutex);
 365     if(DALI_LIKELY(frameIndex < mImpl->mWebPAnimInfo.frame_count && mImpl->mLoadSucceeded))
 366     {
 367       DALI_LOG_INFO(gWebPLoadingLogFilter, Debug::Concise, "LoadFrame( frameIndex:%d )\n", frameIndex);
 368
 369       if(mImpl->mPreLoadedFrame && mImpl->mLatestLoadedFrame == static_cast<int32_t>(frameIndex))
 370       {
 371         pixelBuffer = mImpl->mPreLoadedFrame;
 372       }
 373       else
 374       {
 375         pixelBuffer = DecodeFrame(frameIndex);
 376       }
 377       mImpl->mPreLoadedFrame.Reset();
 378
 379       // If time stamp of next frame is unknown, load a frame more to know it.
 380       if(frameIndex + 1 < mImpl->mWebPAnimInfo.frame_count && mImpl->mTimeStamp[frameIndex + 1] == 0u)
 381       {
 382         mImpl->mPreLoadedFrame = DecodeFrame(frameIndex + 1);
 383       }
 384     }
 385     else
 386     {
 387       mImpl->ReleaseResource();
 388     }
 389   }
 390 #endif
 391   return pixelBuffer;
 392 }
 393
 394 Dali::Devel::PixelBuffer WebPLoading::DecodeFrame(uint32_t frameIndex)
 395 {
 396   Dali::Devel::PixelBuffer pixelBuffer;
 397 #ifdef DALI_ANIMATED_WEBP_ENABLED
 398   if(mImpl->mLatestLoadedFrame > static_cast<int32_t>(frameIndex))
 399   {
 400     mImpl->mLatestLoadedFrame = INITIAL_INDEX;
 401     WebPAnimDecoderReset(mImpl->mWebPAnimDecoder);
 402   }
 403
 404   uint8_t* frameBuffer = nullptr;
 405   int32_t  timestamp   = 0u;
 406   for(; mImpl->mLatestLoadedFrame < static_cast<int32_t>(frameIndex);)
 407   {
 408     WebPAnimDecoderGetNext(mImpl->mWebPAnimDecoder, &frameBuffer, &timestamp);
 409     mImpl->mTimeStamp[++mImpl->mLatestLoadedFrame] = timestamp;
 410   }
 411
 412   if(frameBuffer != nullptr)
 413   {
 414     const int bufferSize = mImpl->mWebPAnimInfo.canvas_width * mImpl->mWebPAnimInfo.canvas_height * sizeof(uint32_t);
 415     pixelBuffer          = Dali::Devel::PixelBuffer::New(mImpl->mWebPAnimInfo.canvas_width, mImpl->mWebPAnimInfo.canvas_height, Dali::Pixel::RGBA8888);
 416     memcpy(pixelBuffer.GetBuffer(), frameBuffer, bufferSize);
 417   }
 418
 419 #endif
 420   return pixelBuffer;
 421 }
 422
 423 ImageDimensions WebPLoading::GetImageSize() const
 424 {
 425   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 426   {
 427     mImpl->LoadWebPInformation();
 428   }
 429   return mImpl->mImageSize;
 430 }
 431
 432 uint32_t WebPLoading::GetImageCount() const
 433 {
 434   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 435   {
 436     mImpl->LoadWebPInformation();
 437   }
 438   return mImpl->mFrameCount;
 439 }
 440
 441 uint32_t WebPLoading::GetFrameInterval(uint32_t frameIndex) const
 442 {
 443   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 444   {
 445     DALI_LOG_ERROR("WebP file is still not loaded, this frame interval could not be correct value.\n");
 446   }
 447   if(frameIndex >= GetImageCount())
 448   {
 449     DALI_LOG_ERROR("Input frameIndex exceeded frame count of the WebP.");
 450     return 0u;
 451   }
 452   else
 453   {
 454     int32_t interval = 0u;
 455     if(GetImageCount() == 1u)
 456     {
 457       return 0u;
 458     }
 459     else if(frameIndex + 1 == GetImageCount())
 460     {
 461       // For the interval between last frame and first frame, use last interval again.
 462       interval = mImpl->mTimeStamp[frameIndex] - mImpl->mTimeStamp[frameIndex - 1];
 463     }
 464     else
 465     {
 466       interval = mImpl->mTimeStamp[frameIndex + 1] - mImpl->mTimeStamp[frameIndex];
 467     }
 468
 469     if(DALI_UNLIKELY(interval < 0))
 470     {
 471       DALI_LOG_ERROR("This interval value is not correct, because the frame still hasn't ever been decoded.");
 472       return 0u;
 473     }
 474     return static_cast<uint32_t>(interval);
 475   }
 476 }
 477
 478 std::string WebPLoading::GetUrl() const
 479 {
 480   return mImpl->mUrl;
 481 }
 482
 483 bool WebPLoading::HasLoadingSucceeded() const
 484 {
 485   return mImpl->mLoadSucceeded;
 486 }
 487
 488 } // namespace Adaptor
 489
 490 } // namespace Internal
 491
 492 } // namespace Dali