PSDCodec

java.lang.Object
- net.sourceforge.jiu.ops.Operation
- - net.sourceforge.jiu.codecs.ImageCodec
  - - net.sourceforge.jiu.codecs.PSDCodec

```
public class PSDCodec
extends ImageCodec
```
A codec to read images from Photoshop PSD files. PSD was created by Adobe for their Photoshop image editing software. Note that only a small subset of valid PSD files is supported by this codec. Typical file extension is .psd.

Author:

Marco Schmidt

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`channels`
`private static int`	`COLOR_MODE_GRAYSCALE`
`private static int`	`COLOR_MODE_INDEXED`
`private static int`	`COLOR_MODE_RGB_TRUECOLOR`
`private int`	`colorMode`
`private short`	`compression`
`private static short`	`COMPRESSION_NONE`
`private static short`	`COMPRESSION_PACKBITS`
`private int`	`depth`
`private Gray8Image`	`gray8Image`
`private int`	`height`
`private java.io.DataInput`	`in`
`private int`	`magic`
`private static int`	`MAGIC_8BPS`
`private Palette`	`palette`
`private Paletted8Image`	`paletted8Image`
`private RGB24Image`	`rgb24Image`
`private int`	`width`

Constructor Summary

Constructors
Constructor and Description

PSDCodec()

Constructors
Constructor and Description
`PSDCodec()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`allocate()`
`private static java.lang.String`	`getColorTypeName(int colorMode)`
`java.lang.String`	`getFormatName()` Returns the name of the file format supported by this codec.
`java.lang.String[]`	`getMimeTypes()` Return the MIME (Multipurpose Internet Mail Extensions) type strings for this format, or `null` if none are available.
`boolean`	`isLoadingSupported()` Returns if this codec is able to load images in the file format supported by this codec.
`boolean`	`isSavingSupported()` Returns if this codec is able to save images in the file format supported by this codec.
`private void`	`load()` Attempts to load an Image from argument stream `in` (which could, as an example, be a `RandomAccessFile` instance, it implements the `DataInput` interface).
`private void`	`loadHeader()` Reads the PSD header to private members of this class instance.
`private void`	`loadImageData()`
`private void`	`loadPackbitsCompressedData(byte[] data, int offset, int num)`
`void`	`process()` This method does the actual work of the operation.

Methods inherited from class net.sourceforge.jiu.ops.Operation
addProgressListener, addProgressListeners, getAbort, removeProgressListener, setAbort, setProgress, setProgress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAGIC_8BPS
```
private static final int MAGIC_8BPS
```
    See Also:
    
    Constant Field Values
  - COLOR_MODE_GRAYSCALE
```
private static final int COLOR_MODE_GRAYSCALE
```
    See Also:
    
    Constant Field Values
  - COLOR_MODE_INDEXED
```
private static final int COLOR_MODE_INDEXED
```
    See Also:
    
    Constant Field Values
  - COLOR_MODE_RGB_TRUECOLOR
```
private static final int COLOR_MODE_RGB_TRUECOLOR
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_NONE
```
private static final short COMPRESSION_NONE
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_PACKBITS
```
private static final short COMPRESSION_PACKBITS
```
    See Also:
    
    Constant Field Values
  - magic
```
private int magic
```
  - channels
```
private int channels
```
  - height
```
private int height
```
  - width
```
private int width
```
  - depth
```
private int depth
```
  - colorMode
```
private int colorMode
```
  - compression
```
private short compression
```
  - in
```
private java.io.DataInput in
```
  - gray8Image
```
private Gray8Image gray8Image
```
  - palette
```
private Palette palette
```
  - paletted8Image
```
private Paletted8Image paletted8Image
```
  - rgb24Image
```
private RGB24Image rgb24Image
```
- Constructor Detail
  - PSDCodec
```
public PSDCodec()
```
- Method Detail
  - allocate
```
private void allocate()
```
  - getColorTypeName
```
private static java.lang.String getColorTypeName(int colorMode)
```
  - getFormatName
```
public java.lang.String getFormatName()
```
    Description copied from class: ImageCodec
    
    Returns the name of the file format supported by this codec. All classes extending ImageCodec must override this method. When overriding, leave out any words in a particular language so that this format name can be understood by everyone. Usually it is enough to return the format creator plus a typical abbreviation, e.g. Microsoft BMP or Portable Anymap (PNM).
    
    Specified by:
    
    getFormatName in class ImageCodec
    
    Returns:
    
    name of the file format supported by this codec
  - getMimeTypes
```
public java.lang.String[] getMimeTypes()
```
    Description copied from class: ImageCodec
    
    Return the MIME (Multipurpose Internet Mail Extensions) type strings for this format, or null if none are available.
    
    Specified by:
    
    getMimeTypes in class ImageCodec
    
    Returns:
    
    MIME type strings or null
  - isLoadingSupported
```
public boolean isLoadingSupported()
```
    Description copied from class: ImageCodec
    
    Returns if this codec is able to load images in the file format supported by this codec. If true is returned this does not necessarily mean that all files in this format can be read, but at least some.
    
    Specified by:
    
    isLoadingSupported in class ImageCodec
    
    Returns:
    
    if loading is supported
  - isSavingSupported
```
public boolean isSavingSupported()
```
    Description copied from class: ImageCodec
    
    Returns if this codec is able to save images in the file format supported by this codec. If true is returned this does not necessarily mean that all types files in this format can be written, but at least some.
    
    Specified by:
    
    isSavingSupported in class ImageCodec
    
    Returns:
    
    if saving is supported
  - load
```
private void load()
           throws InvalidFileStructureException,
                  java.io.IOException,
                  UnsupportedTypeException,
                  WrongFileFormatException
```
    Attempts to load an Image from argument stream in (which could, as an example, be a RandomAccessFile instance, it implements the DataInput interface). Checks a magic byte sequence and then reads all chunks as they appear in the IFF file. Will return the resulting image or null if no image body chunk was encountered before end-of-stream. Will throw an exception if the file is corrupt, information is missing or there were reading errors.
    
    Throws:
    
    InvalidFileStructureException
    
    java.io.IOException
    
    UnsupportedTypeException
    
    WrongFileFormatException
  - loadHeader
```
private void loadHeader()
                 throws java.io.IOException,
                        WrongFileFormatException
```
    Reads the PSD header to private members of this class instance.
    
    Throws:
    
    java.io.IOException - if there were reading errors
    
    WrongFileFormatException
  - loadPackbitsCompressedData
```
private void loadPackbitsCompressedData(byte[] data,
                                        int offset,
                                        int num)
                                 throws InvalidFileStructureException,
                                        java.io.IOException
```
    Throws:
    
    InvalidFileStructureException
    
    java.io.IOException
  - loadImageData
```
private void loadImageData()
                    throws InvalidFileStructureException,
                           java.io.IOException
```
    Throws:
    
    InvalidFileStructureException
    
    java.io.IOException
  - process
```
public void process()
             throws OperationFailedException
```
    Description copied from class: Operation
    
    This method does the actual work of the operation. It must be called after all parameters have been given to the operation object.
    
    Overrides:
    
    process in class Operation
    
    Throws:
    
    WrongParameterException - if at least one of the input parameters was not initialized appropriately (values out of the valid interval, etc.)
    
    MissingParameterException - if any mandatory parameter was not given to the operation
    
    OperationFailedException

Class PSDCodec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.jiu.codecs.ImageCodec

Methods inherited from class net.sourceforge.jiu.ops.Operation

Methods inherited from class java.lang.Object

Field Detail

MAGIC_8BPS

COLOR_MODE_GRAYSCALE

COLOR_MODE_INDEXED

COLOR_MODE_RGB_TRUECOLOR

COMPRESSION_NONE

COMPRESSION_PACKBITS

magic

channels

height

width

depth

colorMode

compression

in

gray8Image

palette

paletted8Image

rgb24Image

Constructor Detail

PSDCodec

Method Detail

allocate

getColorTypeName

getFormatName

getMimeTypes

isLoadingSupported

isSavingSupported

load

loadHeader

loadPackbitsCompressedData

loadImageData

process