GFxMovieDef.h

Go to the documentation of this file.

#pragma once
 
#include "RE/G/GFxResource.h"
#include "RE/G/GFxResourceID.h"
#include "RE/G/GFxStateBag.h"
#include "RE/G/GMemoryHeap.h"
#include "RE/G/GRect.h"
#include "RE/G/GStats.h"
 
namespace RE
{
    class GASRefCountCollector;
    class GASStringManager;
    class GFxExporterInfo;
    class GFxMovieView;
 
    // Represents loaded shared data for an SWF movie file. These objects are normally created by Loader::CreateMovie and are shared by all movie instances.
    class GFxMovieDef :
        public GFxResource,  // 00
        public GFxStateBag   // 18
    {
    public:
        // SWF 8 file attributes, returned by GetFileAttributes. These attributes are configured in Publish Settings and Document Properties dialogs of the Flash studio.
        enum FileAttrFlags : std::uint32_t
        {
            kUseNetwork = 1 << 0,  // - Indicates that "Access Network only" was selected for an SWF file in publish settings for local playback security
            kHasMetadata = 1 << 4  // - Indicates that the file has embedded metadata, available through the GetMetadata method
        };
 
        // VisitResourceMask defines a set of resource mask flag bits passed as a visitMask argument to VisitResources. If a given flag bit is included in the visitMask, the corresponding resource types are included in the enumeration, otherwise they are ignored.
        enum VisitResourceMask : std::uint32_t
        {
            kNestedMovies = 1 << 15,  // Indicates that resources in the imported movies should also be enumerated.
 
            // Types of resources to visit
            kFonts = 1 << 0,           // Font resources should be enumerated.
            kBitmaps = 1 << 1,         // Image resources with GFxResource::ResourceUse::kBitmap should be enumerated (See GFxResource::ResourceUse). These resources correspond to image shape fills used in the SWF/FLA files.
            kGradientImages = 1 << 2,  // Image resources with GFxResource::ResourceUse::kGradientBitmaps should be enumerated (See GFxResource::ResourceUse). These resources are created based on GradientParams during loading.
            kEditTextFields = 1 << 3,  // Edit text field resources should be enumerated.
            kSounds = 1 << 4,          // Sound resources should be enumerated.
            kSprite = 1 << 5,          // Sprite resources should be enumerated.
 
            // Combined flags
            kAllLocalImages = (kBitmaps | kGradientImages),            // Combines kBitmaps and kGradientImages.
            kAllImages = (kBitmaps | kGradientImages | kNestedMovies)  // Combines kBitmaps, kGradientImages and kNestedMovies.
        };
 
        struct MemoryParams
        {
            MemoryParams(UPInt a_memoryArena = 0);
 
            // members
            GMemoryHeap::HeapDesc desc;                      // 00
            float                 heapLimitMultiplier;       // 40
            std::uint32_t         maxCollectionRoots;        // 44
            std::uint32_t         framesBetweenCollections;  // 48
            std::uint32_t         pad4C;                     // 4C
        };
        static_assert(sizeof(MemoryParams) == 0x50);
 
        class MemoryContext : public GRefCountBase<MemoryContext, GStatGroups::kGStat_Default_Mem>
        {
        public:
            MemoryContext() = delete;
            ~MemoryContext() override;  // 00
        };
        static_assert(sizeof(MemoryContext) == 0x10);
 
        class MemoryContextImpl : public MemoryContext
        {
        public:
            class HeapLimit : public GMemoryHeap::LimitHandler
            {
            public:
                ~HeapLimit() override;
 
                // override (GMemoryHeap::LimitHandler)
                bool OnExceedLimit(GMemoryHeap* a_heap, UPInt a_overLimit) override;    // 01
                void OnFreeSegment(GMemoryHeap* a_heap, UPInt a_freeingSize) override;  // 02
 
                // members
                std::uint64_t unk08;  // 08
                std::uint64_t unk10;  // 10
                std::uint64_t unk18;  // 18
                std::uint64_t unk20;  // 20
                std::uint64_t unk28;  // 28
            };
            static_assert(sizeof(HeapLimit) == 0x30);
 
            // members
            GMemoryHeap*               heap;               // 10
            GPtr<GASRefCountCollector> refCountCollector;  // 18
            GPtr<GASStringManager>     stringManager;      // 20
            std::uint64_t              unk28;              // 28
            HeapLimit                  heapLimit;          // 30
        };
        static_assert(sizeof(MemoryContextImpl) == 0x60);
 
        struct ImportVisitor
        {
            virtual ~ImportVisitor();  // 00
 
            // add
            virtual void Visit(GFxMovieDef* a_parentDef, GFxMovieDef* a_importDef, const char* a_importedMovieFilename) = 0;  // 01
        };
        static_assert(sizeof(ImportVisitor) == 0x8);
 
        struct ResourceVisitor : public GFxFileConstants
        {
            virtual ~ResourceVisitor();  // 00
 
            // add
            virtual void Visit(GFxMovieDef* a_movieDef, GFxResource* a_resource, GFxResourceID a_id, const char* a_exportName) = 0;  // 01
        };
        static_assert(sizeof(ResourceVisitor) == 0x8);
 
        // add
        [[nodiscard]] virtual std::uint32_t          GetVersion() const = 0;                                                                                         // 04
        [[nodiscard]] virtual std::uint32_t          GetLoadingFrame() const = 0;                                                                                    // 05
        [[nodiscard]] virtual float                  GetWidth() const = 0;                                                                                           // 06
        [[nodiscard]] virtual float                  GetHeight() const = 0;                                                                                          // 07
        [[nodiscard]] virtual std::uint32_t          GetFrameCount() const = 0;                                                                                      // 08
        [[nodiscard]] virtual float                  GetFrameRate() const = 0;                                                                                       // 09
        [[nodiscard]] virtual GRectF                 GetFrameRect() const = 0;                                                                                       // 0A
        [[nodiscard]] virtual std::uint32_t          GetSWFFlags() const = 0;                                                                                        // 0B
        [[nodiscard]] virtual const char*            GetFileURL() const = 0;                                                                                         // 0C
        virtual void                                 WaitForLoadFinish(bool a_cancel = false) const = 0;                                                             // 0D
        virtual void                                 WaitForFrame(std::uint32_t a_frame) const = 0;                                                                  // 0E
        [[nodiscard]] virtual std::uint32_t          GetFileAttributes() const = 0;                                                                                  // 0F
        virtual std::uint32_t                        GetMetadata(char* a_buff, std::uint32_t a_buffSize) const = 0;                                                  // 10
        [[nodiscard]] virtual GMemoryHeap*           GetLoadDataHeap() const = 0;                                                                                    // 11
        [[nodiscard]] virtual GMemoryHeap*           GetBindDataHeap() const = 0;                                                                                    // 12
        [[nodiscard]] virtual GMemoryHeap*           GetImageHeap() const = 0;                                                                                       // 13
        [[nodiscard]] virtual GFxResource*           GetMovieDataResource() const = 0;                                                                               // 14
        [[nodiscard]] virtual const GFxExporterInfo* GetExporterInfo() const = 0;                                                                                    // 15
        virtual MemoryContext*                       CreateMemoryContext(const char* a_heapName, const MemoryParams& a_memParams, bool a_debugHeap) = 0;             // 16
        virtual GFxMovieView*                        CreateInstance(const MemoryParams& a_memParams, bool a_initFirstFrame = true) = 0;                              // 17
        virtual GFxMovieView*                        CreateInstance(MemoryContext* a_memContext, bool a_initFirstFrame = true) = 0;                                  // 18
        virtual void                                 VisitImportedMovies(ImportVisitor* a_visitor) = 0;                                                              // 19
        virtual void                                 VisitResources(ResourceVisitor* a_visitor, VisitResourceMask a_visitMask = VisitResourceMask::kAllImages) = 0;  // 1A
        virtual GFxResource*                         GetResource(const char* a_exportName) const = 0;                                                                // 1B
 
        GFxMovieView* CreateInstance(bool a_initFirstFrame = true, UPInt a_memoryArena = 0);
    };
    static_assert(sizeof(GFxMovieDef) == 0x20);
}