avconv: only retry decoding on actual decoding errors
[ffmpeg.git] / tests / checkasm / checkasm.c
1 /*
2  * Assembly testing and benchmarking tool
3  * Copyright (c) 2015 Henrik Gramner
4  * Copyright (c) 2008 Loren Merritt
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with Libav; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include "checkasm.h"
28 #include "libavutil/common.h"
29 #include "libavutil/cpu.h"
30 #include "libavutil/intfloat.h"
31 #include "libavutil/random_seed.h"
32
33 #if HAVE_IO_H
34 #include <io.h>
35 #endif
36
37 #if HAVE_SETCONSOLETEXTATTRIBUTE
38 #include <windows.h>
39 #define COLOR_RED    FOREGROUND_RED
40 #define COLOR_GREEN  FOREGROUND_GREEN
41 #define COLOR_YELLOW (FOREGROUND_RED|FOREGROUND_GREEN)
42 #else
43 #define COLOR_RED    1
44 #define COLOR_GREEN  2
45 #define COLOR_YELLOW 3
46 #endif
47
48 #if HAVE_UNISTD_H
49 #include <unistd.h>
50 #endif
51
52 #if !HAVE_ISATTY
53 #define isatty(fd) 1
54 #endif
55
56 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
57 #include "libavutil/arm/cpu.h"
58
59 void (*checkasm_checked_call)(void *func, int dummy, ...) = checkasm_checked_call_novfp;
60 #endif
61
62 /* List of tests to invoke */
63 static const struct {
64     const char *name;
65     void (*func)(void);
66 } tests[] = {
67 #if CONFIG_AUDIODSP
68     { "audiodsp", checkasm_check_audiodsp },
69 #endif
70 #if CONFIG_BLOCKDSP
71     { "blockdsp", checkasm_check_blockdsp },
72 #endif
73 #if CONFIG_BSWAPDSP
74     { "bswapdsp", checkasm_check_bswapdsp },
75 #endif
76 #if CONFIG_DCA_DECODER
77     { "dcadsp", checkasm_check_dcadsp },
78     { "synth_filter", checkasm_check_synth_filter },
79 #endif
80 #if CONFIG_FMTCONVERT
81     { "fmtconvert", checkasm_check_fmtconvert },
82 #endif
83 #if CONFIG_H264DSP
84     { "h264dsp", checkasm_check_h264dsp },
85 #endif
86 #if CONFIG_H264PRED
87     { "h264pred", checkasm_check_h264pred },
88 #endif
89 #if CONFIG_H264QPEL
90     { "h264qpel", checkasm_check_h264qpel },
91 #endif
92 #if CONFIG_HEVC_DECODER
93     { "hevc_mc", checkasm_check_hevc_mc },
94     { "hevc_idct", checkasm_check_hevc_idct },
95 #endif
96 #if CONFIG_V210_ENCODER
97     { "v210enc", checkasm_check_v210enc },
98 #endif
99 #if CONFIG_VP8DSP
100     { "vp8dsp", checkasm_check_vp8dsp },
101 #endif
102 #if CONFIG_VP9_DECODER
103     { "vp9dsp", checkasm_check_vp9dsp },
104 #endif
105     { NULL }
106 };
107
108 /* List of cpu flags to check */
109 static const struct {
110     const char *name;
111     const char *suffix;
112     int flag;
113 } cpus[] = {
114 #if   ARCH_AARCH64
115     { "ARMV8",    "armv8",    AV_CPU_FLAG_ARMV8 },
116     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
117 #elif ARCH_ARM
118     { "ARMV5TE",  "armv5te",  AV_CPU_FLAG_ARMV5TE },
119     { "ARMV6",    "armv6",    AV_CPU_FLAG_ARMV6 },
120     { "ARMV6T2",  "armv6t2",  AV_CPU_FLAG_ARMV6T2 },
121     { "VFP",      "vfp",      AV_CPU_FLAG_VFP },
122     { "VFP_VM",   "vfp_vm",   AV_CPU_FLAG_VFP_VM },
123     { "VFPV3",    "vfp3",     AV_CPU_FLAG_VFPV3 },
124     { "NEON",     "neon",     AV_CPU_FLAG_NEON },
125 #elif ARCH_PPC
126     { "ALTIVEC",  "altivec",  AV_CPU_FLAG_ALTIVEC },
127     { "VSX",      "vsx",      AV_CPU_FLAG_VSX },
128     { "POWER8",   "power8",   AV_CPU_FLAG_POWER8 },
129 #elif ARCH_X86
130     { "MMX",      "mmx",      AV_CPU_FLAG_MMX|AV_CPU_FLAG_CMOV },
131     { "MMXEXT",   "mmxext",   AV_CPU_FLAG_MMXEXT },
132     { "3DNOW",    "3dnow",    AV_CPU_FLAG_3DNOW },
133     { "3DNOWEXT", "3dnowext", AV_CPU_FLAG_3DNOWEXT },
134     { "SSE",      "sse",      AV_CPU_FLAG_SSE },
135     { "SSE2",     "sse2",     AV_CPU_FLAG_SSE2|AV_CPU_FLAG_SSE2SLOW },
136     { "SSE3",     "sse3",     AV_CPU_FLAG_SSE3|AV_CPU_FLAG_SSE3SLOW },
137     { "SSSE3",    "ssse3",    AV_CPU_FLAG_SSSE3|AV_CPU_FLAG_ATOM },
138     { "SSE4.1",   "sse4",     AV_CPU_FLAG_SSE4 },
139     { "SSE4.2",   "sse42",    AV_CPU_FLAG_SSE42 },
140     { "AVX",      "avx",      AV_CPU_FLAG_AVX },
141     { "XOP",      "xop",      AV_CPU_FLAG_XOP },
142     { "FMA3",     "fma3",     AV_CPU_FLAG_FMA3 },
143     { "FMA4",     "fma4",     AV_CPU_FLAG_FMA4 },
144     { "AVX2",     "avx2",     AV_CPU_FLAG_AVX2 },
145 #endif
146     { NULL }
147 };
148
149 typedef struct CheckasmFuncVersion {
150     struct CheckasmFuncVersion *next;
151     void *func;
152     int ok;
153     int cpu;
154     int iterations;
155     uint64_t cycles;
156 } CheckasmFuncVersion;
157
158 /* Binary search tree node */
159 typedef struct CheckasmFunc {
160     struct CheckasmFunc *child[2];
161     CheckasmFuncVersion versions;
162     uint8_t color; /* 0 = red, 1 = black */
163     char name[1];
164 } CheckasmFunc;
165
166 /* Internal state */
167 static struct {
168     CheckasmFunc *funcs;
169     CheckasmFunc *current_func;
170     CheckasmFuncVersion *current_func_ver;
171     const char *current_test_name;
172     const char *bench_pattern;
173     int bench_pattern_len;
174     int num_checked;
175     int num_failed;
176     int nop_time;
177     int cpu_flag;
178     const char *cpu_flag_name;
179 } state;
180
181 /* PRNG state */
182 AVLFG checkasm_lfg;
183
184 /* float compare support code */
185 static int is_negative(union av_intfloat32 u)
186 {
187     return u.i >> 31;
188 }
189
190 int float_near_ulp(float a, float b, unsigned max_ulp)
191 {
192     union av_intfloat32 x, y;
193
194     x.f = a;
195     y.f = b;
196
197     if (is_negative(x) != is_negative(y)) {
198         // handle -0.0 == +0.0
199         return a == b;
200     }
201
202     if (llabs((int64_t)x.i - y.i) <= max_ulp)
203         return 1;
204
205     return 0;
206 }
207
208 int float_near_ulp_array(const float *a, const float *b, unsigned max_ulp,
209                          unsigned len)
210 {
211     unsigned i;
212
213     for (i = 0; i < len; i++) {
214         if (!float_near_ulp(a[i], b[i], max_ulp))
215             return 0;
216     }
217     return 1;
218 }
219
220 int float_near_abs_eps(float a, float b, float eps)
221 {
222     float abs_diff = fabsf(a - b);
223
224     return abs_diff < eps;
225 }
226
227 int float_near_abs_eps_array(const float *a, const float *b, float eps,
228                          unsigned len)
229 {
230     unsigned i;
231
232     for (i = 0; i < len; i++) {
233         if (!float_near_abs_eps(a[i], b[i], eps))
234             return 0;
235     }
236     return 1;
237 }
238
239 int float_near_abs_eps_ulp(float a, float b, float eps, unsigned max_ulp)
240 {
241     return float_near_ulp(a, b, max_ulp) || float_near_abs_eps(a, b, eps);
242 }
243
244 int float_near_abs_eps_array_ulp(const float *a, const float *b, float eps,
245                          unsigned max_ulp, unsigned len)
246 {
247     unsigned i;
248
249     for (i = 0; i < len; i++) {
250         if (!float_near_abs_eps_ulp(a[i], b[i], eps, max_ulp))
251             return 0;
252     }
253     return 1;
254 }
255
256 /* Print colored text to stderr if the terminal supports it */
257 static void color_printf(int color, const char *fmt, ...)
258 {
259     static int use_color = -1;
260     va_list arg;
261
262 #if HAVE_SETCONSOLETEXTATTRIBUTE
263     static HANDLE con;
264     static WORD org_attributes;
265
266     if (use_color < 0) {
267         CONSOLE_SCREEN_BUFFER_INFO con_info;
268         con = GetStdHandle(STD_ERROR_HANDLE);
269         if (con && con != INVALID_HANDLE_VALUE && GetConsoleScreenBufferInfo(con, &con_info)) {
270             org_attributes = con_info.wAttributes;
271             use_color = 1;
272         } else
273             use_color = 0;
274     }
275     if (use_color)
276         SetConsoleTextAttribute(con, (org_attributes & 0xfff0) | (color & 0x0f));
277 #else
278     if (use_color < 0) {
279         const char *term = getenv("TERM");
280         use_color = term && strcmp(term, "dumb") && isatty(2);
281     }
282     if (use_color)
283         fprintf(stderr, "\x1b[%d;3%dm", (color & 0x08) >> 3, color & 0x07);
284 #endif
285
286     va_start(arg, fmt);
287     vfprintf(stderr, fmt, arg);
288     va_end(arg);
289
290     if (use_color) {
291 #if HAVE_SETCONSOLETEXTATTRIBUTE
292         SetConsoleTextAttribute(con, org_attributes);
293 #else
294         fprintf(stderr, "\x1b[0m");
295 #endif
296     }
297 }
298
299 /* Deallocate a tree */
300 static void destroy_func_tree(CheckasmFunc *f)
301 {
302     if (f) {
303         CheckasmFuncVersion *v = f->versions.next;
304         while (v) {
305             CheckasmFuncVersion *next = v->next;
306             free(v);
307             v = next;
308         }
309
310         destroy_func_tree(f->child[0]);
311         destroy_func_tree(f->child[1]);
312         free(f);
313     }
314 }
315
316 /* Allocate a zero-initialized block, clean up and exit on failure */
317 static void *checkasm_malloc(size_t size)
318 {
319     void *ptr = calloc(1, size);
320     if (!ptr) {
321         fprintf(stderr, "checkasm: malloc failed\n");
322         destroy_func_tree(state.funcs);
323         exit(1);
324     }
325     return ptr;
326 }
327
328 /* Get the suffix of the specified cpu flag */
329 static const char *cpu_suffix(int cpu)
330 {
331     int i = FF_ARRAY_ELEMS(cpus);
332
333     while (--i >= 0)
334         if (cpu & cpus[i].flag)
335             return cpus[i].suffix;
336
337     return "c";
338 }
339
340 #ifdef AV_READ_TIME
341 static int cmp_nop(const void *a, const void *b)
342 {
343     return *(const uint16_t*)a - *(const uint16_t*)b;
344 }
345
346 /* Measure the overhead of the timing code (in decicycles) */
347 static int measure_nop_time(void)
348 {
349     uint16_t nops[10000];
350     int i, nop_sum = 0;
351
352     for (i = 0; i < 10000; i++) {
353         uint64_t t = AV_READ_TIME();
354         nops[i] = AV_READ_TIME() - t;
355     }
356
357     qsort(nops, 10000, sizeof(uint16_t), cmp_nop);
358     for (i = 2500; i < 7500; i++)
359         nop_sum += nops[i];
360
361     return nop_sum / 500;
362 }
363
364 /* Print benchmark results */
365 static void print_benchs(CheckasmFunc *f)
366 {
367     if (f) {
368         print_benchs(f->child[0]);
369
370         /* Only print functions with at least one assembly version */
371         if (f->versions.cpu || f->versions.next) {
372             CheckasmFuncVersion *v = &f->versions;
373             do {
374                 if (v->iterations) {
375                     int decicycles = (10*v->cycles/v->iterations - state.nop_time) / 4;
376                     printf("%s_%s: %d.%d\n", f->name, cpu_suffix(v->cpu), decicycles/10, decicycles%10);
377                 }
378             } while ((v = v->next));
379         }
380
381         print_benchs(f->child[1]);
382     }
383 }
384 #endif
385
386 /* ASCIIbetical sort except preserving natural order for numbers */
387 static int cmp_func_names(const char *a, const char *b)
388 {
389     const char *start = a;
390     int ascii_diff, digit_diff;
391
392     for (; !(ascii_diff = *(const unsigned char*)a - *(const unsigned char*)b) && *a; a++, b++);
393     for (; av_isdigit(*a) && av_isdigit(*b); a++, b++);
394
395     if (a > start && av_isdigit(a[-1]) && (digit_diff = av_isdigit(*a) - av_isdigit(*b)))
396         return digit_diff;
397
398     return ascii_diff;
399 }
400
401 /* Perform a tree rotation in the specified direction and return the new root */
402 static CheckasmFunc *rotate_tree(CheckasmFunc *f, int dir)
403 {
404     CheckasmFunc *r = f->child[dir^1];
405     f->child[dir^1] = r->child[dir];
406     r->child[dir] = f;
407     r->color = f->color;
408     f->color = 0;
409     return r;
410 }
411
412 #define is_red(f) ((f) && !(f)->color)
413
414 /* Balance a left-leaning red-black tree at the specified node */
415 static void balance_tree(CheckasmFunc **root)
416 {
417     CheckasmFunc *f = *root;
418
419     if (is_red(f->child[0]) && is_red(f->child[1])) {
420         f->color ^= 1;
421         f->child[0]->color = f->child[1]->color = 1;
422     }
423
424     if (!is_red(f->child[0]) && is_red(f->child[1]))
425         *root = rotate_tree(f, 0); /* Rotate left */
426     else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
427         *root = rotate_tree(f, 1); /* Rotate right */
428 }
429
430 /* Get a node with the specified name, creating it if it doesn't exist */
431 static CheckasmFunc *get_func(CheckasmFunc **root, const char *name)
432 {
433     CheckasmFunc *f = *root;
434
435     if (f) {
436         /* Search the tree for a matching node */
437         int cmp = cmp_func_names(name, f->name);
438         if (cmp) {
439             f = get_func(&f->child[cmp > 0], name);
440
441             /* Rebalance the tree on the way up if a new node was inserted */
442             if (!f->versions.func)
443                 balance_tree(root);
444         }
445     } else {
446         /* Allocate and insert a new node into the tree */
447         int name_length = strlen(name);
448         f = *root = checkasm_malloc(sizeof(CheckasmFunc) + name_length);
449         memcpy(f->name, name, name_length + 1);
450     }
451
452     return f;
453 }
454
455 /* Perform tests and benchmarks for the specified cpu flag if supported by the host */
456 static void check_cpu_flag(const char *name, int flag)
457 {
458     int old_cpu_flag = state.cpu_flag;
459
460     flag |= old_cpu_flag;
461     av_set_cpu_flags_mask(flag);
462     state.cpu_flag = av_get_cpu_flags();
463
464     if (!flag || state.cpu_flag != old_cpu_flag) {
465         int i;
466
467         state.cpu_flag_name = name;
468         for (i = 0; tests[i].func; i++) {
469             state.current_test_name = tests[i].name;
470             tests[i].func();
471         }
472     }
473 }
474
475 /* Print the name of the current CPU flag, but only do it once */
476 static void print_cpu_name(void)
477 {
478     if (state.cpu_flag_name) {
479         color_printf(COLOR_YELLOW, "%s:\n", state.cpu_flag_name);
480         state.cpu_flag_name = NULL;
481     }
482 }
483
484 int main(int argc, char *argv[])
485 {
486     unsigned int seed;
487     int i, ret = 0;
488
489 #if ARCH_ARM && HAVE_ARMV5TE_EXTERNAL
490     if (have_vfp(av_get_cpu_flags()) || have_neon(av_get_cpu_flags()))
491         checkasm_checked_call = checkasm_checked_call_vfp;
492 #endif
493
494     if (!tests[0].func || !cpus[0].flag) {
495         fprintf(stderr, "checkasm: no tests to perform\n");
496         return 0;
497     }
498
499     if (argc > 1 && !strncmp(argv[1], "--bench", 7)) {
500 #ifndef AV_READ_TIME
501         fprintf(stderr, "checkasm: --bench is not supported on your system\n");
502         return 1;
503 #endif
504         if (argv[1][7] == '=') {
505             state.bench_pattern = argv[1] + 8;
506             state.bench_pattern_len = strlen(state.bench_pattern);
507         } else
508             state.bench_pattern = "";
509
510         argc--;
511         argv++;
512     }
513
514     seed = (argc > 1) ? strtoul(argv[1], NULL, 10) : av_get_random_seed();
515     fprintf(stderr, "checkasm: using random seed %u\n", seed);
516     av_lfg_init(&checkasm_lfg, seed);
517
518     check_cpu_flag(NULL, 0);
519     for (i = 0; cpus[i].flag; i++)
520         check_cpu_flag(cpus[i].name, cpus[i].flag);
521
522     if (state.num_failed) {
523         fprintf(stderr, "checkasm: %d of %d tests have failed\n", state.num_failed, state.num_checked);
524         ret = 1;
525     } else {
526         fprintf(stderr, "checkasm: all %d tests passed\n", state.num_checked);
527 #ifdef AV_READ_TIME
528         if (state.bench_pattern) {
529             state.nop_time = measure_nop_time();
530             printf("nop: %d.%d\n", state.nop_time/10, state.nop_time%10);
531             print_benchs(state.funcs);
532         }
533 #endif
534     }
535
536     destroy_func_tree(state.funcs);
537     return ret;
538 }
539
540 /* Decide whether or not the specified function needs to be tested and
541  * allocate/initialize data structures if needed. Returns a pointer to a
542  * reference function if the function should be tested, otherwise NULL */
543 void *checkasm_check_func(void *func, const char *name, ...)
544 {
545     char name_buf[256];
546     void *ref = func;
547     CheckasmFuncVersion *v;
548     int name_length;
549     va_list arg;
550
551     va_start(arg, name);
552     name_length = vsnprintf(name_buf, sizeof(name_buf), name, arg);
553     va_end(arg);
554
555     if (!func || name_length <= 0 || name_length >= sizeof(name_buf))
556         return NULL;
557
558     state.current_func = get_func(&state.funcs, name_buf);
559     state.funcs->color = 1;
560     v = &state.current_func->versions;
561
562     if (v->func) {
563         CheckasmFuncVersion *prev;
564         do {
565             /* Only test functions that haven't already been tested */
566             if (v->func == func)
567                 return NULL;
568
569             if (v->ok)
570                 ref = v->func;
571
572             prev = v;
573         } while ((v = v->next));
574
575         v = prev->next = checkasm_malloc(sizeof(CheckasmFuncVersion));
576     }
577
578     v->func = func;
579     v->ok = 1;
580     v->cpu = state.cpu_flag;
581     state.current_func_ver = v;
582
583     if (state.cpu_flag)
584         state.num_checked++;
585
586     return ref;
587 }
588
589 /* Decide whether or not the current function needs to be benchmarked */
590 int checkasm_bench_func(void)
591 {
592     return !state.num_failed && state.bench_pattern &&
593            !strncmp(state.current_func->name, state.bench_pattern, state.bench_pattern_len);
594 }
595
596 /* Indicate that the current test has failed */
597 void checkasm_fail_func(const char *msg, ...)
598 {
599     if (state.current_func_ver->cpu && state.current_func_ver->ok) {
600         va_list arg;
601
602         print_cpu_name();
603         fprintf(stderr, "   %s_%s (", state.current_func->name, cpu_suffix(state.current_func_ver->cpu));
604         va_start(arg, msg);
605         vfprintf(stderr, msg, arg);
606         va_end(arg);
607         fprintf(stderr, ")\n");
608
609         state.current_func_ver->ok = 0;
610         state.num_failed++;
611     }
612 }
613
614 /* Update benchmark results of the current function */
615 void checkasm_update_bench(int iterations, uint64_t cycles)
616 {
617     state.current_func_ver->iterations += iterations;
618     state.current_func_ver->cycles += cycles;
619 }
620
621 /* Print the outcome of all tests performed since the last time this function was called */
622 void checkasm_report(const char *name, ...)
623 {
624     static int prev_checked, prev_failed, max_length;
625
626     if (state.num_checked > prev_checked) {
627         int pad_length = max_length + 4;
628         va_list arg;
629
630         print_cpu_name();
631         pad_length -= fprintf(stderr, " - %s.", state.current_test_name);
632         va_start(arg, name);
633         pad_length -= vfprintf(stderr, name, arg);
634         va_end(arg);
635         fprintf(stderr, "%*c", FFMAX(pad_length, 0) + 2, '[');
636
637         if (state.num_failed == prev_failed)
638             color_printf(COLOR_GREEN, "OK");
639         else
640             color_printf(COLOR_RED, "FAILED");
641         fprintf(stderr, "]\n");
642
643         prev_checked = state.num_checked;
644         prev_failed  = state.num_failed;
645     } else if (!state.cpu_flag) {
646         /* Calculate the amount of padding required to make the output vertically aligned */
647         int length = strlen(state.current_test_name);
648         va_list arg;
649
650         va_start(arg, name);
651         length += vsnprintf(NULL, 0, name, arg);
652         va_end(arg);
653
654         if (length > max_length)
655             max_length = length;
656     }
657 }