dali/internal/event/images/image-impl.h

   1 #ifndef __DALI_INTERNAL_IMAGE_H__
   2 #define __DALI_INTERNAL_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2014 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
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/images/image.h>
  26 #include <dali/public-api/images/native-image.h>
  27 #include <dali/public-api/object/base-object.h>
  28 #include <dali/internal/render/gl-resources/texture.h>
  29 #include <dali/internal/event/images/image-factory-cache.h>
  30 #include <dali/internal/event/resources/image-ticket.h>
  31 #include <dali/internal/event/resources/resource-client.h>
  32 #include <dali/internal/event/resources/resource-ticket-observer.h>
  33
  34 namespace Dali
  35 {
  36
  37 class NativeImage;
  38
  39 namespace Internal
  40 {
  41
  42 typedef Dali::Image::LoadPolicy    LoadPolicy;
  43 typedef Dali::Image::ReleasePolicy ReleasePolicy;
  44
  45 class Image;
  46 class ImageFactory;
  47 typedef IntrusivePtr<Image> ImagePtr;
  48
  49 const LoadPolicy    ImageLoadPolicyDefault    = Dali::Image::Immediate;
  50 const ReleasePolicy ImageReleasePolicyDefault = Dali::Image::Never;
  51
  52 /**
  53  * Image represents an image resource that can be added to actors etc.
  54  * When the Image object is created, resource loading will be attempted.
  55  * Provided this is successful, the resource will exist until the Image is destroyed.
  56  */
  57 class Image : public BaseObject, public ResourceTicketObserver
  58 {
  59 protected:
  60
  61   /**
  62    * A reference counted object may only be deleted by calling Unreference()
  63    */
  64   virtual ~Image();
  65
  66   /**
  67    * Constructor, with default parameters
  68    */
  69   Image(LoadPolicy loadPol=ImageLoadPolicyDefault, ReleasePolicy releasePol=ImageReleasePolicyDefault);
  70
  71 public:
  72   /**
  73    * Creates a pointer to an uninitialized Image object.
  74    * @return a pointer to a newly created object.
  75    */
  76   static ImagePtr New();
  77
  78   /**
  79    * Creates object and loads image from filesystem
  80    * the maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
  81    * @param [in] filename   the path of the image on the filesystem
  82    * @param [in] attributes requested parameters for loading (size, scaling etc.)
  83    *                        if width or height is specified as 0, the natural size will be used.
  84    * @param [in] loadPol controls time of loading a resource from the filesystem (default: load when Image is created).
  85    * @param [in] releasePol optionally relase memory when image is not visible on screen (default: keep image data until Image object is alive).
  86    * @return a pointer to a newly created object.
  87    */
  88   static ImagePtr New( const std::string& filename,
  89                        const Dali::ImageAttributes& attributes,
  90                        LoadPolicy loadPol=ImageLoadPolicyDefault,
  91                        ReleasePolicy releasePol=ImageReleasePolicyDefault );
  92
  93   /**
  94    * Creates object with already loaded NativeImage
  95    * the maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
  96    * @pre nativeImg should be initialised
  97    * @param [in] nativeImg already initialised NativeImage
  98    * @param [in] loadPol controls time of loading a resource from the filesystem (default: load when Image is created).
  99    * @param [in] releasePol optionally relase memory when image is not visible on screen (default: keep image data until Image object is alive).
 100    * @return a pointer to a newly created object.
 101    */
 102   static ImagePtr New( NativeImage& nativeImg,
 103                        LoadPolicy loadPol=ImageLoadPolicyDefault,
 104                        ReleasePolicy releasePol=ImageReleasePolicyDefault );
 105
 106   /**
 107    * @copydoc Dali::Image::GetLoadingState()
 108    */
 109   Dali::LoadingState GetLoadingState() const { return mTicket ? mTicket->GetLoadingState() : ResourceLoading; }
 110
 111   /**
 112    * @copydoc Dali::Image::GetLoadPolicy()
 113    */
 114   LoadPolicy GetLoadPolicy () const { return mLoadPolicy; }
 115
 116   /**
 117    * @copydoc Dali::Image::GetReleasePolicy()
 118    */
 119   ReleasePolicy GetReleasePolicy () const { return mReleasePolicy; }
 120
 121   /**
 122    * @copydoc Dali::Image::LoadingFinishedSignal()
 123    */
 124   Dali::Image::ImageSignalV2& LoadingFinishedSignal() { return mLoadingFinishedV2; }
 125
 126   /**
 127    * @copydoc Dali::Image::UploadedSignal()
 128    */
 129   Dali::Image::ImageSignalV2& UploadedSignal() { return mUploadedV2; }
 130
 131   /**
 132    * Connects a callback function with the object's signals.
 133    * @param[in] object The object providing the signal.
 134    * @param[in] tracker Used to disconnect the signal.
 135    * @param[in] signalName The signal to connect to.
 136    * @param[in] functor A newly allocated FunctorDelegate.
 137    * @return True if the signal was connected.
 138    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 139    */
 140   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 141
 142   /**
 143    * returns the Id used for lookups
 144    * @note if LoadPolicy::OnDemand is used and Image is off Stage, this will return 0.
 145    * @return the unique ID of the image data resource. This is actually also the same as Dali Texture id.
 146    */
 147   ResourceId GetResourceId() const;
 148
 149   /**
 150    * Get the attributes of the image.
 151    * Only to be used after the image has finished loading.
 152    * (Ticket's LoadingSucceeded callback was called)
 153    * Reflects the last cached values after a LoadComplete.
 154    * If requested width or height was 0, they are replaced by concrete dimensions.
 155    * @return a copy of the attributes
 156    */
 157   const Dali::ImageAttributes& GetAttributes() const;
 158
 159   /**
 160    * Get the width of the image.
 161    * Only to be used after the image has finished loading.
 162    * (Ticket's LoadingSucceeded callback was called)
 163    * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
 164    * Connect to SignalLoadingFinished or use GetLoadingState to make sure this value is actual.
 165    * @pre image should be loaded
 166    */
 167   unsigned int GetWidth() const;
 168
 169   /**
 170    * Get the height of the image.
 171    * Only to be used after the image has finished loading.
 172    * (Ticket's LoadingSucceeded callback was called)
 173    * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
 174    * Connect to SignalLoadingFinished or use GetLoadingState to make sure this value is actual.
 175    * @pre image should be loaded
 176    */
 177   unsigned int GetHeight() const;
 178
 179   /**
 180    * Return the natural size of the image.
 181    * This is the size that the loaded image will take
 182    */
 183   Vector2 GetNaturalSize() const;
 184
 185   /**
 186    * @copydoc Dali::Image::GetFilename()
 187    */
 188   const std::string& GetFilename() const;
 189
 190   /**
 191    * @copydoc Dali::Image::Reload()
 192    */
 193   void Reload();
 194
 195 public: // From ResourceTicketObserver
 196
 197   /**
 198    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingFailed()
 199    */
 200   virtual void ResourceLoadingFailed(const ResourceTicket& ticket);
 201
 202   /**
 203    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingSucceeded()
 204    */
 205   virtual void ResourceLoadingSucceeded(const ResourceTicket& ticket);
 206
 207   /**
 208    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceUploaded()
 209    */
 210   virtual void ResourceUploaded(const ResourceTicket& ticket);
 211
 212   /**
 213    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceSavingSucceeded()
 214    */
 215   virtual void ResourceSavingSucceeded( const ResourceTicket& ticket );
 216
 217   /**
 218    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceSavingFailed()
 219    */
 220   virtual void ResourceSavingFailed( const ResourceTicket& ticket );
 221
 222 public:
 223
 224   /**
 225    * Indicates that the image is used.
 226    */
 227   virtual void Connect();
 228
 229   /**
 230    * Indicates that the image is not used anymore.
 231    */
 232   virtual void Disconnect();
 233
 234 protected:
 235
 236   /**
 237    * Second stage initialization
 238    */
 239   void Initialize();
 240
 241 private:
 242
 243   /**
 244    * Helper method to set new resource ticket. Stops observing current ticket if any, and starts observing
 245    * the new one or just resets the intrusive pointer.
 246    * @param[in] ticket pointer to new resource Ticket or NULL.
 247    */
 248   void SetTicket( ResourceTicket* ticket );
 249
 250   /**
 251    * Helper method to determine if the filename indicates that the image has a 9 patch border.
 252    * @param[in] filename The filename to check
 253    * @return true if it is a 9 patch image
 254    */
 255   static bool IsNinePatchFileName( const std::string& filename );
 256
 257 protected: //@TODO these should not be protected
 258
 259   ImageFactory&  mImageFactory;
 260
 261   ImageFactoryCache::RequestPtr mRequest; ///< contains the initially requested attributes for image. Request is reissued when memory was released.
 262   ResourceTicketPtr mTicket;              ///< smart pointer to the ticket object that gets completed when load finishes
 263
 264   mutable unsigned int mWidth;     ///< natural width of the image, needs to be mutable for lazy resolving and as the API for GetWidth is const
 265   mutable unsigned int mHeight;    ///< natural height of the image, needs to be mutable for lazy resolving and as the API for GetHeight is const
 266
 267   unsigned int   mConnectionCount; ///< number of on-stage objects using this image
 268
 269   LoadPolicy     mLoadPolicy:2;    ///< 2 bits is enough space
 270   ReleasePolicy  mReleasePolicy:2; ///< 2 bits is enough space
 271
 272 private:
 273
 274   Dali::Image::ImageSignalV2 mLoadingFinishedV2;
 275   Dali::Image::ImageSignalV2 mUploadedV2;
 276
 277   // Changes scope, should be at end of class
 278   DALI_LOG_OBJECT_STRING_DECLARATION;
 279 };
 280
 281 } // namespace Internal
 282
 283 /**
 284  * Helper methods for public API.
 285  */
 286 inline Internal::Image& GetImplementation(Dali::Image& image)
 287 {
 288   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 289
 290   BaseObject& handle = image.GetBaseObject();
 291
 292   return static_cast<Internal::Image&>(handle);
 293 }
 294
 295 inline const Internal::Image& GetImplementation(const Dali::Image& image)
 296 {
 297   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 298
 299   const BaseObject& handle = image.GetBaseObject();
 300
 301   return static_cast<const Internal::Image&>(handle);
 302 }
 303
 304 } // namespace Dali
 305 #endif // __DALI_INTERNAL_IMAGE_H__