Go to the source code of this file.
Classes | |
struct | t4_state_t |
struct | t4_stats_t |
Defines | |
#define | _SPANDSP_T4_H_ |
#define | T4_COMPRESSION_ITU_T4_1D 1 |
#define | T4_COMPRESSION_ITU_T4_2D 2 |
#define | T4_COMPRESSION_ITU_T6 3 |
#define | T4_X_RESOLUTION_R4 4019 |
#define | T4_X_RESOLUTION_R8 8037 |
#define | T4_X_RESOLUTION_R16 16074 |
#define | T4_Y_RESOLUTION_STANDARD 3850 |
#define | T4_Y_RESOLUTION_FINE 7700 |
#define | T4_Y_RESOLUTION_SUPERFINE 15400 |
Functions | |
t4_state_t * | t4_rx_create (const char *file, int output_encoding) |
Allocate a T.4 transmit handling context, and initialise it. | |
int | t4_rx_init (t4_state_t *s, const char *file, int output_encoding) |
Prepare for reception of a document. | |
int | t4_rx_start_page (t4_state_t *s) |
Prepare to receive the next page of the current document. | |
int | t4_rx_put_bit (t4_state_t *s, int bit) |
Put a bit of the current document page. | |
int | t4_rx_put_byte (t4_state_t *s, uint8_t byte) |
Put a byte of the current document page. | |
int | t4_rx_put_chunk (t4_state_t *s, const uint8_t buf[], int len) |
Put a byte of the current document page. | |
int | t4_rx_end_page (t4_state_t *s) |
Complete the reception of a page. | |
int | t4_rx_delete (t4_state_t *s) |
End reception of a document. Tidy up, close the file and free the context. This should be used to end T.4 reception started with t4_rx_create. | |
int | t4_rx_end (t4_state_t *s) |
End reception of a document. Tidy up and close the file. This should be used to end T.4 reception started with t4_rx_init. | |
void | t4_rx_set_rx_encoding (t4_state_t *s, int encoding) |
Set the encoding for the received data. | |
void | t4_rx_set_image_width (t4_state_t *s, int width) |
Set the expected width of the received image, in pixel columns. | |
void | t4_rx_set_y_resolution (t4_state_t *s, int resolution) |
Set the row-to-row (y) resolution to expect for a received image. | |
void | t4_rx_set_x_resolution (t4_state_t *s, int resolution) |
Set the column-to-column (x) resolution to expect for a received image. | |
void | t4_rx_set_sub_address (t4_state_t *s, const char *sub_address) |
Set the sub-address of the fax, for inclusion in the file. | |
void | t4_rx_set_far_ident (t4_state_t *s, const char *ident) |
Set the identity of the remote machine, for inclusion in the file. | |
void | t4_rx_set_vendor (t4_state_t *s, const char *vendor) |
Set the vendor of the remote machine, for inclusion in the file. | |
void | t4_rx_set_model (t4_state_t *s, const char *model) |
Set the model of the remote machine, for inclusion in the file. | |
t4_state_t * | t4_tx_create (const char *file, int start_page, int stop_page) |
Allocate a T.4 receive handling context, and initialise it. | |
int | t4_tx_init (t4_state_t *s, const char *file, int start_page, int stop_page) |
Prepare for transmission of a document. | |
int | t4_tx_start_page (t4_state_t *s) |
Prepare to send the next page of the current document. | |
int | t4_tx_restart_page (t4_state_t *s) |
Prepare the current page for a resend. | |
int | t4_tx_more_pages (t4_state_t *s) |
Check for the existance of the next page. This information can be needed before it is determined that the current page is finished with. | |
int | t4_tx_end_page (t4_state_t *s) |
Complete the sending of a page. | |
int | t4_tx_get_bit (t4_state_t *s) |
Get the next bit of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate. | |
int | t4_tx_get_byte (t4_state_t *s) |
Get the next byte of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate. | |
int | t4_tx_get_chunk (t4_state_t *s, uint8_t buf[], int max_len) |
Get the next chunk of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate. | |
int | t4_tx_check_bit (t4_state_t *s) |
Return the next bit of the current document page, without actually moving forward in the buffer. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added. | |
int | t4_tx_delete (t4_state_t *s) |
End the transmission of a document. Tidy up, close the file and free the context. This should be used to end T.4 transmission started with t4_tx_create. | |
int | t4_tx_end (t4_state_t *s) |
End the transmission of a document. Tidy up and close the file. This should be used to end T.4 transmission started with t4_tx_init. | |
void | t4_tx_set_tx_encoding (t4_state_t *s, int encoding) |
Set the encoding for the encoded data. | |
void | t4_tx_set_min_row_bits (t4_state_t *s, int bits) |
Set the minimum number of encoded bits per row. This allows the makes the encoding process to be set to comply with the minimum row time specified by a remote receiving machine. | |
void | t4_tx_set_local_ident (t4_state_t *s, const char *ident) |
Set the identity of the local machine, for inclusion in page headers. | |
void | t4_tx_set_header_info (t4_state_t *s, const char *info) |
Set the header info. | |
int | t4_tx_get_y_resolution (t4_state_t *s) |
Get the row-to-row (y) resolution of the current page. | |
int | t4_tx_get_x_resolution (t4_state_t *s) |
Get the column-to-column (x) resolution of the current page. | |
int | t4_tx_get_image_width (t4_state_t *s) |
Get the width of the current page, in pixel columns. | |
void | t4_get_transfer_statistics (t4_state_t *s, t4_stats_t *t) |
Get the current transfer statistics. | |
const char * | t4_encoding_to_str (int encoding) |
Get the short text name of an encoding format. |
|
Get the short text name of an encoding format. Get the short text name of an encoding format.
|
|
Get the current transfer statistics. Get the current image transfer statistics.
|
|
Allocate a T.4 transmit handling context, and initialise it.
|
|
End reception of a document. Tidy up, close the file and free the context. This should be used to end T.4 reception started with t4_rx_create.
|
|
End reception of a document. Tidy up and close the file. This should be used to end T.4 reception started with t4_rx_init.
|
|
Complete the reception of a page.
|
|
Prepare for reception of a document.
|
|
Put a bit of the current document page.
|
|
Put a byte of the current document page.
|
|
Put a byte of the current document page.
|
|
Set the identity of the remote machine, for inclusion in the file.
|
|
Set the expected width of the received image, in pixel columns.
|
|
Set the model of the remote machine, for inclusion in the file.
|
|
Set the encoding for the received data.
|
|
Set the sub-address of the fax, for inclusion in the file.
|
|
Set the vendor of the remote machine, for inclusion in the file.
|
|
Set the column-to-column (x) resolution to expect for a received image.
|
|
Set the row-to-row (y) resolution to expect for a received image.
|
|
Prepare to receive the next page of the current document.
|
|
Return the next bit of the current document page, without actually moving forward in the buffer. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added.
|
|
Allocate a T.4 receive handling context, and initialise it.
|
|
End the transmission of a document. Tidy up, close the file and free the context. This should be used to end T.4 transmission started with t4_tx_create.
|
|
End the transmission of a document. Tidy up and close the file. This should be used to end T.4 transmission started with t4_tx_init.
|
|
Complete the sending of a page.
|
|
Get the next bit of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate.
|
|
Get the next byte of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate.
|
|
Get the next chunk of the current document page. The document will be padded for the current minimum scan line time. If the file does not contain an RTC (return to control) code at the end of the page, one will be added where appropriate.
|
|
Get the width of the current page, in pixel columns.
|
|
Get the column-to-column (x) resolution of the current page.
|
|
Get the row-to-row (y) resolution of the current page.
|
|
Prepare for transmission of a document.
|
|
Check for the existance of the next page. This information can be needed before it is determined that the current page is finished with.
|
|
Prepare the current page for a resend.
|
|
Set the header info. Set the info field, included in the header line included in each page of an encoded FAX. This is a string of up to 50 characters. Other information (date, local ident, etc.) are automatically included in the header. If the header info is set to NULL or a zero length string, no header lines will be added to the encoded FAX.
|
|
Set the identity of the local machine, for inclusion in page headers.
|
|
Set the minimum number of encoded bits per row. This allows the makes the encoding process to be set to comply with the minimum row time specified by a remote receiving machine.
|
|
Set the encoding for the encoded data.
|
|
Prepare to send the next page of the current document.
|