tools_common.h

   1 /*
   2  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10 #ifndef VPX_TOOLS_COMMON_H_
  11 #define VPX_TOOLS_COMMON_H_
  12
  13 #include <stdio.h>
  14
  15 #include "./vpx_config.h"
  16 #include "vpx/vpx_codec.h"
  17 #include "vpx/vpx_image.h"
  18 #include "vpx/vpx_integer.h"
  19 #include "vpx_ports/msvc.h"
  20
  21 #if CONFIG_ENCODERS
  22 #include "./y4minput.h"
  23 #endif
  24
  25 #if defined(_MSC_VER)
  26 /* MSVS uses _f{seek,tell}i64. */
  27 #define fseeko _fseeki64
  28 #define ftello _ftelli64
  29 typedef int64_t FileOffset;
  30 #elif defined(_WIN32)
  31 /* MinGW uses f{seek,tell}o64 for large files. */
  32 #define fseeko fseeko64
  33 #define ftello ftello64
  34 typedef off64_t FileOffset;
  35 #elif CONFIG_OS_SUPPORT
  36 #include <sys/types.h> /* NOLINT */
  37 typedef off_t FileOffset;
  38 /* Use 32-bit file operations in WebM file format when building ARM
  39  * executables (.axf) with RVCT. */
  40 #else
  41 #define fseeko fseek
  42 #define ftello ftell
  43 typedef long FileOffset; /* NOLINT */
  44 #endif /* CONFIG_OS_SUPPORT */
  45
  46 #if CONFIG_OS_SUPPORT
  47 #if defined(_MSC_VER)
  48 #include <io.h> /* NOLINT */
  49 #define isatty _isatty
  50 #define fileno _fileno
  51 #else
  52 #include <unistd.h> /* NOLINT */
  53 #endif              /* _MSC_VER */
  54 #endif              /* CONFIG_OS_SUPPORT */
  55
  56 #define LITERALU64(hi, lo) ((((uint64_t)hi) << 32) | lo)
  57
  58 #ifndef PATH_MAX
  59 #define PATH_MAX 512
  60 #endif
  61
  62 #define IVF_FRAME_HDR_SZ (4 + 8) /* 4 byte size + 8 byte timestamp */
  63 #define IVF_FILE_HDR_SZ 32
  64
  65 #define RAW_FRAME_HDR_SZ sizeof(uint32_t)
  66
  67 #define VP8_FOURCC 0x30385056
  68 #define VP9_FOURCC 0x30395056
  69
  70 enum VideoFileType {
  71   FILE_TYPE_RAW,
  72   FILE_TYPE_IVF,
  73   FILE_TYPE_Y4M,
  74   FILE_TYPE_WEBM
  75 };
  76
  77 struct FileTypeDetectionBuffer {
  78   char buf[4];
  79   size_t buf_read;
  80   size_t position;
  81 };
  82
  83 struct VpxRational {
  84   int numerator;
  85   int denominator;
  86 };
  87
  88 struct VpxInputContext {
  89   const char *filename;
  90   FILE *file;
  91   int64_t length;
  92   struct FileTypeDetectionBuffer detect;
  93   enum VideoFileType file_type;
  94   uint32_t width;
  95   uint32_t height;
  96   struct VpxRational pixel_aspect_ratio;
  97   vpx_img_fmt_t fmt;
  98   vpx_bit_depth_t bit_depth;
  99   int only_i420;
 100   uint32_t fourcc;
 101   struct VpxRational framerate;
 102 #if CONFIG_ENCODERS
 103   y4m_input y4m;
 104 #endif
 105 };
 106
 107 #ifdef __cplusplus
 108 extern "C" {
 109 #endif
 110
 111 #if defined(__GNUC__)
 112 #define VPX_NO_RETURN __attribute__((noreturn))
 113 #elif defined(_MSC_VER)
 114 #define VPX_NO_RETURN __declspec(noreturn)
 115 #else
 116 #define VPX_NO_RETURN
 117 #endif
 118
 119 // Tells the compiler to perform `printf` format string checking if the
 120 // compiler supports it; see the 'format' attribute in
 121 // <https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html>.
 122 #define VPX_TOOLS_FORMAT_PRINTF(string_index, first_to_check)
 123 #if defined(__has_attribute)
 124 #if __has_attribute(format)
 125 #undef VPX_TOOLS_FORMAT_PRINTF
 126 #define VPX_TOOLS_FORMAT_PRINTF(string_index, first_to_check) \
 127   __attribute__((__format__(__printf__, string_index, first_to_check)))
 128 #endif
 129 #endif
 130
 131 /* Sets a stdio stream into binary mode */
 132 FILE *set_binary_mode(FILE *stream);
 133
 134 VPX_NO_RETURN void die(const char *fmt, ...) VPX_TOOLS_FORMAT_PRINTF(1, 2);
 135 VPX_NO_RETURN void fatal(const char *fmt, ...) VPX_TOOLS_FORMAT_PRINTF(1, 2);
 136 void warn(const char *fmt, ...) VPX_TOOLS_FORMAT_PRINTF(1, 2);
 137
 138 VPX_NO_RETURN void die_codec(vpx_codec_ctx_t *ctx, const char *s);
 139
 140 /* The tool including this file must define usage_exit() */
 141 VPX_NO_RETURN void usage_exit(void);
 142
 143 #undef VPX_NO_RETURN
 144
 145 int read_yuv_frame(struct VpxInputContext *input_ctx, vpx_image_t *yuv_frame);
 146
 147 typedef struct VpxInterface {
 148   const char *const name;
 149   const uint32_t fourcc;
 150   vpx_codec_iface_t *(*const codec_interface)();
 151 } VpxInterface;
 152
 153 int get_vpx_encoder_count(void);
 154 const VpxInterface *get_vpx_encoder_by_index(int i);
 155 const VpxInterface *get_vpx_encoder_by_name(const char *name);
 156
 157 int get_vpx_decoder_count(void);
 158 const VpxInterface *get_vpx_decoder_by_index(int i);
 159 const VpxInterface *get_vpx_decoder_by_name(const char *name);
 160 const VpxInterface *get_vpx_decoder_by_fourcc(uint32_t fourcc);
 161
 162 int vpx_img_plane_width(const vpx_image_t *img, int plane);
 163 int vpx_img_plane_height(const vpx_image_t *img, int plane);
 164 void vpx_img_write(const vpx_image_t *img, FILE *file);
 165 int vpx_img_read(vpx_image_t *img, FILE *file);
 166
 167 double sse_to_psnr(double samples, double peak, double mse);
 168
 169 #if CONFIG_ENCODERS
 170 int read_frame(struct VpxInputContext *input_ctx, vpx_image_t *img);
 171 int file_is_y4m(const char detect[4]);
 172 int fourcc_is_ivf(const char detect[4]);
 173 void open_input_file(struct VpxInputContext *input);
 174 void close_input_file(struct VpxInputContext *input);
 175 #endif
 176
 177 #if CONFIG_VP9_HIGHBITDEPTH
 178 void vpx_img_upshift(vpx_image_t *dst, vpx_image_t *src, int input_shift);
 179 void vpx_img_downshift(vpx_image_t *dst, vpx_image_t *src, int down_shift);
 180 void vpx_img_truncate_16_to_8(vpx_image_t *dst, vpx_image_t *src);
 181 #endif
 182
 183 int compare_img(const vpx_image_t *const img1, const vpx_image_t *const img2);
 184 #if CONFIG_VP9_HIGHBITDEPTH
 185 void find_mismatch_high(const vpx_image_t *const img1,
 186                         const vpx_image_t *const img2, int yloc[4], int uloc[4],
 187                         int vloc[4]);
 188 #endif
 189 void find_mismatch(const vpx_image_t *const img1, const vpx_image_t *const img2,
 190                    int yloc[4], int uloc[4], int vloc[4]);
 191
 192 #ifdef __cplusplus
 193 } /* extern "C" */
 194 #endif
 195
 196 #endif  // VPX_TOOLS_COMMON_H_