#include <t4_tx.h>

Classes
union	[union].encoder

Public Attributes
t4_row_read_handler_t	row_handler
	Callback function to read a row of pixels from the image source.
void *	row_handler_user_data
	Opaque pointer passed to row_read_handler.
int	row_squashing_ratio
	When superfine and fine resolution images need to be squahed vertically to a lower resolution, this value sets the number of source rows which must be squashed to form each row on the wire.
int	line_image_size
	The size of the compressed image on the line side, in bits.
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.
bool	header_overlays_image
	True for FAX page headers to overlay (i.e. replace) the beginning of the page image. False for FAX page headers to add to the overall length of the page.
const char *	header_info
	The text which will be used in FAX page header. No text results in no header line.
const char *	local_ident
	The local ident string. This is used with header_info to form a page header line.
int	current_page
	The page number of current page. The first page is zero. If FAX page headers are used, the page number in the header will be one more than this value (i.e. they start from 1).
char *	header_text
	The composed text of the FAX page header, if there is one.
tz_t *	tz
	Optional per instance time zone for the FAX page header timestamp.
int	header_row
	Row counter for playing out the rows of the header line.
union	encoder
t4_image_get_handler_t	image_get_handler
int	apply_lab
lab_params_t	lab_params
uint8_t *	colour_map
int	colour_map_entries
image_translate_state_t	translator
uint8_t *	pack_buf
int	pack_ptr
int	pack_row
int	pack_bit_mask
no_encoder_state_t	no_encoder
t4_tx_metadata_t	metadata
	Supporting information, like resolutions, which the backend may want.
t4_tx_tiff_state_t	tiff
	All TIFF file specific state information for the T.4 context.
logging_state_t	logging
	Error and flow logging control.

Detailed Description

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

Member Data Documentation

◆ current_page

int t4_tx_state_s::current_page

The page number of current page. The first page is zero. If FAX page headers are used, the page number in the header will be one more than this value (i.e. they start from 1).

Referenced by 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_tx_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().

◆ header_overlays_image

bool t4_tx_state_s::header_overlays_image

True for FAX page headers to overlay (i.e. replace) the beginning of the page image. False for FAX page headers to add to the overall length of the page.

Referenced by t4_tx_set_header_overlays_image().

◆ header_row

int t4_tx_state_s::header_row

Row counter for playing out the rows of the header line.

Referenced by t4_tx_start_page().

◆ header_text

char* t4_tx_state_s::header_text

The composed text of the FAX page header, if there is one.

Referenced by t4_tx_release().

◆ local_ident

const char* t4_tx_state_s::local_ident

The local ident string. This is used with header_info to form a page header line.

Referenced by t4_tx_set_local_ident().

◆ logging

logging_state_t t4_tx_state_s::logging

Error and flow logging control.

Referenced by t4_tx_get_logging_state(), t4_tx_init(), t4_tx_next_page_has_different_format(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

◆ metadata

t4_tx_metadata_t t4_tx_state_s::metadata

Supporting information, like resolutions, which the backend may want.

Referenced by t4_tx_get_transfer_statistics(), t4_tx_get_tx_compression(), t4_tx_get_tx_image_type(), t4_tx_get_tx_image_width(), t4_tx_get_tx_image_width_code(), t4_tx_get_tx_resolution(), t4_tx_get_tx_x_resolution(), t4_tx_get_tx_y_resolution(), t4_tx_image_complete(), t4_tx_init(), t4_tx_set_max_2d_rows_per_1d_row(), t4_tx_set_min_bits_per_row(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

◆ row_handler

t4_row_read_handler_t t4_tx_state_s::row_handler

Callback function to read a row of pixels from the image source.

Referenced by t4_tx_init(), t4_tx_set_row_read_handler(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

◆ row_handler_user_data

void* t4_tx_state_s::row_handler_user_data

Opaque pointer passed to row_read_handler.

Referenced by t4_tx_init(), t4_tx_set_row_read_handler(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

◆ row_squashing_ratio

int t4_tx_state_s::row_squashing_ratio

When superfine and fine resolution images need to be squahed vertically to a lower resolution, this value sets the number of source rows which must be squashed to form each row on the wire.

Referenced by t4_tx_init(), and t4_tx_set_tx_image_format().