compression_codec.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#ifndef PACS_ENCODING_COMPRESSION_COMPRESSION_CODEC_HPP
#define PACS_ENCODING_COMPRESSION_COMPRESSION_CODEC_HPP
 
#include "kcenon/pacs/encoding/compression/image_params.h"
#include "kcenon/pacs/encoding/transfer_syntax.h"
#include <kcenon/pacs/core/result.h>
 
#include <cstdint>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::encoding::compression {
 
struct compression_options {
    int quality{75};
 
    bool lossless{false};
 
    bool progressive{false};
 
    int chroma_subsampling{2};
};
 
struct compression_result {
    std::vector<uint8_t> data;
 
    image_params output_params;
};
 
using codec_result = kcenon::pacs::Result<compression_result>;
 
class compression_codec {
public:
    virtual ~compression_codec() = default;
 
 
    [[nodiscard]] virtual std::string_view transfer_syntax_uid() const noexcept = 0;
 
    [[nodiscard]] virtual std::string_view name() const noexcept = 0;
 
    [[nodiscard]] virtual bool is_lossy() const noexcept = 0;
 
    [[nodiscard]] virtual bool can_encode(const image_params& params) const noexcept = 0;
 
    [[nodiscard]] virtual bool can_decode(const image_params& params) const noexcept = 0;
 
 
 
    [[nodiscard]] virtual codec_result encode(
        std::span<const uint8_t> pixel_data,
        const image_params& params,
        const compression_options& options = {}) const = 0;
 
    [[nodiscard]] virtual codec_result decode(
        std::span<const uint8_t> compressed_data,
        const image_params& params) const = 0;
 
 
protected:
    compression_codec() = default;
    compression_codec(const compression_codec&) = default;
    compression_codec& operator=(const compression_codec&) = default;
    compression_codec(compression_codec&&) = default;
    compression_codec& operator=(compression_codec&&) = default;
};
 
}  // namespace kcenon::pacs::encoding::compression
 
#endif  // PACS_ENCODING_COMPRESSION_COMPRESSION_CODEC_HPP