GifDecoder (core 1.0 API)

java.lang.Object
- com.holidaystudios.tools.GifDecoder

public class GifDecoder
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`act`
`protected int`	`bgColor`
`protected int`	`bgIndex`
`protected byte[]`	`block`
`protected int`	`blockSize`
`protected int`	`delay`
`protected int`	`dispose`
`protected int`	`frameCount`
`protected java.util.Vector<com.holidaystudios.tools.GifDecoder.GifFrame>`	`frames`
`protected int[]`	`gct`
`protected boolean`	`gctFlag`
`protected int`	`gctSize`
`protected int`	`height`
`protected int`	`ih`
`protected com.holidaystudios.tools.GifDecoder.DixieMap`	`image`
`protected java.io.InputStream`	`in`
`protected boolean`	`interlace`
`protected int`	`iw`
`protected int`	`ix`
`protected int`	`iy`
`protected int`	`lastBgColor`
`protected int`	`lastDispose`
`protected com.holidaystudios.tools.GifDecoder.DixieMap`	`lastPixmap`
`protected int[]`	`lct`
`protected boolean`	`lctFlag`
`protected int`	`lctSize`
`protected int`	`loopCount`
`protected int`	`lrh`
`protected int`	`lrw`
`protected int`	`lrx`
`protected int`	`lry`
`protected static int`	`MAX_STACK_SIZE` max decoder pixel stack size
`protected int`	`pixelAspect`
`protected byte[]`	`pixels`
`protected byte[]`	`pixelStack`
`protected short[]`	`prefix`
`protected int`	`status`
`static int`	`STATUS_FORMAT_ERROR` File read status: Error decoding file (may be partially decoded)
`static int`	`STATUS_OK` File read status: No errors.
`static int`	`STATUS_OPEN_ERROR` File read status: Unable to open source.
`protected byte[]`	`suffix`
`protected int`	`transIndex`
`protected boolean`	`transparency`
`protected int`	`width`

Constructor Summary

Constructors
Constructor and Description

GifDecoder()

Constructors
Constructor and Description
`GifDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`decodeBitmapData()` Decodes LZW image data into pixel array.
`protected boolean`	`err()` Returns true if an error was encountered during reading/decoding
`com.badlogic.gdx.graphics.g2d.Animation<com.badlogic.gdx.graphics.g2d.TextureRegion>`	`getAnimation(com.badlogic.gdx.graphics.g2d.Animation.PlayMode playMode)`
`int`	`getDelay(int n)` Gets display duration for specified frame.
`com.holidaystudios.tools.GifDecoder.DixieMap`	`getFrame(int n)` Gets the image contents of frame n.
`int`	`getFrameCount()` Gets the number of frames read from file.
`int`	`getLoopCount()` Gets the "Netscape" iteration count, if any.
`com.badlogic.gdx.graphics.Pixmap`	`getPixmap()` Gets the first (or only) image read.
`protected void`	`init()` Initializes or re-initializes reader
`static com.badlogic.gdx.graphics.g2d.Animation<com.badlogic.gdx.graphics.g2d.TextureRegion>`	`loadGIFAnimation(com.badlogic.gdx.graphics.g2d.Animation.PlayMode playMode, java.io.InputStream is)`
`void`	`prepAnimation()`
`protected int`	`read()` Reads a single byte from the input stream.
`int`	`read(java.io.InputStream is)` Reads GIF image from stream
`protected void`	`readBitmap()` Reads next frame image
`protected int`	`readBlock()` Reads next variable length block from input.
`protected int[]`	`readColorTable(int ncolors)` Reads color table as 256 RGB integer values
`protected void`	`readContents()` Main file parser.
`protected void`	`readGraphicControlExt()` Reads Graphics Control Extension values
`protected void`	`readHeader()` Reads GIF file header information.
`protected void`	`readLSD()` Reads Logical Screen Descriptor
`protected void`	`readNetscapeExt()` Reads Netscape extenstion to obtain iteration count
`protected int`	`readShort()` Reads next 16-bit value, LSB first
`protected void`	`resetFrame()` Resets frame state for reading next image.
`protected void`	`setPixels()` Creates new frame image from current data (and previous frames as specified by their disposition codes).
`protected void`	`skip()` Skips variable length blocks up to and including next zero length block.

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

Field Detail

STATUS_OK
```
public static final int STATUS_OK
```
File read status: No errors.

See Also:

Constant Field Values

STATUS_FORMAT_ERROR
```
public static final int STATUS_FORMAT_ERROR
```
File read status: Error decoding file (may be partially decoded)

See Also:

Constant Field Values

STATUS_OPEN_ERROR
```
public static final int STATUS_OPEN_ERROR
```
File read status: Unable to open source.

See Also:

Constant Field Values

MAX_STACK_SIZE
```
protected static final int MAX_STACK_SIZE
```
max decoder pixel stack size

See Also:

Constant Field Values

in
```
protected java.io.InputStream in
```

status
```
protected int status
```

width
```
protected int width
```

height
```
protected int height
```

gctFlag
```
protected boolean gctFlag
```

gctSize
```
protected int gctSize
```

loopCount
```
protected int loopCount
```

gct
```
protected int[] gct
```

lct
```
protected int[] lct
```

act
```
protected int[] act
```

bgIndex
```
protected int bgIndex
```

bgColor
```
protected int bgColor
```

lastBgColor
```
protected int lastBgColor
```

pixelAspect
```
protected int pixelAspect
```

lctFlag
```
protected boolean lctFlag
```

interlace
```
protected boolean interlace
```

lctSize
```
protected int lctSize
```

ix
```
protected int ix
```

iy
```
protected int iy
```

iw
```
protected int iw
```

ih
```
protected int ih
```

lrx
```
protected int lrx
```

lry
```
protected int lry
```

lrw
```
protected int lrw
```

lrh
```
protected int lrh
```

image

protected com.holidaystudios.tools.GifDecoder.DixieMap image

lastPixmap

protected com.holidaystudios.tools.GifDecoder.DixieMap lastPixmap

block
```
protected byte[] block
```

blockSize
```
protected int blockSize
```

dispose
```
protected int dispose
```

lastDispose
```
protected int lastDispose
```

transparency
```
protected boolean transparency
```

delay
```
protected int delay
```

transIndex
```
protected int transIndex
```

prefix
```
protected short[] prefix
```

suffix
```
protected byte[] suffix
```

pixelStack
```
protected byte[] pixelStack
```

pixels
```
protected byte[] pixels
```

frames

protected java.util.Vector<com.holidaystudios.tools.GifDecoder.GifFrame> frames

frameCount
```
protected int frameCount
```

Constructor Detail
- GifDecoder
```
public GifDecoder()
```

Method Detail
- loadGIFAnimation
```
public static com.badlogic.gdx.graphics.g2d.Animation<com.badlogic.gdx.graphics.g2d.TextureRegion> loadGIFAnimation(com.badlogic.gdx.graphics.g2d.Animation.PlayMode playMode,
                                                                                                                    java.io.InputStream is)
```
- getDelay
```
public int getDelay(int n)
```
  Gets display duration for specified frame.
  
  Parameters:
  
  n - int index of frame
  
  Returns:
  
  delay in milliseconds
- getFrameCount
```
public int getFrameCount()
```
  Gets the number of frames read from file.
  
  Returns:
  
  frame count
- getPixmap
```
public com.badlogic.gdx.graphics.Pixmap getPixmap()
```
  Gets the first (or only) image read.
  
  Returns:
  
  BufferedPixmap containing first frame, or null if none.
- getLoopCount
```
public int getLoopCount()
```
  Gets the "Netscape" iteration count, if any. A count of 0 means repeat indefinitely.
  
  Returns:
  
  iteration count if one was specified, else 1.
- setPixels
```
protected void setPixels()
```
  Creates new frame image from current data (and previous frames as specified by their disposition codes).
- getFrame
```
public com.holidaystudios.tools.GifDecoder.DixieMap getFrame(int n)
```
  Gets the image contents of frame n.
  
  Returns:
  
  BufferedPixmap representation of frame, or null if n is invalid.
- read
```
public int read(java.io.InputStream is)
```
  Reads GIF image from stream
  
  Parameters:
  
  is - containing GIF file.
  
  Returns:
  
  read status code (0 = no errors)
- decodeBitmapData
```
protected void decodeBitmapData()
```
  Decodes LZW image data into pixel array. Adapted from John Cristy's BitmapMagick.
- err
```
protected boolean err()
```
  Returns true if an error was encountered during reading/decoding
- init
```
protected void init()
```
  Initializes or re-initializes reader
- read
```
protected int read()
```
  Reads a single byte from the input stream.
- readBlock
```
protected int readBlock()
```
  Reads next variable length block from input.
  
  Returns:
  
  number of bytes stored in "buffer"
- readColorTable
```
protected int[] readColorTable(int ncolors)
```
  Reads color table as 256 RGB integer values
  
  Parameters:
  
  ncolors - int number of colors to read
  
  Returns:
  
  int array containing 256 colors (packed ARGB with full alpha)
- readContents
```
protected void readContents()
```
  Main file parser. Reads GIF content blocks.
- readGraphicControlExt
```
protected void readGraphicControlExt()
```
  Reads Graphics Control Extension values
- readHeader
```
protected void readHeader()
```
  Reads GIF file header information.
- readBitmap
```
protected void readBitmap()
```
  Reads next frame image
- readLSD
```
protected void readLSD()
```
  Reads Logical Screen Descriptor
- readNetscapeExt
```
protected void readNetscapeExt()
```
  Reads Netscape extenstion to obtain iteration count
- readShort
```
protected int readShort()
```
  Reads next 16-bit value, LSB first
- resetFrame
```
protected void resetFrame()
```
  Resets frame state for reading next image.
- skip
```
protected void skip()
```
  Skips variable length blocks up to and including next zero length block.
- prepAnimation
```
public void prepAnimation()
```
- getAnimation
```
public com.badlogic.gdx.graphics.g2d.Animation<com.badlogic.gdx.graphics.g2d.TextureRegion> getAnimation(com.badlogic.gdx.graphics.g2d.Animation.PlayMode playMode)
```

Class GifDecoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_OK

STATUS_FORMAT_ERROR

STATUS_OPEN_ERROR

MAX_STACK_SIZE

in

status

width

height

gctFlag

gctSize

loopCount

gct

lct

act

bgIndex

bgColor

lastBgColor

pixelAspect

lctFlag

interlace

lctSize

ix

iy

iw

ih

lrx

lry

lrw

lrh

image

lastPixmap

block

blockSize

dispose

lastDispose

transparency

delay

transIndex

prefix

suffix

pixelStack

pixels

frames

frameCount

Constructor Detail

GifDecoder

Method Detail

loadGIFAnimation

getDelay

getFrameCount

getPixmap

getLoopCount

setPixels

getFrame

read

decodeBitmapData

err

init

read

readBlock

readColorTable

readContents

readGraphicControlExt

readHeader

readBitmap

readLSD

readNetscapeExt

readShort

resetFrame

skip

prepAnimation

getAnimation