|
1 |
| -Release notes for C-Blosc2 2.2.1 |
| 1 | +Release notes for C-Blosc2 2.3.0 |
2 | 2 | ================================
|
3 | 3 |
|
4 |
| -Changes from 2.2.0 to 2.2.1 |
| 4 | +Changes from 2.2.0 to 2.3.0 |
5 | 5 | ===========================
|
6 | 6 |
|
7 |
| -#XXX version-specific blurb XXX# |
8 |
| - |
| 7 | +* [API change] In order to allow to compile with both C-Blosc and C-Blosc2 libraries, a new API has been created for the symbols and function names that had collisions. Here are the changed symbols and functions: |
| 8 | + |
| 9 | + * Blosc2 symbols that take different values than in Blosc1: |
| 10 | + - BLOSC_MAX_OVERHEAD -> BLOSC2_MAX_OVERHEAD |
| 11 | + - BLOSC_MAX_BUFFERSIZE -> BLOSC2_MAX_BUFFERSIZE |
| 12 | + |
| 13 | + * Original Blosc1 API that takes the `blosc1_` prefix: |
| 14 | + - blosc_compress -> blosc1_compress |
| 15 | + - blosc_decompress -> blosc1_decompress |
| 16 | + - blosc_getitem -> blosc1_getitem |
| 17 | + - blosc_get_compressor -> blosc1_get_compressor |
| 18 | + - blosc_set_compressor -> blosc_set_compressor |
| 19 | + - blosc_cbuffer_sizes -> blosc1_cbuffer_sizes |
| 20 | + - blosc_cbuffer_validate -> blosc1_cbuffer_validate |
| 21 | + - blosc_cbuffer_metainfo -> blosc1_cbuffer_metainfo |
| 22 | + - blosc_get_blocksize -> blosc1_get_blocksize |
| 23 | + - blosc_set_blocksize -> blosc1_set_blocksize |
| 24 | + - blosc_set_splitmode -> blosc1_set_splitmode |
| 25 | + |
| 26 | + * API that has been migrated to blosc2_ prefix |
| 27 | + - blosc_init -> blosc2_init |
| 28 | + - blosc_destroy -> blosc2_destroy |
| 29 | + - blosc_free_resources -> blosc2_free_resources |
| 30 | + - blosc_get_nthreads -> blosc2_get_nthreads |
| 31 | + - blosc_set_nthreads -> blosc2_set_nthreads |
| 32 | + - blosc_compcode_to_compname -> blosc2_compcode_to_compname |
| 33 | + - blosc_compname_to_compcode -> blosc2_compname_to_compcode |
| 34 | + - blosc_list_compressors -> blosc2_list_compressors |
| 35 | + - blosc_get_version_string -> blosc2_get_version_string |
| 36 | + - blosc_get_complib_info -> blosc2_get_complib_info |
| 37 | + - blosc_cbuffer_versions -> blosc2_cbuffer_versions |
| 38 | + - blosc_cbuffer_complib -> blosc2_cbuffer_complib |
| 39 | + |
| 40 | + To compile with the previous API (corresponding to C-Blosc2 pre-2.3.0), it is enough to define the `BLOSC1_COMPAT` symbol in your C-Blosc2 app. |
9 | 41 |
|
10 | 42 | Changes from 2.1.1 to 2.2.0
|
11 | 43 | ===========================
|
|
0 commit comments