Atlassian Core
| java.lang.Object | |
| ↳ | com.atlassian.core.util.ImageInfo |
 Known Direct Subclasses
|
Get file format, image resolution, number of bits per pixel and optionally number of images, comments and physical resolution from JPEG, GIF, BMP, PCX, PNG, IFF, RAS, PBM, PGM, PPM, PSD and SWF files (or input streams).
Use the class like this:
ImageInfo ii = new ImageInfo();You can also use this class as a command line program. Call it with a number of image file names and URLs as parameters:
ii.setInput(in); // in can be InputStream or RandomAccessFile
ii.setDetermineImageNumber(true); // default is false
ii.setCollectComments(true); // default is false
if (!ii.check())
{
System.err.println("Not a supported image file format.");
return;
}
System.out.println(ii.getFormatName() + ", " + ii.getMimeType() + ", " + ii.getWidth() + " x " + ii.getHeight()
+ " pixels, " + ii.getBitsPerPixel() + " bits per pixel, " + ii.getNumberOfImages() + " image(s), "
+ ii.getNumberOfComments() + " comment(s).");
// there are other properties, check out the API documentation
java ImageInfo *.jpg *.png *.gif http://somesite.tld/image.jpgor call it without parameters and pipe data to it:
java ImageInfo < image.jpg
Known limitations:
Requirements:
The latest version can be found at http://www.geocities .com/marcoschmidt.geo/image-info.html.
Written by Marco Schmidt.
This class is contributed to the Public Domain. Use it at your own risk.
Last modification 2005-01-02.
setDetermineImageNumber(boolean) with true as argument to identify animated GIFs (
getNumberOfImages() will return a value larger than 1).setCollectComments(boolean). That new method lets the user specify
whether textual comments are to be stored in an internal list when encountered in an input image file / stream. Added
two methods to return the physical width and height of the image in dpi: getPhysicalWidthDpi() and
getPhysicalHeightDpi(). If the physical resolution could not be retrieved, these methods return
-1.isProgressive() returns whether ImageInfo has found that the storage type is progressive (or
interlaced). Thanks to Joe Germuska for suggesting the feature. Bug fix: BMP physical resolution is now correctly
determined. Released as 1.5.| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | FORMAT_BMP | Return value of getFormat() for BMP streams. |
|||||||||
| int | FORMAT_GIF | Return value of getFormat() for GIF streams. |
|||||||||
| int | FORMAT_IFF | Return value of getFormat() for IFF streams. |
|||||||||
| int | FORMAT_JPEG | Return value of getFormat() for JPEG streams. |
|||||||||
| int | FORMAT_PBM | Return value of getFormat() for PBM streams. |
|||||||||
| int | FORMAT_PCX | Return value of getFormat() for PCX streams. |
|||||||||
| int | FORMAT_PGM | Return value of getFormat() for PGM streams. |
|||||||||
| int | FORMAT_PNG | Return value of getFormat() for PNG streams. |
|||||||||
| int | FORMAT_PPM | Return value of getFormat() for PPM streams. |
|||||||||
| int | FORMAT_PSD | Return value of getFormat() for PSD streams. |
|||||||||
| int | FORMAT_RAS | Return value of getFormat() for RAS streams. |
|||||||||
| int | FORMAT_SWF | Return value of getFormat() for SWF (Shockwave) streams. |
|||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Call this method after you have provided an input stream or file using
setInput(InputStream) or
setInput(DataInput). | |||||||||||
If
check() was successful, returns the image's number of bits per pixel. | |||||||||||
Returns the index'th comment retrieved from the file.
| |||||||||||
If
check() was successful, returns the image format as one of the FORMAT_xyz constants from this class. | |||||||||||
If
check() was successful, returns the image format's name. | |||||||||||
If
check() was successful, returns one the image's vertical resolution in pixels. | |||||||||||
If
check() was successful, returns a String with the MIME type of the format. | |||||||||||
If
check() was successful and setCollectComments(boolean) was called with true as
argument, returns the number of comments retrieved from the input image stream / file. | |||||||||||
Returns the number of images in the examined file.
| |||||||||||
Returns the physical height of this image in dots per inch (dpi).
| |||||||||||
If
check() was successful, returns the physical width of this image in dpi (dots per inch) or -1 if no
value could be found. | |||||||||||
If
check() was successful, returns the physical width of this image in dpi (dots per inch) or -1 if no
value could be found. | |||||||||||
Returns the physical width of an image in inches, or
-1.0f if width information is not available. | |||||||||||
If
check() was successful, returns one the image's horizontal resolution in pixels. | |||||||||||
Returns whether the image is stored in a progressive (also called: interlaced) way.
| |||||||||||
To use this class as a command line application, give it either some file names as parameters (information on
them will be printed to standard output, one line per file) or call it with no parameters.
| |||||||||||
Specify whether textual comments are supposed to be extracted from input.
| |||||||||||
Specify whether the number of images in a file is to be determined - default is
false. | |||||||||||
Set the input stream to the argument stream (or file).
| |||||||||||
Set the input stream to the argument stream (or file).
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Return value of getFormat() for BMP streams. BMP only supports one image per file. BMP does not allow
for comments. The physical resolution can be stored.
Return value of getFormat() for GIF streams. ImageInfo can extract comments from GIFs and count the
number of images (GIFs with more than one image are animations). If you know of a place where GIFs store the
physical resolution of an image, please send me
a mail! It is determined whether the GIF stream is interlaced (see isProgressive()).
Return value of getFormat() for IFF streams.
Return value of getFormat() for JPEG streams. ImageInfo can extract physical resolution and comments
from JPEGs (only from APP0 headers). Only one image can be stored in a file. It is determined whether the JPEG
stream is progressive (see isProgressive()).
Return value of getFormat() for PBM streams.
Return value of getFormat() for PCX streams. PCX does not allow for comments or more than one image per
file. However, the physical resolution can be stored.
Return value of getFormat() for PGM streams.
Return value of getFormat() for PNG streams. PNG only supports one image per file. Both physical
resolution and comments can be stored with PNG, but ImageInfo is currently not able to extract those. It is
determined whether the PNG stream is interlaced (see isProgressive()).
Return value of getFormat() for PPM streams.
Return value of getFormat() for PSD streams.
Return value of getFormat() for RAS streams. Sun Raster allows for one image per file only and is not
able to store physical resolution or comments.
Return value of getFormat() for SWF (Shockwave) streams.
Call this method after you have provided an input stream or file using setInput(InputStream) or
setInput(DataInput). If true is returned, the file format was known and information on the file's
content can be retrieved using the various getXyz methods.
If check() was successful, returns the image's number of bits per pixel. Does not include transparency
information like the alpha channel.
Returns the index'th comment retrieved from the file.
| index | int index of comment to return |
|---|
| IllegalArgumentException | if index is smaller than 0 or larger than or equal to the number of comments retrieved |
|---|
If check() was successful, returns the image format as one of the FORMAT_xyz constants from this class.
Use getFormatName() to get a textual description of the file format.
If check() was successful, returns the image format's name. Use getFormat() to get a unique
number.
If check() was successful, returns one the image's vertical resolution in pixels.
If check() was successful, returns a String with the MIME type of the format.
image/jpeg
If check() was successful and setCollectComments(boolean) was called with true as
argument, returns the number of comments retrieved from the input image stream / file. Any number >= 0 and
smaller than this number of comments is then a valid argument for the getComment(int) method.
Returns the number of images in the examined file. Assumes that setDetermineImageNumber(true); was
called before a successful call to check(). This value can currently be only different from
1 for GIF images.
Returns the physical height of this image in dots per inch (dpi). Assumes that check() was successful.
Returns -1 on failure.
If check() was successful, returns the physical width of this image in dpi (dots per inch) or -1 if no
value could be found.
If check() was successful, returns the physical width of this image in dpi (dots per inch) or -1 if no
value could be found.
Returns the physical width of an image in inches, or -1.0f if width information is not available.
Assumes that check() has been called successfully.
-1.0f on failureIf check() was successful, returns one the image's horizontal resolution in pixels.
Returns whether the image is stored in a progressive (also called: interlaced) way.
To use this class as a command line application, give it either some file names as parameters (information on them will be printed to standard output, one line per file) or call it with no parameters. It will then check data given to it via standard input.
| args | the program arguments which must be file names |
|---|
Specify whether textual comments are supposed to be extracted from input. Default is false. If
enabled, comments will be added to an internal list.
| newValue | if true, this class will read comments |
|---|
Specify whether the number of images in a file is to be determined - default is false. This is a
special option because some file formats require running over the entire file to find out the number of images, a
rather time-consuming task. Not all file formats support more than one image. If this method is called with
true as argument, the actual number of images can be queried via getNumberOfImages() after
a successful call to check().
| newValue | will the number of images be determined? |
|---|
Set the input stream to the argument stream (or file).
| inputStream | the input stream to read from |
|---|
Set the input stream to the argument stream (or file). Note that java.io.RandomAccessFile implements java.io.DataInput.
| dataInput | the input stream to read from |
|---|