libbgcode/src/LibBGCode/binarize/binarize.hpp at main · prusa3d/libbgcode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
#ifndef BGCODE_BINARIZE_HPP
#define BGCODE_BINARIZE_HPP

#include "binarize/export.h"
#include "core/core.hpp"

namespace bgcode { namespace binarize {

struct BGCODE_BINARIZE_EXPORT BaseMetadataBlock
{
    // type of data encoding
    uint16_t encoding_type{ 0 };
    // data in key/value form
    std::vector<std::pair<std::string, std::string>> raw_data;

    // read block data in encoded format
    core::EResult read_data(FILE& file, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT FileMetadataBlock : public BaseMetadataBlock
{
    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT PrintMetadataBlock : public BaseMetadataBlock
{
    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT PrinterMetadataBlock : public BaseMetadataBlock
{
    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT ThumbnailBlock
{
    core::ThumbnailParams params;
    std::vector<std::byte> data;

    // write block header and data
    core::EResult write(FILE& file, core::EChecksumType checksum_type);
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT GCodeBlock
{
    uint16_t encoding_type{ 0 };
    std::string raw_data;

    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT SlicerMetadataBlock : public BaseMetadataBlock
{
    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

struct BGCODE_BINARIZE_EXPORT Slicer3MetadataBlock : public BaseMetadataBlock
{
    Slicer3MetadataBlock() : BaseMetadataBlock() {
        encoding_type = static_cast<std::underlying_type_t<core::EMetadataEncodingType>>(
              core::EMetadataEncodingType::JSON);
    }

    void set_json(std::string_view);
    const std::string& json() const;

    // write block header and data
    core::EResult write(FILE& file, core::ECompressionType compression_type, core::EChecksumType checksum_type) const;
    // read block data
    core::EResult read_data(FILE& file, const core::FileHeader& file_header, const core::BlockHeader& block_header);
};

enum class EPeekSlicerMetadataResult {
    Slicer3MetadataFound,
    SlicerMetadataFound,
    OtherBlockFound,
    ReadError
};

// Peek the block content (just metadata extra "header") and decide what kind of block follows
extern BGCODE_BINARIZE_EXPORT EPeekSlicerMetadataResult peek_slicer_metadata_block(FILE& file, const core::BlockHeader& block_header);


struct BinarizerConfig
{
    struct Compression
    {
        core::ECompressionType file_metadata{ core::ECompressionType::None };
        core::ECompressionType printer_metadata{ core::ECompressionType::None };
        core::ECompressionType print_metadata{ core::ECompressionType::None };
        core::ECompressionType slicer_metadata{ core::ECompressionType::None };
        core::ECompressionType gcode{ core::ECompressionType::None };
        core::ECompressionType slicer3_metadata{ core::ECompressionType::None };
    };
    Compression compression;
    core::EGCodeEncodingType gcode_encoding{ core::EGCodeEncodingType::None };
    core::EMetadataEncodingType metadata_encoding{ core::EMetadataEncodingType::INI };
    core::EChecksumType checksum{ core::EChecksumType::CRC32 };
};

struct BGCODE_BINARIZE_EXPORT BinaryData
{
    FileMetadataBlock file_metadata;
    PrinterMetadataBlock printer_metadata;
    std::vector<ThumbnailBlock> thumbnails;
    SlicerMetadataBlock slicer_metadata;
    Slicer3MetadataBlock slicer3_metadata;
    PrintMetadataBlock print_metadata;
};

class BGCODE_BINARIZE_EXPORT Binarizer
{
public:
    bool is_enabled() const;
    void set_enabled(bool enable);

    BinaryData& get_binary_data();
    const BinaryData& get_binary_data() const;

    size_t get_max_gcode_cache_size() const;
    void set_max_gcode_cache_size(size_t size);

    core::EResult initialize(FILE& file, const BinarizerConfig& config);
    core::EResult append_gcode(const std::string& gcode);
    core::EResult finalize();

private:
    FILE* m_file{ nullptr };
    bool m_enabled{ false };
    BinarizerConfig m_config;
    BinaryData m_binary_data;
    std::string m_gcode_cache;
    size_t m_gcode_cache_size{ 65536 };
};

} // namespace binarize
} // namespace bgcode

#endif // BGCODE_BINARIZE_HPP_