jpc_tsfb.h Source File

jpc_tsfb.h
1 /*
2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of
3 * British Columbia.
4 * Copyright (c) 2001-2004 Michael David Adams.
5 * All rights reserved.
6 */
7
8 /* __START_OF_JASPER_LICENSE__
9 *
10 * JasPer License Version 2.0
11 *
12 * Copyright (c) 2001-2006 Michael David Adams
13 * Copyright (c) 1999-2000 Image Power, Inc.
14 * Copyright (c) 1999-2000 The University of British Columbia
15 *
16 * All rights reserved.
17 *
18 * Permission is hereby granted, free of charge, to any person (the
19 * "User") obtaining a copy of this software and associated documentation
20 * files (the "Software"), to deal in the Software without restriction,
21 * including without limitation the rights to use, copy, modify, merge,
22 * publish, distribute, and/or sell copies of the Software, and to permit
23 * persons to whom the Software is furnished to do so, subject to the
24 * following conditions:
25 *
26 * 1. The above copyright notices and this permission notice (which
27 * includes the disclaimer below) shall be included in all copies or
28 * substantial portions of the Software.
29 *
30 * 2. The name of a copyright holder shall not be used to endorse or
31 * promote products derived from the Software without specific prior
32 * written permission.
33 *
34 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
35 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
36 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
37 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
38 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
39 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
40 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
41 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
42 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
43 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
44 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
45 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
46 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
47 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
48 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
49 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
50 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
51 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
52 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
53 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
54 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
55 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
56 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
57 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
58 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
59 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
60 *
61 * __END_OF_JASPER_LICENSE__
62 */
63
64 /*
65 * Tree-Structured Filter Bank (TSFB) Library
66 *
67 * $Id$
68 */
69
70 #ifndef JPC_TSFB_H
71 #define JPC_TSFB_H
72
73 /******************************************************************************\
74 * Includes.
75 \******************************************************************************/
76
77 #include "jasper/jas_seq.h"
78
79 #include "jpc_fix.h"
80 #include "jpc_qmfb.h"
81
82 /******************************************************************************\
83 * Constants.
84 \******************************************************************************/
85
86 #define JPC_TSFB_MAXBANDS (JPC_TSFB_MAXDEPTH * 3 + 1)
87 #define JPC_TSFB_MAXDEPTH 32
88 #define JPC_TSFB_RITIMODE JPC_QMFB1D_RITIMODE
89
90 #define JPC_TSFB_LL 0
91 #define JPC_TSFB_LH 1
92 #define JPC_TSFB_HL 2
93 #define JPC_TSFB_HH 3
94
95 /******************************************************************************\
96 * Types.
97 \******************************************************************************/
98
99 typedef struct {
100 int xstart;
101 int ystart;
102 int xend;
103 int yend;
104 int orient;
105 int locxstart;
106 int locystart;
107 int locxend;
108 int locyend;
109 jpc_fix_t synenergywt;
110 } jpc_tsfb_band_t;
111
112 typedef struct {
113 int numlvls;
114 jpc_qmfb2d_t *qmfb;
115 } jpc_tsfb_t;
116
117 /******************************************************************************\
118 * Functions.
119 \******************************************************************************/
120
121 /* Create a TSFB. */
122 jpc_tsfb_t *jpc_cod_gettsfb(int qmfbid, int numlevels);
123
124 /* Destroy a TSFB. */
125 void jpc_tsfb_destroy(jpc_tsfb_t *tsfb);
126
127 /* Perform analysis. */
128 int jpc_tsfb_analyze(jpc_tsfb_t *tsfb, jas_seq2d_t *x);
129
130 /* Perform synthesis. */
131 int jpc_tsfb_synthesize(jpc_tsfb_t *tsfb, jas_seq2d_t *x);
132
133 int jpc_tsfb_analyze2(jpc_tsfb_t *tsfb, jpc_fix_t *a, int xstart, int ystart,
134 int width, int height, int stride, int numlvls);
135
136 int jpc_tsfb_synthesize2(jpc_tsfb_t *tsfb, jpc_fix_t *a, int xstart, int ystart,
137 int width, int height, int stride, int numlvls);
138
139 /* Get band information for a TSFB. */
140 int jpc_tsfb_getbands(jpc_tsfb_t *tsfb, uint_fast32_t xstart,
141 uint_fast32_t ystart, uint_fast32_t xend, uint_fast32_t yend,
142 jpc_tsfb_band_t *bands);
143
144 #endif