shared/matrix.c

   1 /*
   2  * Copyright © 2011 Intel Corporation
   3  * Copyright © 2012 Collabora, Ltd.
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and
   6  * its documentation for any purpose is hereby granted without fee, provided
   7  * that the above copyright notice appear in all copies and that both that
   8  * copyright notice and this permission notice appear in supporting
   9  * documentation, and that the name of the copyright holders not be used in
  10  * advertising or publicity pertaining to distribution of the software
  11  * without specific, written prior permission.  The copyright holders make
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  16  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  17  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  18  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  19  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  20  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 #include <float.h>
  25 #include <string.h>
  26 #include <stdlib.h>
  27 #include <math.h>
  28
  29 #ifdef IN_WESTON
  30 #include <wayland-server.h>
  31 #else
  32 #define WL_EXPORT
  33 #endif
  34
  35 #include "matrix.h"
  36
  37
  38 /*
  39  * Matrices are stored in column-major order, that is the array indices are:
  40  *  0  4  8 12
  41  *  1  5  9 13
  42  *  2  6 10 14
  43  *  3  7 11 15
  44  */
  45
  46 WL_EXPORT void
  47 weston_matrix_init(struct weston_matrix *matrix)
  48 {
  49         static const struct weston_matrix identity = {
  50                 .d = { 1, 0, 0, 0,  0, 1, 0, 0,  0, 0, 1, 0,  0, 0, 0, 1 },
  51                 .type = 0,
  52         };
  53
  54         memcpy(matrix, &identity, sizeof identity);
  55 }
  56
  57 /* m <- n * m, that is, m is multiplied on the LEFT. */
  58 WL_EXPORT void
  59 weston_matrix_multiply(struct weston_matrix *m, const struct weston_matrix *n)
  60 {
  61         struct weston_matrix tmp;
  62         const float *row, *column;
  63         div_t d;
  64         int i, j;
  65
  66         for (i = 0; i < 16; i++) {
  67                 tmp.d[i] = 0;
  68                 d = div(i, 4);
  69                 row = m->d + d.quot * 4;
  70                 column = n->d + d.rem;
  71                 for (j = 0; j < 4; j++)
  72                         tmp.d[i] += row[j] * column[j * 4];
  73         }
  74         tmp.type = m->type | n->type;
  75         memcpy(m, &tmp, sizeof tmp);
  76 }
  77
  78 WL_EXPORT void
  79 weston_matrix_translate(struct weston_matrix *matrix, float x, float y, float z)
  80 {
  81         struct weston_matrix translate = {
  82                 .d = { 1, 0, 0, 0,  0, 1, 0, 0,  0, 0, 1, 0,  x, y, z, 1 },
  83                 .type = WESTON_MATRIX_TRANSFORM_TRANSLATE,
  84         };
  85
  86         weston_matrix_multiply(matrix, &translate);
  87 }
  88
  89 WL_EXPORT void
  90 weston_matrix_scale(struct weston_matrix *matrix, float x, float y,float z)
  91 {
  92         struct weston_matrix scale = {
  93                 .d = { x, 0, 0, 0,  0, y, 0, 0,  0, 0, z, 0,  0, 0, 0, 1 },
  94                 .type = WESTON_MATRIX_TRANSFORM_SCALE,
  95         };
  96
  97         weston_matrix_multiply(matrix, &scale);
  98 }
  99
 100 WL_EXPORT void
 101 weston_matrix_rotate_xy(struct weston_matrix *matrix, float cos, float sin)
 102 {
 103         struct weston_matrix translate = {
 104                 .d = { cos, sin, 0, 0,  -sin, cos, 0, 0,  0, 0, 1, 0,  0, 0, 0, 1 },
 105                 .type = WESTON_MATRIX_TRANSFORM_ROTATE,
 106         };
 107
 108         weston_matrix_multiply(matrix, &translate);
 109 }
 110
 111 /* v <- m * v */
 112 WL_EXPORT void
 113 weston_matrix_transform(struct weston_matrix *matrix, struct weston_vector *v)
 114 {
 115         int i, j;
 116         struct weston_vector t;
 117
 118         for (i = 0; i < 4; i++) {
 119                 t.f[i] = 0;
 120                 for (j = 0; j < 4; j++)
 121                         t.f[i] += v->f[j] * matrix->d[i + j * 4];
 122         }
 123
 124         *v = t;
 125 }
 126
 127 static inline void
 128 swap_rows(double *a, double *b)
 129 {
 130         unsigned k;
 131         double tmp;
 132
 133         for (k = 0; k < 13; k += 4) {
 134                 tmp = a[k];
 135                 a[k] = b[k];
 136                 b[k] = tmp;
 137         }
 138 }
 139
 140 static inline void
 141 swap_unsigned(unsigned *a, unsigned *b)
 142 {
 143         unsigned tmp;
 144
 145         tmp = *a;
 146         *a = *b;
 147         *b = tmp;
 148 }
 149
 150 static inline unsigned
 151 find_pivot(double *column, unsigned k)
 152 {
 153         unsigned p = k;
 154         for (++k; k < 4; ++k)
 155                 if (fabs(column[p]) < fabs(column[k]))
 156                         p = k;
 157
 158         return p;
 159 }
 160
 161 /*
 162  * reference: Gene H. Golub and Charles F. van Loan. Matrix computations.
 163  * 3rd ed. The Johns Hopkins University Press. 1996.
 164  * LU decomposition, forward and back substitution: Chapter 3.
 165  */
 166
 167 MATRIX_TEST_EXPORT inline int
 168 matrix_invert(double *A, unsigned *p, const struct weston_matrix *matrix)
 169 {
 170         unsigned i, j, k;
 171         unsigned pivot;
 172         double pv;
 173
 174         for (i = 0; i < 4; ++i)
 175                 p[i] = i;
 176         for (i = 16; i--; )
 177                 A[i] = matrix->d[i];
 178
 179         /* LU decomposition with partial pivoting */
 180         for (k = 0; k < 4; ++k) {
 181                 pivot = find_pivot(&A[k * 4], k);
 182                 if (pivot != k) {
 183                         swap_unsigned(&p[k], &p[pivot]);
 184                         swap_rows(&A[k], &A[pivot]);
 185                 }
 186
 187                 pv = A[k * 4 + k];
 188                 if (fabs(pv) < 1e-9)
 189                         return -1; /* zero pivot, not invertible */
 190
 191                 for (i = k + 1; i < 4; ++i) {
 192                         A[i + k * 4] /= pv;
 193
 194                         for (j = k + 1; j < 4; ++j)
 195                                 A[i + j * 4] -= A[i + k * 4] * A[k + j * 4];
 196                 }
 197         }
 198
 199         return 0;
 200 }
 201
 202 MATRIX_TEST_EXPORT inline void
 203 inverse_transform(const double *LU, const unsigned *p, float *v)
 204 {
 205         /* Solve A * x = v, when we have P * A = L * U.
 206          * P * A * x = P * v  =>  L * U * x = P * v
 207          * Let U * x = b, then L * b = P * v.
 208          */
 209         double b[4];
 210         unsigned j;
 211
 212         /* Forward substitution, column version, solves L * b = P * v */
 213         /* The diagonal of L is all ones, and not explicitly stored. */
 214         b[0] = v[p[0]];
 215         b[1] = (double)v[p[1]] - b[0] * LU[1 + 0 * 4];
 216         b[2] = (double)v[p[2]] - b[0] * LU[2 + 0 * 4];
 217         b[3] = (double)v[p[3]] - b[0] * LU[3 + 0 * 4];
 218         b[2] -= b[1] * LU[2 + 1 * 4];
 219         b[3] -= b[1] * LU[3 + 1 * 4];
 220         b[3] -= b[2] * LU[3 + 2 * 4];
 221
 222         /* backward substitution, column version, solves U * y = b */
 223 #if 1
 224         /* hand-unrolled, 25% faster for whole function */
 225         b[3] /= LU[3 + 3 * 4];
 226         b[0] -= b[3] * LU[0 + 3 * 4];
 227         b[1] -= b[3] * LU[1 + 3 * 4];
 228         b[2] -= b[3] * LU[2 + 3 * 4];
 229
 230         b[2] /= LU[2 + 2 * 4];
 231         b[0] -= b[2] * LU[0 + 2 * 4];
 232         b[1] -= b[2] * LU[1 + 2 * 4];
 233
 234         b[1] /= LU[1 + 1 * 4];
 235         b[0] -= b[1] * LU[0 + 1 * 4];
 236
 237         b[0] /= LU[0 + 0 * 4];
 238 #else
 239         for (j = 3; j > 0; --j) {
 240                 unsigned k;
 241                 b[j] /= LU[j + j * 4];
 242                 for (k = 0; k < j; ++k)
 243                         b[k] -= b[j] * LU[k + j * 4];
 244         }
 245
 246         b[0] /= LU[0 + 0 * 4];
 247 #endif
 248
 249         /* the result */
 250         for (j = 0; j < 4; ++j)
 251                 v[j] = b[j];
 252 }
 253
 254 WL_EXPORT int
 255 weston_matrix_invert(struct weston_matrix *inverse,
 256                      const struct weston_matrix *matrix)
 257 {
 258         double LU[16];          /* column-major */
 259         unsigned perm[4];       /* permutation */
 260         unsigned c;
 261
 262         if (matrix_invert(LU, perm, matrix) < 0)
 263                 return -1;
 264
 265         weston_matrix_init(inverse);
 266         for (c = 0; c < 4; ++c)
 267                 inverse_transform(LU, perm, &inverse->d[c * 4]);
 268         inverse->type = matrix->type;
 269
 270         return 0;
 271 }