1 #ifndef __DALI_INTERNAL_RESOURCE_MANAGER_H__
2 #define __DALI_INTERNAL_RESOURCE_MANAGER_H__
5 * Copyright (c) 2014 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/native-image-interface.h>
27 #include <dali/public-api/images/buffer-image.h>
28 #include <dali/public-api/common/ref-counted-dali-vector.h>
30 #include <dali/integration-api/bitmap.h>
31 #include <dali/integration-api/platform-abstraction.h>
32 #include <dali/integration-api/resource-cache.h>
33 #include <dali/integration-api/shader-data.h>
35 #include <dali/internal/common/event-to-update.h>
36 #include <dali/internal/common/message.h>
37 #include <dali/internal/event/common/thread-local-storage.h>
38 #include <dali/internal/common/bitmap-upload.h>
39 #include <dali/internal/event/text/font-impl.h>
40 #include <dali/internal/event/resources/resource-client-declarations.h>
41 #include <dali/internal/event/effects/shader-factory.h>
42 #include <dali/internal/update/resources/resource-manager-declarations.h>
43 #include <dali/internal/update/resources/bitmap-metadata.h>
48 class NativeImageInterface;
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< Integration::ResourceTypeId >
64 : public BasicType< Integration::ResourceTypeId > {};
70 class TextureCacheDispatcher;
71 class PostProcessResourceDispatcher;
74 class NotificationManager;
76 /** Raw bytes of a resource laid out exactly as it wouldbe in a file, but in memory. */
77 typedef Dali::RefCountedVector<uint8_t> RequestBuffer;
78 /** Counting smart pointer for managing a buffer of raw bytes. */
79 typedef IntrusivePtr<RequestBuffer> RequestBufferPtr;
82 * ResourceManager keeps track of resource loading requests, and caches resources that are loaded.
83 * It uses ResourceTicket objects, to keep track of the lifetime of each request.
84 * If the same resource is required by two client objects, they will share the same ResourceTicket
85 * i.e. only one load will occur using the native filesystem.
87 * Multi-threading notes:
88 * Resources are received from the PlatformAbstraction API during the Core::Render() method, which
89 * may be called from a dedicated rendering thread.
90 * Loading requests must be made from the application's main thread e.g. when Dali::Image is created.
92 class ResourceManager : public Integration::ResourceCache
97 * Create a resource manager.
98 * There should exactly one of these objects per Dali Core.
99 * @param[in] platformAbstraction Used to request resources from the native filesystem.
100 * @param[in] notificationManager Used to send NotifyTickets message.
101 * @param[in] postProcessResourcesQueue Used for performing post processing on resources
102 * @param[in] discardQueue Used to cleanup nodes & resources when no longer in use.
103 * @param[in] renderQueue Used to queue resource updates until the next Render.
105 ResourceManager( Integration::PlatformAbstraction& platformAbstraction,
106 NotificationManager& notificationManager,
107 SceneGraph::TextureCacheDispatcher& textureCacheDispatcher,
108 ResourcePostProcessList& postProcessResourcesQueue,
109 SceneGraph::PostProcessResourceDispatcher& postProcessResourceDispatcher,
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 );
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 * Upload an array of bitmaps to a texture.
241 * @param[in] id The resource id
242 * @param[in] uploadArray bitmap upload array.
244 void HandleUpdateTextureRequest( ResourceId id, const BitmapUploadArray& uploadArray );
247 * Requests allocation of a font resource
249 void HandleAllocateFontRequest(ResourceId id, const std::string& familyNameAndStyle);
252 * Load a shader program from a file
253 * @param[in] id The resource id
254 * @param[in] typePath The type & path of the resource
256 void HandleLoadShaderRequest(ResourceId id, const ResourceTypePath& typePath );
259 * Update bitmap area request
260 * @param[in] textureId The resource ID of a bitmap-texture to remove.
261 * @param[in] area The updated area. Zero width/height indicates the whole bitmap has been updated
263 void HandleUpdateBitmapAreaRequest( ResourceId textureId, const Dali::RectArea& area );
266 * Upload a bitmap to a position within a specified texture
267 * @param[in] destId The destination texture ID
268 * @param[in] srcId The resource ID of the bitmap to upload
269 * @param [in] xOffset Specifies an offset in the x direction within the texture
270 * @param [in] yOffset Specifies an offset in the y direction within the texture
272 void HandleUploadBitmapRequest( ResourceId destId, ResourceId srcId, std::size_t xOffset, std::size_t yOffset );
275 * Request reloading a resource from the native filesystem.
276 * @param[in] id The resource id
277 * @param[in] typePath The type & path of the resource
278 * @param[in] priority The priority of the request. This is ignored if the resource is already being refreshed.
279 * @param[in] resetFinishedStatus True if the finished status of the resource id should be reset
281 void HandleReloadResourceRequest( ResourceId id, const ResourceTypePath& typePath, Integration::LoadResourcePriority priority, bool resetFinishedStatus );
284 * Save a resource to the given url
285 * @param[in] id The resource id
286 * @param[in] typePath The type & path of the resource
288 void HandleSaveResourceRequest( ResourceId id, const ResourceTypePath& typePath );
291 * Resource ticket has been discarded, throw away the actual resource
293 void HandleDiscardResourceRequest( ResourceId id, Integration::ResourceTypeId typeId );
296 * Update font texture atlas status
297 * @param[in] id The resource id
298 * @param[in] atlasId texture ID of the atlas
299 * @param[in] loadStatus The status update.
301 void HandleAtlasUpdateRequest( ResourceId id, ResourceId atlasId, Integration::LoadStatus loadStatus );
303 /********************************************************************************
304 ******************** Update thread object direct interface ********************
305 ********************************************************************************/
308 * Check if a resource has completed loading.
309 * @param[in] id The ID of a bitmap/texture resource.
310 * @return true if the bitmap or texture has finished loading
312 bool IsResourceLoaded(ResourceId id);
315 * Check if a resource has failed to load, e.g. file not found, etc.
316 * @param[in] id The ID of a bitmap/texture resource.
317 * @return true if the bitmap or texture has failed to load
319 bool IsResourceLoadFailed(ResourceId id);
322 * Get bitmap metadata. This stores meta data about the resource, but
323 * doesn't keep track of the resource
325 BitmapMetadata GetBitmapMetadata(ResourceId id);
328 * Returns the shader resource corresponding to the Id
329 * @param[in] id - the id of a shader binary resource.
330 * @return the shader binary resource data or NULL if it has not been loaded.
332 Integration::ShaderDataPtr GetShaderData(ResourceId id);
335 * Check if current set of glyph requests on given atlas have finished loading
336 * @param[in] id Request Id of the text atlas texture
337 * @return true if the current set of glyph requests have all completed, false
338 * if there are outstanding glyph requests that haven't finished.
340 bool IsAtlasLoaded(ResourceId id);
343 * Check the load status of a given atlas.
344 * @param[in] id Request Id of the text atlas texture
347 Integration::LoadStatus GetAtlasLoadStatus( ResourceId atlasId );
349 /********************************************************************************
350 ************************* ResourceCache Implementation ************************
351 ********************************************************************************/
355 * @copydoc Integration::ResourceCache::LoadResponse
357 virtual void LoadResponse(ResourceId id, Integration::ResourceTypeId type, Integration::ResourcePointer resource, Integration::LoadStatus loadStatus);
360 * @copydoc Integration::ResourceCache::SaveComplete
362 virtual void SaveComplete(ResourceId id, Integration::ResourceTypeId type);
365 * @copydoc Integration::ResourceCache::LoadFailed
367 virtual void LoadFailed(ResourceId id, Integration::ResourceFailure failure);
370 * @copydoc Integration::ResourceCache::SaveFailed
372 virtual void SaveFailed(ResourceId id, Integration::ResourceFailure failure);
374 /********************************************************************************
375 ********************************* Private Methods *****************************
376 ********************************************************************************/
379 * @param[in] id Resource id to clear
380 * @param[in] typePath Glyphs to be loaded, and cleared beforehand
382 void ClearRequestedGlyphArea( ResourceId id, const ResourceTypePath& typePath );
385 * Sends loaded glyphs to texture atlas for uploading
386 * @param[in] glyphSet Loaded glyphs
388 void UploadGlyphsToTexture( const Integration::GlyphSet& glyphSet );
391 * Sends notification messages for load sucess & failure,
392 * pushes from newComplete / newFailed into oldComplete / oldFailed respectively
394 void NotifyTickets();
397 * Triggers message to Event thread to update the ticket's image attributes
398 * @pre An Image resource with the given id should exist in the cache.
399 * @param id ID of the image resource
400 * @param attributes Resource image attributes
402 void UpdateImageTicket( ResourceId id, ImageAttributes& attributes );
405 * Send message to ResourceClient in event thread
406 * @param[in] message The message to send
408 void SendToClient( MessageBase* message );
411 * Discard all dead resources.
412 * @param[in] updateBufferIndex The current update buffer index.
414 void DiscardDeadResources( BufferIndex updateBufferIndex );
417 struct ResourceManagerImpl;
418 ResourceManagerImpl* mImpl;
421 // Messages sent to resource manager from other threads:
422 // These functions are run on other threads and insert messages to be
423 // picked-up by the update thread in its main loop and executed on that in
426 inline void RequestLoadResourceMessage( EventToUpdate& eventToUpdate,
427 ResourceManager& manager,
429 const ResourceTypePath& typePath,
430 Integration::LoadResourcePriority priority )
432 typedef MessageValue3< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority > LocalType;
434 // Reserve some memory inside the message queue
435 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
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::HandleLoadResourceRequest, id, typePath, priority );
441 inline void RequestDecodeResourceMessage( EventToUpdate& eventToUpdate,
442 ResourceManager& manager,
444 /// We use typePath instead of the raw type for ownership and to enable copying of a concrete type.
445 const ResourceTypePath& typePath,
446 RequestBufferPtr buffer,
447 Integration::LoadResourcePriority priority )
449 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, RequestBufferPtr, Integration::LoadResourcePriority > LocalType;
451 // Reserve some memory inside the message queue
452 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
454 // Construct message in the message queue memory; note that delete should not be called on the return value
455 new (slot) LocalType( &manager, &ResourceManager::HandleDecodeResourceRequest, id, typePath, buffer, priority );
458 inline void RequestAddBitmapImageMessage( EventToUpdate& eventToUpdate,
459 ResourceManager& manager,
461 Integration::Bitmap* resourceData )
463 typedef MessageValue2< ResourceManager, ResourceId, Integration::BitmapPtr > LocalType;
465 // Reserve some memory inside the message queue
466 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
468 // Construct message in the message queue memory; note that delete should not be called on the return value
469 new (slot) LocalType( &manager, &ResourceManager::HandleAddBitmapImageRequest, id, resourceData );
472 inline void RequestAddNativeImageMessage( EventToUpdate& eventToUpdate,
473 ResourceManager& manager,
475 NativeImageInterfacePtr resourceData )
477 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > LocalType;
479 // Reserve some memory inside the message queue
480 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
482 // Construct message in the message queue memory; note that delete should not be called on the return value
483 new (slot) LocalType( &manager, &ResourceManager::HandleAddNativeImageRequest, id, resourceData );
486 inline void RequestAddFrameBufferImageMessage( EventToUpdate& eventToUpdate,
487 ResourceManager& manager,
491 Pixel::Format pixelFormat )
493 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
495 // Reserve some memory inside the message queue
496 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
498 // Construct message in the message queue memory; note that delete should not be called on the return value
499 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, width, height, pixelFormat );
502 inline void RequestAddFrameBufferImageMessage( EventToUpdate& eventToUpdate,
503 ResourceManager& manager,
505 NativeImageInterfacePtr resourceData )
507 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > LocalType;
509 // Reserve some memory inside the message queue
510 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
512 // Construct message in the message queue memory; note that delete should not be called on the return value
513 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, resourceData );
516 inline void RequestAllocateTextureMessage(EventToUpdate& eventToUpdate,
517 ResourceManager& manager,
521 Pixel::Format pixelFormat)
523 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
525 // Reserve some memory inside the message queue
526 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
528 // Construct message in the message queue memory; note that delete should not be called on the return value
529 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateTextureRequest, id, width, height, pixelFormat );
532 inline void RequestUpdateTextureMessage(EventToUpdate& eventToUpdate,
533 ResourceManager& manager,
535 BitmapUploadArray uploadArray )
537 typedef MessageValue2< ResourceManager, ResourceId, BitmapUploadArray > LocalType;
539 // Reserve some memory inside the message queue
540 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
542 // Construct message in the message queue memory; note that delete should not be called on the return value
543 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateTextureRequest, id, uploadArray );
546 inline void RequestAllocateFontMessage( EventToUpdate& eventToUpdate,
547 ResourceManager& manager,
549 const std::string& familyNameAndStyle)
551 typedef MessageValue2< ResourceManager, ResourceId, std::string > LocalType;
553 // Reserve some memory inside the message queue
554 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
556 // Construct message in the message queue memory; note that delete should not be called on the return value
557 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateFontRequest, id, familyNameAndStyle );
560 inline void RequestLoadShaderMessage( EventToUpdate& eventToUpdate,
561 ResourceManager& manager,
563 const ResourceTypePath& typePath )
565 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
567 // Reserve some memory inside the message queue
568 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
570 // Construct message in the message queue memory; note that delete should not be called on the return value
571 new (slot) LocalType( &manager, &ResourceManager::HandleLoadShaderRequest, id, typePath );
574 inline void RequestUpdateBitmapAreaMessage( EventToUpdate& eventToUpdate,
575 ResourceManager& manager,
577 const Dali::RectArea& area )
579 typedef MessageValue2< ResourceManager, ResourceId, Dali::RectArea > LocalType;
581 // Reserve some memory inside the message queue
582 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
584 // Construct message in the message queue memory; note that delete should not be called on the return value
585 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateBitmapAreaRequest, id, area );
588 inline void RequestUploadBitmapMessage( EventToUpdate& eventToUpdate,
589 ResourceManager& manager,
593 std::size_t yOffset )
595 typedef MessageValue4< ResourceManager, ResourceId, ResourceId, std::size_t, std::size_t > LocalType;
597 // Reserve some memory inside the message queue
598 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
600 // Construct message in the message queue memory; note that delete should not be called on the return value
601 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, srcId, xOffset, yOffset );
604 inline void RequestReloadResourceMessage( EventToUpdate& eventToUpdate,
605 ResourceManager& manager,
607 const ResourceTypePath& typePath,
608 Integration::LoadResourcePriority priority,
609 bool resetFinishedStatus )
611 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority, bool > LocalType;
613 // Reserve some memory inside the message queue
614 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
616 // Construct message in the message queue memory; note that delete should not be called on the return value
617 new (slot) LocalType( &manager, &ResourceManager::HandleReloadResourceRequest, id, typePath, priority, resetFinishedStatus );
620 inline void RequestSaveResourceMessage( EventToUpdate& eventToUpdate,
621 ResourceManager& manager,
623 const ResourceTypePath& typePath )
625 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
627 // Reserve some memory inside the message queue
628 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
630 // Construct message in the message queue memory; note that delete should not be called on the return value
631 new (slot) LocalType( &manager, &ResourceManager::HandleSaveResourceRequest, id, typePath );
634 inline void RequestDiscardResourceMessage( EventToUpdate& eventToUpdate,
635 ResourceManager& manager,
637 Integration::ResourceTypeId typeId )
639 typedef MessageValue2< ResourceManager, ResourceId, Integration::ResourceTypeId > LocalType;
641 // Reserve some memory inside the message queue
642 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
644 // Construct message in the message queue memory; note that delete should not be called on the return value
645 new (slot) LocalType( &manager, &ResourceManager::HandleDiscardResourceRequest, id, typeId );
648 inline void RequestAtlasUpdateMessage( EventToUpdate& eventToUpdate,
649 ResourceManager& manager,
652 Integration::LoadStatus loadStatus )
654 typedef MessageValue3< ResourceManager, ResourceId, ResourceId, Integration::LoadStatus > LocalType;
656 // Reserve some memory inside the message queue
657 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
659 // Construct message in the message queue memory; note that delete should not be called on the return value
660 new (slot) LocalType( &manager, &ResourceManager::HandleAtlasUpdateRequest, id, atlasId, loadStatus );
663 } // namespace Internal
667 #endif // __DALI_INTERNAL_RESOURCE_MANAGER_H__