-
Show log
Commit
-
Hash : c519d7b6
Author :
Date : 2024-09-05T11:10:44
Don't ignore JPEG buf size with TJPARAM_NOREALLOC Since the introduction of TJFLAG_NOREALLOC in libjpeg-turbo 1.2.x, the TurboJPEG C API documentation has (confusingly) stated that: - if the JPEG buffer pointer points to a pre-allocated buffer, then the JPEG buffer size must be specified, and - the JPEG buffer size should be specified if the JPEG buffer is pre-allocated to an arbitrary size. The documentation never explicitly stated that the JPEG buffer size should be specified if the JPEG buffer is pre-allocated to a worst-case size, but since focus does not imply exclusion, it also never explicitly stated the reverse. Furthermore, the documentation never stated that this was contingent upon TJPARAM_NOREALLOC/TJFLAG_NOREALLOC. However, effectively the compression and lossless transformation functions ignored the JPEG buffer size(s) passed to them, and assumed that the JPEG buffer(s) had been allocated to a worst-case size, if TJPARAM_NOREALLOC/TJFLAG_NOREALLOC was set. This behavior was an accidental and undocumented throwback to libjpeg-turbo 1.1.x, in which the tjCompress() function provided no way to specify the JPEG buffer size. It was always a bad idea for applications to rely upon that behavior (although our own TJBench application unfortunately did.) However, if such applications exist in the wild, the new behavior would constitute a breaking change, so it has been introduced only into libjpeg-turbo 3.1.x and only into TurboJPEG 3 API functions. The previous behavior has been retained when calling functions from the TurboJPEG 2.1.x API and prior versions. Did I mention that APIs are hard?
-
README
-
TurboJPEG Java Wrapper ====================== The TurboJPEG shared library can optionally be built with a Java Native Interface wrapper, which allows the library to be loaded and used directly from Java applications. The Java front end for this is defined in several classes located under org/libjpegturbo/turbojpeg. The source code for these Java classes is licensed under a BSD-style license, so the files can be incorporated directly into both open source and proprietary projects without restriction. A Java archive (JAR) file containing these classes is also shipped with the "official" distribution packages of libjpeg-turbo. TJComp.java, TJDecomp.java, and TJTran.java, which should be located in the same directory as this README file, demonstrate how to use the TurboJPEG Java API to compress, decompress, and transform JPEG images in memory. Performance Pitfalls -------------------- The TurboJPEG Java API defines several convenience methods that can allocate image buffers or instantiate classes to hold the result of compress, decompress, or transform operations. However, if you use these methods, then be mindful of the amount of new data you are creating on the heap. It may be necessary to manually invoke the garbage collector to prevent heap exhaustion or to prevent performance degradation. Background garbage collection can kill performance, particularly in a multi-threaded environment (Java pauses all threads when the GC runs.) The TurboJPEG Java API always gives you the option of pre-allocating your own source and destination buffers, which allows you to re-use those buffers for compressing/decompressing multiple images. If the image sequence you are compressing or decompressing consists of images of the same size, then pre-allocating the buffers is recommended. Installation Directory ---------------------- The TurboJPEG Java Wrapper will look for the TurboJPEG JNI library (libturbojpeg.so, libturbojpeg.dylib, or turbojpeg.dll) in the system library paths or in any paths specified in LD_LIBRARY_PATH (Un*x), DYLD_LIBRARY_PATH (Mac), or PATH (Windows.) Failing this, on Un*x and Mac systems, the wrapper will look for the JNI library under the library directory configured when libjpeg-turbo was built. If that library directory is /opt/libjpeg-turbo/lib32, then /opt/libjpeg-turbo/lib64 is also searched, and vice versa. If you installed the JNI library into another directory, then you will need to pass an argument of -Djava.library.path={path_to_JNI_library} to java, or manipulate LD_LIBRARY_PATH, DYLD_LIBRARY_PATH, or PATH to include the directory containing the JNI library.