imgseq.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/error.h>
#include <promeki/string.h>
#include <promeki/filepath.h>
#include <promeki/numname.h>
#include <promeki/framerate.h>
#include <promeki/size2d.h>
#include <promeki/pixelformat.h>
#include <promeki/metadata.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class JsonObject;
 
class ImgSeq {
        public:
                static inline const char *TypeTag = "imgseq";
 
                ImgSeq() = default;
 
                static ImgSeq load(const FilePath &path, Error *err = nullptr);
 
                static ImgSeq fromJson(const JsonObject &json, Error *err = nullptr);
 
                static bool isImgSeqJson(const String &jsonText);
 
                Error save(const FilePath &path) const;
 
                JsonObject toJson() const;
 
                Error detectRange(const FilePath &dir);
 
                bool isValid() const { return _name.isValid(); }
 
                const FilePath &dir() const { return _dir; }
 
                void setDir(const FilePath &val) { _dir = val; }
 
                const NumName &name() const { return _name; }
 
                void setName(const NumName &val) { _name = val; }
 
                size_t head() const { return _head; }
 
                void setHead(size_t val) { _head = val; }
 
                size_t tail() const { return _tail; }
 
                void setTail(size_t val) { _tail = val; }
 
                size_t length() const {
                        if (!isValid()) return 0;
                        return (_tail >= _head) ? (_tail - _head + 1) : 0;
                }
 
                const FrameRate &frameRate() const { return _frameRate; }
 
                void setFrameRate(const FrameRate &val) { _frameRate = val; }
 
                const Size2Du32 &videoSize() const { return _videoSize; }
 
                void setVideoSize(const Size2Du32 &val) { _videoSize = val; }
 
                const PixelFormat &pixelFormat() const { return _pixelFormat; }
 
                void setPixelFormat(const PixelFormat &val) { _pixelFormat = val; }
 
                const String &audioFile() const { return _audioFile; }
 
                void setAudioFile(const String &val) { _audioFile = val; }
 
                const Metadata &metadata() const { return _metadata; }
 
                Metadata &metadata() { return _metadata; }
 
                void setMetadata(const Metadata &val) { _metadata = val; }
 
                const FilePath &sidecarPath() const { return _sidecarPath; }
 
                void setSidecarPath(const FilePath &val) { _sidecarPath = val; }
 
                String frameFileName(size_t idx) const { return _name.name(static_cast<int>(_head + idx)); }
 
        private:
                FilePath    _dir;
                NumName     _name;
                size_t      _head = 0;
                size_t      _tail = 0;
                FrameRate   _frameRate;
                Size2Du32   _videoSize;
                PixelFormat _pixelFormat;
                String      _audioFile;
                Metadata    _metadata;
                FilePath    _sidecarPath;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV