readme + license + cleanup

Author: normanrz

.github/workflows/ci.yml

@@ -69,12 +69,10 @@ jobs:
             bloscjni.c ..\\c-blosc\\build\\blosc\\libblosc.a
 
       - name: Build blosc-java
-        run: |
-          mvn compile
+        run: mvn compile
 
       - name: Test blosc-java
-        run: |
-          mvn test
+        run: mvn test
 
       - uses: actions/upload-artifact@v3
         with:
@@ -86,6 +84,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: true
       - uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
@@ -97,16 +97,18 @@ jobs:
           path: src/main/resources
 
       - name: Rename JNI dynamic libraries
-        run: |
-          mv src/main/resources/*/* src/main/resources
+        run: mv src/main/resources/*/* src/main/resources
 
-      - name: Assembly JAR
-        run: |
-          mvn package
+      - name: Append c-blosc license
+        run: cat c-blosc/LICENSE.txt >> LICENSE.txt
+
+      - name: Assemble JAR
+        run: mvn package
 
       - uses: actions/upload-artifact@v3
         with:
           name: blosc-jar
           path: target/*.jar
 
-      - run: java -cp target/*.jar dev.zarr.bloscjava.Blosc
+      - name: Smoke test
+        run: java -cp target/*.jar dev.zarr.bloscjava.Blosc

LICENSE.txt

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 scalable minds <https://scalableminds.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+

README.md

@@ -0,0 +1,45 @@
+# blosc-java
+
+A cross-platform JNI-based wrapper around the [c-blosc](https://github.com/Blosc/c-blosc) library.
+
+The packaged JARs contain binaries for Windows, Mac OS (x86_64 only) and Linux.
+
+## Usage
+```java
+import dev.zarr.bloscjava.Blosc;
+
+// Generate some random data
+int SIZE = 100 * 100 * 100;
+byte[] buf = new byte[SIZE];
+for (int i = 0; i < SIZE; i++) {
+    buf[i] = (int)(i % 24);
+}
+
+byte[] compressedBuf = Blosc.compress(buf, 1, Blosc.Compressor.ZSTD, 9);
+byte[] decompressedBuf = Blosc.decompress(compressedBuf);
+
+assert Arrays.equals(buf, decompressedBuf);
+```
+
+### API
+```java
+byte[] compress(byte[] src, int typeSize, Compressor compressor, int compressorLevel, Shuffle shuffle, int blockSize, int numThreads)
+```
+
+- `src`: Byte array to be compressed. Required.
+- `typeSize`: Number of bytes per primitive value (e.g. 1 for int8, 2 for int16, 4 for int32). Required.
+- `compressor`: Compression algorithm. Available choices: `LZ4`, `LZ4HC`, `BLOSCLZ`, `ZSTD`, `SNAPPY`, `ZLIB`. 
+  Default: `ZSTD`
+- `compressorLevel`: Number from 0 to 9 (0 = little compression, 9 = strongest compression). Default: 5.
+- `shuffle`: Whether to use shuffling. Available choices: `NOSHUFFLE`, `BIT_SHUFFLE`, `BYTE_SHUFFLE`. Default: 
+  `BIT_SHUFFLE` for typeSize == 1, `BYTE_SHUFFLE` else
+- `blockSize`: Requested size of compressed blocks. Use 0 for automatic block sizes.
+- `numThreads`: Number of threads to be used internally. Default: 1.
+
+```java
+byte[] decompress(byte[] src, int numThreads)
+```
+
+- `src`: Byte array to be decompressed. Required.
+- `numThreads`: Number of threads to be used internally. Default: 1.
+

pom.xml

@@ -6,15 +6,48 @@
 
     <groupId>dev.zarr</groupId>
     <artifactId>blosc-java</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>0.1-SNAPSHOT</version>
     <packaging>jar</packaging>
 
+    <licenses>
+        <license>
+            <name>MIT</name>
+            <url>https://unlicense.org/</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+    <scm>
+        <connection>scm:git:https://github.com/scalableminds/blosc-java</connection>
+        <developerConnection>scm:git:git@github.com:scalableminds/blosc-java</developerConnection>
+        <tag>HEAD</tag>
+        <url>https://github.com/scalableminds/blosc-java</url>
+    </scm>
+    <issueManagement>
+        <system>GitHub Issues</system>
+        <url>https://github.com/scalableminds/blosc-java/issues</url>
+    </issueManagement>
+    <ciManagement>
+        <system>GitHub Actions</system>
+        <url>https://github.com/scalableminds/blosc-java/actions</url>
+    </ciManagement>
+
+    <contributors>
+        <contributor>
+            <name>Norman Rzepka</name>
+            <url>https://twitter.com/normanrz</url>
+            <properties>
+                <id>normanrz</id>
+            </properties>
+        </contributor>
+    </contributors>
+
     <properties>
         <maven.compiler.source>8</maven.compiler.source>
         <maven.compiler.target>8</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
     <dependencies>
+        <!-- Test dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

src/main/java/dev/zarr/bloscjava/Blosc$Compressor.class

@@ -21,6 +21,8 @@ public void testCompress() {
         System.out.println(Arrays.toString(buf));
         System.out.println(Arrays.toString(compBuf));
         System.out.println(Arrays.toString(decompBuf));
+
+        assert Arrays.equals(buf, decompBuf);
     }
 
 }