cvslide.hpp

// This file is part of slideio project.
// It is subject to the license terms in the LICENSE file found in the top-level directory
// of this distribution and at http://slideio.com/license.html.
#pragma once
 
#include "slideio/core/slideio_core_def.hpp"
#include "slideio/core/cvscene.hpp"
#include "slideio/core/metadata.hpp"
#include <string>
#include <mutex>
 
#if defined(_MSC_VER)
#pragma warning( push )
#pragma warning(disable: 4251)
#endif
 
namespace slideio
{
    class SLIDEIO_CORE_EXPORTS CVSlide
    {
        friend class ImageDriver;
    protected:
        virtual ~CVSlide() = default;
    public:
        virtual int getNumScenes() const = 0;
        virtual std::string getFilePath() const = 0;
        virtual const std::string& getRawMetadata() const {return m_rawMetadata;}
        const Metadata& getMetadata() const;
        virtual std::shared_ptr<CVScene> getScene(int index) const = 0;
        virtual std::shared_ptr<CVScene> getSceneByName(const std::string& name);
        virtual const std::list<std::string>& getAuxImageNames() const {
            return m_auxNames;
        }
        virtual int getNumAuxImages() const {
            return static_cast<int>(m_auxNames.size());
        }
        virtual std::shared_ptr<CVScene> getAuxImage(const std::string& sceneName) const;
         virtual MetadataFormat getMetadataFormat() const { return m_metadataFormat; }
        void setDriverId(const std::string& driverId) {
            m_driverId = driverId;
         }
        const std::string& getDriverId() const {
            return m_driverId;
        }
         static MetadataFormat recognizeMetadataFormat(const std::string& metadata);
         std::string toString() const;
    protected:
        virtual MetadataBuilder buildMetadataTree() const;
 
    protected:
        std::string m_rawMetadata;
        MetadataFormat m_metadataFormat = MetadataFormat::None;
        std::list<std::string> m_auxNames;
        std::string m_driverId;
 
    private:
        mutable std::once_flag m_metadataOnce;
        mutable Metadata       m_metadata;
    };
}
 
#define CVSlidePtr std::shared_ptr<slideio::CVSlide>
 
#if defined(_MSC_VER)
#pragma warning( pop )
#endif