UnrealEngine/Engine/Plugins/Mutable/Source/CustomizableObject/Internal/MuCO/UnrealMutableModelDiskStreamer.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "MuCO/CustomizableObjectPrivate.h"
#include "MuR/Serialisation.h"

#if WITH_EDITOR
#include "DerivedDataRequestOwner.h"
#endif

class FArchive;
class IAsyncReadFileHandle;
class IAsyncReadRequest;
class IBulkDataIORequest;
class UCustomizableObject;
namespace mu {
	class FModel;
	enum class EDataType : uint8;
}
struct FMutableStreamableBlock;

class FUnrealMutableInputStream : public mu::FInputStream
{
public:

	FUnrealMutableInputStream(FArchive& ar);

	// mu::FInputStream interface
	void Read(void* pData, uint64 size) override;

private:
	FArchive& m_ar;
};


// Implementation of a mutable streamer using bulk storage.
class FUnrealMutableModelBulkReader : public mu::FModelReader
{
public:
	// 
	CUSTOMIZABLEOBJECT_API ~FUnrealMutableModelBulkReader();

	// Own interface

	/** Make sure that the provided object can stream data. */
	CUSTOMIZABLEOBJECT_API bool PrepareStreamingForObject(UCustomizableObject* Object);

#if WITH_EDITOR
	/** Cancel any further streaming operations for the given object. This is necessary if the object compiled data is
	 * going to be modified. This can only happen in the editor, when recompiling.
	 * Any additional streaming requests for this object will fail.
	 */
	CUSTOMIZABLEOBJECT_API void CancelStreamingForObject(const UCustomizableObject* CustomizableObject);

	/** Checks if there are any streaming operations for the parameter object.
	* @return true if there are streaming operations in flight
	*/
	CUSTOMIZABLEOBJECT_API bool AreTherePendingStreamingOperationsForObject(const UCustomizableObject* CustomizableObject) const;
#endif

	/** Release all the pending resources. This disables treamings for all objects. */
	CUSTOMIZABLEOBJECT_API void EndStreaming();

	// mu::ModelReader interface
	CUSTOMIZABLEOBJECT_API bool DoesBlockExist(const mu::FModel*, uint32 BlockKey) override;
	CUSTOMIZABLEOBJECT_API FOperationID BeginReadBlock(const mu::FModel*, uint32 BlockKey, void* pBuffer, uint64 size, mu::EDataType ResourceType, TFunction<void(bool bSuccess)>* CompletionCallback) override;
	CUSTOMIZABLEOBJECT_API bool IsReadCompleted(FOperationID) override;
	CUSTOMIZABLEOBJECT_API bool EndRead(FOperationID) override;

protected:

	struct FReadRequest
	{
		TSharedPtr<IBulkDataIORequest> BulkReadRequest;
		TSharedPtr<IAsyncReadRequest> FileReadRequest;
		TSharedPtr<FAsyncFileCallBack> FileCallback;

#if WITH_EDITORONLY_DATA
		TSharedPtr<UE::DerivedData::FRequestOwner> DDCReadRequest;
#endif
	};
	
	/** Streaming data for one object. */
	struct FObjectData
	{
		TWeakPtr<const mu::FModel> Model;

		FString BulkFilePrefix;
		TMap<FOperationID, FReadRequest> CurrentReadRequests;
		TMap<uint32, TSharedPtr<IAsyncReadFileHandle>> ReadFileHandles;

		TWeakPtr<FModelStreamableBulkData> ModelStreamableBulkData;
	};

	TArray<FObjectData> Objects;

	FCriticalSection FileHandlesCritical;

	/** This is used to generate unique ids for read requests. */
	FOperationID LastOperationID = 0;
};


#if WITH_EDITOR

class UnrealMutableOutputStream : public mu::FOutputStream
{
public:

	UnrealMutableOutputStream(FArchive& ar);

	// mu::FOutputStream interface
	void Write(const void* pData, uint64 size) override;

private:
	FArchive& m_ar;
};


// Implementation of a mutable streamer using bulk storage.
class FUnrealMutableModelBulkWriterEditor : public mu::FModelWriter
{
public:
	// 
	CUSTOMIZABLEOBJECT_API FUnrealMutableModelBulkWriterEditor(FArchive* InMainDataArchive = nullptr, FArchive* InStreamedDataArchive = nullptr);

	// mu::FModelWriter interface
	CUSTOMIZABLEOBJECT_API void OpenWriteFile(uint32 BlockKey, bool bIsStreamable) override;
	CUSTOMIZABLEOBJECT_API void Write(const void* pBuffer, uint64 size) override;
	CUSTOMIZABLEOBJECT_API void CloseWriteFile() override;

protected:

	// Non-owned pointer to an archive where we'll store the main model data (non-streamable)
	FArchive* MainDataArchive = nullptr;

	// Non-owned pointer to an archive where we'll store the resouces (streamable)
	FArchive* StreamedDataArchive = nullptr;

	FArchive* CurrentWriteFile = nullptr;

};


// Implementation of a mutable streamer using bulk storage.
class FUnrealMutableModelBulkWriterCook : public mu::FModelWriter
{
public:
	// 
	CUSTOMIZABLEOBJECT_API FUnrealMutableModelBulkWriterCook(FArchive* InMainDataArchive = nullptr, MutablePrivate::FModelStreamableData* InStreamedData = nullptr);

	// mu::FModelWriter interface
	CUSTOMIZABLEOBJECT_API void OpenWriteFile(uint32 BlockKey, bool bIsStreamable) override;
	CUSTOMIZABLEOBJECT_API void Write(const void* pBuffer, uint64 size) override;
	CUSTOMIZABLEOBJECT_API void CloseWriteFile() override;

protected:

	// Non-owned pointer to an archive where we'll store the main model data (non-streamable)
	FArchive* MainDataArchive = nullptr;

	// Non-owned pointer to an archive where we'll store the resouces (streamable)
	MutablePrivate::FModelStreamableData* StreamedData = nullptr;

	uint32 CurrentKey = 0;
	bool CurrentIsStreamable = false;
};


#endif