com.googlecode.leptonica.android

Class WriteFile

java.lang.Object

com.googlecode.leptonica.android.WriteFile

public class WriteFile
extends Object

Author:

alanv@google.com (Alan Viverette)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_PROGRESSIVE
static int	DEFAULT_QUALITY

Constructor Summary

Constructors

Constructor and Description
WriteFile()

Method Summary

Methods

Modifier and Type	Method and Description
static android.graphics.Bitmap	writeBitmap(Pix pixs) Writes a Pix to an Android Bitmap object.
static byte[]	writeBytes8(Pix pixs) Write an 8bpp Pix to a flat byte array.
static int	writeBytes8(Pix pixs, byte[] data) Write an 8bpp Pix to a flat byte array.
static boolean	writeFiles(Pixa pixas, File path, String prefix, int format) Writes all the images in a Pixa array to individual files using the specified format.
static boolean	writeImpliedFormat(Pix pixs, File file) Writes a Pix to file using the file extension as the output format; supported formats are .jpg or .jpeg for JPEG and .bmp for bitmap.
static boolean	writeImpliedFormat(Pix pixs, File file, int quality, boolean progressive) Writes a Pix to file using the file extension as the output format; supported formats are .jpg or .jpeg for JPEG and .bmp for bitmap.
static byte[]	writeMem(Pix pixs, int format) Write a Pix to a byte array using the specified encoding from Constants.IFF_*.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUALITY

public static final int DEFAULT_QUALITY

See Also:

Constant Field Values

DEFAULT_PROGRESSIVE

public static final boolean DEFAULT_PROGRESSIVE

See Also:

Constant Field Values

Constructor Detail

WriteFile

public WriteFile()

Method Detail

writeBytes8

public static byte[] writeBytes8(Pix pixs)

Write an 8bpp Pix to a flat byte array.

Parameters:

pixs - The 8bpp source image.

Returns:

a byte array where each byte represents a single 8-bit pixel

writeBytes8

public static int writeBytes8(Pix pixs,
              byte[] data)

Write an 8bpp Pix to a flat byte array.

Parameters:

pixs - The 8bpp source image.

data - A byte array large enough to hold the pixels of pixs.

Returns:

the number of bytes written to data

writeFiles

public static boolean writeFiles(Pixa pixas,
                 File path,
                 String prefix,
                 int format)

Writes all the images in a Pixa array to individual files using the specified format. The output file extension will be determined by the format.

Output file names will take the format /.

Parameters:

pixas - The source Pixa image array.

path - The output directory.

prefix - The prefix to give output files.

format - The format to use for output files.

Returns:

true on success

writeMem

public static byte[] writeMem(Pix pixs,
              int format)

Write a Pix to a byte array using the specified encoding from Constants.IFF_*.

Parameters:

pixs - The source image.

format - A format from Constants.IFF_*.

Returns:

a byte array containing encoded bytes

writeImpliedFormat

public static boolean writeImpliedFormat(Pix pixs,
                         File file)

Writes a Pix to file using the file extension as the output format; supported formats are .jpg or .jpeg for JPEG and .bmp for bitmap.

Uses default quality and progressive encoding settings.

Parameters:

pixs - Source image.

file - The file to write.

Returns:

true on success

writeImpliedFormat

public static boolean writeImpliedFormat(Pix pixs,
                         File file,
                         int quality,
                         boolean progressive)

Writes a Pix to file using the file extension as the output format; supported formats are .jpg or .jpeg for JPEG and .bmp for bitmap.

Notes:

1. This determines the output format from the filename extension.
2. The last two args are ignored except for requests for jpeg files.
3. The jpeg default quality is 75.

Parameters:

pixs - Source image.

file - The file to write.

quality - (Only for lossy formats) Quality between 1 - 100, 0 for default.

progressive - (Only for JPEG) Whether to encode as progressive.

Returns:

true on success

writeBitmap

public static android.graphics.Bitmap writeBitmap(Pix pixs)

Writes a Pix to an Android Bitmap object. The output Bitmap will always be in ARGB_8888 format, but the input Pixs may be any bit-depth.

Parameters:

pixs - The source image.

Returns:

a Bitmap containing a copy of the source image, or null on failure