[PR] Add support for native memory compression and decompression

.gitignore

@@ -7,6 +7,7 @@ project/plugins/project
 .idea/
 .bloop/
 .metals/
+.bsp/
 tags
 local.properties
 zstd-jni.iml

README.md

@@ -68,87 +68,16 @@ v0.5.2, as that version is not published to Maven. Before compiling, you need to
 $ cd sbt-java-module-info && ./sbt publishLocal && cd -
 ```
 
-Compile and test:
+Create package:
 ```
- $ ./sbt compile test package
+ $ ./sbt compile package
 ```
 
-If you want to publish it to you local ivy2 repository:
+Insatll package locally into maven repository:
 ```
- $ ./sbt publishLocal
+ $ ./install-jar.sh
 ```
 
-Binary releases
----------------
-
-The binary releases are architecture dependent because we are embedding the
-native library in the provided Jar file. Currently they are built for
-*linux-amd64*, *linux-i386*, *linux-aarch64*, *linux-armhf*, *linux-ppc64*,
-*linux-ppc64le*, *linux-mips64*, *linux-s390x*, *linux-riskv64*, *linux-loongarch64*,
-*win-amd64*, *win-x86*, *win-aarch64*, *darwin-x86_64* (MacOS X), *darwin-aarch64*,
-*freebsd-amd64*, and *freebsd-i386*.
-
-More builds will be available if I get access to more platforms.
-
-You can find published releases on Maven Central.
-
-    <dependency>
-        <groupId>com.github.luben</groupId>
-        <artifactId>zstd-jni</artifactId>
-        <version>VERSION</version>
-    </dependency>
-
-sbt dependency:
-
-    libraryDependencies += "com.github.luben" % "zstd-jni" % "VERSION"
-
-Single architecture classified jars are also published. They can be used like:
-
-    <dependency>
-        <groupId>com.github.luben</groupId>
-        <artifactId>zstd-jni</artifactId>
-        <version>VERSION</version>
-        <classifier>linux_amd64</classifier>
-    </dependency>
-
-or for sbt:
-
-    libraryDependencies += "com.github.luben" % "zstd-jni" % "VERSION" classifier "linux_amd64"
-
-Link for direct download if you don't use a dependency manager:
-
- - https://repo1.maven.org/maven2/com/github/luben/zstd-jni/
-
-If there is not yet a binary release compatible with your platform look how
-to build it locally under the [Building](#building-and-dependencies) section.
-
-Android support
----------------
-
-Zstd-jni is usable in Android applications by importing the sources in Android
-Studio. I guess using git sub-modules will also work.
-
-Android archive (*zstd-jni.aar*) is also published on maven central. You will need
-to add the repository in your build.gradle, e.g.:
-
-    allprojects {
-        repositories {
-            jcenter()
-            mavenCentral()
-        }
-    }
-
-as it is not added by default by Android Studio. And then add dependency on the
-prebuilt android archive (aar):
-
-    dependencies {
-        implementation "com.github.luben:zstd-jni:VERSION@aar"
-        testImplementation "com.github.luben:zstd-jni:VERSION"
-    }
-
-For example Android app and how to declare dependencies and use zstd-jni, consult
-the 2nd and 3rd commit of: https://github.com/luben/ZstdAndroidExample
-
 License
 -------
 

install-jar-os.sh

@@ -0,0 +1,88 @@
+#!/bin/bash
+
+# Determine the OS type
+case "$(uname -s)" in
+    Linux)
+        OS_TYPE="linux"
+        ;;
+    Darwin)
+        OS_TYPE="darwin"
+        ;;
+    MINGW32_NT* | MINGW64_NT*)
+        OS_TYPE="win"
+        ;;
+    *)
+        echo "Unsupported OS"
+        exit 1
+        ;;
+esac
+
+# Determine the architecture
+case "$(uname -m)" in
+    x86_64)
+        ARCH_TYPE="amd64"
+        ;;
+    aarch64)
+        ARCH_TYPE="aarch64"
+        ;;
+    i386 | i686)
+        ARCH_TYPE="i386"
+        ;;
+    arm)
+        ARCH_TYPE="arm"
+        ;;
+    arm64)
+        ARCH_TYPE="aarch64"
+        ;;
+    ppc64)
+        ARCH_TYPE="ppc64"
+        ;;
+    mips64)
+        ARCH_TYPE="mips64"
+        ;;
+    s390x)
+        ARCH_TYPE="s390x"
+        ;;
+    riscv64)
+        ARCH_TYPE="riscv64"
+        ;;
+    loongarch64)
+        ARCH_TYPE="loongarch64"
+        ;;
+    *)
+        echo "Unsupported architecture"
+        exit 1
+        ;;
+esac
+
+echo Build for:
+echo OS_TYPE=$OS_TYPE
+echo ARCH_TYPE=$ARCH_TYPE
+
+# Define the directory and file pattern
+TARGET_DIR="./target"
+FILE_PATTERN="zstd-jni-*"
+
+# Find the jar file matching the pattern
+JAR_FILE=$(find "$TARGET_DIR" | grep ${FILE_PATTERN} | grep ${OS_TYPE} | grep ${ARCH_TYPE} | grep "\.jar")
+echo OS-Specific Artifact: $JAR_FILE
+
+# Check if the jar file exists
+if [[ -z "$JAR_FILE" ]]; then
+  echo "Error: No jar file matching the pattern '$FILE_PATTERN' found in '$TARGET_DIR'."
+  exit 1
+fi
+
+# Extract the version from the jar file name
+VERSION=$(echo "$JAR_FILE" | sed -E 's/.*-([0-9]+\.[0-9]+\.[0-9]+-[0-9]+)-[^-]+\.jar/\1/')
+
+# Check if version was extracted successfully
+if [[ -z "$VERSION" ]]; then
+  echo "Error: Unable to extract version from jar file name '$JAR_FILE'."
+  exit 1
+fi
+echo VERSION=$VERSION
+
+# Run the Maven install command with the extracted version
+echo "Installing zstd-jni library to the local maven repository"
+mvn install:install-file -Dfile="$JAR_FILE" -DgroupId=com.carrotdata -DartifactId=zstd-jni -Dversion="$VERSION" -Dpackaging=jar

install-jar.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Define the directory and file pattern
+TARGET_DIR="./target"
+FILE_PATTERN="zstd-jni-*.jar"
+
+# Find the jar file matching the pattern
+JAR_FILE=$(find "$TARGET_DIR" -name "$FILE_PATTERN" -print -quit)
+
+# Check if the jar file exists
+if [[ -z "$JAR_FILE" ]]; then
+  echo "Error: No jar file matching the pattern '$FILE_PATTERN' found in '$TARGET_DIR'."
+  exit 1
+fi
+
+# Extract the version from the jar file name
+VERSION=$(basename "$JAR_FILE" | sed -n 's/^zstd-jni-\(.*\)\.jar$/\1/p')
+
+# Check if version was extracted successfully
+if [[ -z "$VERSION" ]]; then
+  echo "Error: Unable to extract version from jar file name '$JAR_FILE'."
+  exit 1
+fi
+
+# Run the Maven install command with the extracted version
+echo "Installing zstd-jni library to the local maven repository"
+mvn install:install-file -Dfile="$JAR_FILE" -DgroupId=com.carrotdata -DartifactId=zstd-jni -Dversion="$VERSION" -Dpackaging=jar

src/main/java/com/github/luben/zstd/ZstdCompressCtx.java

@@ -582,8 +582,98 @@ public int compressByteArray(byte[] dstBuff, int dstOffset, int dstSize, byte[]
         }
     }
 
+
+    /**
+     * Compress native memory - to native memory, reusing this ZstdCompressCtx.
+     * @param dstBuff destination memory buffer address
+     * @param dstSize destination memory buffer size
+     * @param srcBuff source memory buffer address
+     * @param srcSize source memory buffer size
+     * @return  the number of bytes written into buffer 'dstBuff'.
+     */
+    public int compressNativeNative(long dstBuff, int dstSize, long srcBuff, int srcSize) {
+      ensureOpen();
+      acquireSharedLock();
+
+      try {
+          long size = compressUnsafeNativeNative0(nativePtr, dstBuff, dstSize, srcBuff, srcSize);
+          if (Zstd.isError(size)) {
+              throw new ZstdException(size);
+          }
+          if (size > Integer.MAX_VALUE) {
+              throw new ZstdException(Zstd.errGeneric(), "Output size is greater than MAX_INT");
+          }
+          return (int) size;
+      } finally {
+          releaseSharedLock();
+      }
+   }
+
+   /**
+    * Compress native memory - to byte array, reusing this ZstdCompressCtx.
+    * @param dstBuff destination buffer
+    * @param dstOffset offset in the destination buffer
+    * @param dstSize destination buffer size
+    * @param srcBuff source memory buffer address
+    * @param srcSize source memory buffer size
+    * @return  the number of bytes written into buffer 'dstBuff'.
+    */
+    public int compressNativeByteArray(byte[] dstBuff, int dstOffset, int dstSize, long srcBuff, int srcSize) {
+      ensureOpen();
+      acquireSharedLock();
+
+      try {
+          long size = compressUnsafeNativeByteArray0(nativePtr, dstBuff, dstOffset, dstSize, srcBuff, srcSize);
+          if (Zstd.isError(size)) {
+              throw new ZstdException(size);
+          }
+          if (size > Integer.MAX_VALUE) {
+              throw new ZstdException(Zstd.errGeneric(), "Output size is greater than MAX_INT");
+          }
+          return (int) size;
+      } finally {
+          releaseSharedLock();
+      }
+    }
+
+    /**
+     * Compress byte array - to native memory, reusing this ZstdCompressCtx.
+     * @param dstBuff destination memory buffer address
+     * @param dstSize destination memory buffer size
+     * @param srcBuff source buffer
+     * @param srcOffset source buffer offset 
+     * @param srcSize source buffer size
+     * @return  the number of bytes written into buffer 'dstBuff'.
+     */
+    public int compressByteArrayNative(long dstBuff, int dstSize, byte[] srcBuff, int srcOffset,
+        int srcSize) {
+      ensureOpen();
+      acquireSharedLock();
+
+      try {
+        long size = compressUnsafeByteArrayNative0(nativePtr, dstBuff, dstSize, srcBuff, srcOffset,
+          srcSize);
+        if (Zstd.isError(size)) {
+          throw new ZstdException(size);
+        }
+        if (size > Integer.MAX_VALUE) {
+          throw new ZstdException(Zstd.errGeneric(), "Output size is greater than MAX_INT");
+        }
+        return (int) size;
+      } finally {
+        releaseSharedLock();
+      }
+    }
+
     private static native long compressByteArray0(long ptr, byte[] dst, int dstOffset, int dstSize, byte[] src, int srcOffset, int srcSize);
 
+    private static native long compressUnsafeNativeNative0(long ptr, long dst, int dstSize, long src, int srcSize);
+
+    private static native long compressUnsafeNativeByteArray0(long ptr, byte[] dst, int dstOffset, int dstSize, long src, int srcSize);
+
+    private static native long compressUnsafeByteArrayNative0(long ptr, long dst, int dstSize, byte[] src, int srcOffset, int srcSize);
+
+
     /* Convenience methods */
 
     /**