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