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
  31 #ifndef __T2_H
  32 #define __T2_H
  33 /**
  34 @file t2.h
  35 @brief Implementation of a tier-2 coding (packetization of code-block data) (T2)
  36
  37 */
  38
  39 /** @defgroup T2 T2 - Implementation of a tier-2 coding */
  40 /*@{*/
  41
  42 /**
  43 Tier-2 coding
  44 */
  45 typedef struct opj_t2 {
  46   /** codec context */
  47   opj_common_ptr cinfo;
  48
  49   /** Encoding: pointer to the src image. Decoding: pointer to the dst image. */
  50   opj_image_t *image;
  51   /** pointer to the image coding parameters */
  52   opj_cp_t *cp;
  53 } opj_t2_t;
  54
  55 /** @name Local static functions */
  56 /*@{*/
  57 /* ----------------------------------------------------------------------- */
  58
  59 static void t2_putcommacode(opj_bio_t *bio, int n);
  60 static int t2_getcommacode(opj_bio_t *bio);
  61 /**
  62 Variable length code for signalling delta Zil (truncation point)
  63 @param bio Bit Input/Output component
  64 @param n delta Zil
  65 */
  66 static void t2_putnumpasses(opj_bio_t *bio, int n);
  67 static int t2_getnumpasses(opj_bio_t *bio);
  68 /**
  69 Encode a packet of a tile to a destination buffer
  70 @param t2 T2 handle
  71 @param tile Tile for which to write the packets
  72 @param tcp Tile coding parameters
  73 @param pi Packet identity
  74 @param dest Destination buffer
  75 @param len Length of the destination buffer
  76 @param image_info Structure to create an index file
  77 @param tileno Number of the tile encoded
  78 @return
  79 */
  80 static int t2_encode_packet(opj_t2_t* t2, opj_tcd_tile_t *tile, opj_tcp_t *tcp, opj_pi_iterator_t *pi, unsigned char *dest, int len, opj_image_info_t *image_info, int tileno);
  81 /**
  82 @param seg
  83 @param cblksty
  84 @param first
  85 */
  86 static void t2_init_seg(opj_tcd_seg_t *seg, int cblksty, int first);
  87 /**
  88 Decode a packet of a tile from a source buffer
  89 @param t2 T2 handle
  90 @param src Source buffer
  91 @param len Length of the source buffer
  92 @param tile Tile for which to write the packets
  93 @param tcp Tile coding parameters
  94 @param pi Packet identity
  95 @return
  96 */
  97 int t2_decode_packet(opj_t2_t* t2, unsigned char *src, int len, opj_tcd_tile_t *tile, opj_tcp_t *tcp, opj_pi_iterator_t *pi);
  98
  99 /* ----------------------------------------------------------------------- */
 100 /*@}*/
 101
 102 /** @name Exported functions */
 103 /*@{*/
 104 /* ----------------------------------------------------------------------- */
 105
 106 /**
 107 Encode the packets of a tile to a destination buffer
 108 @param t2 T2 handle
 109 @param tileno number of the tile encoded
 110 @param tile the tile for which to write the packets
 111 @param maxlayers maximum number of layers
 112 @param dest the destination buffer
 113 @param len the length of the destination buffer
 114 @param image_info structure to create an index file
 115 */
 116 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);
 117
 118 /**
 119 Decode the packets of a tile from a source buffer
 120 @param t2 T2 handle
 121 @param src the source buffer
 122 @param len length of the source buffer
 123 @param tileno number that identifies the tile for which to decode the packets
 124 @param tile tile for which to decode the packets
 125  */
 126 int t2_decode_packets(opj_t2_t *t2, unsigned char *src, int len, int tileno, opj_tcd_tile_t *tile);
 127
 128 /**
 129 Create a T2 handle
 130 @param cinfo Codec context info
 131 @param image Source or destination image
 132 @param cp Image coding parameters
 133 @return Returns a new T2 handle if successful, returns NULL otherwise
 134 */
 135 opj_t2_t* t2_create(opj_common_ptr cinfo, opj_image_t *image, opj_cp_t *cp);
 136 /**
 137 Destroy a T2 handle
 138 @param t2 T2 handle to destroy
 139 */
 140 void t2_destroy(opj_t2_t *t2);
 141
 142 /* ----------------------------------------------------------------------- */
 143 /*@}*/
 144
 145 /*@}*/
 146
 147 #endif /* __T2_H */