dali-toolkit/internal/image-loader/async-image-loader-impl.h

   1 #ifndef DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H
   2 #define DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2021 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/public-api/images/pixel-data.h>
  22 #include <dali/public-api/object/base-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/devel-api/image-loader/async-image-loader-devel.h>
  26 #include <dali-toolkit/internal/image-loader/image-load-thread.h>
  27 #include <dali-toolkit/public-api/image-loader/async-image-loader.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 namespace Internal
  34 {
  35 class AsyncImageLoader : public BaseObject
  36 {
  37 public:
  38   /**
  39    * Constructor
  40    */
  41   AsyncImageLoader();
  42
  43   /**
  44    * @copydoc Toolkit::AsyncImageLoader::New()
  45    */
  46   static IntrusivePtr<AsyncImageLoader> New();
  47
  48   /**
  49    * @copydoc Toolkit::AsyncImageLoader::LoadAnimatedImage( Dali::AnimatedImageLoading animatedImageLoading, uint32_t frameIndex )
  50    */
  51   uint32_t LoadAnimatedImage(Dali::AnimatedImageLoading animatedImageLoading,
  52                              uint32_t                   frameIndex);
  53
  54   /**
  55    * @copydoc Toolkit::AsyncImageLoader::Load( const std::string&, ImageDimensions, FittingMode::Type, SamplingMode::Type, bool , DevelAsyncImageLoader::PreMultiplyOnLoad )
  56    */
  57   uint32_t Load(const VisualUrl&                         url,
  58                 ImageDimensions                          dimensions,
  59                 FittingMode::Type                        fittingMode,
  60                 SamplingMode::Type                       samplingMode,
  61                 bool                                     orientationCorrection,
  62                 DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad);
  63
  64   /**
  65    * @brief Starts an mask applying task.
  66    * @param[in] pixelBuffer of the to be masked image
  67    * @param[in] maskPixelBuffer of the mask image
  68    * @param[in] contentScale The factor to scale the content
  69    * @param[in] cropToMask Whether to crop the content to the mask size
  70    * @param[in] preMultiplyOnLoad ON if the image color should be multiplied by it's alpha. Set to OFF if there is no alpha.
  71    * @return The loading task id
  72    */
  73   uint32_t ApplyMask(Devel::PixelBuffer                       pixelBuffer,
  74                      Devel::PixelBuffer                       maskPixelBuffer,
  75                      float                                    contentScale,
  76                      bool                                     cropToMask,
  77                      DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad);
  78
  79   /**
  80    * @copydoc Toolkit::AsyncImageLoader::ImageLoadedSignal
  81    */
  82   Toolkit::AsyncImageLoader::ImageLoadedSignalType& ImageLoadedSignal();
  83
  84   /**
  85    * @copydoc Toolkit::AsyncImageLoader::PixelBufferLoadedSignal
  86    */
  87   Toolkit::DevelAsyncImageLoader::PixelBufferLoadedSignalType& PixelBufferLoadedSignal();
  88
  89   /**
  90    * @copydoc Toolkit::AsyncImageLoader::Cancel
  91    */
  92   bool Cancel(uint32_t loadingTaskId);
  93
  94   /**
  95    * @copydoc Toolkit::AsyncImageLoader::CancelAll
  96    */
  97   void CancelAll();
  98
  99   /**
 100    * Process the completed loading task from the worker thread.
 101    */
 102   void ProcessLoadedImage();
 103
 104 protected:
 105   /**
 106    * Destructor
 107    */
 108   ~AsyncImageLoader() override;
 109
 110 private:
 111   Toolkit::AsyncImageLoader::ImageLoadedSignalType            mLoadedSignal;
 112   Toolkit::DevelAsyncImageLoader::PixelBufferLoadedSignalType mPixelBufferLoadedSignal;
 113
 114   ImageLoadThread mLoadThread;
 115   uint32_t        mLoadTaskId;
 116   bool            mIsLoadThreadStarted;
 117 };
 118
 119 } // namespace Internal
 120
 121 inline const Internal::AsyncImageLoader& GetImplementation(const Toolkit::AsyncImageLoader& handle)
 122 {
 123   DALI_ASSERT_ALWAYS(handle && "AsyncImageLoader handle is empty");
 124
 125   const BaseObject& object = handle.GetBaseObject();
 126
 127   return static_cast<const Internal::AsyncImageLoader&>(object);
 128 }
 129
 130 inline Internal::AsyncImageLoader& GetImplementation(Toolkit::AsyncImageLoader& handle)
 131 {
 132   DALI_ASSERT_ALWAYS(handle && "AsyncImageLoader handle is empty");
 133
 134   BaseObject& object = handle.GetBaseObject();
 135
 136   return static_cast<Internal::AsyncImageLoader&>(object);
 137 }
 138
 139 } // namespace Toolkit
 140
 141 } // namespace Dali
 142
 143 #endif // DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H