src/lib/openmj2/t2.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 #ifndef __T2_H
  38 #define __T2_H
  39 /**
  40 @file t2.h
  41 @brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
  42
  43 */
  44
  45 /** @defgroup T2 T2 - Implementation of a tier-2 coding */
  46 /*@{*/
  47
  48 /**
  49 Tier-2 coding
  50 */
  51 typedef struct opj_t2 {
  52     /** codec context */
  53     opj_common_ptr cinfo;
  54
  55     /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
  56     opj_image_t *image;
  57     /** pointer to the image coding parameters */
  58     opj_cp_t *cp;
  59 } opj_t2_t;
  60
  61 /** @name Exported functions */
  62 /*@{*/
  63 /* ----------------------------------------------------------------------- */
  64
  65 /**
  66 Encode the packets of a tile to a destination buffer
  67 @param t2 T2 handle
  68 @param tileno number of the tile encoded
  69 @param tile the tile for which to write the packets
  70 @param maxlayers maximum number of layers
  71 @param dest the destination buffer
  72 @param len the length of the destination buffer
  73 @param cstr_info Codestream information structure
  74 @param tpnum Tile part number of the current tile
  75 @param tppos The position of the tile part flag in the progression order
  76 @param pino
  77 @param t2_mode If == 0 In Threshold calculation ,If == 1 Final pass
  78 @param cur_totnum_tp The total number of tile parts in the current tile
  79 */
  80 int t2_encode_packets(opj_t2_t* t2, int tileno, opj_tcd_tile_t *tile,
  81                       int maxlayers, unsigned char *dest, int len, opj_codestream_info_t *cstr_info,
  82                       int tpnum, int tppos, int pino, J2K_T2_MODE t2_mode, int cur_totnum_tp);
  83 /**
  84 Decode the packets of a tile from a source buffer
  85 @param t2 T2 handle
  86 @param src the source buffer
  87 @param len length of the source buffer
  88 @param tileno number that identifies the tile for which to decode the packets
  89 @param tile tile for which to decode the packets
  90 @param cstr_info Codestream information structure
  91  */
  92 int t2_decode_packets(opj_t2_t *t2, unsigned char *src, int len, int tileno,
  93                       opj_tcd_tile_t *tile, opj_codestream_info_t *cstr_info);
  94
  95 /**
  96 Create a T2 handle
  97 @param cinfo Codec context info
  98 @param image Source or destination image
  99 @param cp Image coding parameters
 100 @return Returns a new T2 handle if successful, returns NULL otherwise
 101 */
 102 opj_t2_t* t2_create(opj_common_ptr cinfo, opj_image_t *image, opj_cp_t *cp);
 103 /**
 104 Destroy a T2 handle
 105 @param t2 T2 handle to destroy
 106 */
 107 void t2_destroy(opj_t2_t *t2);
 108
 109 /* ----------------------------------------------------------------------- */
 110 /*@}*/
 111
 112 /*@}*/
 113
 114 #endif /* __T2_H */