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

   1 /*
   2  * Copyright (c) 2024 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       WebPDemuxDelete(demuxer);
 128
 129       if(!mIsAnimatedImage)
 130       {
 131         int32_t imageWidth, imageHeight;
 132         if(WebPGetInfo(mBuffer, mBufferSize, &imageWidth, &imageHeight))
 133         {
 134           mImageSize = ImageDimensions(imageWidth, imageHeight);
 135         }
 136       }
 137 #endif
 138 #ifdef DALI_ANIMATED_WEBP_ENABLED
 139       if(mIsAnimatedImage)
 140       {
 141         WebPAnimDecoderOptions webPAnimDecoderOptions;
 142         WebPAnimDecoderOptionsInit(&webPAnimDecoderOptions);
 143         webPAnimDecoderOptions.color_mode = MODE_RGBA;
 144         mWebPAnimDecoder                  = WebPAnimDecoderNew(&mWebPData, &webPAnimDecoderOptions);
 145         WebPAnimDecoderGetInfo(mWebPAnimDecoder, &mWebPAnimInfo);
 146         mTimeStamp.assign(mWebPAnimInfo.frame_count, 0);
 147         mFrameCount = mWebPAnimInfo.frame_count;
 148         mImageSize  = ImageDimensions(mWebPAnimInfo.canvas_width, mWebPAnimInfo.canvas_height);
 149       }
 150 #endif
 151       mLoadSucceeded = true;
 152     }
 153     else
 154     {
 155       mFrameCount    = 0u;
 156       mLoadSucceeded = false;
 157       DALI_LOG_ERROR("Image loading failed for: \"%s\".\n", mUrl.c_str());
 158     }
 159
 160     return mLoadSucceeded;
 161   }
 162
 163   bool ReadWebPInformation()
 164   {
 165     mBufferSize = 0;
 166
 167     FILE*                                           fp = mFile;
 168     std::unique_ptr<Internal::Platform::FileReader> fileReader;
 169     Dali::Vector<uint8_t>                           dataBuffer;
 170     if(fp == nullptr)
 171     {
 172       if(mIsLocalResource)
 173       {
 174         fileReader = std::make_unique<Internal::Platform::FileReader>(mUrl);
 175       }
 176       else
 177       {
 178         size_t dataSize;
 179         if(DALI_LIKELY(TizenPlatform::Network::DownloadRemoteFileIntoMemory(mUrl, dataBuffer, dataSize, MAXIMUM_DOWNLOAD_IMAGE_SIZE)))
 180         {
 181           mBufferSize = dataBuffer.Size();
 182           if(DALI_LIKELY(mBufferSize > 0U))
 183           {
 184             // Open a file handle on the memory buffer:
 185             fileReader = std::make_unique<Internal::Platform::FileReader>(dataBuffer, mBufferSize);
 186           }
 187         }
 188       }
 189
 190       if(fileReader)
 191       {
 192         fp = fileReader->GetFile();
 193       }
 194     }
 195
 196     if(DALI_LIKELY(fp != nullptr))
 197     {
 198       if(mBufferSize == 0)
 199       {
 200         if(DALI_UNLIKELY(fseek(fp, 0, SEEK_END) <= -1))
 201         {
 202           return false;
 203         }
 204         mBufferSize = ftell(fp);
 205       }
 206
 207       if(DALI_LIKELY(!fseek(fp, 0, SEEK_SET)))
 208       {
 209         mBuffer = reinterpret_cast<WebPByteType*>(malloc(sizeof(WebPByteType) * mBufferSize));
 210         if(DALI_UNLIKELY(!mBuffer))
 211         {
 212           DALI_LOG_ERROR("malloc is failed. request malloc size : %zu\n", sizeof(WebPByteType) * mBufferSize);
 213           return false;
 214         }
 215         mBufferSize = fread(mBuffer, sizeof(WebPByteType), mBufferSize, fp);
 216         return true;
 217       }
 218     }
 219     return false;
 220   }
 221
 222   void ReleaseResource()
 223   {
 224 #ifdef DALI_WEBP_AVAILABLE
 225     mWebPData.bytes = nullptr;
 226     WebPDataInit(&mWebPData);
 227 #endif
 228 #ifdef DALI_ANIMATED_WEBP_ENABLED
 229     if(mIsAnimatedImage)
 230     {
 231       if(mWebPAnimDecoder != nullptr)
 232       {
 233         WebPAnimDecoderDelete(mWebPAnimDecoder);
 234         mWebPAnimDecoder = nullptr;
 235       }
 236     }
 237 #endif
 238     if(mBuffer != nullptr)
 239     {
 240       free((void*)mBuffer);
 241       mBuffer = nullptr;
 242     }
 243
 244     mLoadSucceeded = false;
 245   }
 246
 247   // Moveable but not copyable
 248
 249   Impl(const Impl&) = delete;
 250   Impl& operator=(const Impl&) = delete;
 251   Impl(Impl&&)                 = default;
 252   Impl& operator=(Impl&&) = default;
 253
 254   ~Impl()
 255   {
 256     ReleaseResource();
 257   }
 258
 259   FILE*                 mFile;
 260   std::string           mUrl;
 261   std::vector<uint32_t> mTimeStamp;
 262   int32_t               mLatestLoadedFrame{INITIAL_INDEX};
 263   uint32_t              mFrameCount;
 264   Mutex                 mMutex;
 265   // For the case the system doesn't support DALI_ANIMATED_WEBP_ENABLED
 266   unsigned char*  mBuffer;
 267   uint32_t        mBufferSize;
 268   ImageDimensions mImageSize;
 269   bool            mLoadSucceeded;
 270   bool            mIsAnimatedImage;
 271   bool            mIsLocalResource;
 272
 273 #ifdef DALI_WEBP_AVAILABLE
 274   WebPData mWebPData{0};
 275 #endif
 276
 277 #ifdef DALI_ANIMATED_WEBP_ENABLED
 278   WebPAnimDecoder*         mWebPAnimDecoder{nullptr};
 279   WebPAnimInfo             mWebPAnimInfo{0};
 280   Dali::Devel::PixelBuffer mPreLoadedFrame{};
 281 #endif
 282 };
 283
 284 AnimatedImageLoadingPtr WebPLoading::New(const std::string& url, bool isLocalResource)
 285 {
 286 #ifndef DALI_ANIMATED_WEBP_ENABLED
 287   DALI_LOG_ERROR("The system does not support Animated WebP format.\n");
 288 #endif
 289   return AnimatedImageLoadingPtr(new WebPLoading(url, isLocalResource));
 290 }
 291
 292 AnimatedImageLoadingPtr WebPLoading::New(FILE* const fp)
 293 {
 294 #ifndef DALI_ANIMATED_WEBP_ENABLED
 295   DALI_LOG_ERROR("The system does not support Animated WebP format.\n");
 296 #endif
 297   return AnimatedImageLoadingPtr(new WebPLoading(fp));
 298 }
 299
 300 WebPLoading::WebPLoading(const std::string& url, bool isLocalResource)
 301 : mImpl(new WebPLoading::Impl(url, isLocalResource))
 302 {
 303 }
 304
 305 WebPLoading::WebPLoading(FILE* const fp)
 306 : mImpl(new WebPLoading::Impl(fp))
 307 {
 308 }
 309
 310 WebPLoading::~WebPLoading()
 311 {
 312   delete mImpl;
 313 }
 314
 315 Dali::Devel::PixelBuffer WebPLoading::LoadFrame(uint32_t frameIndex, ImageDimensions desiredSize)
 316 {
 317   Dali::Devel::PixelBuffer pixelBuffer;
 318
 319   // If WebP file is still not loaded, Load the information.
 320   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 321   {
 322     if(DALI_UNLIKELY(!mImpl->LoadWebPInformation()))
 323     {
 324       mImpl->ReleaseResource();
 325       return pixelBuffer;
 326     }
 327   }
 328
 329   // WebPDecodeRGBA is faster than to use demux API for loading non-animated image.
 330   // If frame count is 1, use WebPDecodeRGBA api.
 331 #ifdef DALI_WEBP_AVAILABLE
 332   if(!mImpl->mIsAnimatedImage)
 333   {
 334     int32_t width, height;
 335     if(DALI_LIKELY(WebPGetInfo(mImpl->mBuffer, mImpl->mBufferSize, &width, &height)))
 336     {
 337       WebPBitstreamFeatures features;
 338       if(DALI_LIKELY(VP8_STATUS_NOT_ENOUGH_DATA != WebPGetFeatures(mImpl->mBuffer, mImpl->mBufferSize, &features)))
 339       {
 340         uint32_t channelNumber = (features.has_alpha) ? 4 : 3;
 341         uint8_t* frameBuffer   = nullptr;
 342
 343         if(desiredSize.GetWidth() > 0 && desiredSize.GetHeight() > 0)
 344         {
 345           const int desiredWidth  = desiredSize.GetWidth();
 346           const int desiredHeight = desiredSize.GetHeight();
 347
 348           WebPDecoderConfig config;
 349           if(!DALI_LIKELY(WebPInitDecoderConfig(&config)))
 350           {
 351             DALI_LOG_ERROR("WebPInitDecoderConfig is failed");
 352             return pixelBuffer;
 353           }
 354
 355           // Apply config for scaling
 356           config.options.use_scaling   = 1;
 357           config.options.scaled_width  = desiredWidth;
 358           config.options.scaled_height = desiredHeight;
 359
 360           if(channelNumber == 4)
 361           {
 362             config.output.colorspace = MODE_RGBA;
 363           }
 364           else
 365           {
 366             config.output.colorspace = MODE_RGB;
 367           }
 368
 369           if(WebPDecode(mImpl->mBuffer, mImpl->mBufferSize, &config) == VP8_STATUS_OK)
 370           {
 371             frameBuffer = config.output.u.RGBA.rgba;
 372           }
 373           else
 374           {
 375             DALI_LOG_ERROR("Webp Decoding with scaled size is failed \n");
 376           }
 377
 378           if(frameBuffer != nullptr)
 379           {
 380             Pixel::Format pixelFormat = (channelNumber == 4) ? Pixel::RGBA8888 : Pixel::RGB888;
 381             int32_t       bufferSize  = desiredWidth * desiredHeight * Dali::Pixel::GetBytesPerPixel(pixelFormat);
 382             pixelBuffer               = Dali::Devel::PixelBuffer::New(desiredWidth, desiredHeight, pixelFormat);
 383             memcpy(pixelBuffer.GetBuffer(), frameBuffer, bufferSize);
 384           }
 385
 386           WebPFreeDecBuffer(&config.output);
 387         }
 388         else
 389         {
 390           if(channelNumber == 4)
 391           {
 392             frameBuffer = WebPDecodeRGBA(mImpl->mBuffer, mImpl->mBufferSize, &width, &height);
 393           }
 394           else
 395           {
 396             frameBuffer = WebPDecodeRGB(mImpl->mBuffer, mImpl->mBufferSize, &width, &height);
 397           }
 398
 399           if(frameBuffer != nullptr)
 400           {
 401             Pixel::Format                     pixelFormat = (channelNumber == 4) ? Pixel::RGBA8888 : Pixel::RGB888;
 402             int32_t                           bufferSize  = width * height * Dali::Pixel::GetBytesPerPixel(pixelFormat);
 403             Internal::Adaptor::PixelBufferPtr internal    = Internal::Adaptor::PixelBuffer::New(frameBuffer, bufferSize, width, height, width, pixelFormat);
 404             pixelBuffer                                   = Devel::PixelBuffer(internal.Get());
 405           }
 406         }
 407       }
 408     }
 409     // The single frame resource should be released after loading.
 410     mImpl->ReleaseResource();
 411   }
 412 #endif
 413
 414 #ifdef DALI_ANIMATED_WEBP_ENABLED
 415   if(mImpl->mIsAnimatedImage && mImpl->mBuffer != nullptr)
 416   {
 417     Mutex::ScopedLock lock(mImpl->mMutex);
 418     if(DALI_LIKELY(frameIndex < mImpl->mWebPAnimInfo.frame_count && mImpl->mLoadSucceeded))
 419     {
 420       DALI_LOG_INFO(gWebPLoadingLogFilter, Debug::Concise, "LoadFrame( frameIndex:%d )\n", frameIndex);
 421
 422       if(mImpl->mPreLoadedFrame && mImpl->mLatestLoadedFrame == static_cast<int32_t>(frameIndex))
 423       {
 424         pixelBuffer = mImpl->mPreLoadedFrame;
 425       }
 426       else
 427       {
 428         pixelBuffer = DecodeFrame(frameIndex);
 429       }
 430       mImpl->mPreLoadedFrame.Reset();
 431
 432       // If time stamp of next frame is unknown, load a frame more to know it.
 433       if(frameIndex + 1 < mImpl->mWebPAnimInfo.frame_count && mImpl->mTimeStamp[frameIndex + 1] == 0u)
 434       {
 435         mImpl->mPreLoadedFrame = DecodeFrame(frameIndex + 1);
 436       }
 437     }
 438     else
 439     {
 440       mImpl->ReleaseResource();
 441     }
 442   }
 443 #endif
 444   return pixelBuffer;
 445 }
 446
 447 Dali::Devel::PixelBuffer WebPLoading::DecodeFrame(uint32_t frameIndex)
 448 {
 449   Dali::Devel::PixelBuffer pixelBuffer;
 450 #ifdef DALI_ANIMATED_WEBP_ENABLED
 451   if(mImpl->mLatestLoadedFrame >= static_cast<int32_t>(frameIndex))
 452   {
 453     mImpl->mLatestLoadedFrame = INITIAL_INDEX;
 454     WebPAnimDecoderReset(mImpl->mWebPAnimDecoder);
 455   }
 456
 457   uint8_t* frameBuffer = nullptr;
 458   int32_t  timestamp   = 0u;
 459   for(; mImpl->mLatestLoadedFrame < static_cast<int32_t>(frameIndex);)
 460   {
 461     WebPAnimDecoderGetNext(mImpl->mWebPAnimDecoder, &frameBuffer, &timestamp);
 462     mImpl->mTimeStamp[++mImpl->mLatestLoadedFrame] = timestamp;
 463   }
 464
 465   if(frameBuffer != nullptr)
 466   {
 467     const int bufferSize = mImpl->mWebPAnimInfo.canvas_width * mImpl->mWebPAnimInfo.canvas_height * sizeof(uint32_t);
 468     pixelBuffer          = Dali::Devel::PixelBuffer::New(mImpl->mWebPAnimInfo.canvas_width, mImpl->mWebPAnimInfo.canvas_height, Dali::Pixel::RGBA8888);
 469     memcpy(pixelBuffer.GetBuffer(), frameBuffer, bufferSize);
 470   }
 471
 472 #endif
 473   return pixelBuffer;
 474 }
 475
 476 ImageDimensions WebPLoading::GetImageSize() const
 477 {
 478   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 479   {
 480     mImpl->LoadWebPInformation();
 481   }
 482   return mImpl->mImageSize;
 483 }
 484
 485 uint32_t WebPLoading::GetImageCount() const
 486 {
 487   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 488   {
 489     mImpl->LoadWebPInformation();
 490   }
 491   return mImpl->mFrameCount;
 492 }
 493
 494 uint32_t WebPLoading::GetFrameInterval(uint32_t frameIndex) const
 495 {
 496   if(DALI_UNLIKELY(!mImpl->mLoadSucceeded))
 497   {
 498     DALI_LOG_ERROR("WebP file is still not loaded, this frame interval could not be correct value.\n");
 499   }
 500   if(frameIndex >= GetImageCount())
 501   {
 502     DALI_LOG_ERROR("Input frameIndex exceeded frame count of the WebP.");
 503     return 0u;
 504   }
 505   else
 506   {
 507     int32_t interval = 0u;
 508     if(GetImageCount() == 1u)
 509     {
 510       return 0u;
 511     }
 512     else if(frameIndex + 1 == GetImageCount())
 513     {
 514       // For the interval between last frame and first frame, use last interval again.
 515       interval = mImpl->mTimeStamp[frameIndex] - mImpl->mTimeStamp[frameIndex - 1];
 516     }
 517     else
 518     {
 519       interval = mImpl->mTimeStamp[frameIndex + 1] - mImpl->mTimeStamp[frameIndex];
 520     }
 521
 522     if(DALI_UNLIKELY(interval < 0))
 523     {
 524       DALI_LOG_ERROR("This interval value is not correct, because the frame still hasn't ever been decoded.");
 525       return 0u;
 526     }
 527     return static_cast<uint32_t>(interval);
 528   }
 529 }
 530
 531 std::string WebPLoading::GetUrl() const
 532 {
 533   return mImpl->mUrl;
 534 }
 535
 536 bool WebPLoading::HasLoadingSucceeded() const
 537 {
 538   return mImpl->mLoadSucceeded;
 539 }
 540
 541 } // namespace Adaptor
 542
 543 } // namespace Internal
 544
 545 } // namespace Dali