File: vbz_plugin_user_utils.h

package info (click to toggle)
libvbz-hdf-plugin 1.0.2-3.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,384 kB
  • sloc: cpp: 28,289; python: 392; ansic: 40; sh: 21; makefile: 19; xml: 16
file content (62 lines) | stat: -rw-r--r-- 2,182 bytes parent folder | download | duplicates (2)
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
#pragma once

#include <hdf5.h>
#include "vbz_plugin.h"

#define FILTER_VBZ_VERSION 1

extern "C" const void* vbz_plugin_info(void);

/// \brief Call to enable the vbz filter on the specified creation properties.
/// \param integer_size             Size of integer type to be compressed. Leave at 0 to extract this information from the hdf type.
/// \param use_zig_zag              Control if zig zag encoding should be used on the type. If integer_size is not specified then the
///                                 hdf type's signedness is used to fill in this field.
/// \param zstd_compression_level   Control the level of compression used to filter the dataset.
/// \param vbz_version              The version of compression to apply to user data.
inline int vbz_filter_enable_versioned(
    hid_t creation_properties,
    unsigned int integer_size,
    bool use_zig_zag,
    unsigned int zstd_compression_level,
    int vbz_version)
{
    unsigned int values[4] = {
        (unsigned int)vbz_version,
        integer_size,
        use_zig_zag,
        zstd_compression_level
    };

    return H5Pset_filter(creation_properties, FILTER_VBZ_ID, 0, 4, values);
}

/// \brief Call to enable the vbz filter on the specified creation properties.
/// \param integer_size             Size of integer type to be compressed. Leave at 0 to extract this information from the hdf type.
/// \param use_zig_zag              Control if zig zag encoding should be used on the type. If integer_size is not specified then the
///                                 hdf type's signedness is used to fill in this field.
/// \param zstd_compression_level   Control the level of compression used to filter the dataset.
inline int vbz_filter_enable(
    hid_t creation_properties,
    unsigned int integer_size,
    bool use_zig_zag,
    unsigned int zstd_compression_level)
{
    return vbz_filter_enable_versioned(
        creation_properties,
        integer_size,
        use_zig_zag,
        zstd_compression_level,
        FILTER_VBZ_VERSION
    );
}

inline bool vbz_register()
{
    int retval = H5Zregister(vbz_plugin_info());
    if (retval < 0)
    {
        return 0;
    }

    return 1;
}