C-Blosc2 API#
This section contains the C-Blosc2 public API and the structures needed to use it. C-Blosc2 tries to be backward compatible with both the C-Blosc1 API and format. Furthermore, if you just use the C-Blosc1 API you are guaranteed to generate compressed data containers that can be read with a Blosc1 library.
Having said that, the C-Blosc2 API gives you much more functionality, like 64-bit data containers, more filters, more support for vector instructions, support for accelerated versions of some codecs in Intel’s IPP (like LZ4), the ability to work with data either in-memory or on-disk (frames) or attach metainfo to your datasets (metalayers).
Contents:
- Utility variables
- Utility functions
- Blosc1 API
- Context
- Plugins
- Super-chunk
blosc2_storageblosc2_schunkblosc2_schunk_new()blosc2_schunk_free()blosc2_schunk_open()blosc2_schunk_open_offset()blosc2_schunk_open_udio()blosc2_schunk_copy()blosc2_schunk_from_buffer()blosc2_schunk_to_buffer()blosc2_schunk_to_file()blosc2_schunk_append_file()blosc2_schunk_get_cparams()blosc2_schunk_get_dparams()blosc2_schunk_reorder_offsets()blosc2_schunk_frame_len()blosc2_schunk_fill_special()blosc2_schunk_append_buffer()blosc2_schunk_get_slice_buffer()blosc2_schunk_set_slice_buffer()blosc2_schunk_avoid_cframe_free()- Dealing with chunks
- Creating chunks
- Frame specific functions
- Metalayers
- Blosc2 NDim