#include <t4_tx.h>

Public Attributes
int	rx
	The same structure is used for T.4 transmit and receive. This variable records which mode is in progress.
int	line_encoding
	The type of compression used between the FAX machines.
time_t	page_start_time
	The time at which handling of the current page began.
const char *	header_info
	The text which will be used in FAX page header. No text results in no header line.
struct tz_s *	tz
	Optional per instance time zone for the FAX page header timestamp.
int	line_image_size
	The size of the compressed image on the line side, in bits.
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	image_buffer_size
	The current size of the image buffer.
uint8_t *	image_buffer
	A point to the image buffer.
int	current_page
	The number of pages transferred to date.
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	row_is_2d
	This variable is set if we are treating the current row as a 2D encoded one.
int	row_len
	The current length of the current row.
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.
uint8_t *	row_buf
	Pointer to the buffer for the current pixel row.
uint32_t	tx_bitstream
	Encoded data bits buffer.
int	tx_bits
	The number of bits currently in tx_bitstream.
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.
t4_tiff_state_t	tiff
	All TIFF file specific state information for the T.4 context.
t4_t6_decode_state_t	t4_t6_rx
t4_t6_encode_state_t	t4_t6_tx

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.

Member Data Documentation

◆ bytes_per_row

int t4_state_s::bytes_per_row

The current number of bytes per row of uncompressed image data.

Referenced by t4_rx_end_page(), t4_rx_init(), t4_rx_start_page(), t4_tx_init(), and t4_tx_start_page().

◆ cur_runs

uint32_t* t4_state_s::cur_runs

Black and white run-lengths for the current row.

Referenced by t4_rx_start_page(), t4_tx_init(), and t4_tx_start_page().

◆ current_page

int t4_state_s::current_page

The number of pages transferred to date.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_init(), t4_tx_end_page(), t4_tx_get_current_page_in_file(), t4_tx_get_transfer_statistics(), t4_tx_init(), t4_tx_next_page_has_different_format(), and t4_tx_start_page().

◆ header_info

const char* t4_state_s::header_info

The text which will be used in FAX page header. No text results in no header line.

Referenced by t4_tx_set_header_info(), and t4_tx_start_page().

◆ image_buffer

uint8_t* t4_state_s::image_buffer

A point to the image buffer.

Referenced by t4_rx_end_page(), t4_rx_init(), t4_tx_check_bit(), t4_tx_get_bit(), t4_tx_get_byte(), and t4_tx_get_chunk().

◆ image_buffer_size

int t4_state_s::image_buffer_size

The current size of the image buffer.

Referenced by t4_rx_init(), and t4_tx_init().

◆ image_length

int t4_state_s::image_length

Length of the current page, in pixels.

Referenced by t4_rx_end_page(), t4_rx_get_transfer_statistics(), t4_rx_start_page(), t4_tx_get_transfer_statistics(), and t4_tx_start_page().

◆ image_size

int t4_state_s::image_size

The size of the image in the image buffer, in bytes.

Referenced by t4_rx_end_page(), t4_rx_start_page(), t4_tx_check_bit(), t4_tx_get_bit(), t4_tx_get_byte(), t4_tx_get_chunk(), and t4_tx_start_page().

◆ image_width

int t4_state_s::image_width

Width of the current page, in pixels.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_init(), t4_rx_set_image_width(), t4_rx_start_page(), t4_tx_get_image_width(), t4_tx_get_transfer_statistics(), t4_tx_init(), and t4_tx_start_page().

◆ line_encoding

int t4_state_s::line_encoding

The type of compression used between the FAX machines.

Referenced by t4_rx_end_page(), t4_rx_get_transfer_statistics(), t4_rx_set_rx_encoding(), t4_rx_start_page(), t4_tx_get_transfer_statistics(), t4_tx_set_tx_encoding(), and t4_tx_start_page().

◆ line_image_size

int t4_state_s::line_image_size

The size of the compressed image on the line side, in bits.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_start_page(), t4_tx_get_transfer_statistics(), and t4_tx_start_page().

◆ logging

logging_state_t t4_state_s::logging

Error and flow logging control.

Referenced by t4_rx_end_page(), t4_rx_init(), t4_rx_start_page(), t4_tx_init(), t4_tx_next_page_has_different_format(), and t4_tx_start_page().

◆ max_row_bits

int t4_state_s::max_row_bits

The maximum bits in any row of the current page. For monitoring only.

Referenced by t4_rx_start_page(), and t4_tx_start_page().

◆ min_row_bits

int t4_state_s::min_row_bits

The minimum bits in any row of the current page. For monitoring only.

Referenced by t4_rx_start_page(), and t4_tx_start_page().

◆ page_start_time

time_t t4_state_s::page_start_time

The time at which handling of the current page began.

Referenced by t4_rx_start_page().

◆ ref_runs

uint32_t* t4_state_s::ref_runs

Black and white run-lengths for the reference row.

Referenced by t4_rx_start_page(), t4_tx_init(), and t4_tx_start_page().

◆ row_bits

int t4_state_s::row_bits

The current number of bits in the current encoded row.

Referenced by t4_rx_start_page(), and t4_tx_start_page().

◆ row_buf

uint8_t* t4_state_s::row_buf

Pointer to the buffer for the current pixel row.

Referenced by t4_tx_init(), and t4_tx_start_page().

◆ row_is_2d

int t4_state_s::row_is_2d

This variable is set if we are treating the current row as a 2D encoded one.

Referenced by t4_rx_start_page(), t4_tx_set_tx_encoding(), and t4_tx_start_page().

◆ row_len

int t4_state_s::row_len

The current length of the current row.

Referenced by t4_rx_start_page().

◆ rx

int t4_state_s::rx

The same structure is used for T.4 transmit and receive. This variable records which mode is in progress.

Referenced by t4_rx_init(), t4_rx_release(), t4_tx_init(), and t4_tx_release().

◆ tiff

t4_tiff_state_t t4_state_s::tiff

All TIFF file specific state information for the T.4 context.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_init(), t4_rx_release(), t4_rx_set_dcs(), t4_rx_set_far_ident(), t4_rx_set_model(), t4_rx_set_sub_address(), t4_rx_set_vendor(), t4_rx_start_page(), t4_tx_get_pages_in_file(), t4_tx_get_transfer_statistics(), t4_tx_init(), t4_tx_next_page_has_different_format(), t4_tx_release(), t4_tx_set_local_ident(), and t4_tx_start_page().

◆ tx_bits

int t4_state_s::tx_bits

The number of bits currently in tx_bitstream.

Referenced by t4_rx_start_page(), and t4_tx_start_page().

◆ tx_bitstream

uint32_t t4_state_s::tx_bitstream

Encoded data bits buffer.

Referenced by t4_rx_start_page(), and t4_tx_start_page().

◆ tz

struct tz_s* t4_state_s::tz

Optional per instance time zone for the FAX page header timestamp.

Referenced by t4_tx_set_header_tz().

◆ x_resolution

int t4_state_s::x_resolution

Column-to-column (X) resolution in pixels per metre.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_init(), t4_rx_set_x_resolution(), t4_tx_get_transfer_statistics(), and t4_tx_get_x_resolution().

◆ y_resolution

int t4_state_s::y_resolution

Row-to-row (Y) resolution in pixels per metre.

Referenced by t4_rx_get_transfer_statistics(), t4_rx_init(), t4_rx_set_y_resolution(), t4_tx_get_transfer_statistics(), and t4_tx_get_y_resolution().

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

private/t4_tx.h

Public Attributes

Detailed Description

Member Data Documentation

◆ bytes_per_row

◆ cur_runs

◆ current_page

◆ header_info

◆ image_buffer

◆ image_buffer_size

◆ image_length

◆ image_size

◆ image_width

◆ line_encoding

◆ line_image_size

◆ logging

◆ max_row_bits

◆ min_row_bits

◆ page_start_time

◆ ref_runs

◆ row_bits

◆ row_buf

◆ row_is_2d

◆ row_len

◆ rx

◆ tiff

◆ tx_bits

◆ tx_bitstream

◆ tz

◆ x_resolution

◆ y_resolution