1 #ifndef __DALI_INTERNAL_RESOURCE_MANAGER_H__
2 #define __DALI_INTERNAL_RESOURCE_MANAGER_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/public-api/images/image.h>
26 #include <dali/public-api/images/frame-buffer-image.h>
27 #include <dali/public-api/images/native-image-interface.h>
28 #include <dali/public-api/images/buffer-image.h>
29 #include <dali/devel-api/common/ref-counted-dali-vector.h>
30 #include <dali/devel-api/images/pixel-data.h>
32 #include <dali/integration-api/bitmap.h>
33 #include <dali/integration-api/platform-abstraction.h>
34 #include <dali/integration-api/resource-cache.h>
36 #include <dali/internal/common/message.h>
37 #include <dali/internal/event/common/event-thread-services.h>
38 #include <dali/internal/event/common/thread-local-storage.h>
39 #include <dali/internal/event/resources/resource-type-path.h>
40 #include <dali/internal/event/resources/resource-client-declarations.h>
41 #include <dali/internal/update/resources/resource-manager-declarations.h>
46 class NativeImageInterface;
55 class TextureMetadata;
56 class ImageAttributes;
58 // value types used by messages
59 template <> struct ParameterType< Integration::LoadResourcePriority >
60 : public BasicType< Integration::LoadResourcePriority > {};
61 template <> struct ParameterType< Pixel::Format >
62 : public BasicType< Pixel::Format > {};
63 template <> struct ParameterType< RenderBuffer::Format >
64 : public BasicType< RenderBuffer::Format > {};
65 template <> struct ParameterType< Integration::ResourceTypeId >
66 : public BasicType< Integration::ResourceTypeId > {};
72 class TextureCacheDispatcher;
75 class NotificationManager;
77 /** Raw bytes of a resource laid out exactly as it wouldbe in a file, but in memory. */
78 typedef Dali::RefCountedVector<uint8_t> RequestBuffer;
79 /** Counting smart pointer for managing a buffer of raw bytes. */
80 typedef IntrusivePtr<RequestBuffer> RequestBufferPtr;
83 * ResourceManager keeps track of resource loading requests, and caches resources that are loaded.
84 * It uses ResourceTicket objects, to keep track of the lifetime of each request.
85 * If the same resource is required by two client objects, they will share the same ResourceTicket
86 * i.e. only one load will occur using the native filesystem.
88 * Multi-threading notes:
89 * Resources are received from the PlatformAbstraction API during the Core::Render() method, which
90 * may be called from a dedicated rendering thread.
91 * Loading requests must be made from the application's main thread e.g. when Dali::Image is created.
93 class ResourceManager : public Integration::ResourceCache
98 * Create a resource manager.
99 * There should exactly one of these objects per Dali Core.
100 * @param[in] platformAbstraction Used to request resources from the native filesystem.
101 * @param[in] notificationManager Used to send NotifyTickets message.
102 * @param[in] textureUploadedProcessResourcesQueue Used for performing post processing on resources
103 * @param[in] discardQueue Used to cleanup nodes & resources when no longer in use.
104 * @param[in] renderQueue Used to queue resource updates until the next Render.
106 ResourceManager( Integration::PlatformAbstraction& platformAbstraction,
107 NotificationManager& notificationManager,
108 SceneGraph::TextureCacheDispatcher& textureCacheDispatcher,
109 LockedResourceQueue& textureUploadedProcessResourcesQueue,
110 SceneGraph::DiscardQueue& discardQueue,
111 SceneGraph::RenderQueue& renderQueue );
114 * Virtual destructor.
116 virtual ~ResourceManager();
118 public: // Used by ResourceClient
120 /********************************************************************************
121 ************************ ResourceClient direct interface **********************
122 ********************************************************************************/
125 * Resource client passes itself for secondary intialisation.
126 * (The resource client requires the ResourceManager to be instantiated first).
127 * @param[in] resourceClient The ResourceClient.
129 void SetClient( ResourceClient& resourceClient );
131 /********************************************************************************
132 ************************ UpdateManager direct interface ***********************
133 ********************************************************************************/
136 * Called to update the resource cache before rendering.
137 * New resources will be added to the cache using PlatformAbstraction::FillResourceCache().
138 * Unwanted resources will be added to the DiscardQueue.
139 * @param[in] updateBufferIndex The current update buffer index.
140 * @return true, if a resource load was completed or failed
142 bool UpdateCache( BufferIndex updateBufferIndex );
145 * Iterate through the post process queue, performing requested updates.
146 * @param[in] updateBufferIndex The current update buffer index.
148 void PostProcessResources( BufferIndex updateBufferIndex );
150 /********************************************************************************
151 *************************** CoreImpl direct interface *************************
152 ********************************************************************************/
155 * Returns whether the Resource Manager is still processing any resource requests.
156 * @return true if still processing, false otherwise.
158 bool ResourcesToProcess();
160 /********************************************************************************
161 ********************************* Message handlers *****************************
162 ********************************************************************************/
165 * Request a resource from the native filesystem.
166 * @param[in] id The Id of the requested resource
167 * @param[in] typePath The type & path of requested resource.
168 * @param[in] priority The priority of the request. This is ignored if the resource is already being loaded.
170 void HandleLoadResourceRequest( ResourceId id,
171 const ResourceTypePath& typePath,
172 Integration::LoadResourcePriority priority );
175 * Decode a resource from a memory buffer with the semantics of loading.
176 * Notifications of partial completion, success, and failure will happen via
177 * the same loading notification path used for loading from files: Update()
178 * will retrieve loading events in its main loop and notify listeners to its
179 * own loading events, and forward them, still as loading events, to the event
180 * thread via its update queue.
181 * Resource manager and lower levels make no attempt to detect resource
182 * aliases as is done for multiple requests to load the same resource
183 * file, so the caller is responsible for ensuring that it only requests
184 * the decoding of an in-memory resource once and for doing the sharing of the
185 * resulting object itself. Ultimately this responsibility resides with the
187 * @note ! Only Bitmap resources are supported for decoding from memory !
188 * @param[in] id The Id of the requested resource.
189 * @param[in] typePath The type of the requested resource and a path that is ignored.
190 * @param[in] buffer The raw encoded bytes of the resource as they would appear in a file.
191 * @param[in] priority The priority of the request. This is ignored if the resource is already being loaded.
193 void HandleDecodeResourceRequest( ResourceId id,
194 const ResourceTypePath& typePath,
195 RequestBufferPtr buffer,
196 Integration::LoadResourcePriority priority );
199 * Injects a bitmap resource (does not require loading).
200 * @pre bitmap has to be initialized
201 * @param[in] id The resource id
202 * @param[in] bitmap an initialized bitmap
204 void HandleAddBitmapImageRequest(ResourceId id, Integration::BitmapPtr bitmap);
207 * Add an existing resource to the resource manager.
208 * @param[in] id The resource id
209 * @param [in] resourceData the NativeImageInterface object
210 * @return A ref-counted request object. Keep a copy until the resource is no longer required.
212 void HandleAddNativeImageRequest( ResourceId id, NativeImageInterfacePtr resourceData );
215 * Add an existing resource to the resource manager.
216 * @param[in] id The resource id
217 * @param[in] width width in pixels
218 * @param[in] height height in pixels
219 * @param[in] pixelFormat Pixel format
221 void HandleAddFrameBufferImageRequest( ResourceId id, unsigned int width, unsigned int height, Pixel::Format pixelFormat, RenderBuffer::Format bufferFormat );
224 * Add an existing resource to the resource manager.
225 * @param[in] id The resource id
226 * @param[in] nativeImage The NativeImage
228 void HandleAddFrameBufferImageRequest( ResourceId id, NativeImageInterfacePtr nativeImage );
231 * Allocate a new empty texture.
232 * @param[in] id The resource id
233 * @param[in] width width in pixels
234 * @param[in] height height in pixels
235 * @param[in] pixelFormat Pixel format
237 void HandleAllocateTextureRequest( ResourceId id, unsigned int width, unsigned int height, Pixel::Format pixelFormat );
240 * Update bitmap area request
241 * @param[in] textureId The resource ID of a bitmap-texture to remove.
242 * @param[in] area The updated area. Zero width/height indicates the whole bitmap has been updated
244 void HandleUpdateBitmapAreaRequest( ResourceId textureId, const RectArea& area );
247 * Upload a bitmap to a position within a specified texture
248 * @param[in] destId The destination texture ID
249 * @param[in] bitmap The pointer pointing to the bitmap data to upload
250 * @param [in] xOffset Specifies an offset in the x direction within the texture
251 * @param [in] yOffset Specifies an offset in the y direction within the texture
253 void HandleUploadBitmapRequest( ResourceId destId, Integration::BitmapPtr bitmap, std::size_t xOffset, std::size_t yOffset );
256 * Upload a bitmap to a position within a specified texture
257 * @param[in] destId The destination texture ID
258 * @param[in] srcId The resource ID of the bitmap to upload
259 * @param [in] xOffset Specifies an offset in the x direction within the texture
260 * @param [in] yOffset Specifies an offset in the y direction within the texture
262 void HandleUploadBitmapRequest( ResourceId destId, ResourceId srcId, std::size_t xOffset, std::size_t yOffset );
265 * Upload a pixel buffer to a position within a specified texture
266 * @param[in] destId The destination texture ID
267 * @param[in] pixelData pointer pointing to the pixel data to upload
268 * @param [in] xOffset Specifies an offset in the x direction within the texture
269 * @param [in] yOffset Specifies an offset in the y direction within the texture
271 void HandleUploadBitmapRequest( ResourceId destId, PixelDataPtr pixelData, std::size_t xOffset, std::size_t yOffset );
274 * Request reloading a resource from the native filesystem.
275 * @param[in] id The resource id
276 * @param[in] typePath The type & path of the resource
277 * @param[in] priority The priority of the request. This is ignored if the resource is already being refreshed.
278 * @param[in] resetFinishedStatus True if the finished status of the resource id should be reset
280 void HandleReloadResourceRequest( ResourceId id, const ResourceTypePath& typePath, Integration::LoadResourcePriority priority, bool resetFinishedStatus );
283 * Resource ticket has been discarded, throw away the actual resource
285 void HandleDiscardResourceRequest( ResourceId id, Integration::ResourceTypeId typeId );
288 * @brief Create GL texture for resource.
289 * @param[in] id The resource id.
291 void HandleCreateGlTextureRequest( ResourceId id );
293 /********************************************************************************
294 ******************** Update thread object direct interface ********************
295 ********************************************************************************/
298 * Check if a resource has completed loading.
299 * @param[in] id The ID of a bitmap/texture resource.
300 * @return true if the bitmap or texture has finished loading
302 bool IsResourceLoaded( ResourceId id ) const;
305 * Check if a resource has failed to load, e.g. file not found, etc.
306 * @param[in] id The ID of a bitmap/texture resource.
307 * @return true if the bitmap or texture has failed to load
309 bool HasResourceLoadFailed( ResourceId id ) const;
312 * @param[in] id The ID of a texture resource.
313 * @param[in] value if the FBO has been rendered to
315 void SetFrameBufferBeenRenderedTo( ResourceId id, bool value );
318 * @param[in] id The ID of a texture resource.
319 * @return true if the FBO has been rendered to
321 bool HasFrameBufferBeenRenderedTo( ResourceId id ) const;
324 * Get texture metadata. This stores meta data about the resource, but
325 * doesn't keep track of the resource
326 * @param id of the texture
327 * @param metadata reference
328 * @return false if metadata does not exist
330 bool GetTextureMetadata( ResourceId id, TextureMetadata*& metadata ) const;
332 /********************************************************************************
333 ************************* ResourceCache Implementation ************************
334 ********************************************************************************/
338 * @copydoc Integration::ResourceCache::LoadResponse
340 virtual void LoadResponse(ResourceId id, Integration::ResourceTypeId type, Integration::ResourcePointer resource, Integration::LoadStatus loadStatus);
343 * @copydoc Integration::ResourceCache::LoadFailed
345 virtual void LoadFailed(ResourceId id, Integration::ResourceFailure failure);
347 /********************************************************************************
348 ********************************* Private Methods *****************************
349 ********************************************************************************/
352 * Sends notification messages for load sucess & failure,
353 * pushes from newComplete / newFailed into oldComplete / oldFailed respectively
355 void NotifyTickets();
358 * Triggers message to Event thread to update the ticket's image attributes
359 * @pre An Image resource with the given id should exist in the cache.
360 * @param id ID of the image resource
361 * @param attributes Resource image attributes
363 void UpdateImageTicket( ResourceId id, ImageAttributes& attributes );
366 * Send message to ResourceClient in event thread
367 * @param[in] message The message to send
369 void SendToClient( MessageBase* message );
372 * Discard all dead resources.
373 * @param[in] updateBufferIndex The current update buffer index.
375 void DiscardDeadResources( BufferIndex updateBufferIndex );
380 ResourceManager( const ResourceManager& resourceManager );
383 ResourceManager& operator=( const ResourceManager& rhs );
386 struct ResourceManagerImpl;
387 ResourceManagerImpl* mImpl;
390 // Messages sent to resource manager from other threads:
391 // These functions are run on other threads and insert messages to be
392 // picked-up by the update thread in its main loop and executed on that in
395 inline void RequestLoadResourceMessage( EventThreadServices& eventThreadServices,
396 ResourceManager& manager,
398 const ResourceTypePath& typePath,
399 Integration::LoadResourcePriority priority )
401 typedef MessageValue3< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority > LocalType;
403 // Reserve some memory inside the message queue
404 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
406 // Construct message in the message queue memory; note that delete should not be called on the return value
407 new (slot) LocalType( &manager, &ResourceManager::HandleLoadResourceRequest, id, typePath, priority );
410 inline void RequestDecodeResourceMessage( EventThreadServices& eventThreadServices,
411 ResourceManager& manager,
413 /// We use typePath instead of the raw type for ownership and to enable copying of a concrete type.
414 const ResourceTypePath& typePath,
415 RequestBufferPtr buffer,
416 Integration::LoadResourcePriority priority )
418 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, RequestBufferPtr, Integration::LoadResourcePriority > LocalType;
420 // Reserve some memory inside the message queue
421 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
423 // Construct message in the message queue memory; note that delete should not be called on the return value
424 new (slot) LocalType( &manager, &ResourceManager::HandleDecodeResourceRequest, id, typePath, buffer, priority );
427 inline void RequestAddBitmapImageMessage( EventThreadServices& eventThreadServices,
428 ResourceManager& manager,
430 Integration::Bitmap* resourceData )
432 typedef MessageValue2< ResourceManager, ResourceId, Integration::BitmapPtr > LocalType;
434 // Reserve some memory inside the message queue
435 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
437 // Construct message in the message queue memory; note that delete should not be called on the return value
438 new (slot) LocalType( &manager, &ResourceManager::HandleAddBitmapImageRequest, id, resourceData );
441 inline void RequestAddNativeImageMessage( EventThreadServices& eventThreadServices,
442 ResourceManager& manager,
444 NativeImageInterfacePtr resourceData )
446 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > LocalType;
448 // Reserve some memory inside the message queue
449 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
451 // Construct message in the message queue memory; note that delete should not be called on the return value
452 new (slot) LocalType( &manager, &ResourceManager::HandleAddNativeImageRequest, id, resourceData );
455 inline void RequestAddFrameBufferImageMessage( EventThreadServices& eventThreadServices,
456 ResourceManager& manager,
460 Pixel::Format pixelFormat,
461 RenderBuffer::Format bufferFormat
464 typedef MessageValue5< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format, RenderBuffer::Format > LocalType;
466 // Reserve some memory inside the message queue
467 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
469 // Construct message in the message queue memory; note that delete should not be called on the return value
470 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, width, height, pixelFormat, bufferFormat );
473 inline void RequestAddFrameBufferImageMessage( EventThreadServices& eventThreadServices,
474 ResourceManager& manager,
476 NativeImageInterfacePtr resourceData )
478 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > LocalType;
480 // Reserve some memory inside the message queue
481 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
483 // Construct message in the message queue memory; note that delete should not be called on the return value
484 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, resourceData );
487 inline void RequestAllocateTextureMessage( EventThreadServices& eventThreadServices,
488 ResourceManager& manager,
492 Pixel::Format pixelFormat)
494 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
496 // Reserve some memory inside the message queue
497 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
499 // Construct message in the message queue memory; note that delete should not be called on the return value
500 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateTextureRequest, id, width, height, pixelFormat );
503 inline void RequestUpdateBitmapAreaMessage( EventThreadServices& eventThreadServices,
504 ResourceManager& manager,
506 const Dali::RectArea& area )
508 typedef MessageValue2< ResourceManager, ResourceId, Dali::RectArea > LocalType;
510 // Reserve some memory inside the message queue
511 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
513 // Construct message in the message queue memory; note that delete should not be called on the return value
514 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateBitmapAreaRequest, id, area );
517 inline void RequestUploadBitmapMessage( EventThreadServices& eventThreadServices,
518 ResourceManager& manager,
520 Integration::BitmapPtr bitmap,
522 std::size_t yOffset )
524 typedef MessageValue4< ResourceManager, ResourceId, Integration::BitmapPtr , std::size_t, std::size_t > LocalType;
526 // Reserve some memory inside the message queue
527 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
529 // Construct message in the message queue memory; note that delete should not be called on the return value
530 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, bitmap, xOffset, yOffset );
533 inline void RequestUploadBitmapMessage( EventThreadServices& eventThreadServices,
534 ResourceManager& manager,
538 std::size_t yOffset )
540 typedef MessageValue4< ResourceManager, ResourceId, ResourceId, std::size_t, std::size_t > LocalType;
542 // Reserve some memory inside the message queue
543 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
545 // Construct message in the message queue memory; note that delete should not be called on the return value
546 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, srcId, xOffset, yOffset );
549 inline void RequestUploadBitmapMessage(EventThreadServices& eventThreadServices,
550 ResourceManager& manager,
552 PixelDataPtr pixelData,
556 typedef MessageValue4< ResourceManager, ResourceId, PixelDataPtr , std::size_t, std::size_t > LocalType;
558 // Reserve some memory inside the message queue
559 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
561 // Construct message in the message queue memory; note that delete should not be called on the return value
562 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, pixelData, xOffset, yOffset );
565 inline void RequestReloadResourceMessage( EventThreadServices& eventThreadServices,
566 ResourceManager& manager,
568 const ResourceTypePath& typePath,
569 Integration::LoadResourcePriority priority,
570 bool resetFinishedStatus )
572 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority, bool > LocalType;
574 // Reserve some memory inside the message queue
575 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
577 // Construct message in the message queue memory; note that delete should not be called on the return value
578 new (slot) LocalType( &manager, &ResourceManager::HandleReloadResourceRequest, id, typePath, priority, resetFinishedStatus );
581 inline void RequestDiscardResourceMessage( EventThreadServices& eventThreadServices,
582 ResourceManager& manager,
584 Integration::ResourceTypeId typeId )
586 typedef MessageValue2< ResourceManager, ResourceId, Integration::ResourceTypeId > LocalType;
588 // Reserve some memory inside the message queue
589 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
591 // Construct message in the message queue memory; note that delete should not be called on the return value
592 new (slot) LocalType( &manager, &ResourceManager::HandleDiscardResourceRequest, id, typeId );
595 inline void RequestCreateGlTextureMessage( EventThreadServices& eventThreadServices,
596 ResourceManager& manager,
599 typedef MessageValue1< ResourceManager, ResourceId > LocalType;
601 // Reserve some memory inside the message queue
602 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
604 // Construct message in the message queue memory; note that delete should not be called on the return value
605 new (slot) LocalType( &manager, &ResourceManager::HandleCreateGlTextureRequest, id );
608 } // namespace Internal
612 #endif // __DALI_INTERNAL_RESOURCE_MANAGER_H__