org.apache.flex.swf.io

Class SWFWriter

java.lang.Object

org.apache.flex.swf.io.SWFWriter

All Implemented Interfaces:

Closeable, AutoCloseable, ISWFWriter

Direct Known Subclasses:

SizeReportWritingSWFWriter

public class SWFWriter
extends Object
implements ISWFWriter

The implementation of SWF tag, type encoding logic. The SWF file body are buffered in memory using IOutputBitStream. ZLIB compression is optional. If enabled, compression is on-the-fly via a filtered output stream.

Field Summary

Fields

Modifier and Type	Field and Description
static ISWFWriterFactory	DEFAULT_SWF_WRITER_FACTORY A factory for default SWF writers.
protected org.apache.flex.swf.io.IOutputBitStream	outputBuffer
protected org.apache.flex.swf.io.IOutputBitStream	tagBuffer

Constructor Summary

Constructors

Constructor and Description
SWFWriter(ISWF swf, Header.Compression useCompression) Create a SWF writer.
SWFWriter(ISWF swf, Header.Compression useCompression, boolean enableDebug, boolean enableTelemetry) Create a SWF writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the internal output buffer that stores the encoded SWF tags and part of the SWF header.
protected void	finishTag(ITag tag, org.apache.flex.swf.io.IOutputBitStream tagData, org.apache.flex.swf.io.IOutputBitStream out) Compute the tag length for the tag header, then write the header and the buffered tag body to target output stream.
static double	maxNum(double a, double b, double c, double d) Compares the absolute values of 4 signed doubles and returns the unsigned magnitude of the number with the greatest absolute value.
static int	maxNum(int a, int b, int c, int d) Compares the absolute values of 4 signed integers and returns the unsigned magnitude of the number with the greatest absolute value.
static int	requireFBCount(double value) Calculate number of bits required to represent the given value in double bit value.
static int	requireSBCount(int... values)
static int	requireSBCount(int value) Calculate number of bits required to represent the given value in signed bit values.
static int	requireUBCount(int value) Calculate number of bits required to represent the given value in unsigned bit values.
void	writeARGB(ARGB argb)
protected void	writeCompressibleHeader()
protected void	writeDefineSprite(DefineSpriteTag tag)
void	writeDoABC(DoABCTag tag)
void	writeFileAttributes(FileAttributesTag tag)
void	writeRect(Rect rect)
void	writeRGB(RGB rgb)
void	writeRGBA(RGBA rgba)
int	writeTo(File outputFile) Start writing to a file.
void	writeTo(OutputStream output) This method does not close the output stream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SWF_WRITER_FACTORY

public static final ISWFWriterFactory DEFAULT_SWF_WRITER_FACTORY

A factory for default SWF writers. These SWF writers just write SWFs without any additional features.

tagBuffer

protected org.apache.flex.swf.io.IOutputBitStream tagBuffer

outputBuffer

protected final org.apache.flex.swf.io.IOutputBitStream outputBuffer

Constructor Detail

SWFWriter

public SWFWriter(ISWF swf,
         Header.Compression useCompression)

Create a SWF writer.

Parameters:

swf - the SWF model to be encoded

useCompression - use ZLIB compression if true

SWFWriter

public SWFWriter(ISWF swf,
         Header.Compression useCompression,
         boolean enableDebug,
         boolean enableTelemetry)

Create a SWF writer.

Parameters:

swf - the SWF model to be encoded

useCompression - use ZLIB compression if true

enableDebug - enable debugging of the SWF if true

enableTelemetry - enable telemetry

Method Detail

maxNum

public static int maxNum(int a,
         int b,
         int c,
         int d)

Compares the absolute values of 4 signed integers and returns the unsigned magnitude of the number with the greatest absolute value.

maxNum

public static double maxNum(double a,
            double b,
            double c,
            double d)

Compares the absolute values of 4 signed doubles and returns the unsigned magnitude of the number with the greatest absolute value.

requireFBCount

public static int requireFBCount(double value)

Calculate number of bits required to represent the given value in double bit value.

Parameters:

value - signed integer

Returns:

number of bits required for SB[]

requireSBCount

public static int requireSBCount(int value)

Calculate number of bits required to represent the given value in signed bit values.

Parameters:

value - signed integer

Returns:

number of bits required for SB[]

requireSBCount

public static int requireSBCount(int... values)

requireUBCount

public static int requireUBCount(int value)

Calculate number of bits required to represent the given value in unsigned bit values.

Parameters:

value - signed integer

Returns:

number of bits required for SB[]

finishTag

protected void finishTag(ITag tag,
             org.apache.flex.swf.io.IOutputBitStream tagData,
             org.apache.flex.swf.io.IOutputBitStream out)

Compute the tag length for the tag header, then write the header and the buffered tag body to target output stream.

Parameters:

tag - tag object

tagData - serialized tag body

out - target output stream

writeARGB

public void writeARGB(ARGB argb)

writeCompressibleHeader

protected void writeCompressibleHeader()

writeDoABC

public void writeDoABC(DoABCTag tag)

writeFileAttributes

public void writeFileAttributes(FileAttributesTag tag)

writeRect

public void writeRect(Rect rect)

writeRGB

public void writeRGB(RGB rgb)

writeRGBA

public void writeRGBA(RGBA rgba)

writeDefineSprite

protected void writeDefineSprite(DefineSpriteTag tag)

See Also:

SWFReader.readDefineSprite()

writeTo

public void writeTo(OutputStream output)

This method does not close the output stream.

Specified by:

writeTo in interface ISWFWriter

Parameters:

output - output stream

writeTo

public int writeTo(File outputFile)
            throws FileNotFoundException,
                   IOException

Description copied from interface: ISWFWriter

Start writing to a file.

Specified by:

writeTo in interface ISWFWriter

Parameters:

outputFile - The output File.

Returns:

The number of bytes written.

Throws:

FileNotFoundException

IOException

close

public void close()
           throws IOException

Close the internal output buffer that stores the encoded SWF tags and part of the SWF header. It does not close the OutputStream argument in writeTo(OutputStream).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException