src/lib/openmj2/dwt.h

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