debugmediafile.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/objectbase.h>
#include <promeki/string.h>
#include <promeki/error.h>
#include <promeki/frame.h>
#include <promeki/framenumber.h>
#include <promeki/framecount.h>
#include <promeki/metadata.h>
#include <promeki/list.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class File;
 
class DebugMediaFile : public ObjectBase {
                PROMEKI_OBJECT(DebugMediaFile, ObjectBase)
        public:
                using UPtr = UniquePtr<DebugMediaFile>;
 
                enum Mode {
                        NotOpen = 0,
                        Read,
                        Write
                };
 
                struct OpenOptions {
                                Metadata sessionInfo;
                };
 
                struct FrameIndexEntry {
                                int64_t     fileOffset = 0; 
                                FrameNumber frameNumber;    
                                int64_t     presentationUs =
                                        0; 
                };
 
                static constexpr char kMagic[8] = {'P', 'M', 'D', 'F', '\x1A', '\x0A', '\x00', '\x00'};
 
                static constexpr uint32_t kFormatVersion = 1;
 
                static constexpr uint32_t kFileFlagHasFooter = 0x00000001;
 
                explicit DebugMediaFile(ObjectBase *parent = nullptr);
 
                ~DebugMediaFile() override;
 
                Error open(const String &filename, Mode mode, const OpenOptions &opts = {});
 
                Error close();
 
                bool isOpen() const { return _mode != NotOpen; }
 
                Mode mode() const { return _mode; }
 
                const String &filename() const { return _filename; }
 
                // ---- Write API ----
 
                Error writeFrame(const Frame &frame);
 
                FrameCount framesWritten() const { return _framesWritten; }
 
                // ---- Read API ----
 
                Error readFrame(Frame &out);
 
                Error readFrameAt(const FrameNumber &frameNumber, Frame &out);
 
                Error seek(const FrameNumber &frameNumber);
 
                const Metadata &sessionInfo() const { return _sessionInfo; }
 
                FrameCount frameCount() const;
 
                bool hasFooter() const { return (_fileFlags & kFileFlagHasFooter) != 0; }
 
                const List<FrameIndexEntry> &index() const;
 
        private:
                String                        _filename;
                Mode                          _mode = NotOpen;
                File                         *_file = nullptr; 
                uint32_t                      _fileFlags = 0;
                uint32_t                      _fileVersion = 0;
                int64_t                       _firstFramePos = 0; 
                FrameCount                    _framesWritten{0};
                mutable FrameNumber           _readCursor{0}; 
                mutable bool                  _indexBuilt = false;
                mutable List<FrameIndexEntry> _index;
                Metadata                      _sessionInfo;
 
                Error writeSignature(uint32_t flags);
                Error writeSessionChunk(const Metadata &sessionInfo);
                Error readSignature();
                Error readSessionChunk();
                Error appendFooter();
                Error buildIndex() const;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV