pl.droidsonroids.gif

Class GifDecoder

java.lang.Object

pl.droidsonroids.gif.GifDecoder

public class GifDecoder
extends Object

GifDecoder allows lightweight access to GIF frames, without wrappers like Drawable or View. Bitmap with size equal to or greater than size of the GIF is needed. For access only metadata (size, number of frames etc.) without pixels see GifAnimationMetaData.

Constructor Summary

Constructors

Constructor and Description
GifDecoder(InputSource inputSource) Constructs new GifDecoder.
GifDecoder(InputSource inputSource, GifOptions options) Constructs new GifDecoder

Method Summary

Modifier and Type	Method and Description
long	getAllocationByteCount() See GifDrawable.getAllocationByteCount()
String	getComment() See GifDrawable.getComment()
int	getDuration() See GifDrawable.getDuration()
int	getFrameDuration(int index) See GifDrawable.getFrameDuration(int)
int	getHeight()
int	getLoopCount() See GifDrawable.getLoopCount()
int	getNumberOfFrames()
long	getSourceLength() See GifDrawable.getInputSourceByteCount()
int	getWidth()
boolean	isAnimated()
void	recycle() See GifDrawable.recycle()
void	seekToFrame(int frameIndex, android.graphics.Bitmap buffer) See GifDrawable.seekToFrame(int)
void	seekToTime(int position, android.graphics.Bitmap buffer) See GifDrawable.seekTo(int)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GifDecoder

public GifDecoder(@NonNull
                  InputSource inputSource)
           throws IOException

Constructs new GifDecoder. Equivalent of GifDecoder(InputSource, GifOptions) with null options

Parameters:

inputSource - source

Throws:

IOException - when creation fails

GifDecoder

public GifDecoder(@NonNull
                  InputSource inputSource,
                  @Nullable
                  GifOptions options)
           throws IOException

Constructs new GifDecoder

Parameters:

inputSource - source

options - null-ok; options controlling subsampling and opacity

Throws:

IOException - when creation fails

Method Detail

getComment

public String getComment()

See GifDrawable.getComment()

Returns:

GIF comment

getLoopCount

public int getLoopCount()

See GifDrawable.getLoopCount()

Returns:

loop count, 0 means that animation is infinite

getSourceLength

public long getSourceLength()

See GifDrawable.getInputSourceByteCount()

Returns:

number of bytes backed by input source or -1 if it is unknown

seekToTime

public void seekToTime(int position,
                       @NonNull
                       android.graphics.Bitmap buffer)

See GifDrawable.seekTo(int)

Parameters:

position - position to seek to in milliseconds

buffer - the frame buffer

Throws:

IllegalArgumentException - if position < 0 or buffer is recycled

seekToFrame

public void seekToFrame(int frameIndex,
                        @NonNull
                        android.graphics.Bitmap buffer)

See GifDrawable.seekToFrame(int)

Parameters:

frameIndex - position to seek to in milliseconds

buffer - the frame buffer

Throws:

IllegalArgumentException - if frameIndex < 0 or buffer is recycled

getAllocationByteCount

public long getAllocationByteCount()

See GifDrawable.getAllocationByteCount()

Returns:

possible size of the memory needed to store pixels of this object

getFrameDuration

public int getFrameDuration(int index)

See GifDrawable.getFrameDuration(int)

Parameters:

index - index of the frame

Returns:

duration of the given frame in milliseconds

Throws:

IndexOutOfBoundsException - if index < 0 || index >= <number of frames>

getDuration

public int getDuration()

See GifDrawable.getDuration()

Returns:

duration of of one loop the animation in milliseconds. Result is always multiple of 10.

getWidth

public int getWidth()

Returns:

width od the GIF canvas in pixels

getHeight

public int getHeight()

Returns:

height od the GIF canvas in pixels

getNumberOfFrames

public int getNumberOfFrames()

Returns:

number of frames in GIF, at least one

isAnimated

public boolean isAnimated()

Returns:

true if GIF is animated (has at least 2 frames and positive duration), false otherwise

recycle

public void recycle()

See GifDrawable.recycle()