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.h>
27 #include <dali/public-api/images/bitmap-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/modeling/model-data-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/modeling/internal-mesh-data.h>
43 #include <dali/internal/update/modeling/scene-graph-mesh-declarations.h>
44 #include <dali/internal/update/resources/resource-manager-declarations.h>
45 #include <dali/internal/update/resources/bitmap-metadata.h>
60 // value types used by messages
61 template <> struct ParameterType< Integration::LoadResourcePriority >
62 : public BasicType< Integration::LoadResourcePriority > {};
63 template <> struct ParameterType< Pixel::Format >
64 : public BasicType< Pixel::Format > {};
65 template <> struct ParameterType< Integration::ResourceTypeId >
66 : public BasicType< Integration::ResourceTypeId > {};
72 class TextureCacheDispatcher;
73 class PostProcessResourceDispatcher;
76 class NotificationManager;
78 /** Raw bytes of a resource laid out exactly as it wouldbe in a file, but in memory. */
79 typedef Dali::RefCountedVector<uint8_t> RequestBuffer;
80 /** Counting smart pointer for managing a buffer of raw bytes. */
81 typedef IntrusivePtr<RequestBuffer> RequestBufferPtr;
84 * ResourceManager keeps track of resource loading requests, and caches resources that are loaded.
85 * It uses ResourceTicket objects, to keep track of the lifetime of each request.
86 * If the same resource is required by two client objects, they will share the same ResourceTicket
87 * i.e. only one load will occur using the native filesystem.
89 * Multi-threading notes:
90 * Resources are received from the PlatformAbstraction API during the Core::Render() method, which
91 * may be called from a dedicated rendering thread.
92 * Loading requests must be made from the application's main thread e.g. when Dali::Image is created.
94 class ResourceManager : public Integration::ResourceCache
99 * Create a resource manager.
100 * There should exactly one of these objects per Dali Core.
101 * @param[in] platformAbstraction Used to request resources from the native filesystem.
102 * @param[in] notificationManager Used to send NotifyTickets message.
103 * @param[in] postProcessResourcesQueue Used for performing post processing on resources
104 * @param[in] discardQueue Used to cleanup nodes & resources when no longer in use.
105 * @param[in] renderQueue Used to queue resource updates until the next Render.
107 ResourceManager( Integration::PlatformAbstraction& platformAbstraction,
108 NotificationManager& notificationManager,
109 SceneGraph::TextureCacheDispatcher& textureCacheDispatcher,
110 ResourcePostProcessList& postProcessResourcesQueue,
111 SceneGraph::PostProcessResourceDispatcher& postProcessResourceDispatcher,
112 SceneGraph::DiscardQueue& discardQueue,
113 SceneGraph::RenderQueue& renderQueue );
116 * Virtual destructor.
118 virtual ~ResourceManager();
120 public: // Used by ResourceClient
122 /********************************************************************************
123 ************************ ResourceClient direct interface **********************
124 ********************************************************************************/
127 * Resource client passes itself for secondary intialisation.
128 * (The resource client requires the ResourceManager to be instantiated first).
129 * @param[in] resourceClient The ResourceClient.
131 void SetClient( ResourceClient& resourceClient );
133 /********************************************************************************
134 ************************ UpdateManager direct interface ***********************
135 ********************************************************************************/
138 * Called to update the resource cache before rendering.
139 * New resources will be added to the cache using PlatformAbstraction::FillResourceCache().
140 * Unwanted resources will be added to the DiscardQueue.
141 * @param[in] updateBufferIndex The current update buffer index.
142 * @return true, if a resource load was completed or failed
144 bool UpdateCache( BufferIndex updateBufferIndex );
147 * Iterate through the post process queue, performing requested updates.
148 * @param[in] updateBufferIndex The current update buffer index.
150 void PostProcessResources( BufferIndex updateBufferIndex );
152 /********************************************************************************
153 *************************** CoreImpl direct interface *************************
154 ********************************************************************************/
157 * Returns whether the Resource Manager is still processing any resource requests.
158 * @return true if still processing, false otherwise.
160 bool ResourcesToProcess();
162 /********************************************************************************
163 ********************************* Message handlers *****************************
164 ********************************************************************************/
167 * Request a resource from the native filesystem.
168 * @param[in] id The Id of the requested resource
169 * @param[in] typePath The type & path of requested resource.
170 * @param[in] priority The priority of the request. This is ignored if the resource is already being loaded.
172 void HandleLoadResourceRequest( ResourceId id,
173 const ResourceTypePath& typePath,
174 Integration::LoadResourcePriority priority );
177 * Decode a resource from a memory buffer with the semantics of loading.
178 * Notifications of partial completion, success, and failure will happen via
179 * the same loading notification path used for loading from files: Update()
180 * will retrieve loading events in its main loop and notify listeners to its
181 * own loading events, and forward them, still as loading events, to the event
182 * thread via its update queue.
183 * Resource manager and lower levels make no attempt to detect resource
184 * aliases as is done for multiple requests to load the same resource
185 * file, so the caller is responsible for ensuring that it only requests
186 * the decoding of an in-memory resource once and for doing the sharing of the
187 * resulting object itself. Ultimately this responsibility resides with the
189 * @note ! Only Bitmap resources are supported for decoding from memory !
190 * @param[in] id The Id of the requested resource.
191 * @param[in] typePath The type of the requested resource and a path that is ignored.
192 * @param[in] buffer The raw encoded bytes of the resource as they would appear in a file.
193 * @param[in] priority The priority of the request. This is ignored if the resource is already being loaded.
195 void HandleDecodeResourceRequest( ResourceId id,
196 const ResourceTypePath& typePath,
197 RequestBufferPtr buffer,
198 Integration::LoadResourcePriority priority );
201 * Injects a bitmap resource (does not require loading).
202 * @pre bitmap has to be initialized
203 * @param[in] id The resource id
204 * @param[in] bitmap an initialized bitmap
206 void HandleAddBitmapImageRequest(ResourceId id, Integration::BitmapPtr bitmap);
209 * Add an existing resource to the resource manager.
210 * @param[in] id The resource id
211 * @param [in] resourceData the NativeImage object
212 * @return A ref-counted request object. Keep a copy until the resource is no longer required.
214 void HandleAddNativeImageRequest( ResourceId id, NativeImagePtr resourceData );
217 * Add an existing resource to the resource manager.
218 * @param[in] id The resource id
219 * @param[in] width width in pixels
220 * @param[in] height height in pixels
221 * @param[in] pixelFormat Pixel format
223 void HandleAddFrameBufferImageRequest( ResourceId id, unsigned int width, unsigned int height, Pixel::Format pixelFormat );
226 * Add an existing resource to the resource manager.
227 * @param[in] id The resource id
228 * @param[in] nativeImage The NativeImage
230 void HandleAddFrameBufferImageRequest( ResourceId id, NativeImagePtr nativeImage );
233 * Allocate a new empty texture.
234 * @param[in] id The resource id
235 * @param[in] width width in pixels
236 * @param[in] height height in pixels
237 * @param[in] pixelFormat Pixel format
239 void HandleAllocateTextureRequest( ResourceId id, unsigned int width, unsigned int height, Pixel::Format pixelFormat );
242 * Upload an array of bitmaps to a texture.
243 * @param[in] id The resource id
244 * @param[in] uploadArray bitmap upload array.
246 void HandleUpdateTextureRequest( ResourceId id, const BitmapUploadArray& uploadArray );
249 * Requests allocation of a mesh resource
250 * @param[in] id The resource id
251 * @param[in] meshData The mesh data
253 void HandleAllocateMeshRequest (ResourceId id, MeshData* meshData);
256 * Load a shader program from a file
257 * @param[in] id The resource id
258 * @param[in] typePath The type & path of the resource
260 void HandleLoadShaderRequest(ResourceId id, const ResourceTypePath& typePath );
263 * Update bitmap area request
264 * @param[in] textureId The resource ID of a bitmap-texture to remove.
265 * @param[in] area The updated area. Zero width/height indicates the whole bitmap has been updated
267 void HandleUpdateBitmapAreaRequest( ResourceId textureId, const Dali::RectArea& area );
270 * Upload mesh buffer changes.
271 * @param[in] updateBufferIndex The current update buffer index.
272 * @param[in] id The ID of a Mesh resource.
273 * @param[in] meshData Newly allocated mesh data; ownership is taken.
275 void HandleUpdateMeshRequest( BufferIndex updateBufferIndex, ResourceId id, MeshData* meshData );
278 * Request reloading a resource from the native filesystem.
279 * @param[in] id The resource id
280 * @param[in] typePath The type & path of the resource
281 * @param[in] priority The priority of the request. This is ignored if the resource is already being refreshed.
282 * @param[in] resetFinishedStatus True if the finished status of the resource id should be reset
284 void HandleReloadResourceRequest( ResourceId id, const ResourceTypePath& typePath, Integration::LoadResourcePriority priority, bool resetFinishedStatus );
287 * Save a resource to the given url
288 * @param[in] id The resource id
289 * @param[in] typePath The type & path of the resource
291 void HandleSaveResourceRequest( ResourceId id, const ResourceTypePath& typePath );
294 * Resource ticket has been discarded, throw away the actual resource
296 void HandleDiscardResourceRequest( ResourceId id, Integration::ResourceTypeId typeId );
298 /********************************************************************************
299 ******************** Event thread object direct interface *********************
300 ********************************************************************************/
303 * Called by model implementations which require access to the model
305 * @note Only called from event thread objects - ModelData is not used
307 * @param[in] id - the id of a ModelData resource.
308 * @return the model data or NULL if it has not been loaded.
310 Internal::ModelDataPtr GetModelData(ResourceId id);
312 /********************************************************************************
313 ******************** Update thread object direct interface ********************
314 ********************************************************************************/
317 * Check if a resource has completed loading.
318 * @param[in] id The ID of a bitmap/texture resource.
319 * @return true if the bitmap or texture has finished loading
321 bool IsResourceLoaded(ResourceId id);
324 * Check if a resource has failed to load, e.g. file not found, etc.
325 * @param[in] id The ID of a bitmap/texture resource.
326 * @return true if the bitmap or texture has failed to load
328 bool IsResourceLoadFailed(ResourceId id);
331 * Get bitmap metadata. This stores meta data about the resource, but
332 * doesn't keep track of the resource
334 BitmapMetadata GetBitmapMetadata(ResourceId id);
338 * @note Used by update thread objects (SceneGraph::Mesh) only
339 * @param[in] id - the id of a MeshData resource.
340 * @return the mesh data or NULL if this resource isn't valid
342 Internal::SceneGraph::Mesh* GetMesh(ResourceId id);
345 * Returns the shader resource corresponding to the Id
346 * @param[in] id - the id of a shader binary resource.
347 * @return the shader binary resource data or NULL if it has not been loaded.
349 Integration::ShaderDataPtr GetShaderData(ResourceId id);
351 /********************************************************************************
352 ************************* ResourceCache Implementation ************************
353 ********************************************************************************/
357 * @copydoc Integration::ResourceCache::LoadResponse
359 virtual void LoadResponse(ResourceId id, Integration::ResourceTypeId type, Integration::ResourcePointer resource, Integration::LoadStatus loadStatus);
362 * @copydoc Integration::ResourceCache::SaveComplete
364 virtual void SaveComplete(ResourceId id, Integration::ResourceTypeId type);
367 * @copydoc Integration::ResourceCache::LoadFailed
369 virtual void LoadFailed(ResourceId id, Integration::ResourceFailure failure);
372 * @copydoc Integration::ResourceCache::SaveFailed
374 virtual void SaveFailed(ResourceId id, Integration::ResourceFailure failure);
376 /********************************************************************************
377 ********************************* Private Methods *****************************
378 ********************************************************************************/
382 * Sends notification messages for load sucess & failure,
383 * pushes from newComplete / newFailed into oldComplete / oldFailed respectively
385 void NotifyTickets();
388 * Triggers message to Event thread to update the ticket's image attributes
389 * @pre An Image resource with the given id should exist in the cache.
390 * @param id ID of the image resource
391 * @param attributes Resource image attributes
393 void UpdateImageTicket( ResourceId id, ImageAttributes& attributes );
396 * Send message to ResourceClient in event thread
397 * @param[in] message The message to send
399 void SendToClient( MessageBase* message );
402 * Discard all dead resources.
403 * @param[in] updateBufferIndex The current update buffer index.
405 void DiscardDeadResources( BufferIndex updateBufferIndex );
408 struct ResourceManagerImpl;
409 ResourceManagerImpl* mImpl;
412 // Messages sent to resource manager from other threads:
413 // These functions are run on other threads and insert messages to be
414 // picked-up by the update thread in its main loop and executed on that in
417 inline void RequestLoadResourceMessage( EventToUpdate& eventToUpdate,
418 ResourceManager& manager,
420 const ResourceTypePath& typePath,
421 Integration::LoadResourcePriority priority )
423 typedef MessageValue3< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority > LocalType;
425 // Reserve some memory inside the message queue
426 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
428 // Construct message in the message queue memory; note that delete should not be called on the return value
429 new (slot) LocalType( &manager, &ResourceManager::HandleLoadResourceRequest, id, typePath, priority );
432 inline void RequestDecodeResourceMessage( EventToUpdate& eventToUpdate,
433 ResourceManager& manager,
435 /// We use typePath instead of the raw type for ownership and to enable copying of a concrete type.
436 const ResourceTypePath& typePath,
437 RequestBufferPtr buffer,
438 Integration::LoadResourcePriority priority )
440 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, RequestBufferPtr, Integration::LoadResourcePriority > LocalType;
442 // Reserve some memory inside the message queue
443 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
445 // Construct message in the message queue memory; note that delete should not be called on the return value
446 new (slot) LocalType( &manager, &ResourceManager::HandleDecodeResourceRequest, id, typePath, buffer, priority );
449 inline void RequestAddBitmapImageMessage( EventToUpdate& eventToUpdate,
450 ResourceManager& manager,
452 Integration::Bitmap* resourceData )
454 typedef MessageValue2< ResourceManager, ResourceId, Integration::BitmapPtr > LocalType;
456 // Reserve some memory inside the message queue
457 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
459 // Construct message in the message queue memory; note that delete should not be called on the return value
460 new (slot) LocalType( &manager, &ResourceManager::HandleAddBitmapImageRequest, id, resourceData );
463 inline void RequestAddNativeImageMessage( EventToUpdate& eventToUpdate,
464 ResourceManager& manager,
466 NativeImagePtr resourceData )
468 typedef MessageValue2< ResourceManager, ResourceId, NativeImagePtr > LocalType;
470 // Reserve some memory inside the message queue
471 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
473 // Construct message in the message queue memory; note that delete should not be called on the return value
474 new (slot) LocalType( &manager, &ResourceManager::HandleAddNativeImageRequest, id, resourceData );
477 inline void RequestAddFrameBufferImageMessage( EventToUpdate& eventToUpdate,
478 ResourceManager& manager,
482 Pixel::Format pixelFormat )
484 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
486 // Reserve some memory inside the message queue
487 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
489 // Construct message in the message queue memory; note that delete should not be called on the return value
490 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, width, height, pixelFormat );
493 inline void RequestAddFrameBufferImageMessage( EventToUpdate& eventToUpdate,
494 ResourceManager& manager,
496 NativeImagePtr resourceData )
498 typedef MessageValue2< ResourceManager, ResourceId, NativeImagePtr > LocalType;
500 // Reserve some memory inside the message queue
501 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
503 // Construct message in the message queue memory; note that delete should not be called on the return value
504 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, resourceData );
507 inline void RequestAllocateTextureMessage(EventToUpdate& eventToUpdate,
508 ResourceManager& manager,
512 Pixel::Format pixelFormat)
514 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
516 // Reserve some memory inside the message queue
517 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
519 // Construct message in the message queue memory; note that delete should not be called on the return value
520 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateTextureRequest, id, width, height, pixelFormat );
523 inline void RequestUpdateTextureMessage(EventToUpdate& eventToUpdate,
524 ResourceManager& manager,
526 BitmapUploadArray uploadArray )
528 typedef MessageValue2< ResourceManager, ResourceId, BitmapUploadArray > LocalType;
530 // Reserve some memory inside the message queue
531 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
533 // Construct message in the message queue memory; note that delete should not be called on the return value
534 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateTextureRequest, id, uploadArray );
537 inline void RequestAllocateMeshMessage( EventToUpdate& eventToUpdate,
538 ResourceManager& manager,
540 OwnerPointer<MeshData>& meshData )
542 typedef MessageValue2< ResourceManager, ResourceId, OwnerPointer<MeshData> > LocalType;
544 // Reserve some memory inside the message queue
545 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
547 // Construct message in the message queue memory; note that delete should not be called on the return value
548 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateMeshRequest, id, meshData.Release() );
551 inline void RequestLoadShaderMessage( EventToUpdate& eventToUpdate,
552 ResourceManager& manager,
554 const ResourceTypePath& typePath )
556 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
558 // Reserve some memory inside the message queue
559 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
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::HandleLoadShaderRequest, id, typePath );
565 inline void RequestUpdateBitmapAreaMessage( EventToUpdate& eventToUpdate,
566 ResourceManager& manager,
568 const Dali::RectArea& area )
570 typedef MessageValue2< ResourceManager, ResourceId, Dali::RectArea > LocalType;
572 // Reserve some memory inside the message queue
573 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
575 // Construct message in the message queue memory; note that delete should not be called on the return value
576 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateBitmapAreaRequest, id, area );
579 inline void RequestUpdateMeshMessage( EventToUpdate& eventToUpdate,
580 ResourceManager& manager,
582 const Dali::MeshData& meshData,
583 ResourcePolicy::Discardable discardable )
585 typedef MessageDoubleBuffered2< ResourceManager, ResourceId, OwnerPointer< MeshData > > LocalType;
586 // Reserve some memory inside the message queue
587 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
589 MeshData* internalMeshData = new MeshData( meshData, discardable, false );
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::HandleUpdateMeshRequest, id, internalMeshData );
595 inline void RequestReloadResourceMessage( EventToUpdate& eventToUpdate,
596 ResourceManager& manager,
598 const ResourceTypePath& typePath,
599 Integration::LoadResourcePriority priority,
600 bool resetFinishedStatus )
602 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority, bool > LocalType;
604 // Reserve some memory inside the message queue
605 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ), false );
607 // Construct message in the message queue memory; note that delete should not be called on the return value
608 new (slot) LocalType( &manager, &ResourceManager::HandleReloadResourceRequest, id, typePath, priority, resetFinishedStatus );
611 inline void RequestSaveResourceMessage( EventToUpdate& eventToUpdate,
612 ResourceManager& manager,
614 const ResourceTypePath& typePath )
616 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
618 // Reserve some memory inside the message queue
619 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
621 // Construct message in the message queue memory; note that delete should not be called on the return value
622 new (slot) LocalType( &manager, &ResourceManager::HandleSaveResourceRequest, id, typePath );
625 inline void RequestDiscardResourceMessage( EventToUpdate& eventToUpdate,
626 ResourceManager& manager,
628 Integration::ResourceTypeId typeId )
630 typedef MessageValue2< ResourceManager, ResourceId, Integration::ResourceTypeId > LocalType;
632 // Reserve some memory inside the message queue
633 unsigned int* slot = eventToUpdate.ReserveMessageSlot( sizeof( LocalType ) );
635 // Construct message in the message queue memory; note that delete should not be called on the return value
636 new (slot) LocalType( &manager, &ResourceManager::HandleDiscardResourceRequest, id, typeId );
639 } // namespace Internal
643 #endif // __DALI_INTERNAL_RESOURCE_MANAGER_H__