aboutsummaryrefslogtreecommitdiff
path: root/java
diff options
context:
space:
mode:
authordcommander <dcommander@632fc199-4ca6-4c93-a231-07263d6284db>2013-01-21 23:42:12 +0000
committerdcommander <dcommander@632fc199-4ca6-4c93-a231-07263d6284db>2013-01-21 23:42:12 +0000
commit12dd0021d3342f867bfb293271a415255c01dc81 (patch)
tree46c3ea7665e420a903ac8142504794b1f1b3fad6 /java
parent9fa89524e0608d1feb60f97d8f1d9474526df72e (diff)
Eliminated the awkward and confusing "TurboJPEG/OSS" designation, since there are no other active implementations of the TurboJPEG API anymore; don't refer to the libjpeg API library as "libjpeg-turbo" anymore, since that can be confusing; ARM v7s build instructions
git-svn-id: svn://svn.code.sf.net/p/libjpeg-turbo/code/trunk@919 632fc199-4ca6-4c93-a231-07263d6284db
Diffstat (limited to 'java')
-rw-r--r--java/README34
1 files changed, 17 insertions, 17 deletions
diff --git a/java/README b/java/README
index 8bca071..2576ce2 100644
--- a/java/README
+++ b/java/README
@@ -1,25 +1,25 @@
-TurboJPEG/OSS Java Wrapper
-==========================
-
-TurboJPEG/OSS can optionally be built with a Java Native Interface wrapper,
-which allows the TurboJPEG/OSS dynamic 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.
+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.
TJExample.java, which should also be located in the same directory as this
-README file, demonstrates how to use the TurboJPEG/OSS Java front end to
-compress and decompress JPEG images in memory.
+README file, demonstrates how to use the TurboJPEG Java API to compress and
+decompress JPEG images in memory.
Performance Pitfalls
--------------------
-The TurboJPEG Java front end defines several convenience methods that can
-allocate image buffers or instantiate classes to hold the result of compress,
+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
@@ -27,8 +27,8 @@ 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 Java front end always gives you the option of pre-allocating your own
-source and destination buffers, which allows you to re-use these buffers for
+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.