Backups/TwelveMonkeys
2
0
Fork 0
mirror of https://github.com/haraldk/TwelveMonkeys.git synced 2025-08-05 04:25:29 -04:00
Code Issues Projects Releases Wiki Activity

Updated readme.

Browse Source
This commit is contained in:
Harald Kuhr 2013-11-12 09:23:02 +01:00
parent 38fa2189bc
commit 9849cdb001
1 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -28,7 +28,7 @@ Mainstream format support
* JPEGs with corrupted ICC profiles * JPEGs with corrupted ICC profiles
* JPEGs with corrupted `ICC_PROFILE` segments * JPEGs with corrupted `ICC_PROFILE` segments
* JPEGs using non-standard color spaces, unsupported by Java 2D * JPEGs using non-standard color spaces, unsupported by Java 2D
* Issues warnings instead of throwing exceptions in cases of corrupted data where ever the image data can still be read in a reasonable way * Issues warnings instead of throwing exceptions in cases of corrupted or non-conformant data where ever the image data can still be read in a reasonable way
* Thumbnail support: * Thumbnail support:
* JFIF thumbnails (even if stream contains inconsistent metadata) * JFIF thumbnails (even if stream contains inconsistent metadata)
* JFXX thumbnails (JPEG, Indexed and RGB) * JFXX thumbnails (JPEG, Indexed and RGB)
@ -38,11 +38,16 @@ Mainstream format support
* `javax_imageio_jpeg_image_1.0` format (currently as native format, may change in the future) * `javax_imageio_jpeg_image_1.0` format (currently as native format, may change in the future)
* Illegal combinations of JFIF, Exif and Adobe markers, using "unknown" segments in the * Illegal combinations of JFIF, Exif and Adobe markers, using "unknown" segments in the
"MarkerSequence" tag for the unsupported segments (for `javax_imageio_jpeg_image_1.0` format) "MarkerSequence" tag for the unsupported segments (for `javax_imageio_jpeg_image_1.0` format)
* Extended write support in progress * Extended write support in progress:
* CMYK JPEGs
* YCCK JPEGs
#### JPEG-2000 #### JPEG-2000
* Possibly coming in the future, pending some license issues * Possibly coming in the future, pending some license issues.
If you are one of the authors, or know one of the authors and/or the current license holders of either the original jj2000 package or the JAI ImageIO project, please contact me
(I've tried to get in touch in various ways, without success so far).
#### Adobe Photoshop Document (PSD) #### Adobe Photoshop Document (PSD)
@ -149,6 +154,15 @@ Most of the time, all you need to do is simply include the plugins in your proje
BufferedImage image = ImageIO.read(file); BufferedImage image = ImageIO.read(file);
TODO: Alternative usage using ImageIO.createImageInputStream + getImageReaders(stream) iterator, setInput + param
if (!ImageIO.write(image, format, file)) {
// Handle image not written
}
TODO: Alternative usage using ImageIO.createImageOutputStream + getImageWritersByFormatName(format) iterator, setOutput + param
The plugins are discovered automatically at run time. See the FAQ for more info on how this mechanism works. The plugins are discovered automatically at run time. See the FAQ for more info on how this mechanism works.
For more advanced usage, and information on how to use the ImageIO API, I suggest you read the For more advanced usage, and information on how to use the ImageIO API, I suggest you read the
@ -216,22 +230,24 @@ Floyd-Steinberg error-diffusion dither.
## Building ## Building
Download the project (using Git): Download the project (using [Git](http://git-scm.com/downloads)):
$ git clone git@github.com:haraldk/TwelveMonkeys.git $ git clone git@github.com:haraldk/TwelveMonkeys.git
Build the project (using Maven): This should create a folder named `TwelveMonkeys` in your current directory. Change directory to the `TwelveMonkeys`
folder, and issue the command below to build.
Build the project (using [Maven](http://maven.apache.org/download.cgi)):
$ mvn package $ mvn package
Because the unit tests needs quite a bit of memory to run, you might have to set the environment variable `MAVEN_OPTS` Because the unit tests needs quite a bit of memory to run, you might have to set the environment variable `MAVEN_OPTS`
to give the Java process that runs Maven more memory. I suggest something like `-Xmx512m -XX:MaxPermSize=256m`. to give the Java process that runs Maven more memory. I suggest something like `-Xmx512m -XX:MaxPermSize=256m`.
Optionally install the project in your local Maven repository: Optionally, you can install the project in your local Maven repository using:
$ mvn install $ mvn install
## Installing ## Installing
To install the plug-ins, To install the plug-ins,