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