freeswitch/libs/spandsp/tests/t4_tests.c

/*
 * SpanDSP - a series of DSP components for telephony
 *
 * t4_tests.c - ITU T.4 FAX image to and from TIFF file tests
 *
 * Written by Steve Underwood <steveu@coppice.org>
 *
 * Copyright (C) 2003 Steve Underwood
 *
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2, as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*! \file */

/*! \page t4_tests_page T.4 tests
\section t4_tests_page_sec_1 What does it do
These tests exercise the image compression and decompression methods defined
in ITU specifications T.4 and T.6.
*/

#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif

#include <stdlib.h>
#include <stdio.h>
#include <fcntl.h>
#include <unistd.h>
#include <memory.h>

#define SPANDSP_EXPOSE_INTERNAL_STRUCTURES

#include "spandsp.h"

#define IN_FILE_NAME    "../test-data/itu/fax/itutests.tif"
#define OUT_FILE_NAME   "t4_tests_receive.tif"

#define XSIZE           1728

t4_tx_state_t *send_state;
t4_rx_state_t *receive_state;

int rows_written = 0;
int rows_read = 0;

static void dump_image_as_xxx(t4_rx_state_t *state)
{
#if 0
    uint8_t *s;
    int i;
    int j;
    int k;

    /* Dump the entire image as text 'X's and spaces */
    printf("Image (%d x %d):\n", state->t4_t6.image_width, state->t4_t6.image_length);
    s = state->image_buffer;
    for (i = 0;  i < state->t4_t6.image_length;  i++)
    {
        for (j = 0;  j < state->t4_t6.bytes_per_row;  j++)
        {
            for (k = 0;  k < 8;  k++)
                printf((state->image_buffer[i*state->t4_t6.bytes_per_row + j] & (0x80 >> k))  ?  "X"  :  " ");
        }
        printf("\n");
    }
#endif
}
/*- End of function --------------------------------------------------------*/

static void display_page_stats(t4_rx_state_t *s)
{
    t4_stats_t stats;

    t4_rx_get_transfer_statistics(s, &stats);
    printf("Pages = %d\n", stats.pages_transferred);
    printf("Compression = %s\n", t4_compression_to_str(stats.compression));
    printf("Compressed size = %d\n", stats.line_image_size);
    printf("Raw image size = %d pels x %d pels\n", stats.image_width, stats.image_length);
    printf("Image size = %d pels x %d pels\n", stats.width, stats.length);
    printf("Raw image resolution = %d pels/m x %d pels/m\n", stats.image_x_resolution, stats.image_y_resolution);
    printf("Image resolution = %d pels/m x %d pels/m\n", stats.x_resolution, stats.y_resolution);
    printf("Bad rows = %d\n", stats.bad_rows);
    printf("Longest bad row run = %d\n", stats.longest_bad_row_run);
    printf("Bits per row - min %d, max %d\n", s->decoder.t4_t6.min_row_bits, s->decoder.t4_t6.max_row_bits);
}
/*- End of function --------------------------------------------------------*/

static int detect_non_ecm_page_end(int bit, int page_ended)
{
    static int consecutive_eols;
    static int max_consecutive_eols;
    static int consecutive_zeros;
    static int consecutive_ones;
    static int eol_zeros;
    static int eol_ones;
    static int expected_eols;
    static int end_marks;

    /* Check the EOLs are added properly to the end of a non-ECM image. We can't rely
       on the decoder giving the right answer, as a full set of EOLs is not needed for
       the decoder to work. */
    if (bit == -1)
    {
        /* Reset */
        consecutive_eols = 0;
        max_consecutive_eols = 0;
        consecutive_zeros = 0;
        consecutive_ones = 0;
        end_marks = 0;

        eol_zeros = 11;
        eol_ones = (page_ended == T4_COMPRESSION_T4_2D)  ?  2  :  1;
        expected_eols = (page_ended == T4_COMPRESSION_T6)  ?  2  :  6;
        return 0;
    }

    /* Monitor whether the EOLs are there in the correct amount */
    if (bit == 0)
    {
        consecutive_zeros++;
        consecutive_ones = 0;
    }
    else if (bit == 1)
    {
        if (++consecutive_ones == eol_ones)
        {
            if (consecutive_eols == 0  &&  consecutive_zeros >= eol_zeros)
                consecutive_eols++;
            else if (consecutive_zeros == eol_zeros)
                consecutive_eols++;
            else
                consecutive_eols = 0;
            consecutive_zeros = 0;
            consecutive_ones = 0;
        }
        if (max_consecutive_eols < consecutive_eols)
            max_consecutive_eols = consecutive_eols;
    }
    else if (bit == SIG_STATUS_END_OF_DATA)
    {
        if (end_marks == 0)
        {
            if (max_consecutive_eols != expected_eols)
            {
                printf("Only %d EOLs (should be %d)\n", max_consecutive_eols, expected_eols);
                return 2;
            }
            consecutive_zeros = 0;
            consecutive_eols = 0;
            max_consecutive_eols = 0;
        }
        if (!page_ended)
        {
            /* We might need to push a few bits to get the receiver to report the
               end of page condition (at least with T.6). */
            if (++end_marks > 50)
            {
                printf("Receiver missed the end of page mark\n");
                return 2;
            }
            return 0;
        }
        return 1;
    }
    return 0;
}
/*- End of function --------------------------------------------------------*/

int main(int argc, char *argv[])
{
    static const int compression_sequence[] =
    {
        //T4_COMPRESSION_NONE,
        T4_COMPRESSION_T4_1D,
        T4_COMPRESSION_T4_2D,
        T4_COMPRESSION_T6,
        T4_COMPRESSION_T85,
        T4_COMPRESSION_T85_L0,
#if defined(SPANDSP_SUPPORT_T88x)
        T4_COMPRESSION_T88,
#endif
#if defined(SPANDSP_SUPPORT_T42x)
        T4_COMPRESSION_T42_T81,
        T4_COMPRESSION_SYCC_T81,
#endif
#if defined(SPANDSP_SUPPORT_T43x)
        T4_COMPRESSION_T43,
#endif
#if defined(SPANDSP_SUPPORT_T45x)
        T4_COMPRESSION_T45,
#endif
        -1
    };
    int sends;
    int bit;
    int end_of_page;
    int end_marks;
    int res;
    int compression;
    int compression_step;
    int min_row_bits;
    int block_size;
    char buf[1024];
    uint8_t block[1024];
    const char *in_file_name;
    const char *decode_file_name;
    const char *page_header_tz;
    tz_t tz;
    int opt;
    int len;
    int i;
    int bit_error_rate;
    int tests_failed;
    bool restart_pages;
    bool add_page_headers;
    bool overlay_page_headers;
    bool dump_as_xxx;
    unsigned int last_pkt_no;
    unsigned int pkt_no;
    int page_ended;
    FILE *file;

    tests_failed = 0;
    compression = -1;
    compression_step = 0;
    add_page_headers = false;
    overlay_page_headers = false;
    restart_pages = false;
    in_file_name = IN_FILE_NAME;
    decode_file_name = NULL;
    page_header_tz = NULL;
    /* Use a non-zero default minimum row length to ensure we test the consecutive EOLs part
       properly. */
    min_row_bits = 50;
    block_size = 1;
    bit_error_rate = 0;
    dump_as_xxx = false;
    while ((opt = getopt(argc, argv, "b:c:d:ehHri:m:t:x")) != -1)
    {
        switch (opt)
        {
        case 'b':
            block_size = atoi(optarg);
            if (block_size > 1024)
            {
                printf("Block size too large. Must be 1024 or less\n");
                exit(2);
            }
            break;
        case 'c':
            if (strcmp(optarg, "T41D") == 0)
            {
                compression = T4_COMPRESSION_T4_1D;
                compression_step = -1;
            }
            else if (strcmp(optarg, "T42D") == 0)
            {
                compression = T4_COMPRESSION_T4_2D;
                compression_step = -1;
            }
            else if (strcmp(optarg, "T6") == 0)
            {
                compression = T4_COMPRESSION_T6;
                compression_step = -1;
            }
            else if (strcmp(optarg, "T85") == 0)
            {
                compression = T4_COMPRESSION_T85;
                compression_step = -1;
            }
#if defined(SPANDSP_SUPPORT_T88)
            else if (strcmp(optarg, "T88") == 0)
            {
                compression = T4_COMPRESSION_T88;
                compression_step = -1;
            }
#endif
            else if (strcmp(optarg, "T81") == 0)
            {
                compression = T4_COMPRESSION_T42_T81;
                compression_step = -1;
            }
            else if (strcmp(optarg, "T43") == 0)
            {
                compression = T4_COMPRESSION_T43;
                compression_step = -1;
            }
#if defined(SPANDSP_SUPPORT_T45)
            else if (strcmp(optarg, "T45") == 0)
            {
                compression = T4_COMPRESSION_T45;
                compression_step = -1;
            }
#endif
            else
            {
                printf("Unrecognised compression.\n");
                exit(2);
            }
            break;
        case 'd':
            decode_file_name = optarg;
            break;
        case 'e':
            bit_error_rate = 0x3FF;
            break;
        case 'h':
            add_page_headers = true;
            overlay_page_headers = false;
            break;
        case 'H':
            add_page_headers = true;
            overlay_page_headers = true;
            break;
        case 'r':
            restart_pages = true;
            break;
        case 'i':
            in_file_name = optarg;
            break;
        case 'm':
            min_row_bits = atoi(optarg);
            break;
        case 't':
            page_header_tz = optarg;
            break;
        case 'x':
            dump_as_xxx = true;
            break;
        default:
            //usage();
            exit(2);
            break;
        }
    }

    end_of_page = T4_DECODE_MORE_DATA;
    if (decode_file_name)
    {
        if (compression < 0)
            compression = T4_COMPRESSION_T4_1D;
        /* Receive end puts TIFF to a new file. We assume the receive width here. */
        if ((receive_state = t4_rx_init(NULL, OUT_FILE_NAME, T4_COMPRESSION_T4_2D)) == NULL)
        {
            printf("Failed to init T.4 rx\n");
            exit(2);
        }
        span_log_set_level(t4_rx_get_logging_state(receive_state), SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | SPAN_LOG_SHOW_TAG | SPAN_LOG_FLOW);
        t4_rx_set_rx_encoding(receive_state, compression);
        t4_rx_set_x_resolution(receive_state, T4_X_RESOLUTION_R8);
        //t4_rx_set_y_resolution(receive_state, T4_Y_RESOLUTION_FINE);
        t4_rx_set_y_resolution(receive_state, T4_Y_RESOLUTION_STANDARD);
        t4_rx_set_image_width(receive_state, XSIZE);

        t4_rx_start_page(receive_state);
        last_pkt_no = 0;
        file = fopen(decode_file_name, "r");
        while (fgets(buf, 1024, file))
        {
            if (sscanf(buf, "HDLC:  FCD: 06 %x", &pkt_no) == 1)
            {
                /* Useful for breaking up T.38 ECM logs */
                for (i = 0;  i < 256;  i++)
                {
                    if (sscanf(&buf[18 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit;
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (sscanf(buf, "HDLC:  %x", &pkt_no) == 1)
            {
                /* Useful for breaking up HDLC decodes of ECM logs */
                for (i = 0;  i < 256;  i++)
                {
                    if (sscanf(&buf[19 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit;
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (sscanf(buf, "%*d:%*d:%*d.%*d T.38 Rx %d: IFP %x %x", &pkt_no, (unsigned int *) &bit, (unsigned int *) &bit) == 3)
            {
                /* Useful for breaking up T.38 non-ECM logs */
                if (pkt_no != last_pkt_no + 1)
                    printf("Packet %u\n", pkt_no);
                last_pkt_no = pkt_no;
                for (i = 0;  i < 256;  i++)
                {
                    if (sscanf(&buf[47 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit_reverse8(bit);
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (strlen(buf) > 2  &&  sscanf(buf, "T.30 Rx:  %x %x %x %x", (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &pkt_no) == 4)
            {
                /* Useful for breaking up ECM logs */
                if (pkt_no != last_pkt_no + 1)
                    printf("Packet %u\n", pkt_no);
                last_pkt_no = pkt_no;
                for (i = 0;  i < 256;  i++)
                {
                    if (sscanf(&buf[22 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit_reverse8(bit);
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (sscanf(buf, "%04x  %02x %02x %02x", (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &bit) == 4)
            {
                for (i = 0;  i < 16;  i++)
                {
                    if (sscanf(&buf[6 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit_reverse8(bit);
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (sscanf(buf, "%08x  %02x %02x %02x", (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &bit, (unsigned int *) &bit) == 4)
            {
                for (i = 0;  i < 16;  i++)
                {
                    if (sscanf(&buf[10 + 3*i], "%x", (unsigned int *) &bit) != 1)
                        break;
                    block[i] = bit_reverse8(bit);
                }
                end_of_page = t4_rx_put(receive_state, block, i);
            }
            else if (sscanf(buf, "Rx bit %*d - %d", &bit) == 1)
            {
                if ((end_of_page = t4_rx_put_bit(receive_state, bit)))
                {
                    printf("End of page detected\n");
                    break;
                }
            }
        }
        fclose(file);
        if (dump_as_xxx)
            dump_image_as_xxx(receive_state);
        t4_rx_end_page(receive_state);
        display_page_stats(receive_state);
        t4_rx_free(receive_state);
    }
    else
    {
#if 1
        printf("Testing TIFF->compress->decompress->TIFF cycle\n");
        /* Send end gets TIFF from a file */
        if ((send_state = t4_tx_init(NULL, in_file_name, -1, -1)) == NULL)
        {
            printf("Failed to init T.4 send\n");
            exit(2);
        }
        span_log_set_level(t4_tx_get_logging_state(send_state), SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | SPAN_LOG_SHOW_TAG | SPAN_LOG_FLOW);
        t4_tx_set_min_bits_per_row(send_state, min_row_bits);
        t4_tx_set_local_ident(send_state, "111 2222 3333");

        /* Receive end puts TIFF to a new file. */
        if ((receive_state = t4_rx_init(NULL, OUT_FILE_NAME, T4_COMPRESSION_T4_2D)) == NULL)
        {
            printf("Failed to init T.4 rx for '%s'\n", OUT_FILE_NAME);
            exit(2);
        }
        span_log_set_level(t4_rx_get_logging_state(receive_state), SPAN_LOG_SHOW_SEVERITY | SPAN_LOG_SHOW_PROTOCOL | SPAN_LOG_SHOW_TAG | SPAN_LOG_FLOW);

        /* Now send and receive all the pages in the source TIFF file */
        sends = 0;
        /* If we are stepping around the compression schemes, reset to the start of the sequence. */
        if (compression_step > 0)
            compression_step = 0;
        for (;;)
        {
            end_marks = 0;
            /* Add a header line to alternate pages, if required */
            if (add_page_headers  &&  (sends & 2))
                t4_tx_set_header_info(send_state, "Header");
            else
                t4_tx_set_header_info(send_state, NULL);
            if (page_header_tz  &&  page_header_tz[0])
            {
                if (tz_init(&tz, page_header_tz))
                    t4_tx_set_header_tz(send_state, &tz);
            }
            t4_tx_set_header_overlays_image(send_state, overlay_page_headers);
            if (restart_pages  &&  (sends & 1))
            {
                /* Use restart, to send the page a second time */
                if (t4_tx_restart_page(send_state))
                    break;
            }
            else
            {
                if (compression_step >= 0)
                {
                    compression = compression_sequence[compression_step++];
                    if (compression < 0  ||  (block_size == 0  &&  compression_step >= 3))
                    {
                        compression_step = 0;
                        compression = compression_sequence[compression_step++];
                    }
                }
                if (t4_tx_set_tx_image_format(send_state,
                                              compression,
                                              T4_SUPPORT_WIDTH_215MM
                                            | T4_SUPPORT_LENGTH_US_LETTER
                                            | T4_SUPPORT_LENGTH_US_LEGAL
                                            | T4_SUPPORT_LENGTH_UNLIMITED,
                                              T4_RESOLUTION_R8_STANDARD
                                            | T4_RESOLUTION_R8_FINE
                                            | T4_RESOLUTION_R8_SUPERFINE
                                            | T4_RESOLUTION_R16_SUPERFINE
                                            | T4_RESOLUTION_200_100
                                            | T4_RESOLUTION_200_200
                                            | T4_RESOLUTION_200_400
                                            | T4_RESOLUTION_300_300
                                            | T4_RESOLUTION_300_600
                                            | T4_RESOLUTION_400_400
                                            | T4_RESOLUTION_400_800
                                            | T4_RESOLUTION_600_600
                                            | T4_RESOLUTION_600_1200
                                            | T4_RESOLUTION_1200_1200,
                                              T4_RESOLUTION_100_100
                                            | T4_RESOLUTION_200_200
                                            | T4_RESOLUTION_300_300
                                            | T4_RESOLUTION_400_400
                                            | T4_RESOLUTION_600_600
                                            | T4_RESOLUTION_1200_1200) < 0)
                {
                    break;
                }
                t4_rx_set_rx_encoding(receive_state, compression);

                if (t4_tx_start_page(send_state))
                    break;
                t4_rx_set_x_resolution(receive_state, t4_tx_get_tx_x_resolution(send_state));
                t4_rx_set_y_resolution(receive_state, t4_tx_get_tx_y_resolution(send_state));
                t4_rx_set_image_width(receive_state, t4_tx_get_tx_image_width(send_state));
            }
            t4_rx_start_page(receive_state);
            detect_non_ecm_page_end(-1, compression);
            page_ended = false;
            switch (block_size)
            {
            case 0:
                /* Bit by bit operation. This is only appropriate for T.4 1D and 2D,
                   which are used without ECM. */
                while ((bit = t4_tx_get_bit(send_state)) >= 0)
                {
                    /* Monitor whether the EOLs are there in the correct amount */
                    if ((res = detect_non_ecm_page_end(bit, page_ended)))
                    {
                        printf("Incorrect EOLs - %d\n", res);
                        tests_failed += (res - 1);
                        break;
                    }
                    if (bit_error_rate)
                    {
                        if ((rand() % bit_error_rate) == 0)
                            bit ^= 1;
                    }
                    end_of_page = t4_rx_put_bit(receive_state, bit);
                }
                while (end_of_page != T4_DECODE_OK)
                {
                    end_of_page = t4_rx_put_bit(receive_state, 0);
                    if (++end_marks > 50)
                    {
                        printf("Receiver missed the end of page mark\n");
                        tests_failed++;
                        break;
                    }
                }
                /* Now throw junk at the receive context, to ensure stuff occuring
                   after the end of page condition has no bad effect. */
                for (i = 0;  i < 1000;  i++)
                    t4_rx_put_bit(receive_state, (rand() >> 10) & 1);
                break;
            default:
                do
                {
                    len = t4_tx_get(send_state, block, block_size);
                    if (len > 0)
                        end_of_page = t4_rx_put(receive_state, block, len);
                }
                while (len > 0);
                /* Some decoders require a few extra bits before they recognise the end
                   of an image, so be prepared to offer it a few. */
                while (end_of_page != T4_DECODE_OK)
                {
                    block[0] = 0;
                    end_of_page = t4_rx_put(receive_state, block, 1);
                    if (++end_marks > 5)
                    {
                        printf("Receiver missed the end of page mark\n");
                        tests_failed++;
                        break;
                    }
                }
                break;
            }
            if (dump_as_xxx)
                dump_image_as_xxx(receive_state);
            display_page_stats(receive_state);
            if (!restart_pages  ||  (sends & 1))
                t4_tx_end_page(send_state);
            t4_rx_end_page(receive_state);
            sends++;
        }
        t4_tx_free(send_state);
        t4_rx_free(receive_state);
        /* And we should now have a matching received TIFF file. Note this will only match
           at the image level. TIFF files allow a lot of ways to express the same thing,
           so bit matching of the files is not the normal case. */
        fflush(stdout);
        sprintf(buf, "tiffcmp -t %s %s", in_file_name, OUT_FILE_NAME);
        if (tests_failed  ||  system(buf))
        {
            printf("Tests failed\n");
            exit(2);
        }
#endif
        printf("Tests passed\n");
    }
    return 0;
}
/*- End of function --------------------------------------------------------*/
/*- End of file ------------------------------------------------------------*/