tests/utils.h

   1 /*
   2 ** Copyright (C) 2002-2009 Erik de Castro Lopo <erikd@mega-nerd.com>
   3 **
   4 ** This program is free software; you can redistribute it and/or modify
   5 ** it under the terms of the GNU General Public License as published by
   6 ** the Free Software Foundation; either version 2 of the License, or
   7 ** (at your option) any later version.
   8 **
   9 ** This program is distributed in the hope that it will be useful,
  10 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 ** GNU General Public License for more details.
  13 **
  14 ** You should have received a copy of the GNU General Public License
  15 ** along with this program; if not, write to the Free Software
  16 ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17 */
  18
  19 /*
  20 **      Utility functions to make writing the test suite easier.
  21 **
  22 **      The .c and .h files were generated automagically with Autogen from
  23 **      the files utils.def and utils.tpl.
  24 */
  25
  26
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif  /* __cplusplus */
  31
  32 #include <stdint.h>
  33 #include <stdarg.h>
  34
  35 #define SF_COUNT_TO_LONG(x)     ((long) (x))
  36 #define ARRAY_LEN(x)            ((int) (sizeof (x)) / (sizeof ((x) [0])))
  37 #define SIGNED_SIZEOF(x)        ((int64_t) (sizeof (x)))
  38
  39 #define PIPE_INDEX(x)   ((x) + 500)
  40 #define PIPE_TEST_LEN   12345
  41
  42 void gen_windowed_sine_float (float *data, int len, double maximum) ;
  43 void gen_windowed_sine_double (double *data, int len, double maximum) ;
  44
  45
  46 void    create_short_sndfile (const char *filename, int format, int channels) ;
  47
  48 void    check_file_hash_or_die  (const char *filename, uint64_t target_hash, int line_num) ;
  49
  50 void    print_test_name (const char *test, const char *filename) ;
  51
  52 void    dump_data_to_file (const char *filename, const void *data, unsigned int datalen) ;
  53
  54 void    write_mono_file (const char * filename, int format, int srate, float * output, int len) ;
  55
  56 static inline void
  57 exit_if_true (int test, const char *format, ...)
  58 {       if (test)
  59         {       va_list argptr ;
  60                 va_start (argptr, format) ;
  61                 vprintf (format, argptr) ;
  62                 va_end (argptr) ;
  63                 exit (1) ;
  64                 } ;
  65 } /* exit_if_true */
  66
  67 /*
  68 **      Functions for saving two vectors of data in an ascii text file which
  69 **      can then be loaded into GNU octave for comparison.
  70 */
  71
  72 int     oct_save_short  (const short *a, const short *b, int len) ;
  73 int     oct_save_int    (const int *a, const int *b, int len) ;
  74 int     oct_save_float  (const float *a, const float *b, int len) ;
  75 int     oct_save_double (const double *a, const double *b, int len) ;
  76
  77
  78 void    delete_file (int format, const char *filename) ;
  79
  80 void    count_open_files (void) ;
  81 void    increment_open_file_count (void) ;
  82 void    check_open_file_count_or_die (int lineno) ;
  83
  84 #ifdef SNDFILE_H
  85
  86 void    dump_log_buffer (SNDFILE *file) ;
  87 void    check_log_buffer_or_die (SNDFILE *file, int line_num) ;
  88 int     string_in_log_buffer (SNDFILE *file, const char *s) ;
  89 void    hexdump_file (const char * filename, sf_count_t offset, sf_count_t length) ;
  90
  91
  92 SNDFILE *test_open_file_or_die
  93                         (const char *filename, int mode, SF_INFO *sfinfo, int allow_fd, int line_num) ;
  94
  95 void    test_read_write_position_or_die
  96                         (SNDFILE *file, int line_num, int pass, sf_count_t read_pos, sf_count_t write_pos) ;
  97
  98 void    test_seek_or_die
  99                         (SNDFILE *file, sf_count_t offset, int whence, sf_count_t new_pos, int channels, int line_num) ;
 100
 101
 102 void    test_read_short_or_die
 103                         (SNDFILE *file, int pass, short *test, sf_count_t items, int line_num) ;
 104 void    test_read_int_or_die
 105                         (SNDFILE *file, int pass, int *test, sf_count_t items, int line_num) ;
 106 void    test_read_float_or_die
 107                         (SNDFILE *file, int pass, float *test, sf_count_t items, int line_num) ;
 108 void    test_read_double_or_die
 109                         (SNDFILE *file, int pass, double *test, sf_count_t items, int line_num) ;
 110
 111 void    test_readf_short_or_die
 112                         (SNDFILE *file, int pass, short *test, sf_count_t frames, int line_num) ;
 113 void    test_readf_int_or_die
 114                         (SNDFILE *file, int pass, int *test, sf_count_t frames, int line_num) ;
 115 void    test_readf_float_or_die
 116                         (SNDFILE *file, int pass, float *test, sf_count_t frames, int line_num) ;
 117 void    test_readf_double_or_die
 118                         (SNDFILE *file, int pass, double *test, sf_count_t frames, int line_num) ;
 119
 120
 121
 122 void    test_write_short_or_die
 123                         (SNDFILE *file, int pass, const short *test, sf_count_t items, int line_num) ;
 124 void    test_write_int_or_die
 125                         (SNDFILE *file, int pass, const int *test, sf_count_t items, int line_num) ;
 126 void    test_write_float_or_die
 127                         (SNDFILE *file, int pass, const float *test, sf_count_t items, int line_num) ;
 128 void    test_write_double_or_die
 129                         (SNDFILE *file, int pass, const double *test, sf_count_t items, int line_num) ;
 130
 131 void    test_writef_short_or_die
 132                         (SNDFILE *file, int pass, const short *test, sf_count_t frames, int line_num) ;
 133 void    test_writef_int_or_die
 134                         (SNDFILE *file, int pass, const int *test, sf_count_t frames, int line_num) ;
 135 void    test_writef_float_or_die
 136                         (SNDFILE *file, int pass, const float *test, sf_count_t frames, int line_num) ;
 137 void    test_writef_double_or_die
 138                         (SNDFILE *file, int pass, const double *test, sf_count_t frames, int line_num) ;
 139
 140
 141 void compare_short_or_die (const short *left, const short *right, unsigned count, int line_num) ;
 142 void compare_int_or_die (const int *left, const int *right, unsigned count, int line_num) ;
 143 void compare_float_or_die (const float *left, const float *right, unsigned count, int line_num) ;
 144 void compare_double_or_die (const double *left, const double *right, unsigned count, int line_num) ;
 145
 146
 147
 148 void    gen_lowpass_noise_float (float *data, int len) ;
 149
 150 sf_count_t              file_length (const char * fname) ;
 151 sf_count_t              file_length_fd (int fd) ;
 152
 153 #endif
 154
 155 #ifdef __cplusplus
 156 }               /* extern "C" */
 157 #endif  /* __cplusplus */
 158
 159
 160