src/lib/openjp2/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 opj_dwt_encode(opj_tcd_tilecomp_v2_t * tilec);
  56
  57 /**
  58 Inverse 5-3 wavelet tranform in 2-D.
  59 Apply a reversible inverse DWT transform to a component of an image.
  60 @param tilec Tile component information (current tile)
  61 @param numres Number of resolution levels to decode
  62 */
  63 opj_bool opj_dwt_decode(opj_tcd_tilecomp_v2_t* tilec, OPJ_UINT32 numres);
  64
  65 /**
  66 Get the gain of a subband for the reversible 5-3 DWT.
  67 @param orient Number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
  68 @return Returns 0 if orient = 0, returns 1 if orient = 1 or 2, returns 2 otherwise
  69 */
  70 OPJ_UINT32 opj_dwt_getgain(OPJ_UINT32 orient) ;
  71 /**
  72 Get the norm of a wavelet function of a subband at a specified level for the reversible 5-3 DWT.
  73 @param level Level of the wavelet function
  74 @param orient Band of the wavelet function
  75 @return Returns the norm of the wavelet function
  76 */
  77 OPJ_FLOAT64 opj_dwt_getnorm(OPJ_UINT32 level, OPJ_UINT32 orient);
  78 /**
  79 Forward 9-7 wavelet transform in 2-D.
  80 Apply an irreversible DWT transform to a component of an image.
  81 @param tilec Tile component information (current tile)
  82 */
  83 opj_bool opj_dwt_encode_real(opj_tcd_tilecomp_v2_t * tilec);
  84 /**
  85 Inverse 9-7 wavelet transform in 2-D.
  86 Apply an irreversible inverse DWT transform to a component of an image.
  87 @param tilec Tile component information (current tile)
  88 @param numres Number of resolution levels to decode
  89 */
  90 opj_bool opj_dwt_decode_real(opj_tcd_tilecomp_v2_t* restrict tilec, OPJ_UINT32 numres);
  91
  92 /**
  93 Get the gain of a subband for the irreversible 9-7 DWT.
  94 @param orient Number that identifies the subband (0->LL, 1->HL, 2->LH, 3->HH)
  95 @return Returns the gain of the 9-7 wavelet transform
  96 */
  97 OPJ_UINT32 opj_dwt_getgain_real(OPJ_UINT32 orient);
  98 /**
  99 Get the norm of a wavelet function of a subband at a specified level for the irreversible 9-7 DWT
 100 @param level Level of the wavelet function
 101 @param orient Band of the wavelet function
 102 @return Returns the norm of the 9-7 wavelet
 103 */
 104 OPJ_FLOAT64 opj_dwt_getnorm_real(OPJ_UINT32 level, OPJ_UINT32 orient);
 105 /**
 106 Explicit calculation of the Quantization Stepsizes
 107 @param tccp Tile-component coding parameters
 108 @param prec Precint analyzed
 109 */
 110 void opj_dwt_calc_explicit_stepsizes(opj_tccp_t * tccp, OPJ_UINT32 prec);
 111 /* ----------------------------------------------------------------------- */
 112 /*@}*/
 113
 114 /*@}*/
 115
 116 #endif /* __DWT_H */