libopenjpeg/jpt.h

   1 /*
   2  * Copyright (c) 2004, Yannick Verschueren
   3  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   4  * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __JPT_H
  30 #define __JPT_H
  31 /**
  32 @file jpt.h
  33 @brief JPT-stream reader (JPEG 2000, JPIP)
  34
  35 JPT-stream functions are implemented in J2K.C.
  36 */
  37
  38 /**
  39 Message Header JPT stream structure
  40 */
  41 typedef struct opj_jpt_msg_header {
  42   /** In-class Identifier */
  43   unsigned int Id;
  44   /** Last byte information */
  45   unsigned int last_byte;
  46   /** Class Identifier */
  47   unsigned int Class_Id;
  48   /** CSn : index identifier */
  49   unsigned int CSn_Id;
  50   /** Message offset */
  51   unsigned int Msg_offset;
  52   /** Message length */
  53   unsigned int Msg_length;
  54   /** Auxiliary for JPP case */
  55   unsigned int Layer_nb;
  56 } opj_jpt_msg_header_t;
  57
  58 /* ----------------------------------------------------------------------- */
  59
  60 /**
  61 Initialize the value of the message header structure
  62 @param header Message header structure
  63 */
  64 void jpt_init_msg_header(opj_jpt_msg_header_t * header);
  65
  66 /**
  67 Read the message header for a JPP/JPT - stream
  68 @param cinfo Codec context info
  69 @param cio CIO handle
  70 @param header Message header structure
  71 */
  72 void jpt_read_msg_header(opj_common_ptr cinfo, opj_cio_t *cio, opj_jpt_msg_header_t *header);
  73
  74 #endif