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 TOOLS_COMMON_H_
  11 #define 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
  20 #if CONFIG_ENCODERS
  21 #include "./y4minput.h"
  22 #endif
  23
  24 #if defined(_MSC_VER)
  25 /* MSVS uses _f{seek,tell}i64. */
  26 #define fseeko _fseeki64
  27 #define ftello _ftelli64
  28 #elif defined(_WIN32)
  29 /* MinGW uses f{seek,tell}o64 for large files. */
  30 #define fseeko fseeko64
  31 #define ftello ftello64
  32 #endif  /* _WIN32 */
  33
  34 #if CONFIG_OS_SUPPORT
  35 #if defined(_MSC_VER)
  36 #include <io.h>  /* NOLINT */
  37 #define snprintf _snprintf
  38 #define isatty   _isatty
  39 #define fileno   _fileno
  40 #else
  41 #include <unistd.h>  /* NOLINT */
  42 #endif  /* _MSC_VER */
  43 #endif  /* CONFIG_OS_SUPPORT */
  44
  45 /* Use 32-bit file operations in WebM file format when building ARM
  46  * executables (.axf) with RVCT. */
  47 #if !CONFIG_OS_SUPPORT
  48 #define fseeko fseek
  49 #define ftello ftell
  50 #endif  /* CONFIG_OS_SUPPORT */
  51
  52 #define LITERALU64(hi, lo) ((((uint64_t)hi) << 32) | lo)
  53
  54 #ifndef PATH_MAX
  55 #define PATH_MAX 512
  56 #endif
  57
  58 #define IVF_FRAME_HDR_SZ (4 + 8)  /* 4 byte size + 8 byte timestamp */
  59 #define IVF_FILE_HDR_SZ 32
  60
  61 #define RAW_FRAME_HDR_SZ sizeof(uint32_t)
  62
  63 #define VP8_FOURCC 0x30385056
  64 #define VP9_FOURCC 0x30395056
  65
  66 enum VideoFileType {
  67   FILE_TYPE_RAW,
  68   FILE_TYPE_IVF,
  69   FILE_TYPE_Y4M,
  70   FILE_TYPE_WEBM
  71 };
  72
  73 struct FileTypeDetectionBuffer {
  74   char buf[4];
  75   size_t buf_read;
  76   size_t position;
  77 };
  78
  79 struct VpxRational {
  80   int numerator;
  81   int denominator;
  82 };
  83
  84 struct VpxInputContext {
  85   const char *filename;
  86   FILE *file;
  87   int64_t length;
  88   struct FileTypeDetectionBuffer detect;
  89   enum VideoFileType file_type;
  90   uint32_t width;
  91   uint32_t height;
  92   vpx_img_fmt_t fmt;
  93   vpx_bit_depth_t bit_depth;
  94   int only_i420;
  95   uint32_t fourcc;
  96   struct VpxRational framerate;
  97 #if CONFIG_ENCODERS
  98   y4m_input y4m;
  99 #endif
 100 };
 101
 102 #ifdef __cplusplus
 103 extern "C" {
 104 #endif
 105
 106 #if defined(__GNUC__)
 107 #define VPX_NO_RETURN __attribute__((noreturn))
 108 #else
 109 #define VPX_NO_RETURN
 110 #endif
 111
 112 /* Sets a stdio stream into binary mode */
 113 FILE *set_binary_mode(FILE *stream);
 114
 115 void die(const char *fmt, ...) VPX_NO_RETURN;
 116 void fatal(const char *fmt, ...) VPX_NO_RETURN;
 117 void warn(const char *fmt, ...);
 118
 119 void die_codec(vpx_codec_ctx_t *ctx, const char *s) VPX_NO_RETURN;
 120
 121 /* The tool including this file must define usage_exit() */
 122 void usage_exit() VPX_NO_RETURN;
 123
 124 #undef VPX_NO_RETURN
 125
 126 int read_yuv_frame(struct VpxInputContext *input_ctx, vpx_image_t *yuv_frame);
 127
 128 typedef struct VpxInterface {
 129   const char *const name;
 130   const uint32_t fourcc;
 131   vpx_codec_iface_t *(*const codec_interface)();
 132 } VpxInterface;
 133
 134 int get_vpx_encoder_count();
 135 const VpxInterface *get_vpx_encoder_by_index(int i);
 136 const VpxInterface *get_vpx_encoder_by_name(const char *name);
 137
 138 int get_vpx_decoder_count();
 139 const VpxInterface *get_vpx_decoder_by_index(int i);
 140 const VpxInterface *get_vpx_decoder_by_name(const char *name);
 141 const VpxInterface *get_vpx_decoder_by_fourcc(uint32_t fourcc);
 142
 143 // TODO(dkovalev): move this function to vpx_image.{c, h}, so it will be part
 144 // of vpx_image_t support
 145 int vpx_img_plane_width(const vpx_image_t *img, int plane);
 146 int vpx_img_plane_height(const vpx_image_t *img, int plane);
 147 void vpx_img_write(const vpx_image_t *img, FILE *file);
 148 int vpx_img_read(vpx_image_t *img, FILE *file);
 149
 150 double sse_to_psnr(double samples, double peak, double mse);
 151
 152 #ifdef __cplusplus
 153 }  /* extern "C" */
 154 #endif
 155
 156 #endif  // TOOLS_COMMON_H_