src/lib/openjpip/boxheader_manager.h

   1 /*
   2  * $Id: boxheader_manager.h 44 2011-02-15 12:32:29Z kaori $
   3  *
   4  * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2011, Professor Benoit Macq
   6  * Copyright (c) 2010-2011, Kaori Hagihara
   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         BOXHEADER_MANAGER_H_
  32 # define        BOXHEADER_MANAGER_H_
  33
  34 #include "byte_manager.h"
  35 #include "box_manager.h"
  36
  37 /** box header parameters*/
  38 typedef struct boxheader_param{
  39   Byte_t  headlen;              /**< header length  8 or 16*/
  40   Byte8_t length;               /**< length of the reference Box*/
  41   char    type[4];              /**< type of information in the DBox*/
  42   struct boxheader_param *next; /**< pointer to the next header box*/
  43 } boxheader_param_t;
  44
  45
  46 /**
  47  * generate a box header at the given offset
  48  *
  49  * @param[in] fd     file discriptor of the JP2 file
  50  * @param[in] offset Box offset
  51  * @return           pointer to the structure of generate box header parameters
  52  */
  53 boxheader_param_t * gene_boxheader( int fd, OPJ_OFF_T offset);
  54
  55 /**
  56  * generate a child box header at the given offset
  57  *
  58  * @param[in] superbox super box pointer
  59  * @param[in] offset   offset from DBox first byte of superbox
  60  * @return             pointer to the structure of generate box header parameters
  61  */
  62 boxheader_param_t * gene_childboxheader( box_param_t *superbox, OPJ_OFF_T offset);
  63
  64 /**
  65  * print box header parameters
  66  *
  67  * @param[in] boxheader boxheader pointer
  68  */
  69 void print_boxheader( boxheader_param_t *boxheader);
  70
  71 #endif      /* !BOXHEADER_MANAGER_H_ */