src/lib/openjpip/msgqueue_manager.h

   1 /*
   2  * $Id$
   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  * Copyright (c) 2011,      Lucian Corlaciu, GSoC
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef         MSGQUEUE_MANAGER_H_
  33 # define        MSGQUEUE_MANAGER_H_
  34
  35 #include "byte_manager.h"
  36 #include "cachemodel_manager.h"
  37 #include "placeholder_manager.h"
  38
  39 #define PRECINCT_MSG 0
  40 #define EXT_PRECINCT_MSG 1
  41 #define TILE_HEADER_MSG 2
  42 #define TILE_MSG 4
  43 #define EXT_TILE_MSG 5
  44 #define MAINHEADER_MSG 6
  45 #define METADATA_MSG 8
  46
  47 /** message parameters */
  48 typedef struct message_param{
  49   opj_bool    last_byte;          /**< if message contains the last byte of the data-bin*/
  50   Byte8_t in_class_id;        /**< in-class identifier A.2.3*/
  51   Byte8_t class_id;           /**< class identifiers */
  52   Byte8_t csn;                /**< index of the codestream*/
  53   Byte8_t bin_offset;         /**< offset of the data in this message from the start of the data-bin*/
  54   Byte8_t length;             /**< message byte length*/
  55   Byte8_t aux;                /**<*/
  56   OPJ_OFF_T res_offset;         /**< offset in the resource*/
  57   placeholder_param_t *phld;  /**< placeholder pointer in index*/
  58   struct message_param *next; /**< pointer to the next message*/
  59 } message_param_t;
  60
  61 /** message queue parameters */
  62 typedef struct msgqueue_param{
  63   message_param_t *first;         /**< first message pointer of the list*/
  64   message_param_t *last;          /**< last  message pointer of the list*/
  65   opj_bool stateless;                 /**< if this is a stateless message queue*/
  66   cachemodel_param_t *cachemodel; /**< reference cachemodel pointer*/
  67 } msgqueue_param_t;
  68
  69 /**
  70  * generate message queue
  71  *
  72  * @param[in] stateless   if this is a stateless message queue
  73  * @param[in] cachemodel  cachemodel pointer
  74  * @return                generated message queue pointer
  75  */
  76 msgqueue_param_t * gene_msgqueue( opj_bool stateless, cachemodel_param_t *cachemodel);
  77
  78 /**
  79  * delete message queue
  80  *
  81  * @param[in] msgqueue address of the message queue pointer
  82  */
  83 void delete_msgqueue( msgqueue_param_t **msgqueue);
  84
  85 /**
  86  * delete a message in msgqueue
  87  *
  88  * @param[in] message  address of the deleting message pointer
  89  * @param[in] msgqueue message queue pointer
  90  */
  91 void delete_message_in_msgqueue( message_param_t **message, msgqueue_param_t *msgqueue);
  92
  93 /**
  94  * print message queue
  95  *
  96  * @param[in] msgqueue message queue pointer
  97  */
  98 void print_msgqueue( msgqueue_param_t *msgqueue);
  99
 100
 101 /**
 102  * enqueue main header data-bin into message queue
 103  *
 104  * @param[in,out] msgqueue message queue pointer
 105  */
 106 void enqueue_mainheader( msgqueue_param_t *msgqueue);
 107
 108 /**
 109  * enqueue tile headers data-bin into message queue
 110  *
 111  * @param[in]     tile_id  tile id starting from 0
 112  * @param[in,out] msgqueue message queue pointer
 113  */
 114 void enqueue_tileheader( int tile_id, msgqueue_param_t *msgqueue);
 115
 116 /**
 117  * enqueue tile data-bin into message queue
 118  *
 119  * @param[in]     tile_id  tile id starting from 0
 120  * @param[in]     level    decomposition level
 121  * @param[in,out] msgqueue message queue pointer
 122  */
 123 void enqueue_tile( Byte4_t tile_id, int level, msgqueue_param_t *msgqueue);
 124
 125 /**
 126  * enqueue precinct data-bin into message queue
 127  *
 128  * @param[in]     seq_id   precinct sequence number within its tile
 129  * @param[in]     tile_id  tile index
 130  * @param[in]     comp_id  component number
 131  * @param[in]     layers   num of layers
 132  * @param[in,out] msgqueue message queue
 133  */
 134 void enqueue_precinct( int seq_id, int tile_id, int comp_id, int layers, msgqueue_param_t *msgqueue);
 135
 136
 137 /**
 138  * enqueue Metadata-bin into message queue
 139  *
 140  * @param[in]     meta_id  metadata-bin id
 141  * @param[in,out] msgqueue message queue pointer
 142  */
 143 void enqueue_metadata( Byte8_t meta_id, msgqueue_param_t *msgqueue);
 144
 145
 146 /**
 147  * reconstruct JPT/JPP-stream from message queue
 148  *
 149  * @param[in] msgqueue message queue pointer
 150  * @param[in] tmpfd    file discriptor to write JPT/JPP-stream
 151  */
 152 void recons_stream_from_msgqueue( msgqueue_param_t *msgqueue, int tmpfd);
 153
 154
 155 /**
 156  * parse JPT- JPP- stream to message queue
 157  *
 158  * @param[in]     JPIPstream   JPT- JPP- stream data pointer
 159  * @param[in]     streamlen    JPIPstream length
 160  * @param[in]     offset       offset of the stream from the whole beginning
 161  * @param[in,out] msgqueue     adding message queue pointer
 162  */
 163 void parse_JPIPstream( Byte_t *JPIPstream, Byte8_t streamlen, OPJ_OFF_T offset, msgqueue_param_t *msgqueue);
 164
 165 /**
 166  * parse JPT- JPP- stream to message queue
 167  *
 168  * @param[in] msgqueue     reference message queue pointer
 169  * @param[in] stream       stream data pointer
 170  * @param[in] streamlen    stream length
 171  * @param[in] metadatalist adding metadata list pointer
 172  */
 173 void parse_metamsg( msgqueue_param_t *msgqueue, Byte_t *stream, Byte8_t streamlen, metadatalist_param_t *metadatalist);
 174
 175 /**
 176  * compute precinct ID A.3.2.1
 177  *
 178  * @param[in]  t                 tile index
 179  * @param[in]  c                 component index
 180  * @param[in]  s                 sequence number
 181  * @param[in]  num_components    total number of components
 182  * @param[in]  num_tiles         total number of tiles
 183  * @return                       precicnt id
 184  */
 185 Byte8_t comp_precinct_id( int t, int c, int s, int num_components, int num_tiles);
 186
 187 #endif      /* !MSGQUEUE_MANAGER_H_ */