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/message.h>
36 #include <dali/internal/event/common/event-thread-services.h>
37 #include <dali/internal/event/common/thread-local-storage.h>
38 #include <dali/internal/event/resources/resource-client-declarations.h>
39 #include <dali/internal/event/effects/shader-factory.h>
40 #include <dali/internal/update/modeling/internal-mesh-data.h>
41 #include <dali/internal/update/modeling/scene-graph-mesh-declarations.h>
42 #include <dali/internal/update/resources/resource-manager-declarations.h>
43 #include <dali/internal/update/resources/bitmap-metadata.h>
48 class NativeImageInterface;
58 class ImageAttributes;
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 NativeImageInterface object
212 * @return A ref-counted request object. Keep a copy until the resource is no longer required.
214 void HandleAddNativeImageRequest( ResourceId id, NativeImageInterfacePtr 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, NativeImageInterfacePtr 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 * Requests allocation of a mesh resource
243 * @param[in] id The resource id
244 * @param[in] meshData The mesh data
246 void HandleAllocateMeshRequest (ResourceId id, MeshData* meshData);
249 * Load a shader program from a file
250 * @param[in] id The resource id
251 * @param[in] typePath The type & path of the resource
253 void HandleLoadShaderRequest(ResourceId id, const ResourceTypePath& typePath );
256 * Update bitmap area request
257 * @param[in] textureId The resource ID of a bitmap-texture to remove.
258 * @param[in] area The updated area. Zero width/height indicates the whole bitmap has been updated
260 void HandleUpdateBitmapAreaRequest( ResourceId textureId, const Dali::RectArea& area );
263 * Upload a bitmap to a position within a specified texture
264 * @param[in] destId The destination texture ID
265 * @param[in] bitmap The pointer pointing to the bitmap data to upload
266 * @param [in] xOffset Specifies an offset in the x direction within the texture
267 * @param [in] yOffset Specifies an offset in the y direction within the texture
269 void HandleUploadBitmapRequest( ResourceId destId, Integration::BitmapPtr bitmap, std::size_t xOffset, std::size_t yOffset );
272 * Upload a bitmap to a position within a specified texture
273 * @param[in] destId The destination texture ID
274 * @param[in] srcId The resource ID of the bitmap to upload
275 * @param [in] xOffset Specifies an offset in the x direction within the texture
276 * @param [in] yOffset Specifies an offset in the y direction within the texture
278 void HandleUploadBitmapRequest( ResourceId destId, ResourceId srcId, std::size_t xOffset, std::size_t yOffset );
281 * Upload mesh buffer changes.
282 * @param[in] updateBufferIndex The current update buffer index.
283 * @param[in] id The ID of a Mesh resource.
284 * @param[in] meshData Newly allocated mesh data; ownership is taken.
286 void HandleUpdateMeshRequest( BufferIndex updateBufferIndex, ResourceId id, MeshData* meshData );
289 * Request reloading a resource from the native filesystem.
290 * @param[in] id The resource id
291 * @param[in] typePath The type & path of the resource
292 * @param[in] priority The priority of the request. This is ignored if the resource is already being refreshed.
293 * @param[in] resetFinishedStatus True if the finished status of the resource id should be reset
295 void HandleReloadResourceRequest( ResourceId id, const ResourceTypePath& typePath, Integration::LoadResourcePriority priority, bool resetFinishedStatus );
298 * Save a resource to the given url
299 * @param[in] id The resource id
300 * @param[in] typePath The type & path of the resource
302 void HandleSaveResourceRequest( ResourceId id, const ResourceTypePath& typePath );
305 * Resource ticket has been discarded, throw away the actual resource
307 void HandleDiscardResourceRequest( ResourceId id, Integration::ResourceTypeId typeId );
309 /********************************************************************************
310 ******************** Update thread object direct interface ********************
311 ********************************************************************************/
314 * Check if a resource has completed loading.
315 * @param[in] id The ID of a bitmap/texture resource.
316 * @return true if the bitmap or texture has finished loading
318 bool IsResourceLoaded(ResourceId id);
321 * Check if a resource has failed to load, e.g. file not found, etc.
322 * @param[in] id The ID of a bitmap/texture resource.
323 * @return true if the bitmap or texture has failed to load
325 bool IsResourceLoadFailed(ResourceId id);
328 * Get bitmap metadata. This stores meta data about the resource, but
329 * doesn't keep track of the resource
331 BitmapMetadata GetBitmapMetadata(ResourceId id);
335 * @note Used by update thread objects (SceneGraph::Mesh) only
336 * @param[in] id - the id of a MeshData resource.
337 * @return the mesh data or NULL if this resource isn't valid
339 Internal::SceneGraph::Mesh* GetMesh(ResourceId id);
342 * Returns the shader resource corresponding to the Id
343 * @param[in] id - the id of a shader binary resource.
344 * @return the shader binary resource data or NULL if it has not been loaded.
346 Integration::ShaderDataPtr GetShaderData(ResourceId id);
348 /********************************************************************************
349 ************************* ResourceCache Implementation ************************
350 ********************************************************************************/
354 * @copydoc Integration::ResourceCache::LoadResponse
356 virtual void LoadResponse(ResourceId id, Integration::ResourceTypeId type, Integration::ResourcePointer resource, Integration::LoadStatus loadStatus);
359 * @copydoc Integration::ResourceCache::SaveComplete
361 virtual void SaveComplete(ResourceId id, Integration::ResourceTypeId type);
364 * @copydoc Integration::ResourceCache::LoadFailed
366 virtual void LoadFailed(ResourceId id, Integration::ResourceFailure failure);
369 * @copydoc Integration::ResourceCache::SaveFailed
371 virtual void SaveFailed(ResourceId id, Integration::ResourceFailure failure);
373 /********************************************************************************
374 ********************************* Private Methods *****************************
375 ********************************************************************************/
378 * Sends notification messages for load sucess & failure,
379 * pushes from newComplete / newFailed into oldComplete / oldFailed respectively
381 void NotifyTickets();
384 * Triggers message to Event thread to update the ticket's image attributes
385 * @pre An Image resource with the given id should exist in the cache.
386 * @param id ID of the image resource
387 * @param attributes Resource image attributes
389 void UpdateImageTicket( ResourceId id, ImageAttributes& attributes );
392 * Send message to ResourceClient in event thread
393 * @param[in] message The message to send
395 void SendToClient( MessageBase* message );
398 * Discard all dead resources.
399 * @param[in] updateBufferIndex The current update buffer index.
401 void DiscardDeadResources( BufferIndex updateBufferIndex );
404 struct ResourceManagerImpl;
405 ResourceManagerImpl* mImpl;
408 // Messages sent to resource manager from other threads:
409 // These functions are run on other threads and insert messages to be
410 // picked-up by the update thread in its main loop and executed on that in
413 inline void RequestLoadResourceMessage( EventThreadServices& eventThreadServices,
414 ResourceManager& manager,
416 const ResourceTypePath& typePath,
417 Integration::LoadResourcePriority priority )
419 typedef MessageValue3< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority > LocalType;
421 // Reserve some memory inside the message queue
422 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
424 // Construct message in the message queue memory; note that delete should not be called on the return value
425 new (slot) LocalType( &manager, &ResourceManager::HandleLoadResourceRequest, id, typePath, priority );
428 inline void RequestDecodeResourceMessage( EventThreadServices& eventThreadServices,
429 ResourceManager& manager,
431 /// We use typePath instead of the raw type for ownership and to enable copying of a concrete type.
432 const ResourceTypePath& typePath,
433 RequestBufferPtr buffer,
434 Integration::LoadResourcePriority priority )
436 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, RequestBufferPtr, Integration::LoadResourcePriority > LocalType;
438 // Reserve some memory inside the message queue
439 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
441 // Construct message in the message queue memory; note that delete should not be called on the return value
442 new (slot) LocalType( &manager, &ResourceManager::HandleDecodeResourceRequest, id, typePath, buffer, priority );
445 inline void RequestAddBitmapImageMessage( EventThreadServices& eventThreadServices,
446 ResourceManager& manager,
448 Integration::Bitmap* resourceData )
450 typedef MessageValue2< ResourceManager, ResourceId, Integration::BitmapPtr > LocalType;
452 // Reserve some memory inside the message queue
453 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
455 // Construct message in the message queue memory; note that delete should not be called on the return value
456 new (slot) LocalType( &manager, &ResourceManager::HandleAddBitmapImageRequest, id, resourceData );
459 inline void RequestAddNativeImageMessage( EventThreadServices& eventThreadServices,
460 ResourceManager& manager,
462 NativeImageInterfacePtr resourceData )
464 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > 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::HandleAddNativeImageRequest, id, resourceData );
473 inline void RequestAddFrameBufferImageMessage( EventThreadServices& eventThreadServices,
474 ResourceManager& manager,
478 Pixel::Format pixelFormat )
480 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
482 // Reserve some memory inside the message queue
483 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
485 // Construct message in the message queue memory; note that delete should not be called on the return value
486 new (slot) LocalType( &manager, &ResourceManager::HandleAddFrameBufferImageRequest, id, width, height, pixelFormat );
489 inline void RequestAddFrameBufferImageMessage( EventThreadServices& eventThreadServices,
490 ResourceManager& manager,
492 NativeImageInterfacePtr resourceData )
494 typedef MessageValue2< ResourceManager, ResourceId, NativeImageInterfacePtr > 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::HandleAddFrameBufferImageRequest, id, resourceData );
503 inline void RequestAllocateTextureMessage( EventThreadServices& eventThreadServices,
504 ResourceManager& manager,
508 Pixel::Format pixelFormat)
510 typedef MessageValue4< ResourceManager, ResourceId, unsigned int, unsigned int, Pixel::Format > LocalType;
512 // Reserve some memory inside the message queue
513 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
515 // Construct message in the message queue memory; note that delete should not be called on the return value
516 new (slot) LocalType( &manager, &ResourceManager::HandleAllocateTextureRequest, id, width, height, pixelFormat );
519 inline void RequestAllocateMeshMessage( EventThreadServices& eventThreadServices,
520 ResourceManager& manager,
522 OwnerPointer<MeshData>& meshData )
524 typedef MessageValue2< ResourceManager, ResourceId, OwnerPointer<MeshData> > LocalType;
526 // Reserve some memory inside the message queue
527 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
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::HandleAllocateMeshRequest, id, meshData.Release() );
533 inline void RequestLoadShaderMessage( EventThreadServices& eventThreadServices,
534 ResourceManager& manager,
536 const ResourceTypePath& typePath )
538 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
540 // Reserve some memory inside the message queue
541 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
543 // Construct message in the message queue memory; note that delete should not be called on the return value
544 new (slot) LocalType( &manager, &ResourceManager::HandleLoadShaderRequest, id, typePath );
547 inline void RequestUpdateBitmapAreaMessage( EventThreadServices& eventThreadServices,
548 ResourceManager& manager,
550 const Dali::RectArea& area )
552 typedef MessageValue2< ResourceManager, ResourceId, Dali::RectArea > LocalType;
554 // Reserve some memory inside the message queue
555 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
557 // Construct message in the message queue memory; note that delete should not be called on the return value
558 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateBitmapAreaRequest, id, area );
561 inline void RequestUploadBitmapMessage( EventThreadServices& eventThreadServices,
562 ResourceManager& manager,
564 Integration::BitmapPtr bitmap,
566 std::size_t yOffset )
568 typedef MessageValue4< ResourceManager, ResourceId, Integration::BitmapPtr , std::size_t, std::size_t > LocalType;
570 // Reserve some memory inside the message queue
571 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
573 // Construct message in the message queue memory; note that delete should not be called on the return value
574 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, bitmap, xOffset, yOffset );
577 inline void RequestUploadBitmapMessage( EventThreadServices& eventThreadServices,
578 ResourceManager& manager,
582 std::size_t yOffset )
584 typedef MessageValue4< ResourceManager, ResourceId, ResourceId, std::size_t, std::size_t > LocalType;
586 // Reserve some memory inside the message queue
587 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
589 // Construct message in the message queue memory; note that delete should not be called on the return value
590 new (slot) LocalType( &manager, &ResourceManager::HandleUploadBitmapRequest, destId, srcId, xOffset, yOffset );
593 inline void RequestUpdateMeshMessage( EventThreadServices& eventThreadServices,
594 ResourceManager& manager,
596 const Dali::MeshData& meshData,
597 ResourcePolicy::Discardable discardable )
599 typedef MessageDoubleBuffered2< ResourceManager, ResourceId, OwnerPointer< MeshData > > LocalType;
600 // Reserve some memory inside the message queue
601 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
603 MeshData* internalMeshData = new MeshData( meshData, discardable, false );
605 // Construct message in the message queue memory; note that delete should not be called on the return value
606 new (slot) LocalType( &manager, &ResourceManager::HandleUpdateMeshRequest, id, internalMeshData );
609 inline void RequestReloadResourceMessage( EventThreadServices& eventThreadServices,
610 ResourceManager& manager,
612 const ResourceTypePath& typePath,
613 Integration::LoadResourcePriority priority,
614 bool resetFinishedStatus )
616 typedef MessageValue4< ResourceManager, ResourceId, ResourceTypePath, Integration::LoadResourcePriority, bool > LocalType;
618 // Reserve some memory inside the message queue
619 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ), false );
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::HandleReloadResourceRequest, id, typePath, priority, resetFinishedStatus );
625 inline void RequestSaveResourceMessage( EventThreadServices& eventThreadServices,
626 ResourceManager& manager,
628 const ResourceTypePath& typePath )
630 typedef MessageValue2< ResourceManager, ResourceId, ResourceTypePath > LocalType;
632 // Reserve some memory inside the message queue
633 unsigned int* slot = eventThreadServices.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::HandleSaveResourceRequest, id, typePath );
639 inline void RequestDiscardResourceMessage( EventThreadServices& eventThreadServices,
640 ResourceManager& manager,
642 Integration::ResourceTypeId typeId )
644 typedef MessageValue2< ResourceManager, ResourceId, Integration::ResourceTypeId > LocalType;
646 // Reserve some memory inside the message queue
647 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
649 // Construct message in the message queue memory; note that delete should not be called on the return value
650 new (slot) LocalType( &manager, &ResourceManager::HandleDiscardResourceRequest, id, typeId );
653 } // namespace Internal
657 #endif // __DALI_INTERNAL_RESOURCE_MANAGER_H__