/* cairo - a vector graphics library with display and print output

 *

 * Copyright © 2002 University of Southern California

 *

 * This library is free software; you can redistribute it and/or

 * modify it either under the terms of the GNU Lesser General Public

 * License version 2.1 as published by the Free Software Foundation

 * (the "LGPL") or, at your option, under the terms of the Mozilla

 * Public License Version 1.1 (the "MPL"). If you do not alter this

 * notice, a recipient may use your version of this file under either

 * the MPL or the LGPL.

 *

 * You should have received a copy of the LGPL along with this library

 * in the file COPYING-LGPL-2.1; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA

 * You should have received a copy of the MPL along with this library

 * in the file COPYING-MPL-1.1

 *

 * The contents of this file are subject to the Mozilla Public License

 * Version 1.1 (the "License"); you may not use this file except in

 * compliance with the License. You may obtain a copy of the License at

 * http://www.mozilla.org/MPL/

 *

 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY

 * OF ANY KIND, either express or implied. See the LGPL or the MPL for

 * the specific language governing rights and limitations.

 *

 * The Original Code is the cairo graphics library.

 *

 * The Initial Developer of the Original Code is University of Southern

 * California.

 *

 * Contributor(s):

 *	Carl D. Worth <cworth@cworth.org>

 */

#include "cairoint.h"

#include "cairo-error-private.h"

#include <float.h>

#define PIXMAN_MAX_INT ((pixman_fixed_1 >> 1) - pixman_fixed_e) /* need to ensure deltas also fit */

/**

 * SECTION:cairo-matrix

 * @Title: cairo_matrix_t

 * @Short_Description: Generic matrix operations

 * @See_Also: #cairo_t

 *

 * #cairo_matrix_t is used throughout cairo to convert between different

 * coordinate spaces.  A #cairo_matrix_t holds an affine transformation,

 * such as a scale, rotation, shear, or a combination of these.

 * The transformation of a point (<literal>x</literal>,<literal>y</literal>)

 * is given by:

 *

 * <programlisting>

 * x_new = xx * x + xy * y + x0;

 * y_new = yx * x + yy * y + y0;

 * </programlisting>

 *

 * The current transformation matrix of a #cairo_t, represented as a

 * #cairo_matrix_t, defines the transformation from user-space

 * coordinates to device-space coordinates. See cairo_get_matrix() and

 * cairo_set_matrix().

 **/

static void

_cairo_matrix_scalar_multiply (cairo_matrix_t *matrix, double scalar);

static void

_cairo_matrix_compute_adjoint (cairo_matrix_t *matrix);

/**

 * cairo_matrix_init_identity:

 * @matrix: a #cairo_matrix_t

 *

 * Modifies @matrix to be an identity transformation.

 *

 * Since: 1.0

 **/

void

{

		       1, 0,

		       0, 1,

		       0, 0);

/**

 * cairo_matrix_init:

 * @matrix: a #cairo_matrix_t

 * @xx: xx component of the affine transformation

 * @yx: yx component of the affine transformation

 * @xy: xy component of the affine transformation

 * @yy: yy component of the affine transformation

 * @x0: X translation component of the affine transformation

 * @y0: Y translation component of the affine transformation

 *

 * Sets @matrix to be the affine transformation given by

 * @xx, @yx, @xy, @yy, @x0, @y0. The transformation is given

 * by:

 * <programlisting>

 *  x_new = xx * x + xy * y + x0;

 *  y_new = yx * x + yy * y + y0;

 * </programlisting>

 *

 * Since: 1.0

 **/

void

		   double xx, double yx,

		   double xy, double yy,

		   double x0, double y0)

{

/**

 * _cairo_matrix_get_affine:

 * @matrix: a #cairo_matrix_t

 * @xx: location to store xx component of matrix

 * @yx: location to store yx component of matrix

 * @xy: location to store xy component of matrix

 * @yy: location to store yy component of matrix

 * @x0: location to store x0 (X-translation component) of matrix, or %NULL

 * @y0: location to store y0 (Y-translation component) of matrix, or %NULL

 *

 * Gets the matrix values for the affine transformation that @matrix represents.

 * See cairo_matrix_init().

 *

 *

 * This function is a leftover from the old public API, but is still

 * mildly useful as an internal means for getting at the matrix

 * members in a positional way. For example, when reassigning to some

 * external matrix type, or when renaming members to more meaningful

 * names (such as a,b,c,d,e,f) for particular manipulations.

 **/

void

			  double *xx, double *yx,

			  double *xy, double *yy,

			  double *x0, double *y0)

{

/**

 * cairo_matrix_init_translate:

 * @matrix: a #cairo_matrix_t

 * @tx: amount to translate in the X direction

 * @ty: amount to translate in the Y direction

 *

 * Initializes @matrix to a transformation that translates by @tx and

 * @ty in the X and Y dimensions, respectively.

 *

 * Since: 1.0

 **/

void

			     double tx, double ty)

{

		       1, 0,

		       0, 1,

		       tx, ty);

/**

 * cairo_matrix_translate:

 * @matrix: a #cairo_matrix_t

 * @tx: amount to translate in the X direction

 * @ty: amount to translate in the Y direction

 *

 * Applies a translation by @tx, @ty to the transformation in

 * @matrix. The effect of the new transformation is to first translate

 * the coordinates by @tx and @ty, then apply the original transformation

 * to the coordinates.

 *

 * Since: 1.0

 **/

void

{

    cairo_matrix_t tmp;

/**

 * cairo_matrix_init_scale:

 * @matrix: a #cairo_matrix_t

 * @sx: scale factor in the X direction

 * @sy: scale factor in the Y direction

 *

 * Initializes @matrix to a transformation that scales by @sx and @sy

 * in the X and Y dimensions, respectively.

 *

 * Since: 1.0

 **/

void

			 double sx, double sy)

{

		       sx,  0,

		       0, sy,

		       0, 0);

/**

 * cairo_matrix_scale:

 * @matrix: a #cairo_matrix_t

 * @sx: scale factor in the X direction

 * @sy: scale factor in the Y direction

 *

 * Applies scaling by @sx, @sy to the transformation in @matrix. The

 * effect of the new transformation is to first scale the coordinates

 * by @sx and @sy, then apply the original transformation to the coordinates.

 *

 * Since: 1.0

 **/

void

{

    cairo_matrix_t tmp;

/**

 * cairo_matrix_init_rotate:

 * @matrix: a #cairo_matrix_t

 * @radians: angle of rotation, in radians. The direction of rotation

 * is defined such that positive angles rotate in the direction from

 * the positive X axis toward the positive Y axis. With the default

 * axis orientation of cairo, positive angles rotate in a clockwise

 * direction.

 *

 * Initialized @matrix to a transformation that rotates by @radians.

 *

 * Since: 1.0

 **/

void

			  double radians)

{

    double  s;

    double  c;

		       c, s,

		       -s, c,

		       0, 0);

/**

 * cairo_matrix_rotate:

 * @matrix: a #cairo_matrix_t

 * @radians: angle of rotation, in radians. The direction of rotation

 * is defined such that positive angles rotate in the direction from

 * the positive X axis toward the positive Y axis. With the default

 * axis orientation of cairo, positive angles rotate in a clockwise

 * direction.

 *

 * Applies rotation by @radians to the transformation in

 * @matrix. The effect of the new transformation is to first rotate the

 * coordinates by @radians, then apply the original transformation

 * to the coordinates.

 *

 * Since: 1.0

 **/

void

{

    cairo_matrix_t tmp;

/**

 * cairo_matrix_multiply:

 * @result: a #cairo_matrix_t in which to store the result

 * @a: a #cairo_matrix_t

 * @b: a #cairo_matrix_t

 *

 * Multiplies the affine transformations in @a and @b together

 * and stores the result in @result. The effect of the resulting

 * transformation is to first apply the transformation in @a to the

 * coordinates and then apply the transformation in @b to the

 * coordinates.

 *

 * It is allowable for @result to be identical to either @a or @b.

 *

 * Since: 1.0

 **/

/*

 * XXX: The ordering of the arguments to this function corresponds

 *      to [row_vector]*A*B. If we want to use column vectors instead,

 *      then we need to switch the two arguments and fix up all

 *      uses.

 */

void

{

    cairo_matrix_t r;

void

			const cairo_matrix_t *a,

			const cairo_matrix_t *b)

{

/**

 * cairo_matrix_transform_distance:

 * @matrix: a #cairo_matrix_t

 * @dx: X component of a distance vector. An in/out parameter

 * @dy: Y component of a distance vector. An in/out parameter

 *

 * Transforms the distance vector (@dx,@dy) by @matrix. This is

 * similar to cairo_matrix_transform_point() except that the translation

 * components of the transformation are ignored. The calculation of

 * the returned vector is as follows:

 *

 * <programlisting>

 * dx_new = xx * dx + xy * dy;

 * dy_new = yx * dx + yy * dy;

 * </programlisting>

 *

 * Since: 1.0

 **/

void

{

    double new_x, new_y;

/**

 * cairo_matrix_transform_point:

 * @matrix: a #cairo_matrix_t

 * @x: X position. An in/out parameter

 * @y: Y position. An in/out parameter

 *

 * Transforms the point (@x, @y) by @matrix.

 *

 * Since: 1.0

 **/

void

{

void

				      double *x1, double *y1,

				      double *x2, double *y2,

				      cairo_bool_t *is_tight)

{

    int i;

    double quad_x[4], quad_y[4];

    double min_x, max_x;

    double min_y, max_y;

	/* non-rotation/skew matrix, just map the two extreme points */

	    } else {

	    }

	}

	}

	    } else {

	    }

	}

	}

    }

    /* general matrix */

    }

        /* it's tight if and only if the four corner points form an axis-aligned

           rectangle.

           And that's true if and only if we can derive corners 0 and 3 from

           corners 1 and 2 in one of two straightforward ways...

           We could use a tolerance here but for now we'll fall back to FALSE in the case

           of floating point error.

        */

    }

}

cairo_private void

					    cairo_box_t          *bbox,

					    cairo_bool_t *is_tight)

{

    double x1, y1, x2, y2;

static void

{

/* This function isn't a correct adjoint in that the implicit 1 in the

   homogeneous result should actually be ad-bc instead. But, since this

   adjoint is only used in the computation of the inverse, which

   divides by det (A)=ad-bc anyway, everything works out in the end. */

static void

{

    /* adj (A) = transpose (C:cofactor (A,i,j)) */

    double a, b, c, d, tx, ty;

			      &a,  &b,

			      &c,  &d,

			      &tx, &ty);

		       d, -b,

		       -c, a,

/**

 * cairo_matrix_invert:

 * @matrix: a #cairo_matrix_t

 *

 * Changes @matrix to be the inverse of its original value. Not

 * all transformation matrices have inverses; if the matrix

 * collapses points together (it is <firstterm>degenerate</firstterm>),

 * then it has no inverse and this function will fail.

 *

 * Returns: If @matrix has an inverse, modifies @matrix to

 *  be the inverse matrix and returns %CAIRO_STATUS_SUCCESS. Otherwise,

 *  returns %CAIRO_STATUS_INVALID_MATRIX.

 *

 * Since: 1.0

 **/

cairo_status_t

{

    double det;

    /* Simple scaling|translation matrices are quite common... */

	}

	}

    }

    /* inv (A) = 1/det (A) * adj (A) */

}

cairo_bool_t

{

    double det;

}

cairo_bool_t

{

}

double

{

    double a, b, c, d;

}

/**

 * _cairo_matrix_compute_basis_scale_factors:

 * @matrix: a matrix

 * @basis_scale: the scale factor in the direction of basis

 * @normal_scale: the scale factor in the direction normal to the basis

 * @x_basis: basis to use.  X basis if true, Y basis otherwise.

 *

 * Computes |Mv| and det(M)/|Mv| for v=[1,0] if x_basis is true, and v=[0,1]

 * otherwise, and M is @matrix.

 *

 * Return value: the scale factor of @matrix on the height of the font,

 * or 1.0 if @matrix is %NULL.

 **/

cairo_status_t

					   double *basis_scale, double *normal_scale,

					   cairo_bool_t x_basis)

{

    double det;

    {

    }

    else

    {

	double major, minor;

	/*

	 * ignore mirroring

	 */

	else

	{

	}

	else

	{

	}

    }

}

cairo_bool_t

				      int *itx, int *ity)

{

    {

        {

        }

    }

}

#define SCALING_EPSILON _cairo_fixed_to_double(1)

static cairo_bool_t

}

/* This only returns true if the matrix is 90 degree rotations or

 * flips. It appears calling code is relying on this. It will return

 * false for other rotations even if the scale is one. Approximations

 * are allowed to handle matricies filled in using trig functions

 * such as sin(M_PI_2).

 */

cairo_bool_t

{

    } else {

    }

}

/* By pixel exact here, we mean a matrix that is composed only of

 * 90 degree rotations, flips, and integer translations and produces a 1:1

 * mapping between source and destination pixels. If we transform an image

 * with a pixel-exact matrix, filtering is not useful.

 */

cairo_bool_t

{

    cairo_fixed_t x0_fixed, y0_fixed;

}

/*

  A circle in user space is transformed into an ellipse in device space.

  The following is a derivation of a formula to calculate the length of the

  major axis for this ellipse; this is useful for error bounds calculations.

  Thanks to Walter Brisken <wbrisken@aoc.nrao.edu> for this derivation:

  1.  First some notation:

  All capital letters represent vectors in two dimensions.  A prime '

  represents a transformed coordinate.  Matrices are written in underlined

  form, ie _R_.  Lowercase letters represent scalar real values.

  2.  The question has been posed:  What is the maximum expansion factor

  achieved by the linear transformation

  X' = X _R_

  where _R_ is a real-valued 2x2 matrix with entries:

  _R_ = [a b]

        [c d]  .

  In other words, what is the maximum radius, MAX[ |X'| ], reached for any

  X on the unit circle ( |X| = 1 ) ?

  3.  Some useful formulae

  (A) through (C) below are standard double-angle formulae.  (D) is a lesser

  known result and is derived below:

  (A)  sin²(θ) = (1 - cos(2*θ))/2

  (B)  cos²(θ) = (1 + cos(2*θ))/2

  (C)  sin(θ)*cos(θ) = sin(2*θ)/2

  (D)  MAX[a*cos(θ) + b*sin(θ)] = sqrt(a² + b²)

  Proof of (D):

  find the maximum of the function by setting the derivative to zero:

       -a*sin(θ)+b*cos(θ) = 0

  From this it follows that

       tan(θ) = b/a

  and hence

       sin(θ) = b/sqrt(a² + b²)

  and

       cos(θ) = a/sqrt(a² + b²)

  Thus the maximum value is

       MAX[a*cos(θ) + b*sin(θ)] = (a² + b²)/sqrt(a² + b²)

                                   = sqrt(a² + b²)

  4.  Derivation of maximum expansion

  To find MAX[ |X'| ] we search brute force method using calculus.  The unit

  circle on which X is constrained is to be parameterized by t:

       X(θ) = (cos(θ), sin(θ))

  Thus

       X'(θ) = X(θ) * _R_ = (cos(θ), sin(θ)) * [a b]

                                               [c d]

             = (a*cos(θ) + c*sin(θ), b*cos(θ) + d*sin(θ)).

  Define

       r(θ) = |X'(θ)|

  Thus

       r²(θ) = (a*cos(θ) + c*sin(θ))² + (b*cos(θ) + d*sin(θ))²

             = (a² + b²)*cos²(θ) + (c² + d²)*sin²(θ)

                 + 2*(a*c + b*d)*cos(θ)*sin(θ)

  Now apply the double angle formulae (A) to (C) from above:

       r²(θ) = (a² + b² + c² + d²)/2

	     + (a² + b² - c² - d²)*cos(2*θ)/2

  	     + (a*c + b*d)*sin(2*θ)

             = f + g*cos(φ) + h*sin(φ)

  Where

       f = (a² + b² + c² + d²)/2

       g = (a² + b² - c² - d²)/2

       h = (a*c + d*d)

       φ = 2*θ

  It is clear that MAX[ |X'| ] = sqrt(MAX[ r² ]).  Here we determine MAX[ r² ]

  using (D) from above:

       MAX[ r² ] = f + sqrt(g² + h²)

  And finally

       MAX[ |X'| ] = sqrt( f + sqrt(g² + h²) )

  Which is the solution to this problem.

  Walter Brisken

  2004/10/08

  (Note that the minor axis length is at the minimum of the above solution,

  which is just sqrt ( f - sqrt(g² + h²) ) given the symmetry of (D)).

  For another derivation of the same result, using Singular Value Decomposition,

  see doc/tutorial/src/singular.c.

*/

/* determine the length of the major axis of a circle of the given radius

   after applying the transformation matrix. */

double

					     double radius)

{

    double  a, b, c, d, f, g, h, i, j;

                              &a, &b,

                              &c, &d,

                              NULL, NULL);

    /*

     * we don't need the minor axis length, which is

     * double min = radius * sqrt (f - sqrt (g*g+h*h));

     */

}

static const pixman_transform_t pixman_identity_transform = {{

        {1 << 16,        0,       0},

        {       0, 1 << 16,       0},

        {       0,       0, 1 << 16}

    }};

static cairo_status_t

				pixman_transform_t	*pixman_transform,

				double xc,

				double yc)

{

    cairo_matrix_t inv;

    unsigned max_iterations;

    /* The conversion above breaks cairo's translation invariance:

     * a translation of (a, b) in device space translates to

     * a translation of (xx * a + xy * b, yx * a + yy * b)

     * for cairo, while pixman uses rounded versions of xx ... yy.

     * This error increases as a and b get larger.

     *

     * To compensate for this, we fix the point (xc, yc) in pattern

     * space and adjust pixman's transform to agree with cairo's at

     * that point.

     */

		  fabs (matrix->xy) > PIXMAN_MAX_INT ||

		  fabs (matrix->x0) > PIXMAN_MAX_INT ||

		  fabs (matrix->yx) > PIXMAN_MAX_INT ||

		  fabs (matrix->yy) > PIXMAN_MAX_INT ||

		  fabs (matrix->y0) > PIXMAN_MAX_INT))

    {

    }

    /* Note: If we can't invert the transformation, skip the adjustment. */

    /* find the pattern space coordinate that maps to (xc, yc) */

    do {

	double x,y;

	pixman_vector_t vector;

	cairo_fixed_16_16_t dx, dy;

	/* If we can't transform the reference point, skip the adjustment. */

	/* Ideally, the vector should now be (xc, yc).

	 * We can now compensate for the resulting error.

	 */

    /* We didn't find an exact match between cairo and pixman, but

     * the matrix should be mostly correct */

}

static inline double

{

}

/**

 * _cairo_matrix_is_pixman_translation:

 * @matrix: a matrix

 * @filter: the filter to be used on the pattern transformed by @matrix

 * @x_offset: the translation in the X direction

 * @y_offset: the translation in the Y direction

 *

 * Checks if @matrix translated by (x_offset, y_offset) can be

 * represented using just an offset (within the range pixman can

 * accept) and an identity matrix.

 *

 * Passing a non-zero value in x_offset/y_offset has the same effect

 * as applying cairo_matrix_translate(matrix, x_offset, y_offset) and

 * setting x_offset and y_offset to 0.

 *

 * Upon return x_offset and y_offset contain the translation vector if

 * the return value is %TRUE. If the return value is %FALSE, they will

 * not be modified.

 *

 * Return value: %TRUE if @matrix can be represented as a pixman

 * translation, %FALSE otherwise.

 **/

cairo_bool_t

				     cairo_filter_t            filter,

				     int                      *x_offset,

				     int                      *y_offset)

{

    double tx, ty;

    }

}

/**

 * _cairo_matrix_to_pixman_matrix_offset:

 * @matrix: a matrix

 * @filter: the filter to be used on the pattern transformed by @matrix

 * @xc: the X coordinate of the point to fix in pattern space

 * @yc: the Y coordinate of the point to fix in pattern space

 * @out_transform: the transformation which best approximates @matrix

 * @x_offset: the translation in the X direction

 * @y_offset: the translation in the Y direction

 *

 * This function tries to represent @matrix translated by (x_offset,

 * y_offset) as a %pixman_transform_t and an translation.

 *

 * Passing a non-zero value in x_offset/y_offset has the same effect

 * as applying cairo_matrix_translate(matrix, x_offset, y_offset) and

 * setting x_offset and y_offset to 0.

 *

 * If it is possible to represent the matrix with an identity

 * %pixman_transform_t and a translation within the valid range for

 * pixman, this function will set @out_transform to be the identity,

 * @x_offset and @y_offset to be the translation vector and will

 * return %CAIRO_INT_STATUS_NOTHING_TO_DO. Otherwise it will try to

 * evenly divide the translational component of @matrix between

 * @out_transform and (@x_offset, @y_offset).

 *

 * Upon return x_offset and y_offset contain the translation vector.

 *

 * Return value: %CAIRO_INT_STATUS_NOTHING_TO_DO if the out_transform

 * is the identity, %CAIRO_STATUS_INVALID_MATRIX if it was not

 * possible to represent @matrix as a pixman_transform_t without

 * overflows, %CAIRO_STATUS_SUCCESS otherwise.

 **/

cairo_status_t

				       cairo_filter_t            filter,

				       double                    xc,

				       double                    yc,

				       pixman_transform_t	*out_transform,

				       int                      *x_offset,

				       int                      *y_offset)

{

    cairo_bool_t is_pixman_translation;

								 filter,

								 x_offset,

								 y_offset);

    } else {

	cairo_matrix_t m;

	    double tx, ty, norm;

	    int i, j;

	    /* pixman also limits the [xy]_offset to 16 bits so evenly

	     * spread the bits between the two.

	     *

	     * To do this, find the solutions of:

	     *   |x| = |x*m.xx + y*m.xy + m.x0|

	     *   |y| = |x*m.yx + y*m.yy + m.y0|

	     *

	     * and select the one whose maximum norm is smallest.

	     */

		    double x, y, den, new_norm;

		    }

		}

	    }

	} else {

	}

    }

}