GifEncoder (bus-all 5.8.2 API)

java.lang.Object
- org.aoju.bus.extra.captcha.GifEncoder

public class GifEncoder
extends Object

Gif生成工具类GifEncoder—对包含一个或多个帧的GIF文件进行编码

 Example:
    GifEncoder e = new GifEncoder();
    e.start(outputFileName);
    e.setDelay(1000);
    e.addFrame(image1);
    e.addFrame(image2);
    e.finish();

Since:: JDK 1.8+
Version:: 5.8.2
Author:: Kimi Liu

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closeStream` 完成后关闭流
`protected int`	`colorDepth` 位平面数
`protected byte[]`	`colorTab` RGB调色板
`protected int`	`delay` 帧延迟
`protected int`	`dispose` 处理代码(-1 = default)
`protected boolean`	`firstFrame`
`protected int`	`height`
`protected BufferedImage`	`image` 当前帧
`protected byte[]`	`indexedPixels` 转换帧索引到调色板
`protected OutputStream`	`out`
`protected int`	`palSize` 颜色表大小
`protected byte[]`	`pixels` BGR字节数组从帧
`protected int`	`repeat` 没有重复
`protected int`	`sample` 量化器的默认采样间隔
`protected boolean`	`sizeSet` 如果为假，则从第一帧获取大小
`protected boolean`	`started` 准备输出帧
`protected int`	`transIndex` 透明索引的颜色表
`protected Color`	`transparent` 如果给定透明颜色
`protected boolean[]`	`usedEntry` 激活的调色板条目
`protected int`	`width` 图像大小

Constructor Summary

Constructors
Constructor and Description

GifEncoder()

Constructors
Constructor and Description
`GifEncoder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addFrame(BufferedImage im)` 添加下一个GIF帧。帧不是立即写入的，而是延迟到接收到下一帧，以便插入计时数据。调用finish()刷新所有帧。如果setSize未被调用，则第一个图像的大小将用于所有后续帧。
`protected void`	`analyzePixels()` 分析图像颜色并创建颜色地图
`protected int`	`findClosest(Color c)` 返回调色板颜色最接近c的索引
`boolean`	`finish()` 刷新任何挂起的数据并关闭输出文件如果写入OutputStream，则该流不是关闭的
`byte[]`	`getFrameByteArray()`
`protected void`	`getImagePixels()` 将图像像素提取到字节数组"pixels"中
`boolean`	`outFlush()`
`void`	`reset()`
`void`	`setDelay(int ms)` 设置每帧之间的延迟时间，或对后续帧进行更改(适用于最后添加的帧)
`void`	`setDispose(int code)` 设置最后添加帧和任何后续帧的GIF帧处理代码如果没有设置透明颜色，默认为0，否则为2
`void`	`setFrameRate(float fps)` 以帧每秒为单位设置帧速率相当于`setDelay(1000/fps)`
`void`	`setQuality(int quality)` 设置颜色量化的质量(将图像转换为GIF规范允许的最大256色) 较低的值(最小值= 1)产生较好的颜色，但处理速度明显较慢 10是默认值，可以以合理的速度生成良好的颜色映射大于20的值不会产生显著的速度改进
`void`	`setRepeat(int iter)` 设置一组GIF帧的播放次数。默认是1;0表示无限期地玩下去必须在添加第一个映像之前调用。
`void`	`setSize(int w, int h)` 设置GIF帧大小。默认大小是未调用此方法时添加的第一个帧的大小
`void`	`setTransparent(Color c)` 设置最后添加的帧和任何后续帧的透明颜色由于所有颜色在量化过程中都要进行修改，因此最接近给定颜色的每一帧的最终调色板中的颜色将成为该帧的透明颜色,可以设置为null来表示没有透明颜色
`boolean`	`start(OutputStream os)` 启动给定流上的GIF文件创建。流不是自动关闭的
`boolean`	`start(String file)` 初始化写入指定名称的GIF文件
`protected void`	`writeGraphicCtrlExt()` 写入图形控制扩展名
`protected void`	`writeImageDesc()` Writes Image Descriptor
`protected void`	`writeLSD()` 写入逻辑屏幕描述符
`protected void`	`writeNetscapeExt()` 写入Netscape应用程序扩展名以定义重复计数
`protected void`	`writePalette()` 写颜色表
`protected void`	`writePixels()` 编码和写入像素数据
`protected void`	`writeShort(int value)` 将16位值写入输出流，首先是LSB
`protected void`	`writeString(String s)` 将字符串写入输出流

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

- Field Detail
  - width
```
protected int width
```
    图像大小
  - height
```
protected int height
```
  - transparent
```
protected Color transparent
```
    如果给定透明颜色
  - transIndex
```
protected int transIndex
```
    透明索引的颜色表
  - repeat
```
protected int repeat
```
    没有重复
  - delay
```
protected int delay
```
    帧延迟
  - started
```
protected boolean started
```
    准备输出帧
  - out
```
protected OutputStream out
```
  - image
```
protected BufferedImage image
```
    当前帧
  - pixels
```
protected byte[] pixels
```
    BGR字节数组从帧
  - indexedPixels
```
protected byte[] indexedPixels
```
    转换帧索引到调色板
  - colorDepth
```
protected int colorDepth
```
    位平面数
  - colorTab
```
protected byte[] colorTab
```
    RGB调色板
  - usedEntry
```
protected boolean[] usedEntry
```
    激活的调色板条目
  - palSize
```
protected int palSize
```
    颜色表大小
  - dispose
```
protected int dispose
```
    处理代码(-1 = default)
  - closeStream
```
protected boolean closeStream
```
    完成后关闭流
  - firstFrame
```
protected boolean firstFrame
```
  - sizeSet
```
protected boolean sizeSet
```
    如果为假，则从第一帧获取大小
  - sample
```
protected int sample
```
    量化器的默认采样间隔
- Constructor Detail
  - GifEncoder
```
public GifEncoder()
```
- Method Detail
  - setDelay
```
public void setDelay(int ms)
```
    设置每帧之间的延迟时间，或对后续帧进行更改(适用于最后添加的帧)
    
    Parameters:
    
    ms - int延迟时间(毫秒)
  - setDispose
```
public void setDispose(int code)
```
    设置最后添加帧和任何后续帧的GIF帧处理代码如果没有设置透明颜色，默认为0，否则为2
    
    Parameters:
    
    code - int处理代码
  - setRepeat
```
public void setRepeat(int iter)
```
    设置一组GIF帧的播放次数。默认是1;0表示无限期地玩下去必须在添加第一个映像之前调用。
    
    Parameters:
    
    iter - 迭代次数
  - setTransparent
```
public void setTransparent(Color c)
```
    设置最后添加的帧和任何后续帧的透明颜色由于所有颜色在量化过程中都要进行修改，因此最接近给定颜色的每一帧的最终调色板中的颜色将成为该帧的透明颜色,可以设置为null来表示没有透明颜色
    
    Parameters:
    
    c - 颜色被当作透明显示
  - addFrame
```
public boolean addFrame(BufferedImage im)
```
    添加下一个GIF帧。帧不是立即写入的，而是延迟到接收到下一帧，以便插入计时数据。调用finish()刷新所有帧。如果setSize未被调用，则第一个图像的大小将用于所有后续帧。
    
    Parameters:
    
    im - BufferedImage 包含要写入的帧
    
    Returns:
    
    如果成功返回true
  - outFlush
```
public boolean outFlush()
```
  - getFrameByteArray
```
public byte[] getFrameByteArray()
```
  - finish
```
public boolean finish()
```
    刷新任何挂起的数据并关闭输出文件如果写入OutputStream，则该流不是关闭的
    
    Returns:
    
    the true/false
  - reset
```
public void reset()
```
  - setFrameRate
```
public void setFrameRate(float fps)
```
    以帧每秒为单位设置帧速率相当于setDelay(1000/fps)
    
    Parameters:
    
    fps - 浮点帧速率(帧/秒)
  - setQuality
```
public void setQuality(int quality)
```
    设置颜色量化的质量(将图像转换为GIF规范允许的最大256色) 较低的值(最小值= 1)产生较好的颜色，但处理速度明显较慢 10是默认值，可以以合理的速度生成良好的颜色映射大于20的值不会产生显著的速度改进
    
    Parameters:
    
    quality - int大于0
  - setSize
```
public void setSize(int w,
                    int h)
```
    设置GIF帧大小。默认大小是未调用此方法时添加的第一个帧的大小
    
    Parameters:
    
    w - int框架宽度
    
    h - int框宽度
  - start
```
public boolean start(OutputStream os)
```
    启动给定流上的GIF文件创建。流不是自动关闭的
    
    Parameters:
    
    os - 输出流的GIF图像被写入
    
    Returns:
    
    如果初始写入失败，则为false
  - start
```
public boolean start(String file)
```
    初始化写入指定名称的GIF文件
    
    Parameters:
    
    file - 包含输出文件名的字符串
    
    Returns:
    
    如果打开或初始写入失败，则为false
  - analyzePixels
```
protected void analyzePixels()
```
    分析图像颜色并创建颜色地图
  - findClosest
```
protected int findClosest(Color c)
```
    返回调色板颜色最接近c的索引
    
    Parameters:
    
    c - 颜色
    
    Returns:
    
    返回索引
  - getImagePixels
```
protected void getImagePixels()
```
    将图像像素提取到字节数组"pixels"中
  - writeGraphicCtrlExt
```
protected void writeGraphicCtrlExt()
                            throws IOException
```
    写入图形控制扩展名
    
    Throws:
    
    IOException - IO异常
  - writeImageDesc
```
protected void writeImageDesc()
                       throws IOException
```
    Writes Image Descriptor
    
    Throws:
    
    IOException - IO异常
  - writeLSD
```
protected void writeLSD()
                 throws IOException
```
    写入逻辑屏幕描述符
    
    Throws:
    
    IOException - IO异常
  - writeNetscapeExt
```
protected void writeNetscapeExt()
                         throws IOException
```
    写入Netscape应用程序扩展名以定义重复计数
    
    Throws:
    
    IOException - IO异常
  - writePalette
```
protected void writePalette()
                     throws IOException
```
    写颜色表
    
    Throws:
    
    IOException - IO异常
  - writePixels
```
protected void writePixels()
                    throws IOException
```
    编码和写入像素数据
    
    Throws:
    
    IOException - IO异常
  - writeShort
```
protected void writeShort(int value)
                   throws IOException
```
    将16位值写入输出流，首先是LSB
    
    Parameters:
    
    value - 16位值
    
    Throws:
    
    IOException - IO异常
  - writeString
```
protected void writeString(String s)
                    throws IOException
```
    将字符串写入输出流
    
    Parameters:
    
    s - 字符串信息
    
    Throws:
    
    IOException - IO异常

Class GifEncoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

transparent

transIndex

repeat

delay

started

out

image

pixels

indexedPixels

colorDepth

colorTab

usedEntry

palSize

dispose

closeStream

firstFrame

sizeSet

sample

Constructor Detail

GifEncoder

Method Detail

setDelay

setDispose

setRepeat

setTransparent

addFrame

outFlush

getFrameByteArray

finish

reset

setFrameRate

setQuality

setSize

start

start

analyzePixels

findClosest

getImagePixels

writeGraphicCtrlExt

writeImageDesc

writeLSD

writeNetscapeExt

writePalette

writePixels

writeShort

writeString