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    * @return a pointer to a newly created object.
  99    */
 100   static ImagePtr New( NativeImage& nativeImg );
 101
 102   /**
 103    * @copydoc Dali::Image::GetLoadingState()
 104    */
 105   Dali::LoadingState GetLoadingState() const { return mTicket ? mTicket->GetLoadingState() : ResourceLoading; }
 106
 107   /**
 108    * @copydoc Dali::Image::GetLoadPolicy()
 109    */
 110   LoadPolicy GetLoadPolicy () const { return mLoadPolicy; }
 111
 112   /**
 113    * @copydoc Dali::Image::GetReleasePolicy()
 114    */
 115   ReleasePolicy GetReleasePolicy () const { return mReleasePolicy; }
 116
 117   /**
 118    * @copydoc Dali::Image::LoadingFinishedSignal()
 119    */
 120   Dali::Image::ImageSignalV2& LoadingFinishedSignal() { return mLoadingFinishedV2; }
 121
 122   /**
 123    * @copydoc Dali::Image::UploadedSignal()
 124    */
 125   Dali::Image::ImageSignalV2& UploadedSignal() { return mUploadedV2; }
 126
 127   /**
 128    * Connects a callback function with the object's signals.
 129    * @param[in] object The object providing the signal.
 130    * @param[in] tracker Used to disconnect the signal.
 131    * @param[in] signalName The signal to connect to.
 132    * @param[in] functor A newly allocated FunctorDelegate.
 133    * @return True if the signal was connected.
 134    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 135    */
 136   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 137
 138   /**
 139    * returns the Id used for lookups
 140    * @note if LoadPolicy::OnDemand is used and Image is off Stage, this will return 0.
 141    * @return the unique ID of the image data resource. This is actually also the same as Dali Texture id.
 142    */
 143   ResourceId GetResourceId() const;
 144
 145   /**
 146    * Get the attributes of the image.
 147    * Only to be used after the image has finished loading.
 148    * (Ticket's LoadingSucceeded callback was called)
 149    * Reflects the last cached values after a LoadComplete.
 150    * If requested width or height was 0, they are replaced by concrete dimensions.
 151    * @return a copy of the attributes
 152    */
 153   const Dali::ImageAttributes& GetAttributes() const;
 154
 155   /**
 156    * Get the width of the image.
 157    * Only to be used after the image has finished loading.
 158    * (Ticket's LoadingSucceeded callback was called)
 159    * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
 160    * Connect to SignalLoadingFinished or use GetLoadingState to make sure this value is actual.
 161    * @pre image should be loaded
 162    */
 163   unsigned int GetWidth() const;
 164
 165   /**
 166    * Get the height of the image.
 167    * Only to be used after the image has finished loading.
 168    * (Ticket's LoadingSucceeded callback was called)
 169    * The returned value will reflect the true image dimensions once the asynchronous loading has finished.
 170    * Connect to SignalLoadingFinished or use GetLoadingState to make sure this value is actual.
 171    * @pre image should be loaded
 172    */
 173   unsigned int GetHeight() const;
 174
 175   /**
 176    * Return the natural size of the image.
 177    * This is the size that the loaded image will take
 178    */
 179   Vector2 GetNaturalSize() const;
 180
 181   /**
 182    * @copydoc Dali::Image::GetFilename()
 183    */
 184   const std::string& GetFilename() const;
 185
 186   /**
 187    * @copydoc Dali::Image::Reload()
 188    */
 189   void Reload();
 190
 191 public: // From ResourceTicketObserver
 192
 193   /**
 194    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingFailed()
 195    */
 196   virtual void ResourceLoadingFailed(const ResourceTicket& ticket);
 197
 198   /**
 199    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceLoadingSucceeded()
 200    */
 201   virtual void ResourceLoadingSucceeded(const ResourceTicket& ticket);
 202
 203   /**
 204    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceUploaded()
 205    */
 206   virtual void ResourceUploaded(const ResourceTicket& ticket);
 207
 208   /**
 209    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceSavingSucceeded()
 210    */
 211   virtual void ResourceSavingSucceeded( const ResourceTicket& ticket );
 212
 213   /**
 214    * @copydoc Dali::Internal::ResourceTicketObserver::ResourceSavingFailed()
 215    */
 216   virtual void ResourceSavingFailed( const ResourceTicket& ticket );
 217
 218 public:
 219
 220   /**
 221    * Indicates that the image is used.
 222    */
 223   virtual void Connect();
 224
 225   /**
 226    * Indicates that the image is not used anymore.
 227    */
 228   virtual void Disconnect();
 229
 230 protected:
 231
 232   /**
 233    * Second stage initialization
 234    */
 235   void Initialize();
 236
 237 private:
 238
 239   /**
 240    * Helper method to set new resource ticket. Stops observing current ticket if any, and starts observing
 241    * the new one or just resets the intrusive pointer.
 242    * @param[in] ticket pointer to new resource Ticket or NULL.
 243    */
 244   void SetTicket( ResourceTicket* ticket );
 245
 246   /**
 247    * Helper method to determine if the filename indicates that the image has a 9 patch border.
 248    * @param[in] filename The filename to check
 249    * @return true if it is a 9 patch image
 250    */
 251   static bool IsNinePatchFileName( const std::string& filename );
 252
 253 protected: //@TODO these should not be protected
 254
 255   ImageFactory&  mImageFactory;
 256
 257   ImageFactoryCache::RequestPtr mRequest; ///< contains the initially requested attributes for image. Request is reissued when memory was released.
 258   ResourceTicketPtr mTicket;              ///< smart pointer to the ticket object that gets completed when load finishes
 259
 260   mutable unsigned int mWidth;     ///< natural width of the image, needs to be mutable for lazy resolving and as the API for GetWidth is const
 261   mutable unsigned int mHeight;    ///< natural height of the image, needs to be mutable for lazy resolving and as the API for GetHeight is const
 262
 263   unsigned int   mConnectionCount; ///< number of on-stage objects using this image
 264
 265   LoadPolicy     mLoadPolicy:2;    ///< 2 bits is enough space
 266   ReleasePolicy  mReleasePolicy:2; ///< 2 bits is enough space
 267
 268 private:
 269
 270   Dali::Image::ImageSignalV2 mLoadingFinishedV2;
 271   Dali::Image::ImageSignalV2 mUploadedV2;
 272
 273   // Changes scope, should be at end of class
 274   DALI_LOG_OBJECT_STRING_DECLARATION;
 275 };
 276
 277 } // namespace Internal
 278
 279 /**
 280  * Helper methods for public API.
 281  */
 282 inline Internal::Image& GetImplementation(Dali::Image& image)
 283 {
 284   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 285
 286   BaseObject& handle = image.GetBaseObject();
 287
 288   return static_cast<Internal::Image&>(handle);
 289 }
 290
 291 inline const Internal::Image& GetImplementation(const Dali::Image& image)
 292 {
 293   DALI_ASSERT_ALWAYS( image && "Image handle is empty" );
 294
 295   const BaseObject& handle = image.GetBaseObject();
 296
 297   return static_cast<const Internal::Image&>(handle);
 298 }
 299
 300 } // namespace Dali
 301 #endif // __DALI_INTERNAL_IMAGE_H__