libopenjpeg/t2.h

   1 /*
   2  * Copyright (c) 2001-2003, David Janssens
   3  * Copyright (c) 2002-2003, Yannick Verschueren
   4  * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
   5  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   6  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30 #ifndef __T2_H
  31 #define __T2_H
  32 /**
  33 @file t2.h
  34 @brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
  35
  36 */
  37
  38 /** @defgroup T2 T2 - Implementation of a tier-2 coding */
  39 /*@{*/
  40
  41 /**
  42 Tier-2 coding
  43 */
  44 typedef struct opj_t2 {
  45         /** codec context */
  46         opj_common_ptr cinfo;
  47
  48         /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
  49         opj_image_t *image;
  50         /** pointer to the image coding parameters */
  51         opj_cp_t *cp;
  52 } opj_t2_t;
  53
  54 /** @name Exported functions */
  55 /*@{*/
  56 /* ----------------------------------------------------------------------- */
  57
  58 /**
  59 Encode the packets of a tile to a destination buffer
  60 @param t2 T2 handle
  61 @param tileno number of the tile encoded
  62 @param tile the tile for which to write the packets
  63 @param maxlayers maximum number of layers
  64 @param dest the destination buffer
  65 @param len the length of the destination buffer
  66 @param image_info structure to create an index file
  67 */
  68 int t2_encode_packets(opj_t2_t* t2, int tileno, opj_tcd_tile_t *tile, int maxlayers, unsigned char *dest, int len, opj_image_info_t *image_info);
  69
  70 /**
  71 Decode the packets of a tile from a source buffer
  72 @param t2 T2 handle
  73 @param src the source buffer
  74 @param len length of the source buffer
  75 @param tileno number that identifies the tile for which to decode the packets
  76 @param tile tile for which to decode the packets
  77  */
  78 int t2_decode_packets(opj_t2_t *t2, unsigned char *src, int len, int tileno, opj_tcd_tile_t *tile);
  79
  80 /**
  81 Create a T2 handle
  82 @param cinfo Codec context info
  83 @param image Source or destination image
  84 @param cp Image coding parameters
  85 @return Returns a new T2 handle if successful, returns NULL otherwise
  86 */
  87 opj_t2_t* t2_create(opj_common_ptr cinfo, opj_image_t *image, opj_cp_t *cp);
  88 /**
  89 Destroy a T2 handle
  90 @param t2 T2 handle to destroy
  91 */
  92 void t2_destroy(opj_t2_t *t2);
  93
  94 /* ----------------------------------------------------------------------- */
  95 /*@}*/
  96
  97 /*@}*/
  98
  99 #endif /* __T2_H */