1/* 2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of 3 * British Columbia. 4 * Copyright (c) 2001-2002 Michael David Adams. 5 * All rights reserved. 6 */ 7 8/* __START_OF_JASPER_LICENSE__ 9 * 10 * JasPer Software License 11 * 12 * IMAGE POWER JPEG-2000 PUBLIC LICENSE 13 * ************************************ 14 * 15 * GRANT: 16 * 17 * Permission is hereby granted, free of charge, to any person (the "User") 18 * obtaining a copy of this software and associated documentation, to deal 19 * in the JasPer Software without restriction, including without limitation 20 * the right to use, copy, modify, merge, publish, distribute, sublicense, 21 * and/or sell copies of the JasPer Software (in source and binary forms), 22 * and to permit persons to whom the JasPer Software is furnished to do so, 23 * provided further that the License Conditions below are met. 24 * 25 * License Conditions 26 * ****************** 27 * 28 * A. Redistributions of source code must retain the above copyright notice, 29 * and this list of conditions, and the following disclaimer. 30 * 31 * B. Redistributions in binary form must reproduce the above copyright 32 * notice, and this list of conditions, and the following disclaimer in 33 * the documentation and/or other materials provided with the distribution. 34 * 35 * C. Neither the name of Image Power, Inc. nor any other contributor 36 * (including, but not limited to, the University of British Columbia and 37 * Michael David Adams) may be used to endorse or promote products derived 38 * from this software without specific prior written permission. 39 * 40 * D. User agrees that it shall not commence any action against Image Power, 41 * Inc., the University of British Columbia, Michael David Adams, or any 42 * other contributors (collectively "Licensors") for infringement of any 43 * intellectual property rights ("IPR") held by the User in respect of any 44 * technology that User owns or has a right to license or sublicense and 45 * which is an element required in order to claim compliance with ISO/IEC 46 * 15444-1 (i.e., JPEG-2000 Part 1). "IPR" means all intellectual property 47 * rights worldwide arising under statutory or common law, and whether 48 * or not perfected, including, without limitation, all (i) patents and 49 * patent applications owned or licensable by User; (ii) rights associated 50 * with works of authorship including copyrights, copyright applications, 51 * copyright registrations, mask work rights, mask work applications, 52 * mask work registrations; (iii) rights relating to the protection of 53 * trade secrets and confidential information; (iv) any right analogous 54 * to those set forth in subsections (i), (ii), or (iii) and any other 55 * proprietary rights relating to intangible property (other than trademark, 56 * trade dress, or service mark rights); and (v) divisions, continuations, 57 * renewals, reissues and extensions of the foregoing (as and to the extent 58 * applicable) now existing, hereafter filed, issued or acquired. 59 * 60 * E. If User commences an infringement action against any Licensor(s) then 61 * such Licensor(s) shall have the right to terminate User's license and 62 * all sublicenses that have been granted hereunder by User to other parties. 63 * 64 * F. This software is for use only in hardware or software products that 65 * are compliant with ISO/IEC 15444-1 (i.e., JPEG-2000 Part 1). No license 66 * or right to this Software is granted for products that do not comply 67 * with ISO/IEC 15444-1. The JPEG-2000 Part 1 standard can be purchased 68 * from the ISO. 69 * 70 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. 71 * NO USE OF THE JASPER SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER 72 * THIS DISCLAIMER. THE JASPER SOFTWARE IS PROVIDED BY THE LICENSORS AND 73 * CONTRIBUTORS UNDER THIS LICENSE ON AN ``AS-IS'' BASIS, WITHOUT WARRANTY 74 * OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, 75 * WARRANTIES THAT THE JASPER SOFTWARE IS FREE OF DEFECTS, IS MERCHANTABLE, 76 * IS FIT FOR A PARTICULAR PURPOSE OR IS NON-INFRINGING. THOSE INTENDING 77 * TO USE THE JASPER SOFTWARE OR MODIFICATIONS THEREOF FOR USE IN HARDWARE 78 * OR SOFTWARE PRODUCTS ARE ADVISED THAT THEIR USE MAY INFRINGE EXISTING 79 * PATENTS, COPYRIGHTS, TRADEMARKS, OR OTHER INTELLECTUAL PROPERTY RIGHTS. 80 * THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE JASPER SOFTWARE 81 * IS WITH THE USER. SHOULD ANY PART OF THE JASPER SOFTWARE PROVE DEFECTIVE 82 * IN ANY RESPECT, THE USER (AND NOT THE INITIAL DEVELOPERS, THE UNIVERSITY 83 * OF BRITISH COLUMBIA, IMAGE POWER, INC., MICHAEL DAVID ADAMS, OR ANY 84 * OTHER CONTRIBUTOR) SHALL ASSUME THE COST OF ANY NECESSARY SERVICING, 85 * REPAIR OR CORRECTION. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, 86 * WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE 87 * INITIAL DEVELOPER, THE UNIVERSITY OF BRITISH COLUMBIA, IMAGE POWER, INC., 88 * MICHAEL DAVID ADAMS, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE 89 * JASPER SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO 90 * THE USER OR ANY OTHER PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR 91 * CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, 92 * DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR 93 * MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF 94 * SUCH PARTY HAD BEEN INFORMED, OR OUGHT TO HAVE KNOWN, OF THE POSSIBILITY 95 * OF SUCH DAMAGES. THE JASPER SOFTWARE AND UNDERLYING TECHNOLOGY ARE NOT 96 * FAULT-TOLERANT AND ARE NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE OR 97 * RESALE AS ON-LINE CONTROL EQUIPMENT IN HAZARDOUS ENVIRONMENTS REQUIRING 98 * FAIL-SAFE PERFORMANCE, SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES, 99 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL, DIRECT 100 * LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH THE FAILURE OF THE 101 * JASPER SOFTWARE OR UNDERLYING TECHNOLOGY OR PRODUCT COULD LEAD DIRECTLY 102 * TO DEATH, PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE 103 * ("HIGH RISK ACTIVITIES"). LICENSOR SPECIFICALLY DISCLAIMS ANY EXPRESS 104 * OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES. USER WILL NOT 105 * KNOWINGLY USE, DISTRIBUTE OR RESELL THE JASPER SOFTWARE OR UNDERLYING 106 * TECHNOLOGY OR PRODUCTS FOR HIGH RISK ACTIVITIES AND WILL ENSURE THAT ITS 107 * CUSTOMERS AND END-USERS OF ITS PRODUCTS ARE PROVIDED WITH A COPY OF THE 108 * NOTICE SPECIFIED IN THIS SECTION. 109 * 110 * __END_OF_JASPER_LICENSE__ 111 */ 112 113/* 114 * Sequence/Matrix Library 115 * 116 * $Id: jas_seq.h 14449 2005-10-20 12:15:56Z stippi $ 117 */ 118 119#ifndef JAS_SEQ_H 120#define JAS_SEQ_H 121 122/******************************************************************************\ 123* Includes. 124\******************************************************************************/ 125 126#include <jasper/jas_stream.h> 127#include <jasper/jas_types.h> 128 129#ifdef __cplusplus 130extern "C" { 131#endif 132 133/******************************************************************************\ 134* Constants. 135\******************************************************************************/ 136 137/* This matrix is a reference to another matrix. */ 138#define JAS_MATRIX_REF 0x0001 139 140/******************************************************************************\ 141* Types. 142\******************************************************************************/ 143 144/* An element in a sequence. */ 145typedef int_fast32_t jas_seqent_t; 146 147/* An element in a matrix. */ 148typedef int_fast32_t jas_matent_t; 149 150/* Matrix. */ 151 152typedef struct { 153 154 /* Additional state information. */ 155 int flags_; 156 157 /* The starting horizontal index. */ 158 int_fast32_t xstart_; 159 160 /* The starting vertical index. */ 161 int_fast32_t ystart_; 162 163 /* The ending horizontal index. */ 164 int_fast32_t xend_; 165 166 /* The ending vertical index. */ 167 int_fast32_t yend_; 168 169 /* The number of rows in the matrix. */ 170 int_fast32_t numrows_; 171 172 /* The number of columns in the matrix. */ 173 int_fast32_t numcols_; 174 175 /* Pointers to the start of each row. */ 176 jas_seqent_t **rows_; 177 178 /* The allocated size of the rows array. */ 179 int_fast32_t maxrows_; 180 181 /* The matrix data buffer. */ 182 jas_seqent_t *data_; 183 184 /* The allocated size of the data array. */ 185 int_fast32_t datasize_; 186 187} jas_matrix_t; 188 189typedef jas_matrix_t jas_seq2d_t; 190typedef jas_matrix_t jas_seq_t; 191 192/******************************************************************************\ 193* Functions/macros for matrix class. 194\******************************************************************************/ 195 196/* Get the number of rows. */ 197#define jas_matrix_numrows(matrix) \ 198 ((matrix)->numrows_) 199 200/* Get the number of columns. */ 201#define jas_matrix_numcols(matrix) \ 202 ((matrix)->numcols_) 203 204/* Get a matrix element. */ 205#define jas_matrix_get(matrix, i, j) \ 206 ((matrix)->rows_[i][j]) 207 208/* Set a matrix element. */ 209#define jas_matrix_set(matrix, i, j, v) \ 210 ((matrix)->rows_[i][j] = (v)) 211 212/* Get an element from a matrix that is known to be a row or column vector. */ 213#define jas_matrix_getv(matrix, i) \ 214 (((matrix)->numrows_ == 1) ? ((matrix)->rows_[0][i]) : \ 215 ((matrix)->rows_[i][0])) 216 217/* Set an element in a matrix that is known to be a row or column vector. */ 218#define jas_matrix_setv(matrix, i, v) \ 219 (((matrix)->numrows_ == 1) ? ((matrix)->rows_[0][i] = (v)) : \ 220 ((matrix)->rows_[i][0] = (v))) 221 222/* Get the address of an element in a matrix. */ 223#define jas_matrix_getref(matrix, i, j) \ 224 (&(matrix)->rows_[i][j]) 225 226#define jas_matrix_getvref(matrix, i) \ 227 (((matrix)->numrows_ > 1) ? jas_matrix_getref(matrix, i, 0) : jas_matrix_getref(matrix, 0, i)) 228 229#define jas_matrix_length(matrix) \ 230 (max((matrix)->numrows_, (matrix)->numcols_)) 231 232/* Create a matrix with the specified dimensions. */ 233jas_matrix_t *jas_matrix_create(int numrows, int numcols); 234 235/* Destroy a matrix. */ 236void jas_matrix_destroy(jas_matrix_t *matrix); 237 238/* Resize a matrix. The previous contents of the matrix are lost. */ 239int jas_matrix_resize(jas_matrix_t *matrix, int numrows, int numcols); 240 241int jas_matrix_output(jas_matrix_t *matrix, FILE *out); 242 243/* Create a matrix that references part of another matrix. */ 244void jas_matrix_bindsub(jas_matrix_t *mat0, jas_matrix_t *mat1, int r0, int c0, 245 int r1, int c1); 246 247/* Create a matrix that is a reference to a row of another matrix. */ 248#define jas_matrix_bindrow(mat0, mat1, r) \ 249 (jas_matrix_bindsub((mat0), (mat1), (r), 0, (r), (mat1)->numcols_ - 1)) 250 251/* Create a matrix that is a reference to a column of another matrix. */ 252#define jas_matrix_bindcol(mat0, mat1, c) \ 253 (jas_matrix_bindsub((mat0), (mat1), 0, (c), (mat1)->numrows_ - 1, (c))) 254 255/* Clip the values of matrix elements to the specified range. */ 256void jas_matrix_clip(jas_matrix_t *matrix, jas_seqent_t minval, 257 jas_seqent_t maxval); 258 259/* Arithmetic shift left of all elements in a matrix. */ 260void jas_matrix_asl(jas_matrix_t *matrix, int n); 261 262/* Arithmetic shift right of all elements in a matrix. */ 263void jas_matrix_asr(jas_matrix_t *matrix, int n); 264 265/* Almost-but-not-quite arithmetic shift right of all elements in a matrix. */ 266void jas_matrix_divpow2(jas_matrix_t *matrix, int n); 267 268/* Set all elements of a matrix to the specified value. */ 269void jas_matrix_setall(jas_matrix_t *matrix, jas_seqent_t val); 270 271/* The spacing between rows of a matrix. */ 272#define jas_matrix_rowstep(matrix) \ 273 (((matrix)->numrows_ > 1) ? ((matrix)->rows_[1] - (matrix)->rows_[0]) : (0)) 274 275/* The spacing between columns of a matrix. */ 276#define jas_matrix_step(matrix) \ 277 (((matrix)->numrows_ > 1) ? (jas_matrix_rowstep(matrix)) : (1)) 278 279/* Compare two matrices for equality. */ 280int jas_matrix_cmp(jas_matrix_t *mat0, jas_matrix_t *mat1); 281 282/******************************************************************************\ 283* Functions/macros for 2-D sequence class. 284\******************************************************************************/ 285 286jas_seq2d_t *jas_seq2d_copy(jas_seq2d_t *x); 287 288jas_matrix_t *jas_seq2d_create(int xstart, int ystart, int xend, int yend); 289 290#define jas_seq2d_destroy(s) \ 291 jas_matrix_destroy(s) 292 293#define jas_seq2d_xstart(s) \ 294 ((s)->xstart_) 295#define jas_seq2d_ystart(s) \ 296 ((s)->ystart_) 297#define jas_seq2d_xend(s) \ 298 ((s)->xend_) 299#define jas_seq2d_yend(s) \ 300 ((s)->yend_) 301#define jas_seq2d_getref(s, x, y) \ 302 (jas_matrix_getref(s, (y) - (s)->ystart_, (x) - (s)->xstart_)) 303#define jas_seq2d_get(s, x, y) \ 304 (jas_matrix_get(s, (y) - (s)->ystart_, (x) - (s)->xstart_)) 305#define jas_seq2d_rowstep(s) \ 306 jas_matrix_rowstep(s) 307#define jas_seq2d_width(s) \ 308 ((s)->xend_ - (s)->xstart_) 309#define jas_seq2d_height(s) \ 310 ((s)->yend_ - (s)->ystart_) 311#define jas_seq2d_setshift(s, x, y) \ 312 ((s)->xstart_ = (x), (s)->ystart_ = (y), \ 313 (s)->xend_ = (s)->xstart_ + (s)->numcols_, \ 314 (s)->yend_ = (s)->ystart_ + (s)->numrows_) 315 316void jas_seq2d_bindsub(jas_matrix_t *s, jas_matrix_t *s1, int xstart, 317 int ystart, int xend, int yend); 318 319/******************************************************************************\ 320* Functions/macros for 1-D sequence class. 321\******************************************************************************/ 322 323#define jas_seq_create(start, end) \ 324 (jas_seq2d_create(start, 0, end, 1)) 325 326#define jas_seq_destroy(seq) \ 327 (jas_seq2d_destroy(seq)) 328 329#define jas_seq_set(seq, i, v) \ 330 ((seq)->rows_[0][(i) - (seq)->xstart_] = (v)) 331#define jas_seq_getref(seq, i) \ 332 (&(seq)->rows_[0][(i) - (seq)->xstart_]) 333#define jas_seq_get(seq, i) \ 334 ((seq)->rows_[0][(i) - (seq)->xstart_]) 335#define jas_seq_start(seq) \ 336 ((seq)->xstart_) 337#define jas_seq_end(seq) \ 338 ((seq)->xend_) 339 340#ifdef __cplusplus 341} 342#endif 343 344#endif 345