28#if !defined(_SPANDSP_T30_API_H_)
29#define _SPANDSP_T30_API_H_
38#if defined(__cplusplus)
64SPAN_DECLARE(
int)
t30_set_tx_nsf(t30_state_t *s,
const uint8_t *nsf,
int len);
71SPAN_DECLARE(
size_t)
t30_get_tx_nsf(t30_state_t *s,
const uint8_t *nsf[]);
78SPAN_DECLARE(
size_t)
t30_get_rx_nsf(t30_state_t *s,
const uint8_t *nsf[]);
86SPAN_DECLARE(
int)
t30_set_tx_nsc(t30_state_t *s,
const uint8_t *nsc,
int len);
93SPAN_DECLARE(
size_t)
t30_get_tx_nsc(t30_state_t *s,
const uint8_t *nsc[]);
100SPAN_DECLARE(
size_t)
t30_get_rx_nsc(t30_state_t *s,
const uint8_t *nsc[]);
108SPAN_DECLARE(
int)
t30_set_tx_nss(t30_state_t *s,
const uint8_t *nss,
int len);
115SPAN_DECLARE(
size_t)
t30_get_tx_nss(t30_state_t *s,
const uint8_t *nss[]);
122SPAN_DECLARE(
size_t)
t30_get_rx_nss(t30_state_t *s,
const uint8_t *nss[]);
264SPAN_DECLARE(
int)
t30_set_tx_tsa(t30_state_t *s,
int type,
const char *address,
int len);
273SPAN_DECLARE(
size_t)
t30_get_tx_tsa(t30_state_t *s,
int *type,
const char *address[]);
281SPAN_DECLARE(
size_t)
t30_get_rx_tsa(t30_state_t *s,
int *type,
const char *address[]);
291SPAN_DECLARE(
int)
t30_set_tx_ira(t30_state_t *s,
int type,
const char *address,
int len);
300SPAN_DECLARE(
size_t)
t30_get_tx_ira(t30_state_t *s,
int *type,
const char *address[]);
308SPAN_DECLARE(
size_t)
t30_get_rx_ira(t30_state_t *s,
int *type,
const char *address[]);
318SPAN_DECLARE(
int)
t30_set_tx_cia(t30_state_t *s,
int type,
const char *address,
int len);
327SPAN_DECLARE(
size_t)
t30_get_tx_cia(t30_state_t *s,
int *type,
const char *address[]);
335SPAN_DECLARE(
size_t)
t30_get_rx_cia(t30_state_t *s,
int *type,
const char *address[]);
345SPAN_DECLARE(
int)
t30_set_tx_isp(t30_state_t *s,
int type,
const char *address,
int len);
354SPAN_DECLARE(
size_t)
t30_get_tx_isp(t30_state_t *s,
int *type,
const char *address[]);
362SPAN_DECLARE(
size_t)
t30_get_rx_isp(t30_state_t *s,
int *type,
const char *address[]);
372SPAN_DECLARE(
int)
t30_set_tx_csa(t30_state_t *s,
int type,
const char *address,
int len);
381SPAN_DECLARE(
size_t)
t30_get_tx_csa(t30_state_t *s,
int *type,
const char *address[]);
389SPAN_DECLARE(
size_t)
t30_get_rx_csa(t30_state_t *s,
int *type,
const char *address[]);
443SPAN_DECLARE(
void)
t30_set_rx_file(t30_state_t *s,
const char *file,
int stop_page);
452SPAN_DECLARE(
void)
t30_set_tx_file(t30_state_t *s,
const char *file,
int start_page,
int stop_page);
603#if defined(__cplusplus)
struct logging_state_s logging_state_t
Definition logging.h:72
void(* t30_phase_e_handler_t)(void *user_data, int completion_code)
T.30 phase E callback handler.
Definition t30.h:177
int(* t30_phase_d_handler_t)(void *user_data, int result)
T.30 phase D callback handler.
Definition t30.h:169
void(* t30_real_time_frame_handler_t)(void *user_data, bool direction, const uint8_t msg[], int len)
T.30 real time frame handler.
Definition t30.h:187
int(* t30_phase_b_handler_t)(void *user_data, int result)
T.30 phase B callback handler.
Definition t30.h:160
int(* t30_document_get_handler_t)(void *user_data, uint8_t msg[], int len)
T.30 send document handler.
Definition t30.h:228
int(* t30_document_handler_t)(void *user_data, int status)
T.30 document handler.
Definition t30.h:198
int(* t30_document_put_handler_t)(void *user_data, const uint8_t msg[], int len)
T.30 deliver handler.
Definition t30.h:238
const char * t30_get_tx_polled_sub_address(t30_state_t *s)
Get the received polled sub-address associated with a T.30 context.
Definition t30_api.c:288
int t30_set_tx_isp(t30_state_t *s, int type, const char *address, int len)
Set the transmitted ISP associated with a T.30 context.
Definition t30_api.c:618
int t30_set_tx_csa(t30_state_t *s, int type, const char *address, int len)
Set the transmitted CSA associated with a T.30 context.
Definition t30_api.c:658
size_t t30_get_tx_nss(t30_state_t *s, const uint8_t *nss[])
Set an NSS frame to be associated with a T.30 context.
Definition t30_api.c:470
int t33_sub_address_extract_field(uint8_t field[21], const uint8_t t33[], int field_no)
Get the specified field from a T.33 formatted string.
Definition t30_api.c:100
const char * t30_get_rx_polled_sub_address(t30_state_t *s)
Get the received polled sub-address associated with a T.30 context.
Definition t30_api.c:297
int t30_set_tx_selective_polling_address(t30_state_t *s, const char *selective_polling_address)
Set the transmitted selective polling address associated with a T.30 context.
Definition t30_api.c:238
int t30_set_tx_ira(t30_state_t *s, int type, const char *address, int len)
Set the transmitted IRA associated with a T.30 context.
Definition t30_api.c:538
void t30_set_phase_e_handler(t30_state_t *s, t30_phase_e_handler_t handler, void *user_data)
Set a callback function for T.30 phase E handling.
Definition t30_api.c:1012
const char * t30_get_rx_country(t30_state_t *s)
Get the country of origin of the remote FAX machine associated with a T.30 context.
Definition t30_api.c:745
const char * t30_get_tx_sub_address(t30_state_t *s)
Get the received sub-address associated with a T.30 context.
Definition t30_api.c:220
int t30_set_ecm_capability(t30_state_t *s, bool enabled)
Select ECM capability.
Definition t30_api.c:786
const char * t30_get_rx_model(t30_state_t *s)
Get the name of the model of the remote FAX machine associated with a T.30 context.
Definition t30_api.c:757
int t30_set_supported_output_compressions(t30_state_t *s, int supported_compressions)
Specify the output encoding for TIFF files created during FAX reception.
Definition t30_api.c:818
size_t t30_get_rx_cia(t30_state_t *s, int *type, const char *address[])
Get the received CIA associated with a T.30 context.
Definition t30_api.c:606
void t30_set_phase_b_handler(t30_state_t *s, t30_phase_b_handler_t handler, void *user_data)
Set a callback function for T.30 phase B handling.
Definition t30_api.c:998
int t30_set_tx_page_header_overlays_image(t30_state_t *s, bool header_overlays_image)
Set page header overlay mode.
Definition t30_api.c:698
void t30_set_max_command_tries(t30_state_t *s, int tries)
Select maximum command tries.
Definition t30_api.c:800
size_t t30_get_rx_nss(t30_state_t *s, const uint8_t *nss[])
Set an NSS frame to be associated with a T.30 context.
Definition t30_api.c:479
size_t t30_get_rx_isp(t30_state_t *s, int *type, const char *address[])
Get the received ISP associated with a T.30 context.
Definition t30_api.c:646
const char * t30_get_rx_ident(t30_state_t *s)
Set the transmitted identifier associated with a T.30 context.
Definition t30_api.c:195
size_t t30_get_tx_nsc(t30_state_t *s, const uint8_t *nsc[])
Set an NSC frame to be associated with a T.30 context.
Definition t30_api.c:432
size_t t30_get_tx_nsf(t30_state_t *s, const uint8_t *nsf[])
Set an NSF frame to be associated with a T.30 context.
Definition t30_api.c:394
size_t t30_get_rx_csa(t30_state_t *s, int *type, const char *address[])
Get the received CSA associated with a T.30 context.
Definition t30_api.c:686
int t30_set_tx_cia(t30_state_t *s, int type, const char *address, int len)
Set the transmitted CIA associated with a T.30 context.
Definition t30_api.c:578
size_t t30_get_tx_csa(t30_state_t *s, int *type, const char *address[])
Get the received CSA associated with a T.30 context.
Definition t30_api.c:674
int t30_set_tx_password(t30_state_t *s, const char *password)
Set the transmitted password associated with a T.30 context.
Definition t30_api.c:340
size_t t30_get_tx_isp(t30_state_t *s, int *type, const char *address[])
Get the received ISP associated with a T.30 context.
Definition t30_api.c:634
size_t t30_get_tx_tsa(t30_state_t *s, int *type, const char *address[])
Get the received TSA associated with a T.30 context.
Definition t30_api.c:514
size_t t30_get_tx_cia(t30_state_t *s, int *type, const char *address[])
Get the received CIA associated with a T.30 context.
Definition t30_api.c:594
void t33_sub_address_add_field(uint8_t t33[], const uint8_t field[], int type)
Append the specified field to a T.33 formatted string.
Definition t30_api.c:157
int t30_set_supported_compressions(t30_state_t *s, int supported_compressions)
Specify supported compression types.
Definition t30_api.c:877
int t30_set_tx_nss(t30_state_t *s, const uint8_t *nss, int len)
Set the transmitted NSS frame to be associated with a T.30 context.
Definition t30_api.c:450
int t30_set_supported_modems(t30_state_t *s, int supported_modems)
Specify supported modems.
Definition t30_api.c:869
void t30_set_iaf_mode(t30_state_t *s, int iaf)
Set Internet aware FAX (IAF) mode.
Definition t30_api.c:780
int t30_set_tx_sender_ident(t30_state_t *s, const char *sender_ident)
Set the transmitted sender ident associated with a T.30 context.
Definition t30_api.c:306
logging_state_t * t30_get_logging_state(t30_state_t *s)
Get a pointer to the logging context associated with a T.30 context.
Definition t30_api.c:1047
int t30_set_tx_tsa(t30_state_t *s, int type, const char *address, int len)
Set the transmitted TSA associated with a T.30 context.
Definition t30_api.c:488
int t30_set_supported_bilevel_resolutions(t30_state_t *s, int supported_resolutions)
Specify supported bi-level resolutions.
Definition t30_api.c:913
void t30_set_tx_file(t30_state_t *s, const char *file, int start_page, int stop_page)
Set next transmit file name.
Definition t30_api.c:771
const char * t30_get_tx_ident(t30_state_t *s)
Set the transmitted identifier associated with a T.30 context.
Definition t30_api.c:186
const char * t30_get_rx_sender_ident(t30_state_t *s)
Get the received sender ident associated with a T.30 context.
Definition t30_api.c:331
void t30_set_keep_bad_quality_pages(t30_state_t *s, bool keep_bad_pages)
Set the save bad quality pages handling associated with a T.30 context.
Definition t30_api.c:812
size_t t30_get_rx_ira(t30_state_t *s, int *type, const char *address[])
Get the received IRA associated with a T.30 context.
Definition t30_api.c:566
int t30_set_supported_colour_resolutions(t30_state_t *s, int supported_resolutions)
Specify supported colour resolutions.
Definition t30_api.c:938
const char * t30_get_tx_selective_polling_address(t30_state_t *s)
Get the received selective polling address associated with a T.30 context.
Definition t30_api.c:254
int t30_set_tx_page_header_info(t30_state_t *s, const char *info)
Set the transmitted header information associated with a T.30 context.
Definition t30_api.c:706
void t30_set_rx_file(t30_state_t *s, const char *file, int stop_page)
Set next receive file name.
Definition t30_api.c:763
int t30_set_supported_image_sizes(t30_state_t *s, int supported_image_sizes)
Specify supported image sizes.
Definition t30_api.c:955
size_t t30_get_tx_ira(t30_state_t *s, int *type, const char *address[])
Get the received IRA associated with a T.30 context.
Definition t30_api.c:554
const char * t30_get_tx_password(t30_state_t *s)
Get the received password associated with a T.30 context.
Definition t30_api.c:356
void t30_set_phase_d_handler(t30_state_t *s, t30_phase_d_handler_t handler, void *user_data)
Set a callback function for T.30 phase D handling.
Definition t30_api.c:1005
size_t t30_get_tx_page_header_info(t30_state_t *s, char *info)
Get the header information associated with a T.30 context.
Definition t30_api.c:723
void t30_set_retransmit_capable(t30_state_t *s, bool enabled)
Select page retransmission capable.
Definition t30_api.c:794
int t30_set_tx_ident(t30_state_t *s, const char *id)
Set the transmitted identifier associated with a T.30 context.
Definition t30_api.c:169
int t30_set_minimum_scan_line_time(t30_state_t *s, int min_time)
Specify minimum scan line time.
Definition t30_api.c:847
int t30_set_tx_nsf(t30_state_t *s, const uint8_t *nsf, int len)
Set the transmitted NSF frame to be associated with a T.30 context.
Definition t30_api.c:374
size_t t30_get_rx_nsf(t30_state_t *s, const uint8_t *nsf[])
Set an NSF frame to be associated with a T.30 context.
Definition t30_api.c:403
int t30_set_receiver_not_ready(t30_state_t *s, int count)
Specify a period of responding with receiver not ready.
Definition t30_api.c:991
const char * t30_get_rx_selective_polling_address(t30_state_t *s)
Get the received selective polling address associated with a T.30 context.
Definition t30_api.c:263
int t30_set_tx_nsc(t30_state_t *s, const uint8_t *nsc, int len)
Set the transmitted NSC frame to be associated with a T.30 context.
Definition t30_api.c:412
void t30_set_real_time_frame_handler(t30_state_t *s, t30_real_time_frame_handler_t handler, void *user_data)
Set a callback function for T.30 frame exchange monitoring.
Definition t30_api.c:1026
const char * t30_get_rx_sub_address(t30_state_t *s)
Get the received sub-address associated with a T.30 context.
Definition t30_api.c:229
size_t t30_get_rx_nsc(t30_state_t *s, const uint8_t *nsc[])
Set an NSC frame to be associated with a T.30 context.
Definition t30_api.c:441
size_t t30_get_rx_tsa(t30_state_t *s, int *type, const char *address[])
Get the received TSA associated with a T.30 context.
Definition t30_api.c:526
int t30_set_supported_t30_features(t30_state_t *s, int supported_t30_features)
Specify supported T.30 features.
Definition t30_api.c:972
void t30_set_status(t30_state_t *s, int status)
Set T.30 status.
Definition t30_api.c:980
int t30_set_tx_sub_address(t30_state_t *s, const char *sub_address)
Set the transmitted sub-address associated with a T.30 context.
Definition t30_api.c:204
int t30_set_tx_page_header_tz(t30_state_t *s, const char *tzstring)
Set the transmitted header timestamp timezone associated with a T.30 context.
Definition t30_api.c:732
const char * t30_get_tx_sender_ident(t30_state_t *s)
Get the received sender ident associated with a T.30 context.
Definition t30_api.c:322
void t30_set_document_handler(t30_state_t *s, t30_document_handler_t handler, void *user_data)
Set a callback function for T.30 end of document handling.
Definition t30_api.c:1019
const char * t30_get_rx_password(t30_state_t *s)
Get the received password associated with a T.30 context.
Definition t30_api.c:365
const char * t30_get_rx_vendor(t30_state_t *s)
Get the name of the vendor of the remote FAX machine associated with a T.30 context.
Definition t30_api.c:751
int t30_set_tx_polled_sub_address(t30_state_t *s, const char *polled_sub_address)
Set the transmitted polled sub-address associated with a T.30 context.
Definition t30_api.c:272
void t30_set_max_response_tries(t30_state_t *s, int tries)
Select maximum response tries.
Definition t30_api.c:806