git.sesse.net Git - movit/blob - util.h

   1 #ifndef _MOVIT_UTIL_H
   2 #define _MOVIT_UTIL_H 1
   3
   4 // Various utilities.
   5
   6 #include <epoxy/gl.h>
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <Eigen/Core>
  10 #include <string>
  11
  12 #define BUFFER_OFFSET(i) ((char *)NULL + (i))
  13
  14 namespace movit {
  15
  16 // Converts a HSV color to RGB. Assumes h in [0, 2pi> or [-pi, pi>
  17 void hsv2rgb(float h, float s, float v, float *r, float *g, float *b);
  18
  19 // Converts a HSV color to RGB, but keeps luminance constant
  20 // (ie. color luminance is as if S=0).
  21 void hsv2rgb_normalized(float h, float s, float v, float *r, float *g, float *b);
  22
  23 // Read a file from disk and return its contents.
  24 // Dies if the file does not exist.
  25 std::string read_file(const std::string &filename);
  26
  27 // Reads <base>.<extension>, <base>.130.<extension> or <base>.300es.<extension> and
  28 // returns its contents, depending on <movit_shader_level>.
  29 std::string read_version_dependent_file(const std::string &base, const std::string &extension);
  30
  31 // Compile the given GLSL shader (typically a vertex or fragment shader)
  32 // and return the object number.
  33 GLuint compile_shader(const std::string &shader_src, GLenum type);
  34
  35 // Print a 3x3 matrix to standard output. Useful for debugging.
  36 void print_3x3_matrix(const Eigen::Matrix3d &m);
  37
  38 // Output a GLSL 3x3 matrix declaration.
  39 std::string output_glsl_mat3(const std::string &name, const Eigen::Matrix3d &m);
  40
  41 // Output GLSL scalar, 2-length and 3-length vector declarations.
  42 std::string output_glsl_float(const std::string &name, float x);
  43 std::string output_glsl_vec2(const std::string &name, float x, float y);
  44 std::string output_glsl_vec3(const std::string &name, float x, float y, float z);
  45
  46 // Calculate a / b, rounding up. Does not handle overflow correctly.
  47 unsigned div_round_up(unsigned a, unsigned b);
  48
  49 enum CombineRoundingBehavior {
  50         COMBINE_DO_NOT_ROUND = 0,
  51         COMBINE_ROUND_TO_FP16 = 1,
  52 };
  53
  54 // Calculate where to sample, and with what weight, if one wants to use
  55 // the GPU's bilinear hardware to sample w1 * x[pos1] + w2 * x[pos2],
  56 // where pos1 and pos2 must be normalized coordinates describing neighboring
  57 // texels in the mipmap level at which you sample. <num_subtexels> is the
  58 // number of distinct accessible subtexels in the given mipmap level,
  59 // calculated by num_texels / movit_texel_subpixel_precision. It is a float
  60 // for performance reasons, even though it is expected to be a whole number.
  61 // <inv_num_subtexels> is simply its inverse (1/x).
  62 //
  63 // Note that since the GPU might have limited precision in its linear
  64 // interpolation, the effective weights might be different from the ones you
  65 // asked for. sum_sq_error, if not NULL, will contain the sum of the
  66 // (estimated) squared errors of the two weights.
  67 //
  68 // The answer, in "offset", comes as a normalized coordinate,
  69 // so if e.g. w2 = 0, you have simply offset = pos1. If <rounding_behavior>
  70 // is COMBINE_ROUND_TO_FP16, the coordinate is assumed to be stored as a
  71 // rounded fp16 value. This enables more precise calculation of total_weight
  72 // and sum_sq_error.
  73 template<class DestFloat>
  74 void combine_two_samples(float w1, float w2, float pos1, float pos2, float num_subtexels, float inv_num_subtexels,
  75                          DestFloat *offset, DestFloat *total_weight, float *sum_sq_error);
  76
  77 // Create a VBO with the given data, and bind it to the vertex attribute
  78 // with name <attribute_name>. Returns the VBO number.
  79 GLuint fill_vertex_attribute(GLuint glsl_program_num, const std::string &attribute_name, GLint size, GLenum type, GLsizeiptr data_size, const GLvoid *data);
  80
  81 // Clean up after fill_vertex_attribute().
  82 void cleanup_vertex_attribute(GLuint glsl_program_num, const std::string &attribute_name, GLuint vbo);
  83
  84 // If v is not already a power of two, return the first higher power of two.
  85 unsigned next_power_of_two(unsigned v);
  86
  87 // Get a pointer that represents the current OpenGL context, in a cross-platform way.
  88 // This is not intended for anything but identification (ie., so you can associate
  89 // different FBOs with different contexts); you should probably not try to cast it
  90 // back into anything you intend to pass into OpenGL.
  91 void *get_gl_context_identifier();
  92
  93 }  // namespace movit
  94
  95 #ifdef NDEBUG
  96 #define check_error()
  97 #else
  98 #define check_error() { int err = glGetError(); if (err != GL_NO_ERROR) { printf("GL error 0x%x at %s:%d\n", err, __FILE__, __LINE__); abort(); } }
  99 #endif
 100
 101 // CHECK() is like assert(), but retains any side effects no matter the compilation mode.
 102 #ifdef NDEBUG
 103 #define CHECK(x) (void)(x)
 104 #else
 105 #define CHECK(x) do { bool ok = x; if (!ok) { fprintf(stderr, "%s:%d: %s: Assertion `%s' failed.\n", __FILE__, __LINE__, __PRETTY_FUNCTION__, #x); abort(); } } while (false)
 106 #endif
 107
 108 #endif // !defined(_MOVIT_UTIL_H)