mlt-ffi 0.2.0

Diplomat FFI bindings for mlt-core
Documentation 
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

#ifndef MltLayerBuilder_D_HPP
#define MltLayerBuilder_D_HPP

#include "diplomat_runtime.hpp"
#include <cstdlib>
#include <functional>
#include <memory>
#include <optional>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>

namespace diplomat::capi {
struct ConvertError;
}
class ConvertError;
namespace diplomat::capi {
struct MltBuffer;
}
class MltBuffer;
namespace diplomat::capi {
struct MltEncoderOptions;
}
class MltEncoderOptions;
class MltMvtGeometryType;

namespace diplomat {
namespace capi {
struct MltLayerBuilder;
} // namespace capi
} // namespace diplomat

/**
 * A layer written one feature at a time, then encoded without going through MVT.
 */
class MltLayerBuilder {
public:
    /**
     * Start a layer.
     */
    inline static diplomat::result<diplomat::result<std::unique_ptr<MltLayerBuilder>, std::unique_ptr<ConvertError>>,
                                   diplomat::Utf8Error>
    new_(std::string_view name, uint32_t extent);

    /**
     * Start another layer, keeping the allocations of the last one.
     */
    inline diplomat::result<diplomat::result<std::monostate, std::unique_ptr<ConvertError>>, diplomat::Utf8Error> reset(
        std::string_view name, uint32_t extent);

    /**
     * Declare a property column, returning the key to set it with.
     * Declaring a name again returns its existing key.
     */
    inline diplomat::result<uint32_t, diplomat::Utf8Error> add_property(std::string_view name);

    /**
     * Start a feature with its geometry given as MVT commands, ending the previous one.
     * A ring with positive area starts a polygon and any other ring is a hole of the last one.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> begin_mvt_feature(
        MltMvtGeometryType geometry, diplomat::span<const uint32_t> commands, std::optional<uint64_t> id);

    /**
     * Set a boolean property of the current feature.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> set_bool(uint32_t key, bool value);

    /**
     * Set an integer property of the current feature.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> set_i64(uint32_t key, int64_t value);

    /**
     * Set a 32-bit float property of the current feature.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> set_f32(uint32_t key, float value);

    /**
     * Set a 64-bit float property of the current feature.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> set_f64(uint32_t key, double value);

    /**
     * Set a string property of the current feature.
     */
    inline diplomat::result<diplomat::result<std::monostate, std::unique_ptr<ConvertError>>, diplomat::Utf8Error>
    set_str(uint32_t key, std::string_view value);

    /**
     * Encode the layer and append it to `out`.
     */
    inline diplomat::result<std::monostate, std::unique_ptr<ConvertError>> encode_into(const MltEncoderOptions& options,
                                                                                       MltBuffer& out) const;

    inline const diplomat::capi::MltLayerBuilder* AsFFI() const;
    inline diplomat::capi::MltLayerBuilder* AsFFI();
    inline static const MltLayerBuilder* FromFFI(const diplomat::capi::MltLayerBuilder* ptr);
    inline static MltLayerBuilder* FromFFI(diplomat::capi::MltLayerBuilder* ptr);
    inline static void operator delete(void* ptr);

private:
    MltLayerBuilder() = delete;
    MltLayerBuilder(const MltLayerBuilder&) = delete;
    MltLayerBuilder(MltLayerBuilder&&) noexcept = delete;
    MltLayerBuilder operator=(const MltLayerBuilder&) = delete;
    MltLayerBuilder operator=(MltLayerBuilder&&) noexcept = delete;
    static void operator delete[](void*, size_t) = delete;
};

#endif // MltLayerBuilder_D_HPP