Difference between revisions of "Org.simantics.fastlz"

From Developer Documents
Jump to navigation Jump to search
Line 54: Line 54:
 
= Current Development =
 
= Current Development =
  
* Add LZ4 support
+
* Add pure Java implementation of LZ4 as a fallback

Revision as of 08:16, 12 July 2012

org.simantics.fastlz is a simple JNI wrapper for the open-source FastLZ real-time data compression library. The native library is a pure C implementation. Our version is based on SVN revision 12. The library also contains a Java port of the algorithm which is employed by the front-end if the native library is not available or if arguments are java heap buffers instead of native direct buffers.

Dependencies

  • None, it is a self-sufficient JAR ready for deployment as OSGi bundle or POJO
  • Data to compress/decompress!

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 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.

See the actual code for proper Javadoc.

Download

Version Date Download
1.2.0 now SVN

Current Development

  • Add pure Java implementation of LZ4 as a fallback