dali-toolkit/internal/visuals/texture-manager-impl.h

   1 #ifndef DALI_TOOLKIT_TEXTURE_MANAGER_IMPL_H
   2 #define DALI_TOOLKIT_TEXTURE_MANAGER_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2017 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 <deque>
  22 #include <functional>
  23 #include <string>
  24 #include <memory>
  25 #include <dali/public-api/common/dali-vector.h>
  26 #include <dali/public-api/object/ref-object.h>
  27 #include <dali/public-api/rendering/texture-set.h>
  28 #include <dali/devel-api/common/owner-container.h>
  29 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali-toolkit/devel-api/image-loader/async-image-loader-devel.h>
  33 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
  34 #include <dali-toolkit/public-api/image-loader/async-image-loader.h>
  35 #include <dali-toolkit/internal/visuals/texture-upload-observer.h>
  36 #include <dali-toolkit/internal/visuals/visual-url.h>
  37 #include <dali-toolkit/internal/helpers/round-robin-container-view.h>
  38 #include <dali-toolkit/internal/image-loader/async-image-loader-impl.h>
  39
  40
  41 namespace Dali
  42 {
  43
  44 namespace Toolkit
  45 {
  46
  47 namespace Internal
  48 {
  49 class ImageAtlasManager;
  50 typedef IntrusivePtr<ImageAtlasManager> ImageAtlasManagerPtr;
  51
  52 /**
  53  * The TextureManager provides a common Image loading API for Visuals.
  54  *
  55  * The TextureManager is responsible for providing sync, async, atlased and non-atlased loads.
  56  * Texture caching is provided and performed when possible.
  57  * Broken Images are automatically provided on load failure.
  58  */
  59 class TextureManager : public ConnectionTracker
  60 {
  61 public:
  62
  63   typedef int32_t TextureId;       ///< The TextureId type. This is used as a handle to refer to a particular Texture.
  64   static const int INVALID_TEXTURE_ID = -1; ///< Used to represent a null TextureId or error
  65
  66   /**
  67    * Whether the texture should be atlased or uploaded into it's own GPU texture
  68    */
  69   enum UseAtlas
  70   {
  71     NO_ATLAS,
  72     USE_ATLAS
  73   };
  74
  75   /**
  76    * Whether the pixel data should be kept in TextureManager, or uploaded for rendering
  77    */
  78   enum StorageType
  79   {
  80     KEEP_PIXEL_BUFFER,
  81     UPLOAD_TO_TEXTURE
  82   };
  83
  84   /**
  85    * Whether the texture should be loaded synchronously or asynchronously.
  86    */
  87   enum LoadType
  88   {
  89     LOAD_ASYNCHRONOUSLY,
  90     LOAD_SYNCHRONOUSLY
  91   };
  92
  93   /**
  94    * @brief The LoadState Enumeration represents the current state of a particular Texture's life-cycle.
  95    */
  96   enum LoadState
  97   {
  98     NOT_STARTED,     ///< Default
  99     LOADING,         ///< Loading has been started, but not finished.
 100     LOAD_FINISHED,   ///< Loading has finished. (for CPU storage only)
 101     WAITING_FOR_MASK,///< Loading has finished, but waiting for mask image
 102     UPLOADED,        ///< Uploaded and ready. (For GPU upload only)
 103     CANCELLED,       ///< Removed before loading completed
 104     LOAD_FAILED      ///< Async loading failed, e.g. connection problem
 105   };
 106
 107   /**
 108    * @brief Types of reloading policies
 109    */
 110   enum class ReloadPolicy
 111   {
 112     CACHED = 0,             ///< Loads cached texture if it exists.
 113     FORCED                  ///< Forces reloading of texture.
 114   };
 115
 116   /**
 117    * @brief Whether to multiply alpha into color channels on load
 118    */
 119   enum class MultiplyOnLoad
 120   {
 121     LOAD_WITHOUT_MULTIPLY = 0, ///< Don't modify the image
 122     MULTIPLY_ON_LOAD           ///< Multiply alpha into color channels on load
 123   };
 124
 125 public:
 126
 127   struct MaskingData
 128   {
 129     MaskingData();
 130     ~MaskingData() = default;
 131
 132     VisualUrl mAlphaMaskUrl;
 133     TextureManager::TextureId mAlphaMaskId;
 134     float mContentScaleFactor;
 135     bool mCropToMask;
 136   };
 137   using MaskingDataPointer = std::unique_ptr<MaskingData>;
 138
 139
 140   /**
 141    * Class to provide lifecycle event on destruction of texture manager.
 142    */
 143   struct LifecycleObserver
 144   {
 145     /**
 146      * Called shortly before the texture manager is destroyed.
 147      */
 148     virtual void TextureManagerDestroyed() = 0;
 149   };
 150
 151   /**
 152    * Constructor.
 153    */
 154   TextureManager();
 155
 156   /**
 157    * Destructor.
 158    */
 159   ~TextureManager();
 160
 161   // TextureManager Main API:
 162
 163   /**
 164    * @brief Requests an image load of the given URL.
 165    *
 166    * The parameters are used to specify how the image is loaded.
 167    * The observer has the UploadComplete method called when the load is ready.
 168    *
 169    * When the client has finished with the Texture, Remove() should be called.
 170    *
 171    * @param[in] url                   The URL of the image to load
 172    * @param[in] desiredSize           The size the image is likely to appear at. This can be set to 0,0 for automatic
 173    * @param[in] fittingMode           The FittingMode to use
 174    * @param[in] samplingMode          The SamplingMode to use
 175    * @param[in] maskInfo              Mask info structure
 176    * @param[in] synchronousLoading    true if the URL should be loaded synchronously
 177    * @param[out] textureId,           The textureId of the URL
 178    * @param[out] textureRect          The rectangle within the texture atlas that this URL occupies
 179    * @param[in,out] atlasingStatus    Set to USE_ATLAS to attempt atlasing. If atlasing fails, the image will still
 180    *                                  be loaded, and marked successful, but this will be set to false.
 181    *                                  If atlasing succeeds, this will be set to true.
 182    * @param[out] loadingStatus        The loading status of the texture
 183    * @param[in] wrapModeU             Horizontal Wrap mode
 184    * @param[in] wrapModeV             Vertical Wrap mode
 185    * @param[in] textureObserver       The client object should inherit from this and provide the "UploadCompleted" virtual.
 186    *                                  This is called when an image load completes (or fails).
 187    * @param[in] atlasObserver         This is used if the texture is atlased, and will be called instead of
 188    *                                  textureObserver.UploadCompleted
 189    * @param[in] imageAtlasManager     The atlas manager to use for atlasing textures
 190    * @param[in] orientationCorrection Whether to rotate image to match embedded orientation data
 191    * @param[in] reloadPolicy          Forces a reload of the texture even if already cached
 192    * @param[in,out] preMultiplyOnLoad True if the image color should be multiplied by it's alpha. Set to false if the
 193    *                                  image has no alpha channel
 194    *
 195    * @return                          The texture set containing the image, or empty if still loading.
 196    */
 197
 198   TextureSet LoadTexture( const VisualUrl&             url,
 199                           Dali::ImageDimensions        desiredSize,
 200                           Dali::FittingMode::Type      fittingMode,
 201                           Dali::SamplingMode::Type     samplingMode,
 202                           const MaskingDataPointer&    maskInfo,
 203                           bool                         synchronousLoading,
 204                           TextureManager::TextureId&   textureId,
 205                           Vector4&                     textureRect,
 206                           bool&                        atlasingStatus,
 207                           bool&                        loadingStatus,
 208                           Dali::WrapMode::Type         wrapModeU,
 209                           Dali::WrapMode::Type         wrapModeV,
 210                           TextureUploadObserver*       textureObserver,
 211                           AtlasUploadObserver*         atlasObserver,
 212                           ImageAtlasManagerPtr         imageAtlasManager,
 213                           bool                         orientationCorrection,
 214                           TextureManager::ReloadPolicy reloadPolicy,
 215                           MultiplyOnLoad&              preMultiplyOnLoad );
 216
 217   /**
 218    * @brief Requests an image load of the given URL.
 219    *
 220    * The parameters are used to specify how the image is loaded.
 221    * The observer has the UploadComplete method called when the load is ready.
 222    *
 223    * When the client has finished with the Texture, Remove() should be called.
 224    *
 225    * @param[in] url                   The URL of the image to load
 226    * @param[in] desiredSize           The size the image is likely to appear at. This can be set to 0,0 for automatic
 227    * @param[in] fittingMode           The FittingMode to use
 228    * @param[in] samplingMode          The SamplingMode to use
 229    * @param[in] useAtlasing           Set to USE_ATLAS to attempt atlasing. If atlasing fails, the image will still be loaded, and marked successful,
 230    *                                  but "useAtlasing" will be set to false in the "UploadCompleted" callback from the TextureManagerUploadObserver.
 231    * @param[in] observer              The client object should inherit from this and provide the "UploadCompleted" virtual.
 232    *                                  This is called when an image load completes (or fails).
 233    * @param[in] orientationCorrection Whether to rotate image to match embedded orientation data
 234    * @param[in] reloadPolicy          Forces a reload of the texture even if already cached
 235    * @param[in,out] preMultiplyOnLoad     True if the image color should be multiplied by it's alpha. Set to false if the image has no alpha channel
 236    * @return                          A TextureId to use as a handle to reference this Texture
 237    */
 238   TextureId RequestLoad( const VisualUrl&                   url,
 239                          const ImageDimensions              desiredSize,
 240                          FittingMode::Type                  fittingMode,
 241                          Dali::SamplingMode::Type           samplingMode,
 242                          const UseAtlas                     useAtlasing,
 243                          TextureUploadObserver*             observer,
 244                          bool                               orientationCorrection,
 245                          TextureManager::ReloadPolicy       reloadPolicy,
 246                          MultiplyOnLoad&                    preMultiplyOnLoad );
 247
 248   /**
 249    * @brief Requests an image load of the given URL, when the texture has
 250    * have loaded, it will perform a blend with the image mask, and upload
 251    * the blended texture.
 252    *
 253    * The parameters are used to specify how the image is loaded.
 254    * The observer has the UploadComplete method called when the load is ready.
 255    *
 256    * When the client has finished with the Texture, Remove() should be called.
 257    *
 258    * @param[in] url                   The URL of the image to load
 259    * @param[in] maskTextureId         The texture id of an image to mask this with
 260    *                                  (can be INVALID if no masking required)
 261    * @param[in] contentScale          The scale factor to apply to the image before masking
 262    * @param[in] desiredSize           The size the image is likely to appear at. This can be set to 0,0 for automatic
 263    * @param[in] fittingMode           The FittingMode to use
 264    * @param[in] samplingMode          The SamplingMode to use
 265    * @param[in] useAtlasing           Set to USE_ATLAS to attempt atlasing. If atlasing fails, the image will still
 266    *                                  be loaded, and marked successful,
 267    *                                  but "useAtlasing" will be set to false in the "UploadCompleted" callback from
 268    *                                  the TextureManagerUploadObserver.
 269    * @param[in] cropToMask            Only used with masking, this will crop the scaled image to the mask size.
 270    *                                  If false, then the mask will be scaled to fit the image before being applied.
 271    * @param[in] observer              The client object should inherit from this and provide the "UploadCompleted"
 272    *                                  virtual.
 273    *                                  This is called when an image load completes (or fails).
 274    * @param[in] orientationCorrection Whether to rotate image to match embedded orientation data
 275    * @param[in] reloadPolicy          Forces a reload of the texture even if already cached
 276    * @param[in] preMultiplyOnLoad     True if the image color should be multiplied by it's alpha. Set to false if the
 277    *                                  image has no alpha channel
 278    * @return                          A TextureId to use as a handle to reference this Texture
 279    */
 280   TextureId RequestLoad( const VisualUrl&                   url,
 281                          TextureId                          maskTextureId,
 282                          float                              contentScale,
 283                          const ImageDimensions              desiredSize,
 284                          FittingMode::Type                  fittingMode,
 285                          Dali::SamplingMode::Type           samplingMode,
 286                          const UseAtlas                     useAtlasing,
 287                          bool                               cropToMask,
 288                          TextureUploadObserver*             observer,
 289                          bool                               orientationCorrection,
 290                          TextureManager::ReloadPolicy       reloadPolicy,
 291                          MultiplyOnLoad&                    preMultiplyOnLoad );
 292
 293   /**
 294    * Requests a masking image to be loaded. This mask is not uploaded to GL,
 295    * instead, it is stored in CPU memory, and can be used for CPU blending.
 296    */
 297   TextureId RequestMaskLoad( const VisualUrl& maskUrl );
 298
 299   /**
 300    * @brief Remove a Texture from the TextureManager.
 301    *
 302    * Textures are cached and therefore only the removal of the last
 303    * occurrence of a Texture will cause its removal internally.
 304    *
 305    * @param[in] textureId The ID of the Texture to remove.
 306    */
 307   void Remove( const TextureManager::TextureId textureId );
 308
 309   /**
 310    * Get the visualUrl associated with the texture id
 311    */
 312   const VisualUrl& GetVisualUrl( TextureId textureId );
 313
 314   /**
 315    * @brief Get the current state of a texture
 316    * @param[in] textureId The texture id to query
 317    * @return The loading state if the texture is valid, or NOT_STARTED if the textureId
 318    * is not valid.
 319    */
 320   LoadState GetTextureState( TextureId textureId );
 321
 322   /**
 323    * @brief Get the associated texture set if the texture id is valid
 324    * @param[in] textureId The texture Id to look up
 325    * @return the associated texture set, or an empty handle if textureId is not valid
 326    */
 327   TextureSet GetTextureSet( TextureId textureId );
 328
 329   /**
 330    * Adds an external texture to the texture manager
 331    * @param[in] texture The texture to add
 332    * @return string containing the URL for the texture
 333    */
 334   std::string AddExternalTexture( TextureSet& texture );
 335
 336   /**
 337    * Removes an external texture from texture manager
 338    * @param[in] url The string containing the texture to remove
 339    * @return handle to the texture
 340    */
 341   TextureSet RemoveExternalTexture( const std::string& url );
 342
 343   /**
 344    * Add an observer to the object.
 345    * @param[in] observer The observer to add.
 346    */
 347   void AddObserver( TextureManager::LifecycleObserver& observer );
 348
 349   /**
 350    * Remove an observer from the object
 351    * @pre The observer has already been added.
 352    * @param[in] observer The observer to remove.
 353    */
 354   void RemoveObserver( TextureManager::LifecycleObserver& observer );
 355
 356 private:
 357
 358   /**
 359    * @brief Requests an image load of the given URL, when the texture has
 360    * have loaded, if there is a valid maskTextureId, it will perform a
 361    * CPU blend with the mask, and upload the blend texture.
 362    *
 363    * The parameters are used to specify how the image is loaded.
 364    * The observer has the UploadComplete method called when the load is ready.
 365    *
 366    * When the client has finished with the Texture, Remove() should be called.
 367    *
 368    * @param[in] url                   The URL of the image to load
 369    * @param[in] maskTextureId         The texture id of an image to use as a mask. If no mask is required, then set
 370    *                                  to INVALID_TEXTURE_ID
 371    * @param[in] contentScale          The scaling factor to apply to the content when masking
 372    * @param[in] desiredSize           The size the image is likely to appear at. This can be set to 0,0 for automatic
 373    * @param[in] fittingMode           The FittingMode to use
 374    * @param[in] samplingMode          The SamplingMode to use
 375    * @param[in] useAtlasing           Set to USE_ATLAS to attempt atlasing. If atlasing fails, the image will still be
 376    *                                  loaded, and marked successful, but "useAtlasing" will be set to false in the
 377    *                                  "UploadCompleted" callback from the TextureManagerUploadObserver.
 378    * @param[in] cropToMask            Whether to crop the target after masking, or scale the mask to the image before
 379    *                                  masking.
 380    * @param[in] storageType,          Whether the pixel data is stored in the cache or uploaded to the GPU
 381    * @param[in] observer              The client object should inherit from this and provide the "UploadCompleted"
 382    *                                  virtual.
 383    *                                  This is called when an image load completes (or fails).
 384    * @param[in] orientationCorrection Whether to rotate image to match embedded orientation data
 385    * @param[in] reloadPolicy          Forces a reload of the texture even if already cached
 386    * @param[in] preMultiplyOnLoad     True if the image color should be multiplied by it's alpha. Set to false if
 387    *                                  there is no alpha
 388    * @return                          A TextureId to use as a handle to reference this Texture
 389    */
 390   TextureId RequestLoadInternal(
 391     const VisualUrl&                    url,
 392     TextureId                           maskTextureId,
 393     float                               contentScale,
 394     const ImageDimensions               desiredSize,
 395     FittingMode::Type                   fittingMode,
 396     Dali::SamplingMode::Type            samplingMode,
 397     UseAtlas                            useAtlas,
 398     bool                                cropToMask,
 399     StorageType                         storageType,
 400     TextureUploadObserver*              observer,
 401     bool                                orientationCorrection,
 402     TextureManager::ReloadPolicy        reloadPolicy,
 403     MultiplyOnLoad&                     preMultiplyOnLoad );
 404
 405   /**
 406    * @brief Get the current state of a texture
 407    * @param[in] textureId The texture id to query
 408    * @return The loading state if the texture is valid, or NOT_STARTED if the textureId
 409    * is not valid.
 410    */
 411   LoadState GetTextureStateInternal( TextureId textureId );
 412
 413   typedef size_t TextureHash; ///< The type used to store the hash used for Texture caching.
 414
 415   /**
 416    * @brief This struct is used to manage the life-cycle of Texture loading and caching.
 417    */
 418   struct TextureInfo
 419   {
 420     TextureInfo( TextureId textureId,
 421                  TextureId maskTextureId,
 422                  const VisualUrl& url,
 423                  ImageDimensions desiredSize,
 424                  float scaleFactor,
 425                  FittingMode::Type fittingMode,
 426                  Dali::SamplingMode::Type samplingMode,
 427                  bool loadSynchronously,
 428                  bool cropToMask,
 429                  UseAtlas useAtlas,
 430                  TextureManager::TextureHash hash,
 431                  bool orientationCorrection,
 432                  bool preMultiplyOnLoad )
 433     : url( url ),
 434       desiredSize( desiredSize ),
 435       useSize( desiredSize ),
 436       atlasRect( 0.0f, 0.0f, 1.0f, 1.0f ), // Full atlas rectangle
 437       textureId( textureId ),
 438       maskTextureId( maskTextureId ),
 439       hash( hash ),
 440       scaleFactor( scaleFactor ),
 441       referenceCount( 1u ),
 442       loadState( NOT_STARTED ),
 443       fittingMode( fittingMode ),
 444       samplingMode( samplingMode ),
 445       storageType( UPLOAD_TO_TEXTURE ),
 446       loadSynchronously( loadSynchronously ),
 447       useAtlas( useAtlas ),
 448       cropToMask( cropToMask ),
 449       orientationCorrection( true ),
 450       preMultiplyOnLoad( preMultiplyOnLoad ),
 451       preMultiplied( false )
 452     {
 453     }
 454
 455     /**
 456      * Container type used to store all observer clients of this Texture
 457      */
 458     typedef Dali::Vector< TextureUploadObserver* > ObserverListType;
 459
 460     ObserverListType observerList; ///< Container used to store all observer clients of this Texture
 461     Toolkit::ImageAtlas atlas;     ///< The atlas this Texture lays within (if any)
 462     Devel::PixelBuffer pixelBuffer;///< The PixelBuffer holding the image data (May be empty after upload)
 463     TextureSet textureSet;         ///< The TextureSet holding the Texture
 464     VisualUrl url;                 ///< The URL of the image
 465     ImageDimensions desiredSize;   ///< The size requested
 466     ImageDimensions useSize;       ///< The size used
 467     Vector4 atlasRect;             ///< The atlas rect used if atlased
 468     TextureId textureId;           ///< The TextureId associated with this Texture
 469     TextureId maskTextureId;       ///< The mask TextureId to be applied on load
 470     TextureManager::TextureHash hash; ///< The hash used to cache this Texture
 471     float scaleFactor;             ///< The scale factor to apply to the Texture when masking
 472     int16_t referenceCount;        ///< The reference count of clients using this Texture
 473     LoadState loadState:3;         ///< The load state showing the load progress of the Texture
 474     FittingMode::Type fittingMode:2; ///< The requested FittingMode
 475     Dali::SamplingMode::Type samplingMode:3; ///< The requested SamplingMode
 476     StorageType storageType:1;     ///< CPU storage / GPU upload;
 477     bool loadSynchronously:1;      ///< True if synchronous loading was requested
 478     UseAtlas useAtlas:1;           ///< USE_ATLAS if an atlas was requested.
 479                                    ///< This is updated to false if atlas is not used
 480     bool cropToMask:1;             ///< true if the image should be cropped to the mask size.
 481     bool orientationCorrection:1;  ///< true if the image should be rotated to match exif orientation data
 482     bool preMultiplyOnLoad:1;      ///< true if the image's color should be multiplied by it's alpha
 483     bool preMultiplied:1;          ///< true if the image's color was multiplied by it's alpha
 484   };
 485
 486   // Structs:
 487
 488   /**
 489    * Struct to hold information about a requested Async load.
 490    * This is used to look up a TextureManager::TextureId from the returned AsyncLoad Id.
 491    */
 492   struct AsyncLoadingInfo
 493   {
 494     AsyncLoadingInfo( TextureId textureId )
 495     : textureId( textureId ),
 496       loadId( 0 )
 497     {
 498     }
 499
 500     TextureId           textureId;   ///< The external Texture Id assigned to this load
 501     uint32_t            loadId;      ///< The load Id used by the async loader to reference this load
 502   };
 503
 504   // Private typedefs:
 505
 506   typedef std::deque<AsyncLoadingInfo>  AsyncLoadingInfoContainerType;  ///< The container type used to manage Asynchronous loads in progress
 507   typedef std::vector<TextureInfo>      TextureInfoContainerType;       ///< The container type used to manage the life-cycle and caching of Textures
 508
 509   /**
 510    * @brief Used internally to initiate a load.
 511    * @param[in] textureInfo The TextureInfo struct associated with the Texture
 512    * @return                True if the load was initiated
 513    */
 514   bool LoadTexture( TextureInfo& textureInfo );
 515
 516   /**
 517    * Add the observer to the observer list
 518    * @param[in] textureInfo The TextureInfo struct associated with the texture
 519    * observer The observer wishing to observe the texture upload
 520    */
 521   void ObserveTexture( TextureInfo & textureInfo, TextureUploadObserver* observer );
 522
 523   /**
 524    * @brief This signal handler is called when the async local loader finishes loading.
 525    * @param[in] id        This is the async image loaders Id
 526    * @param[in] pixelBuffer The loaded image data
 527    */
 528   void AsyncLocalLoadComplete( uint32_t id, Devel::PixelBuffer pixelBuffer );
 529
 530   /**
 531    * @brief This signal handler is called when the async local loader finishes loading.
 532    * @param[in] id        This is the async image loaders Id
 533    * @param[in] pixelBuffer The loaded image data
 534    */
 535   void AsyncRemoteLoadComplete( uint32_t id, Devel::PixelBuffer pixelBuffer );
 536
 537   /**
 538    * Common method to handle loading completion
 539    * @param[in] container The Async loading container
 540    * @param[in] id        This is the async image loaders Id
 541    * @param[in] pixelBuffer The loaded image data
 542    */
 543   void AsyncLoadComplete( AsyncLoadingInfoContainerType& container, uint32_t id, Devel::PixelBuffer pixelBuffer );
 544
 545   /**
 546    * @brief Performs Post-Load steps including atlasing.
 547    * @param[in] textureInfo The struct associated with this Texture
 548    * @param[in] pixelBuffer The image pixelBuffer
 549    * @return    True if successful
 550    */
 551   void PostLoad( TextureManager::TextureInfo& textureInfo, Devel::PixelBuffer& pixelBuffer );
 552
 553   /**
 554    * Check if there is a texture waiting to be masked. If there
 555    * is then apply this mask and upload it.
 556    * @param[in] maskTextureInfo The texture info of the mask that has just loaded.
 557    */
 558   void CheckForWaitingTexture( TextureInfo& maskTextureInfo );
 559
 560   /**
 561    * Apply the mask to the pixelBuffer.
 562    * @param[in] pixelBuffer The pixelBuffer to apply the mask to
 563    * @param[in] maskTextureId The texture id of the mask.
 564    * @param[in] contentScale The factor to scale the content
 565    * @param[in] cropToMask Whether to crop the content to the mask size
 566    */
 567   void ApplyMask( Devel::PixelBuffer& pixelBuffer, TextureId maskTextureId,
 568                   float contentScale, bool cropToMask );
 569
 570   /**
 571    * Upload the texture specified in pixelBuffer to the appropriate location
 572    * @param[in] pixelBuffer The image data to upload
 573    * @param[in] textureInfo The texture info containing the location to
 574    * store the data to.
 575    */
 576   void UploadTexture( Devel::PixelBuffer& pixelBuffer, TextureInfo& textureInfo );
 577
 578   /**
 579    * Mark the texture as complete, and inform observers
 580    * @param[in] textureInfo The struct associated with this Texture
 581    */
 582   void UploadComplete( TextureInfo& textureInfo );
 583
 584   /**
 585    * Notify the current observers that the texture upload is complete,
 586    * then remove the observers from the list.
 587    * @param[in] textureInfo The struct associated with this Texture
 588    * @param[in] success If the pixel data was retrieved successfully and uploaded to GPU
 589    */
 590   void NotifyObservers( TextureInfo& textureInfo, bool success );
 591
 592   /**
 593    * @brief Generates a new, unique TextureId
 594    * @return A unique TextureId
 595    */
 596   TextureManager::TextureId GenerateUniqueTextureId();
 597
 598   /**
 599    * @brief Used to lookup an index into the TextureInfoContainer from a TextureId
 600    * @param[in] textureId The TextureId to look up
 601    * @return              The cache index
 602    */
 603   int GetCacheIndexFromId( TextureId textureId );
 604
 605
 606   /**
 607    * @brief Generates a hash for caching based on the input parameters.
 608    * Only applies size, fitting mode andsampling mode if the size is specified.
 609    * Only applies maskTextureId if it isn't INVALID_TEXTURE_ID
 610    * Always applies useAtlas.
 611    * @param[in] url          The URL of the image to load
 612    * @param[in] size         The image size
 613    * @param[in] fittingMode  The FittingMode to use
 614    * @param[in] samplingMode The SamplingMode to use
 615    * @param[in] useAtlas     True if atlased
 616    * @param[in] maskTextureId The masking texture id (or INVALID_TEXTURE_ID)
 617    * @return                 A hash of the provided data for caching.
 618    */
 619   TextureHash GenerateHash( const std::string& url, const ImageDimensions size,
 620                             const FittingMode::Type fittingMode,
 621                             const Dali::SamplingMode::Type samplingMode, const UseAtlas useAtlas,
 622                             TextureId maskTextureId,
 623                             MultiplyOnLoad preMultiplyOnLoad);
 624   /**
 625    * @brief Looks up a cached texture by its hash.
 626    * If found, the given parameters are used to check there is no hash-collision.
 627    * @param[in] hash          The hash to look up
 628    * @param[in] url           The URL of the image to load
 629    * @param[in] size          The image size
 630    * @param[in] fittingMode   The FittingMode to use
 631    * @param[in] samplingMode  The SamplingMode to use
 632    * @param[in] useAtlas      True if atlased
 633    * @param[in] maskTextureId Optional texture ID to use to mask this image
 634    * @return A TextureId of a cached Texture if found. Or INVALID_TEXTURE_ID if not found.
 635    */
 636   TextureManager::TextureId FindCachedTexture(
 637     const TextureManager::TextureHash hash,
 638     const std::string& url,
 639     const ImageDimensions size,
 640     const FittingMode::Type fittingMode,
 641     const Dali::SamplingMode::Type samplingMode,
 642     const bool useAtlas,
 643     TextureId maskTextureId,
 644     MultiplyOnLoad preMultiplyOnLoad);
 645
 646 private:
 647
 648   /**
 649    * @brief Helper class to keep the relation between AsyncImageLoader and corresponding LoadingInfo container
 650    */
 651   class AsyncLoadingHelper : public ConnectionTracker
 652   {
 653   public:
 654     /**
 655      * @brief Create an AsyncLoadingHelper.
 656      * @param[in] textureManager Reference to the texture manager
 657      */
 658     AsyncLoadingHelper(TextureManager& textureManager);
 659
 660     /**
 661      * @brief Load a new texture.
 662      * @param[in] textureId             TextureId to reference the texture that will be loaded
 663      * @param[in] url                   The URL of the image to load
 664      * @param[in] desiredSize           The size the image is likely to appear at.
 665      *                                  This can be set to 0,0 for automatic
 666      * @param[in] fittingMode           The FittingMode to use
 667      * @param[in] samplingMode          The SamplingMode to use
 668      * @param[in] orientationCorrection Whether to use image metadata to rotate or flip the image,
 669      *                                  e.g., from portrait to landscape
 670      */
 671     void Load(TextureId textureId,
 672               const VisualUrl& url,
 673               ImageDimensions desiredSize,
 674               FittingMode::Type fittingMode,
 675               SamplingMode::Type samplingMode,
 676               bool orientationCorrection);
 677
 678   public:
 679     AsyncLoadingHelper(const AsyncLoadingHelper&) = delete;
 680     AsyncLoadingHelper& operator=(const AsyncLoadingHelper&) = delete;
 681
 682     AsyncLoadingHelper(AsyncLoadingHelper&& rhs);
 683     AsyncLoadingHelper& operator=(AsyncLoadingHelper&&rhs) = delete;
 684
 685   private:
 686     /**
 687      * @brief Main constructor that used by all other constructors
 688      */
 689     AsyncLoadingHelper(Toolkit::AsyncImageLoader loader,
 690                        TextureManager& textureManager,
 691                        AsyncLoadingInfoContainerType&& loadingInfoContainer);
 692
 693     /**
 694      * @brief Callback to be called when texture loading is complete, it passes the pixel buffer on to texture manager.
 695      * @param[in] id          Loader id
 696      * @param[in] pixelBuffer Image data
 697      */
 698     void AsyncLoadComplete(uint32_t id, Devel::PixelBuffer pixelBuffer);
 699
 700   private:
 701     Toolkit::AsyncImageLoader     mLoader;
 702     TextureManager&               mTextureManager;
 703     AsyncLoadingInfoContainerType mLoadingInfoContainer;
 704   };
 705
 706   struct ExternalTextureInfo
 707   {
 708     TextureId textureId;
 709     TextureSet textureSet;
 710   };
 711
 712 private:
 713
 714   /**
 715    * Deleted copy constructor.
 716    */
 717   TextureManager( const TextureManager& ) = delete;
 718
 719   /**
 720    * Deleted assignment operator.
 721    */
 722   TextureManager& operator=( const TextureManager& rhs ) = delete;
 723
 724   /**
 725    * This is called by the TextureManagerUploadObserver when an observer is destroyed.
 726    * We use the callback to know when to remove an observer from our notify list.
 727    * @param[in] observer The observer that generated the callback
 728    */
 729   void ObserverDestroyed( TextureUploadObserver* observer );
 730
 731 private:  // Member Variables:
 732
 733   TextureInfoContainerType                      mTextureInfoContainer; ///< Used to manage the life-cycle and caching of Textures
 734   RoundRobinContainerView< AsyncLoadingHelper > mAsyncLocalLoaders;    ///< The Asynchronous image loaders used to provide all local async loads
 735   RoundRobinContainerView< AsyncLoadingHelper > mAsyncRemoteLoaders;   ///< The Asynchronous image loaders used to provide all remote async loads
 736   std::vector< ExternalTextureInfo >            mExternalTextures;     ///< Externally provided textures
 737   Dali::Vector<LifecycleObserver*>              mLifecycleObservers;   ///< Lifecycle observers of texture manager
 738   TextureId                                     mCurrentTextureId;     ///< The current value used for the unique Texture Id generation
 739 };
 740
 741
 742 } // name Internal
 743
 744 } // namespace Toolkit
 745
 746 } // namespace Dali
 747
 748 #endif // DALI_TOOLKIT_TEXTURE_MANAGER_IMPL_H