wavpack-numcodecs 0.1.4__tar.gz → 0.2.0__tar.gz

{wavpack_numcodecs-0.1.4/wavpack_numcodecs.egg-info → wavpack-numcodecs-0.2.0}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: wavpack-numcodecs
-Version: 0.1.4
+Version: 0.2.0
 Summary: Numcodecs implementation of WavPack audio codec.
-Home-page: https://github.com/AllenNeuralDynamics/wavpack-numcodecs
-Author: Alessio Buccino, David Bryant
-Author-email: alessiop.buccino@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
+Author-email: Alessio Buccino <alessiop.buccino@gmail.com>, David Bryant <david@wavpack.com>
+License: MIT
+Project-URL: Homepage, https://github.com/AllenNeuralDynamics/wavpack-numcodecs
+Keywords: example,project
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -24,6 +23,20 @@ License-File: LICENSE
 This implementation enables one to use WavPack as a compressor in 
 [Zarr](https://zarr.readthedocs.io/en/stable/index.html).
 
+
+### Requirements
+
+To install `wavpack-numcodecs` on MacOS, you need to install `wavpack` with `brew`:
+
+```bash
+brew install wavpack
+```
+
+For Linux and Windows, the package comes with pre-built binaries of the most 
+[recent version Wavpack version](https://github.com/dbry/WavPack/releases/tag/5.7.0).
+
+On Linux, if an existing `wavpack` installation is found, the package will use it. Otherwise, it will use the pre-built binaries available in the `wavpack_numcodecs/libraries` folder.
+
 ## Installation
 
 Install via `pip`:
@@ -62,3 +75,16 @@ Available `**kwargs` can be browsed with: `WavPack?`
 In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
 installed.
 
+# Developmers guide
+
+## How to upgrade WavPack installation
+
+To upgrade the WavPack installation, you need to:
+
+1. Download the latest version of WavPack from the [official website](https://www.wavpack.com/downloads.html).
+2. Extract the content of the downloaded file.
+3. Create a new folder in the `src/wavpack_numcodecs/libraries` folder with the name of the version of the WavPack you are installing.
+4. Add the Windows .dll and .lib files to the `windows-x86_32` and `windows-x86_64` folders, respectievely.
+5. Build the Linux shared library and copy the `.so` file to the `linux-x86_64` folder.
+6. Set the `LATET_WAVPACK_VERSION` variable in the `setup.py` to match the version of the WavPack you are installing.
+7. Update the version of the CI workflows in the `.github/workflows/` folder.

wavpack-numcodecs-0.2.0/README.md

@@ -0,0 +1,76 @@
+[![PyPI version](https://badge.fury.io/py/wavpack-numcodecs.svg)](https://badge.fury.io/py/wavpack-numcodecs) ![tests](https://github.com/AllenNeuralDynamics/wavpack-numcodecs/actions/workflows/python-package-cython.yml/badge.svg)
+
+
+# WavPack - numcodecs implementation
+
+[Numcodecs](https://numcodecs.readthedocs.io/en/latest/index.html) wrapper to the 
+[WavPack](https://www.wavpack.com/index.html) audio codec.
+
+This implementation enables one to use WavPack as a compressor in 
+[Zarr](https://zarr.readthedocs.io/en/stable/index.html).
+
+
+### Requirements
+
+To install `wavpack-numcodecs` on MacOS, you need to install `wavpack` with `brew`:
+
+```bash
+brew install wavpack
+```
+
+For Linux and Windows, the package comes with pre-built binaries of the most 
+[recent version Wavpack version](https://github.com/dbry/WavPack/releases/tag/5.7.0).
+
+On Linux, if an existing `wavpack` installation is found, the package will use it. Otherwise, it will use the pre-built binaries available in the `wavpack_numcodecs/libraries` folder.
+
+## Installation
+
+Install via `pip`:
+
+```
+pip install wavpack-numcodecs
+```
+
+Or from sources:
+
+```
+git clone https://github.com/AllenNeuralDynamics/wavpack-numcodecs.git
+cd wavpack_numcodecs
+pip install .
+```
+
+## Usage
+
+This is a simple example on how to use the `WavPackCodec` with `zarr`:
+
+```
+from wavpack_numcodecs import WavPack
+
+data = ... # any numpy array
+
+# instantiate WavPack compressor
+wv_compressor = WavPack(level=2, bps=None)
+
+z = zarr.array(data, compressor=wv_compressor)
+
+data_read = z[:]
+```
+Available `**kwargs` can be browsed with: `WavPack?`
+
+**NOTE:** 
+In order to reload in zarr an array saved with the `WavPack`, you just need to have the `wavpack_numcodecs` package
+installed.
+
+# Developmers guide
+
+## How to upgrade WavPack installation
+
+To upgrade the WavPack installation, you need to:
+
+1. Download the latest version of WavPack from the [official website](https://www.wavpack.com/downloads.html).
+2. Extract the content of the downloaded file.
+3. Create a new folder in the `src/wavpack_numcodecs/libraries` folder with the name of the version of the WavPack you are installing.
+4. Add the Windows .dll and .lib files to the `windows-x86_32` and `windows-x86_64` folders, respectievely.
+5. Build the Linux shared library and copy the `.so` file to the `linux-x86_64` folder.
+6. Set the `LATET_WAVPACK_VERSION` variable in the `setup.py` to match the version of the WavPack you are installing.
+7. Update the version of the CI workflows in the `.github/workflows/` folder.

wavpack-numcodecs-0.2.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "wavpack-numcodecs"
+version = "0.2.0"
+description = "Numcodecs implementation of WavPack audio codec."
+authors = [
+    {name = "Alessio Buccino", email = "alessiop.buccino@gmail.com"},
+    {name = "David Bryant", email = "david@wavpack.com"},
+]
+readme = "README.md"
+license = {text = "MIT"}
+keywords = ["example", "project"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "numpy",
+    "numcodecs",
+    "packaging"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/AllenNeuralDynamics/wavpack-numcodecs"
+
+
+
+[build-system]
+requires = ["setuptools>=62.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+package-data = {"wavpack_numcodecs" = ["**/*.pyx", "**/*.pxd", "**/*.c", "**/*.h", "**/*.so", "**/*.so.*", "**/*.dll"]}
+
+[tool.setuptools.exclude-package-data]
+wavpack_numcodecs = ["**/tests/test_*"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["wavpack_numcodecs*"]
+namespaces = false
+exclude = ["wavpack_numcodecs.*.tests"]
+
+[tool.black]
+line-length = 120

{wavpack_numcodecs-0.1.4 → wavpack-numcodecs-0.2.0}/setup.py

@@ -1,10 +1,11 @@
 # -*- coding: utf-8 -*-
 import platform
 import shutil
+import os
 from pathlib import Path
 from subprocess import check_output
 
-from setuptools import Extension, find_packages, setup
+from setuptools import Extension, setup
 
 try:
     from Cython.Build import cythonize
@@ -14,16 +15,12 @@ except ImportError:
 else:
     have_cython = True
 
-
-def open_requirements(fname):
-    with open(fname, mode="r") as f:
-        requires = f.read().split("\n")
-    requires = [e for e in requires if len(e) > 0 and not e.startswith("#")]
-    return requires
+LATEST_WAVPACK_VERSION = "5.7.0"
+SRC_FOLDER = "src/wavpack_numcodecs"
 
 
 def get_build_extensions():
-    include_dirs = ["wavpack_numcodecs/include"]
+    include_dirs = [f"{SRC_FOLDER}/include"]
     runtime_library_dirs = []
     extra_link_args = []
 
@@ -31,43 +28,53 @@ def get_build_extensions():
         libraries = ["wavpack"]
         if shutil.which("wavpack") is not None:
             out = check_output(["wavpack", "--version"])
-            print(f"wavpack is installed!\n{out.decode()}")
+            print(f"WavPack is installed!\n{out.decode()}")
             extra_link_args = ["-L/usr/local/lib/", "-L/usr/bin/"]
             runtime_library_dirs = ["/usr/local/lib/", "/usr/bin/"]
         else:
             print("Using shipped libraries")
-            extra_link_args = [f"-Lwavpack_numcodecs/libraries/linux-x86_64"]
-            runtime_library_dirs = ["$ORIGIN/libraries/linux-x86_64"]
+            extra_link_args = [f"-L{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/linux-x86_64"]
+            runtime_library_dirs = [
+                "$ORIGIN/libraries/{LATEST_WAVPACK_VERSION}/linux-x86_64",
+                f"{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/linux-x86_64"
+            ]
             # hack
             shutil.copy(
-                "wavpack_numcodecs/libraries/linux-x86_64/libwavpack.so",
-                "wavpack_numcodecs/libraries/linux-x86_64/libwavpack.so.1",
+                f"{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/linux-x86_64/libwavpack.so",
+                f"{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/linux-x86_64/libwavpack.so.1",
             )
     elif platform.system() == "Darwin":
         libraries = ["wavpack"]
         assert shutil.which("wavpack") is not None, (
-            "wavpack need to be installed externally. " "You can use: brew install wavpack"
+            f"WavPack needs to be installed externally for MacOS platforms.\n"
+            f"You can use homebrew: \n\t >>> brew install wavpack\nor compile it from source:"
+            f"\n\t >>> wget https://www.wavpack.com/wavpack-{LATEST_WAVPACK_VERSION}.tar.bz2"
+            f"\n\t >>> tar -xf wavpack-{LATEST_WAVPACK_VERSION}.tar.bz2"
+            f"\n\t >>> cd wavpack-{LATEST_WAVPACK_VERSION}\n\t >>> ./configure\n\t >>> sudo make install\n\t >>> cd .."
         )
         print("wavpack is installed!")
         extra_link_args = ["-L~/include/", "-L/usr/local/include/", "-L/usr/include"]
+        runtime_library_dirs = ["/opt/homebrew/lib/", "/opt/homebrew/Cellar"]
+        for rt_dir in runtime_library_dirs:
+            extra_link_args.append(f"-L{rt_dir}")
     else:  # windows
         libraries = ["wavpackdll"]
         # add library folder to PATH and copy .dll in the src
         if "64" in platform.architecture()[0]:
-            lib_path = "wavpack_numcodecs/libraries/windows-x86_64"
+            lib_path = f"{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/windows-x86_64"
         else:
-            lib_path = "wavpack_numcodecs/libraries/windows-x86_32"
+            lib_path = f"{SRC_FOLDER}/libraries/{LATEST_WAVPACK_VERSION}/windows-x86_32"
         extra_link_args = [f"/LIBPATH:{lib_path}"]
         for libfile in Path(lib_path).iterdir():
-            shutil.copy(libfile, "wavpack_numcodecs")
+            shutil.copy(libfile, SRC_FOLDER)
 
     if have_cython:
         print("Building with Cython")
-        sources_compat_ext = ["wavpack_numcodecs/compat_ext.pyx"]
-        sources_wavpack_ext = ["wavpack_numcodecs/wavpack.pyx"]
+        sources_compat_ext = [f"{SRC_FOLDER}/compat_ext.pyx"]
+        sources_wavpack_ext = [f"{SRC_FOLDER}/wavpack.pyx"]
     else:
-        sources_compat_ext = ["wavpack_numcodecs/compat_ext.c"]
-        sources_wavpack_ext = ["wavpack_numcodecs/wavpack.c"]
+        sources_compat_ext = [f"{SRC_FOLDER}/compat_ext.c"]
+        sources_wavpack_ext = [f"{SRC_FOLDER}/wavpack.c"]
 
     extensions = [
         Extension("wavpack_numcodecs.compat_ext", sources=sources_compat_ext, extra_compile_args=[]),
@@ -87,34 +94,12 @@ def get_build_extensions():
     return extensions
 
 
-d = {}
-exec(open("wavpack_numcodecs/version.py").read(), None, d)
-version = d["version"]
-long_description = open("README.md").read()
-
-install_requires = open_requirements("requirements.txt")
 entry_points = {"numcodecs.codecs": ["wavpack = wavpack_numcodecs:WavPack"]}
 extensions = get_build_extensions()
 cmdclass = {"build_ext": build_ext} if have_cython else {}
 
 setup(
-    name="wavpack_numcodecs",
-    version=version,
-    author="Alessio Buccino, David Bryant",
-    author_email="alessiop.buccino@gmail.com",
-    description="Numcodecs implementation of WavPack audio codec.",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/AllenNeuralDynamics/wavpack-numcodecs",
-    install_requires=install_requires,
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    packages=find_packages(),
     ext_modules=extensions,
-    entry_points=entry_points,
     cmdclass=cmdclass,
-    include_package_data=True,
+    entry_points=entry_points,
 )

{wavpack_numcodecs-0.1.4 → wavpack-numcodecs-0.2.0/src}/wavpack_numcodecs/__init__.py

@@ -8,4 +8,6 @@ from .globals import (
     set_num_decoding_threads,
     set_num_encoding_threads,
 )
-from .version import version as __version__
+import importlib.metadata
+
+__version__ = importlib.metadata.version("wavpack_numcodecs")

{wavpack_numcodecs-0.1.4 → wavpack-numcodecs-0.2.0/src}/wavpack_numcodecs/include/wavpack/wavpack.h

@@ -1,7 +1,7 @@
 ////////////////////////////////////////////////////////////////////////////
 //                           **** WAVPACK ****                            //
 //                  Hybrid Lossless Wavefile Compressor                   //
-//                Copyright (c) 1998 - 2022 David Bryant.                 //
+//                Copyright (c) 1998 - 2024 David Bryant.                 //
 //                          All Rights Reserved.                          //
 //      Distributed under the BSD Software License (see license.txt)      //
 ////////////////////////////////////////////////////////////////////////////
@@ -189,6 +189,7 @@ typedef struct {
 #define ID_ALT_MD5_CHECKSUM     (ID_OPTIONAL_DATA | 0x9)
 #define ID_NEW_CONFIG_BLOCK     (ID_OPTIONAL_DATA | 0xa)
 #define ID_CHANNEL_IDENTITIES   (ID_OPTIONAL_DATA | 0xb)
+#define ID_WVX_NEW_BITSTREAM    (ID_OPTIONAL_DATA | ID_WVX_BITSTREAM)
 #define ID_BLOCK_CHECKSUM       (ID_OPTIONAL_DATA | 0xf)
 
 ///////////////////////// WavPack Configuration ///////////////////////////////
@@ -228,6 +229,7 @@ typedef struct {
 #define CONFIG_MD5_CHECKSUM     0x8000000 // store MD5 signature
 #define CONFIG_MERGE_BLOCKS     0x10000000 // merge blocks of equal redundancy (for lossyWAV)
 #define CONFIG_PAIR_UNDEF_CHANS 0x20000000 // encode undefined channels in stereo pairs
+#define CONFIG_OPTIMIZE_32BIT   0x40000000 // new optimizations for 32-bit integer files
 #define CONFIG_OPTIMIZE_MONO    0x80000000 // optimize for mono streams posing as stereo
 
 // The lower 8 bits of qmode indicate the use of new features in version 5 that (presently)
@@ -330,8 +332,8 @@ WavpackContext *WavpackOpenFileInput (const char *infilename, char *error, int f
 
 // new for multithreaded
 
-#define OPEN_THREADS_SHFT 12     // specify number of worker threads here for multichannel file
-#define OPEN_THREADS_MASK 0xF000 // decode; 0 to disable, otherwise 2-15 (1 is useless)
+#define OPEN_THREADS_SHFT 12     // specify number of additional worker threads here for
+#define OPEN_THREADS_MASK 0xF000 // decode; 0 to disable, otherwise 1-15 added threads
 
 int WavpackGetMode (WavpackContext *wpc);