t4_state_t Struct Reference

#include <t4.h>

List of all members.

Public Attributes
int	rx
	The same structure is used for T.4 transmit and receive. This variable records which mode is in progress.
const char *	vendor
	The vendor of the machine which produced the TIFF file.
const char *	model
	The model of machine which produced the TIFF file.
const char *	local_ident
	The local ident string.
const char *	far_ident
	The remote end's ident string.
const char *	sub_address
	The FAX sub-address.
const char *	dcs
	The FAX DCS information, as an ASCII string.
const char *	header_info
	The text which will be used in FAX page header. No text results in no header line.
int	line_encoding
	The type of compression used between the FAX machines.
int	min_bits_per_row
	The minimum number of encoded bits per row. This is a timing thing for hardware FAX machines.
int	output_compression
	The compression type for output to the TIFF file.
int	output_t4_options
	The TIFF G3 FAX options.
t4_row_read_handler_t	row_read_handler
	Callback function to read a row of pixels from the image source.
void *	row_read_user_data
	Opaque pointer passed to row_read_handler.
t4_row_write_handler_t	row_write_handler
	Callback function to write a row of pixels to the image destination.
void *	row_write_user_data
	Opaque pointer passed to row_write_handler.
time_t	page_start_time
	The time at which handling of the current page began.
int	bytes_per_row
	The current number of bytes per row of uncompressed image data.
int	image_size
	The size of the image in the image buffer, in bytes.
int	line_image_size
	The size of the compressed image on the line side, in bits.
int	image_buffer_size
	The current size of the image buffer.
uint8_t *	image_buffer
	A point to the image buffer.
TIFF *	tiff_file
	The libtiff context for the current TIFF file.
const char *	file
	The current file name.
int	start_page
	The first page to transfer. -1 to start at the beginning of the file.
int	stop_page
	The last page to transfer. -1 to continue to the end of the file.
int	pages_transferred
	The number of pages transferred to date.
int	pages_in_file
	The number of pages in the current TIFF file.
int	x_resolution
	Column-to-column (X) resolution in pixels per metre.
int	y_resolution
	Row-to-row (Y) resolution in pixels per metre.
int	image_width
	Width of the current page, in pixels.
int	image_length
	Length of the current page, in pixels.
int	row
	Current pixel row number.
int	curr_bad_row_run
	The current number of consecutive bad rows.
int	longest_bad_row_run
	The longest run of consecutive bad rows seen in the current page.
int	bad_rows
	The total number of bad rows in the current page.
uint32_t	rx_bitstream
	Incoming bit buffer for decompression.
int	rx_bits
	The number of bits currently in rx_bitstream.
int	rx_skip_bits
	The number of bits to be skipped before trying to match the next code word.
int	row_is_2d
	This variable is set if we are treating the current row as a 2D encoded one.
int	its_black
	TRUE if the current run is black.
int	row_len
	The current length of the current row.
int	consecutive_eols
	This variable is used to count the consecutive EOLS we have seen. If it reaches six, this is the end of the image. It is initially set to -1 for 1D and 2D decoding, as an indicator that we must wait for the first EOL, before decodin any image data.
uint32_t *	cur_runs
	Black and white run-lengths for the current row.
uint32_t *	ref_runs
	Black and white run-lengths for the reference row.
int	ref_steps
	The number of runs currently in the reference row.
int	b_cursor
	The current step into the reference row run-lengths buffer.
int	a_cursor
	The current step into the current row run-lengths buffer.
int	a0
	The reference or starting changing element on the coding line. At the start of the coding line, a0 is set on an imaginary white changing element situated just before the first element on the line. During the coding of the coding line, the position of a0 is defined by the previous coding mode. (See 4.2.1.3.2.).
int	b1
	The first changing element on the reference line to the right of a0 and of opposite colour to a0.
int	run_length
	The length of the in-progress run of black or white.
int	black_white
	2D horizontal mode control.
uint32_t	tx_bitstream
	Encoded data bits buffer.
int	tx_bits
	The number of bits currently in tx_bitstream.
int	last_row_starts_at
	A pointer into the image buffer indicating where the last row begins.
int	row_starts_at
	A pointer into the image buffer indicating where the current row begins.
uint8_t *	row_buf
	Pointer to the buffer for the current pixel row.
int	bit_pos
	Pointer to the byte containing the next image bit to transmit.
int	bit_ptr
	Pointer to the bit within the byte containing the next image bit to transmit.
int	max_rows_to_next_1d_row
	The current maximum contiguous rows that may be 2D encoded.
int	rows_to_next_1d_row
	Number of rows left that can be 2D encoded, before a 1D encoded row must be used.
int	row_bits
	The current number of bits in the current encoded row.
int	min_row_bits
	The minimum bits in any row of the current page. For monitoring only.
int	max_row_bits
	The maximum bits in any row of the current page. For monitoring only.
logging_state_t	logging
	Error and flow logging control.

---

Detailed Description

T.4 FAX compression/decompression descriptor. This defines the working state for a single instance of a T.4 FAX compression or decompression channel.

---

The documentation for this struct was generated from the following file:

• t4.h