image_prober.hpp

/*
 * Copyright (c) 2024 The RefValue Project
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include "../compat.hpp"
#include "abstract/image_header_extractor.hpp"
#include "image_general_header.hpp"
 
#include <cstddef>
#include <iosfwd>
#include <memory>
#include <optional>
#include <span>
#include <string_view>
 
namespace essence::imaging {
    class image_prober {
    public:
        ES_API(CPPESSENCE) image_prober();
 
        ES_API(CPPESSENCE) explicit image_prober(std::span<const abstract::image_header_extractor> extra_extractors);
 
        ES_API(CPPESSENCE) image_prober(image_prober&&) noexcept;
        ES_API(CPPESSENCE) ~image_prober();
        ES_API(CPPESSENCE) image_prober& operator=(image_prober&&) noexcept;
 
        [[nodiscard]] ES_API(CPPESSENCE) std::span<const abstract::image_header_extractor> extractors() const noexcept;
 
        [[nodiscard]] ES_API(CPPESSENCE) std::optional<image_general_header> extract_header(
            std::string_view path) const;
 
        [[nodiscard]] ES_API(CPPESSENCE) std::optional<image_general_header> extract_header(std::istream& stream) const;
 
        [[nodiscard]] ES_API(CPPESSENCE) std::optional<image_general_header> extract_header(std::span<const std::byte> buffer) const;
 
    private:
        class impl;
 
        std::unique_ptr<impl> impl_;
    };
} // namespace essence::imaging