Org.simantics.fastlz

From Developer Documents
Jump to: navigation, search

org.simantics.fastlz is a simple JNI wrapper for different open-source real-time data compression libraries. The native library contains pure C implementations. The library also contains pure Java ports of the algorithms which are employed by the front-end if the native library is not available or if arguments are java heap buffers instead of native direct buffers.

Current codecs:

FastLZ
Our version is based on SVN revision 12.
LZ4
Our version is based on SVN revision 68.

Dependencies

  • No Java or native dependencies. It is a self-sufficient JAR ready for deployment as OSGi bundle or POJO. Native DLL's only depend on standard libraries that are always available.

Manual

Use of both FastLZ and LZ4 codecs happens through the org.simantics.fastlz.CompressionCodec interface and the org.simantics.fastlz.Compressions facade class:

<syntaxhighlight lang="java"> public final class Compressions {

public static final String FASTLZ = "FastLZ"; public static final String LZ4 = "LZ4";

public static CompressionCodec get(String codec); public static OutputStream write(String codec, File file) throws FileNotFoundException; public static InputStream read(String codec, File file) throws FileNotFoundException;

}

public interface CompressionCodec {

int compressBound(int inputSize); int compressBuffer(ByteBuffer input, int inputOffset, int length, ByteBuffer output, int outputOffset);

int decompressBuffer(ByteBuffer input, int inputOffset, int length, ByteBuffer output, int outputOffset, int maxout);

InputStream read(File file) throws FileNotFoundException; OutputStream write(File file) throws FileNotFoundException;

} </syntaxhighlight>

ByteBuffers used in this interface can be either heap (ByteBuffer.allocate) or direct (ByteBuffer.allocateDirect). Use the same buffer type for both arguments for best performance. Output buffers must be writable or IllegalArgumentException is thrown.

See the actual code for proper Javadoc.

Download

Version Date Download
1.2.0 12.7.2012 SVN

Future Development

  • Add pure Java implementation of LZ4 as a fallback
  • Rename plug-in to org.simantics.compression