libopenjpeg/dwt.h

   1 /*
   2  * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   3  * Copyright (c) 2002-2007, Professor Benoit Macq
   4  * Copyright (c) 2001-2003, David Janssens
   5  * Copyright (c) 2002-2003, Yannick Verschueren
   6  * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
   7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef __DWT_H
  33 #define __DWT_H
  34 /**
  35 @file dwt.h
  36 @brief Implementation of a discrete wavelet transform (DWT)
  37
  38 The functions in DWT.C have for goal to realize forward and inverse discret wavelet
  39 transform with filter 5-3 (reversible) and filter 9-7 (irreversible). The functions in
  40 DWT.C are used by some function in TCD.C.
  41 */
  42
  43 /** @defgroup DWT DWT - Implementation of a discrete wavelet transform */
  44 /*@{*/
  45
  46
  47 /** @name Exported functions */
  48 /*@{*/
  49 /* ----------------------------------------------------------------------- */
  50 /**
  51 Forward 5-3 wavelet tranform in 2-D.
  52 Apply a reversible DWT transform to a component of an image.
  53 @param tilec Tile component information (current tile)
  54 */
  55 opj_bool dwt_encode_v2(struct opj_tcd_tilecomp_v2 * tilec);
  56
  57 /**
  58 Forward 5-3 wavelet tranform in 2-D.
  59 Apply a reversible DWT transform to a component of an image.
  60 @param tilec Tile component information (current tile)
  61 */
  62 void dwt_encode(opj_tcd_tilecomp_t * tilec);
  63 /**
  64 Inverse 5-3 wavelet tranform in 2-D.
  65 Apply a reversible inverse DWT transform to a component of an image.
  66 @param tilec Tile component information (current tile)
  67 @param numres Number of resolution levels to decode
  68 */
  69 #ifdef OPJ_V1
  70 void dwt_decode(opj_tcd_tilecomp_t* tilec, int numres);
  71 #endif
  72 opj_bool dwt_decode(opj_tcd_tilecomp_t* tilec, OPJ_UINT32 numres);
  73
  74 opj_bool dwt_decode_v2(opj_tcd_tilecomp_v2_t* tilec, OPJ_UINT32 numres);
  75
  76 /**
  77 Get the gain of a subband for the reversible 5-3 DWT.
  78 @param orient Number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
  79 @return Returns 0 if orient = 0, returns 1 if orient = 1 or 2, returns 2 otherwise
  80 */
  81 int dwt_getgain(int orient);
  82
  83 OPJ_UINT32 dwt_getgain_v2(OPJ_UINT32 orient) ;
  84 /**
  85 Get the norm of a wavelet function of a subband at a specified level for the reversible 5-3 DWT.
  86 @param level Level of the wavelet function
  87 @param orient Band of the wavelet function
  88 @return Returns the norm of the wavelet function
  89 */
  90 double dwt_getnorm(int level, int orient);
  91 /**
  92 Forward 9-7 wavelet transform in 2-D.
  93 Apply an irreversible DWT transform to a component of an image.
  94 @param tilec Tile component information (current tile)
  95 */
  96 void dwt_encode_real(opj_tcd_tilecomp_t * tilec);
  97 opj_bool dwt_encode_real_v2(opj_tcd_tilecomp_v2_t * tilec);
  98 /**
  99 KEEP TRUNK VERSION + return type of v2 because rev557
 100 Inverse 9-7 wavelet transform in 2-D.
 101 Apply an irreversible inverse DWT transform to a component of an image.
 102 @param tilec Tile component information (current tile)
 103 @param numres Number of resolution levels to decode
 104 */
 105 /* V1 void dwt_decode_real(opj_tcd_tilecomp_t* tilec, int numres); */
 106 opj_bool dwt_decode_real(opj_tcd_tilecomp_t* tilec, int numres);
 107
 108 opj_bool dwt_decode_real_v2(opj_tcd_tilecomp_v2_t* restrict tilec, OPJ_UINT32 numres);
 109
 110 /**
 111 Get the gain of a subband for the irreversible 9-7 DWT.
 112 @param orient Number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
 113 @return Returns the gain of the 9-7 wavelet transform
 114 */
 115 int dwt_getgain_real(int orient);
 116 OPJ_UINT32 dwt_getgain_real_v2(OPJ_UINT32 orient);
 117 /**
 118 Get the norm of a wavelet function of a subband at a specified level for the irreversible 9-7 DWT
 119 @param level Level of the wavelet function
 120 @param orient Band of the wavelet function
 121 @return Returns the norm of the 9-7 wavelet
 122 */
 123 double dwt_getnorm_real(int level, int orient);
 124 /**
 125 Explicit calculation of the Quantization Stepsizes
 126 @param tccp Tile-component coding parameters
 127 @param prec Precint analyzed
 128 */
 129 void dwt_calc_explicit_stepsizes(opj_tccp_t * tccp, int prec);
 130 /* ----------------------------------------------------------------------- */
 131 /*@}*/
 132
 133 /*@}*/
 134
 135 #endif /* __DWT_H */