int
fz_mul255 (
int a,
int b
)
Multiply scaled two integers in the 0..255 range
int
fz_div255 (
int c,
int a
)
Undo alpha premultiplication.
#define FZ_EXPAND(A)
Expand a value A from the 0…255 range to the 0..256 range
#define FZ_COMBINE(A,B)
Combine values A (in any range) and B (in the 0..256 range), to give a single value in the same range as A was.
#define FZ_COMBINE2(A,B,C,D)
Combine values A and C (in the same (any) range) and B and D (in the 0..256 range), to give a single value in the same range as A and C were.
#define FZ_BLEND(SRC, DST, AMOUNT)
Blend SRC and DST (in the same range) together according to AMOUNT (in the 0…256 range).
float
fz_atof (
const char *s
)
Range checking atof
int
fz_atoi (
const char *s
)
atoi that copes with NULL
int64_t
fz_atoi64 (
const char *s
)
64bit atoi that copes with NULL
size_t
fz_atoz (
const char *s
)
size_t atoi that copes with NULL.
NOTE: limited to 63bits. Negative numbers are returned as 0.
float
fz_abs (
float f
)
Some standard math functions, done as static inlines for speed. People with compilers that do not adequately implement inline may like to reimplement these using macros.
int
fz_absi (
int i
)
float
fz_min (
float a,
float b
)
int
fz_mini (
int a,
int b
)
size_t
fz_minz (
size_t a,
size_t b
)
int64_t
fz_mini64 (
int64_t a,
int64_t b
)
float
fz_max (
float a,
float b
)
int
fz_maxi (
int a,
int b
)
size_t
fz_maxz (
size_t a,
size_t b
)
int64_t
fz_maxi64 (
int64_t a,
int64_t b
)
float
fz_clamp (
float x,
float min,
float max
)
int
fz_clampi (
int x,
int min,
int max
)
int64_t
fz_clamp64 (
int64_t x,
int64_t min,
int64_t max
)
double
fz_clampd (
double x,
double min,
double max
)
void *
fz_clampp (
void *x,
void *min,
void *max
)
struct fz_point
{
float x, y;
}
fz_point is a point in a two-dimensional space.
fz_point
fz_make_point (
float x,
float y
)
#define FZ_MIN_INF_RECT ((int)0x80000000)
fz_rect is a rectangle represented by two diagonally opposite corners at arbitrary coordinates.
Rectangles are always axis-aligned with the X- and Y- axes. We wish to distinguish rectangles in 3 categories; infinite, finite, and invalid. Zero area rectangles are a sub-category of finite ones.
For all valid rectangles, x0 <= x1 and y0 <= y1 in all cases. Infinite rectangles have x0 = y0 = FZ_MIN_INF_RECT, x1 = y1 = FZ_MAX_INF_RECT. For any non infinite valid rectangle, the area is defined as (x1 - x0) * (y1 - y0).
To check for empty or infinite rectangles use fz_is_empty_rect and fz_is_infinite_rect. To check for valid rectangles use fz_is_valid_rect.
We choose this representation, so that we can easily distinguish the difference between intersecting 2 valid rectangles and getting an invalid one, as opposed to getting a zero area one (which nonetheless has valid bounds within the plane).
We choose FZ_{MIN,MAX}_INF_RECT to be the largest 32bit signed integer values that survive roundtripping to floats.
#define FZ_MAX_INF_RECT ((int)0x7fffff80)
struct fz_rect
{
float x0, y0;
float x1, y1;
}
fz_rect
fz_make_rect (
float x0,
float y0,
float x1,
float y1
)
struct fz_irect
{
int x0, y0;
int x1, y1;
}
fz_irect is a rectangle using integers instead of floats.
It’s used in the draw device and for pixmap dimensions.
fz_irect
fz_make_irect (
int x0,
int y0,
int x1,
int y1
)
extern const fz_rect fz_unit_rect
A rectangle with sides of length one.
The bottom left corner is at (0, 0) and the top right corner is at (1, 1).
extern const fz_rect fz_empty_rect
An empty rectangle with an area equal to zero.
extern const fz_irect fz_empty_irect
extern const fz_rect fz_infinite_rect
An infinite rectangle.
extern const fz_irect fz_infinite_irect
extern const fz_rect fz_invalid_rect
An invalid rectangle.
extern const fz_irect fz_invalid_irect
int
fz_is_empty_rect (
fz_rect r
)
Check if rectangle is empty.
An empty rectangle is defined as one whose area is zero. All invalid rectangles are empty.
int
fz_is_empty_irect (
fz_irect r
)
int
fz_is_infinite_rect (
fz_rect r
)
Check if rectangle is infinite.
int
fz_is_infinite_irect (
fz_irect r
)
Check if an integer rectangle is infinite.
int
fz_is_valid_rect (
fz_rect r
)
Check if rectangle is valid.
int
fz_is_valid_irect (
fz_irect r
)
Check if an integer rectangle is valid.
unsigned int
fz_irect_width (
fz_irect r
)
Return the width of an irect. Invalid irects return 0.
int
fz_irect_height (
fz_irect r
)
Return the height of an irect. Invalid irects return 0.
struct fz_matrix
{
float a, b, c, d, e, f;
}
fz_matrix is a row-major 3x3 matrix used for representing transformations of coordinates throughout MuPDF.
Since all points reside in a two-dimensional space, one vector is always a constant unit vector; hence only some elements may vary in a matrix. Below is how the elements map between different representations.
This 2-d matrix
/ a b 0 \
| c d 0 |
\ e f 1 /
is represented as a 1-d vector:
[ a b c d e f ]
extern const fz_matrix fz_identity
Identity transform matrix.
fz_matrix
fz_make_matrix (
float a,
float b,
float c,
float d,
float e,
float f
)
int
fz_is_identity (
fz_matrix m
)
fz_matrix
fz_concat (
fz_matrix left,
fz_matrix right
)
Multiply two matrices.
The order of the two matrices are important since matrix multiplication is not commutative.
Returns result.
fz_matrix
fz_scale (
float sx,
float sy
)
Create a scaling matrix.
The returned matrix is of the form [ sx 0 0 sy 0 0 ].
Returns m.
fz_matrix
fz_pre_scale (
fz_matrix m,
float sx,
float sy
)
Scale a matrix by premultiplication.
Returns m (updated).
fz_matrix
fz_post_scale (
fz_matrix m,
float sx,
float sy
)
Scale a matrix by postmultiplication.
Returns m (updated).
fz_matrix
fz_shear (
float sx,
float sy
)
Create a shearing matrix.
The returned matrix is of the form [ 1 sy sx 1 0 0 ].
Returns m.
fz_matrix
fz_pre_shear (
fz_matrix m,
float sx,
float sy
)
Premultiply a matrix with a shearing matrix.
The shearing matrix is of the form [ 1 sy sx 1 0 0 ].
Returns m (updated).
fz_matrix
fz_rotate (
float degrees
)
Create a rotation matrix.
The returned matrix is of the form [ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
Returns m.
fz_matrix
fz_pre_rotate (
fz_matrix m,
float degrees
)
Rotate a transformation by premultiplying.
The premultiplied matrix is of the form [ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
Returns m (updated).
fz_matrix
fz_translate (
float tx,
float ty
)
Create a translation matrix.
The returned matrix is of the form [ 1 0 0 1 tx ty ].
Returns m.
fz_matrix
fz_pre_translate (
fz_matrix m,
float tx,
float ty
)
Translate a matrix by premultiplication.
Returns m.
fz_matrix
fz_transform_page (
fz_rect mediabox,
float resolution,
float rotate
)
Create transform matrix to draw page at a given resolution and rotation. Adjusts the scaling factors so that the page covers whole number of pixels and adjust the page origin to be at 0,0.
fz_matrix
fz_invert_matrix (
fz_matrix matrix
)
Create an inverse matrix.
Returns inverse.
int
fz_try_invert_matrix (
fz_matrix *inv,
fz_matrix src
)
Attempt to create an inverse matrix.
Returns 1 if matrix is degenerate (singular), or 0 otherwise.
int
fz_is_rectilinear (
fz_matrix m
)
Check if a transformation is rectilinear.
Rectilinear means that no shearing is present and that any rotations present are a multiple of 90 degrees. Usually this is used to make sure that axis-aligned rectangles before the transformation are still axis-aligned rectangles afterwards.
float
fz_matrix_expansion (
fz_matrix m
)
Calculate average scaling factor of matrix.
fz_rect
fz_intersect_rect (
fz_rect a,
fz_rect b
)
Compute intersection of two rectangles.
Given two rectangles, update the first to be the smallest axis-aligned rectangle that covers the area covered by both given rectangles. If either rectangle is empty then the intersection is also empty. If either rectangle is infinite then the intersection is simply the non-infinite rectangle. Should both rectangles be infinite, then the intersection is also infinite.
fz_irect
fz_intersect_irect (
fz_irect a,
fz_irect b
)
Compute intersection of two bounding boxes.
Similar to fz_intersect_rect but operates on two bounding boxes instead of two rectangles.
fz_rect
fz_union_rect (
fz_rect a,
fz_rect b
)
Compute union of two rectangles.
Given two rectangles, update the first to be the smallest axis-aligned rectangle that encompasses both given rectangles. If either rectangle is infinite then the union is also infinite. If either rectangle is empty then the union is simply the non-empty rectangle. Should both rectangles be empty, then the union is also empty.
fz_irect
fz_irect_from_rect (
fz_rect rect
)
Convert a rect into the minimal bounding box that covers the rectangle.
Coordinates in a bounding box are integers, so rounding of the rects coordinates takes place. The top left corner is rounded upwards and left while the bottom right corner is rounded downwards and to the right.
fz_irect
fz_round_rect (
fz_rect rect
)
Round rectangle coordinates.
Coordinates in a bounding box are integers, so rounding of the rects coordinates takes place. The top left corner is rounded upwards and left while the bottom right corner is rounded downwards and to the right.
This differs from fz_irect_from_rect, in that fz_irect_from_rect slavishly follows the numbers (i.e any slight over/under calculations can cause whole extra pixels to be added). fz_round_rect allows for a small amount of rounding error when calculating the bbox.
fz_rect
fz_rect_from_irect (
fz_irect bbox
)
Convert a bbox into a rect.
For our purposes, a rect can represent all the values we meet in a bbox, so nothing can go wrong.
Returns rect (updated).
fz_rect
fz_expand_rect (
fz_rect b,
float expand
)
Expand a bbox by a given amount in all directions.
fz_irect
fz_expand_irect (
fz_irect a,
int expand
)
float
fz_rect_area (
fz_rect r
)
Calculate the area of a rectangle.
Always non-negative. All invalid or empty rects return 0.
fz_rect
fz_include_point_in_rect (
fz_rect r,
fz_point p
)
Expand a bbox to include a given point. To create a rectangle that encompasses a sequence of points, the rectangle must first be set to be the empty rectangle at one of the points before including the others.
fz_rect
fz_translate_rect (
fz_rect a,
float xoff,
float yoff
)
Translate bounding box.
Translate a bbox by a given x and y offset. Allows for overflow.
fz_irect
fz_translate_irect (
fz_irect a,
int xoff,
int yoff
)
int
fz_contains_rect (
fz_rect a,
fz_rect b
)
Test rectangle inclusion.
Return true if a entirely contains b.
int
fz_overlaps_rect (
fz_rect a,
fz_rect b
)
Test rectangle overlap.
Returns true if the area of the overlap is non zero.
fz_point
fz_transform_point (
fz_point point,
fz_matrix m
)
Apply a transformation to a point.
Returns transform (unchanged).
fz_point
fz_transform_point_xy (
float x,
float y,
fz_matrix m
)
fz_point
fz_transform_vector (
fz_point vector,
fz_matrix m
)
Apply a transformation to a vector.
fz_rect
fz_transform_rect (
fz_rect rect,
fz_matrix m
)
Apply a transform to a rectangle.
After the four corner points of the axis-aligned rectangle have been transformed it may not longer be axis-aligned. So a new axis-aligned rectangle is created covering at least the area of the transformed rectangle.
fz_point
fz_normalize_vector (
fz_point p
)
Normalize a vector to length one.
fz_matrix
fz_gridfit_matrix (
int as_tiled,
fz_matrix m
)
Grid fit a matrix.
as_tiled = 0 => adjust the matrix so that the image of the unit square completely covers any pixel that was touched by the image of the unit square under the original matrix.
as_tiled = 1 => adjust the matrix so that the corners of the image of the unit square align with the closest integer corner of the image of the unit square under the original matrix.
float
fz_matrix_max_expansion (
fz_matrix m
)
Find the largest expansion performed by this matrix. (i.e. max(abs(m.a),abs(m.b),abs(m.c),abs(m.d))
struct fz_quad
{
fz_point ul, ur, ll, lr;
}
A representation for a region defined by 4 points.
The significant difference between quads and rects is that the edges of quads are not axis aligned.
fz_quad
fz_make_quad (
float ul_x,
float ul_y,
float ur_x,
float ur_y,
float ll_x,
float ll_y,
float lr_x,
float lr_y
)
Inline convenience construction function.
extern const fz_quad fz_invalid_quad
extern const fz_quad fz_infinite_quad
int
fz_is_valid_quad (
fz_quad q
)
Is a quad valid?
int
fz_is_empty_quad (
fz_quad q
)
Is a quad empty?
int
fz_is_infinite_quad (
fz_quad q
)
Is a quad infinite?
fz_quad
fz_quad_from_rect (
fz_rect r
)
Convert a rect to a quad (losslessly).
fz_rect
fz_rect_from_quad (
fz_quad q
)
Convert a quad to the smallest rect that covers it.
fz_quad
fz_transform_quad (
fz_quad q,
fz_matrix m
)
Transform a quad by a matrix.
int
fz_is_point_inside_quad (
fz_point p,
fz_quad q
)
Inclusion test for quads.
int
fz_is_point_inside_rect (
fz_point p,
fz_rect r
)
Inclusion test for rects. (Rect is assumed to be open, i.e. top right corner is not included).
int
fz_is_point_inside_irect (
int x,
int y,
fz_irect r
)
Inclusion test for irects. (Rect is assumed to be open, i.e. top right corner is not included).
int
fz_is_rect_inside_rect (
fz_rect inner,
fz_rect outer
)
Inclusion test for rects.
rects are assumed to be both open or both closed.
No invalid rect can include any other rect. No invalid rect can be included by any rect. Empty (point) rects can include themselves. Empty (line) rects can include many (subline) rects.
int
fz_is_irect_inside_irect (
fz_irect inner,
fz_irect outer
)
Inclusion test for irects.
rects are assumed to be both open or both closed.
No invalid rect can include any other rect. No invalid rect can be included by any rect. Empty (point) rects can include themselves. Empty (line) rects can include many (subline) rects.
int
fz_is_quad_inside_quad (
fz_quad needle,
fz_quad haystack
)
Inclusion test for quad in quad.
This may break down if quads are not ‘well formed’.
int
fz_is_quad_intersecting_quad (
fz_quad a,
fz_quad b
)
Intersection test for quads.
This may break down if quads are not ‘well formed’.
Checked integer arithmetic helpers – return whether operation succeeded without overflow or underflow.
Use builtin C23 ckd_mul, ckd_add, ckd_sub if available.
#define fz_ckd_mul_i32(O,A,B)
We add explicit casts here to ensure that these match the non-C23 cases below.
#define fz_ckd_mul_u32(O,A,B)
#define fz_ckd_mul_int(O,A,B)
#define fz_ckd_mul_uint(O,A,B)
#define fz_ckd_mul_size(O,A,B)
#define fz_ckd_mul_i64(O,A,B)
#define fz_ckd_mul_u64(O,A,B)
#define fz_ckd_add_i32(O,A,B)
#define fz_ckd_add_u32(O,A,B)
#define fz_ckd_add_int(O,A,B)
#define fz_ckd_add_uint(O,A,B)
#define fz_ckd_add_size(O,A,B)
#define fz_ckd_add_i64(O,A,B)
#define fz_ckd_add_u64(O,A,B)
#define fz_ckd_sub_i32(O,A,B)
#define fz_ckd_sub_u32(O,A,B)
#define fz_ckd_sub_int(O,A,B)
#define fz_ckd_sub_uint(O,A,B)
#define fz_ckd_sub_size(O,A,B)
#define fz_ckd_sub_i64(O,A,B)
#define fz_ckd_sub_u64(O,A,B)
int
fz_ckd_mul_i32 (
int32_t *out,
int32_t a,
int32_t b
)
int
fz_ckd_add_i32 (
int32_t *out,
int32_t a,
int32_t b
)
int
fz_ckd_sub_i32 (
int32_t *out,
int32_t a,
int32_t b
)
int
fz_ckd_mul_u32 (
uint32_t *out,
uint32_t a,
uint32_t b
)
int
fz_ckd_add_u32 (
uint32_t *out,
uint32_t a,
uint32_t b
)
int
fz_ckd_sub_u32 (
uint32_t *out,
uint32_t a,
uint32_t b
)
int
fz_ckd_mul_int (
int *out,
int a,
int b
)
int
fz_ckd_add_int (
int *out,
int a,
int b
)
int
fz_ckd_sub_int (
int *out,
int a,
int b
)
int
fz_ckd_mul_uint (
unsigned int *out,
unsigned int a,
unsigned int b
)
int
fz_ckd_add_uint (
unsigned int *out,
unsigned int a,
unsigned int b
)
int
fz_ckd_sub_uint (
unsigned int *out,
unsigned int a,
unsigned int b
)
int
fz_ckd_mul_size (
size_t *out,
size_t a,
size_t b
)
int
fz_ckd_add_size (
size_t *out,
size_t a,
size_t b
)
int
fz_ckd_sub_size (
size_t *out,
size_t a,
size_t b
)
int
fz_ckd_mul_i64 (
int64_t *out,
int64_t a,
int64_t b
)
int
fz_ckd_add_i64 (
int64_t *out,
int64_t a,
int64_t b
)
int
fz_ckd_sub_i64 (
int64_t *out,
int64_t a,
int64_t b
)
int
fz_ckd_mul_u64 (
uint64_t *out,
uint64_t a,
uint64_t b
)
int
fz_ckd_add_u64 (
uint64_t *out,
uint64_t a,
uint64_t b
)
int
fz_ckd_sub_u64 (
uint64_t *out,
uint64_t a,
uint64_t b
)
#define fz_bytes_from_bits(A)
int
fz_ckd_size_from_i64 (
size_t *out,
int64_t in
)
int
fz_ckd_int_from_i64 (
int *out,
int64_t in
)