transfer_syntax.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_TRANSFER_SYNTAX_HPP
#define PACS_ENCODING_TRANSFER_SYNTAX_HPP
 
#include "kcenon/pacs/encoding/byte_order.h"
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace kcenon::pacs::encoding {
 
class transfer_syntax {
public:
    explicit transfer_syntax(std::string_view uid);
 
 
    [[nodiscard]] std::string_view uid() const noexcept;
 
    [[nodiscard]] std::string_view name() const noexcept;
 
    [[nodiscard]] byte_order endianness() const noexcept;
 
    [[nodiscard]] vr_encoding vr_type() const noexcept;
 
    [[nodiscard]] bool is_encapsulated() const noexcept;
 
    [[nodiscard]] bool is_deflated() const noexcept;
 
 
 
    [[nodiscard]] bool is_valid() const noexcept;
 
    [[nodiscard]] bool is_supported() const noexcept;
 
 
 
    static const transfer_syntax implicit_vr_little_endian;
 
    static const transfer_syntax explicit_vr_little_endian;
 
    static const transfer_syntax explicit_vr_big_endian;
 
    static const transfer_syntax deflated_explicit_vr_le;
 
    static const transfer_syntax jpeg_baseline;
 
    static const transfer_syntax jpeg_lossless;
 
    static const transfer_syntax jpeg2000_lossless;
 
    static const transfer_syntax jpeg2000_lossy;
 
    static const transfer_syntax rle_lossless;
 
    static const transfer_syntax htj2k_lossless;
 
    static const transfer_syntax htj2k_rpcl;
 
    static const transfer_syntax htj2k_lossy;
 
    static const transfer_syntax hevc_main;
 
    static const transfer_syntax hevc_main10;
 
    static const transfer_syntax jpegxl_lossless;
 
    static const transfer_syntax jpegxl_jpeg_recompression;
 
    static const transfer_syntax jpegxl_lossy;
 
    static const transfer_syntax frame_deflate;
 
 
 
    bool operator==(const transfer_syntax& other) const noexcept;
 
    bool operator!=(const transfer_syntax& other) const noexcept;
 
 
private:
    friend std::optional<transfer_syntax> find_transfer_syntax(std::string_view);
    friend std::vector<transfer_syntax> supported_transfer_syntaxes();
    friend std::vector<transfer_syntax> all_transfer_syntaxes();
 
    transfer_syntax(std::string_view uid, std::string_view name,
                    byte_order endian, vr_encoding vr,
                    bool encapsulated, bool deflated, bool supported);
 
    std::string uid_;
    std::string name_;
    byte_order endianness_;
    vr_encoding vr_type_;
    bool encapsulated_;
    bool deflated_;
    bool valid_;
    bool supported_;
};
 
 
[[nodiscard]] std::optional<transfer_syntax> find_transfer_syntax(
    std::string_view uid);
 
[[nodiscard]] std::vector<transfer_syntax> supported_transfer_syntaxes();
 
[[nodiscard]] std::vector<transfer_syntax> all_transfer_syntaxes();
 
 
}  // namespace kcenon::pacs::encoding
 
#endif  // PACS_ENCODING_TRANSFER_SYNTAX_HPP