src/lib/openjpip/cachemodel_manager.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2014, 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     CACHEMODEL_MANAGER_H_
  32 # define    CACHEMODEL_MANAGER_H_
  33
  34 #include "target_manager.h"
  35
  36 /** Cache model parameters*/
  37 typedef struct cachemodel_param {
  38     target_param_t *target;        /**< reference pointer to the target*/
  39     OPJ_BOOL jppstream;                /**< return type, true: JPP-stream, false: JPT-stream*/
  40     OPJ_BOOL mhead_model;              /**< main header model, if sent, 1, else 0*/
  41     OPJ_BOOL *tp_model;                /**< dynamic array pointer of tile part model, if sent, 1, else 0*/
  42     OPJ_BOOL *th_model;                /**< dynamic array pointer of tile header model*/
  43     OPJ_BOOL **pp_model;               /**< dynamic array pointer of precint packet model*/
  44     struct cachemodel_param *next; /**< pointer to the next cache model*/
  45 } cachemodel_param_t;
  46
  47 /** Cache model list parameters*/
  48 typedef struct cachemodellist_param {
  49     cachemodel_param_t *first; /**< first cache model pointer of the list*/
  50     cachemodel_param_t *last;  /**< last  cache model pointer of the list*/
  51 } cachemodellist_param_t;
  52
  53
  54 /**
  55  * generate a cache model list
  56  *
  57  * @return pointer to the generated cache model list
  58  */
  59 cachemodellist_param_t * gene_cachemodellist(void);
  60
  61 /**
  62  * generate a cache model under a list
  63  *
  64  * @param[in] cachemodellist cachemodel list to insert the generated cache model, NULL for stateless
  65  * @param[in] target         pointer the reference target
  66  * @param[in] reqJPP         if JPP-stream is desired true, JPT-stream false
  67  * @return                   pointer to the generated cache model
  68  */
  69 cachemodel_param_t * gene_cachemodel(cachemodellist_param_t *cachemodellist,
  70                                      target_param_t *target, OPJ_BOOL reqJPP);
  71
  72
  73 /**
  74  * print cache model
  75  *
  76  * @param[in] cachemodel cache model
  77  */
  78 void print_cachemodel(cachemodel_param_t cachemodel);
  79
  80
  81 /**
  82  * search a cache model of a target
  83  *
  84  * @param[in] target         referring target
  85  * @param[in] cachemodellist cache model list
  86  * @return                   found cache model pointer
  87  */
  88 cachemodel_param_t * search_cachemodel(target_param_t *target,
  89                                        cachemodellist_param_t *cachemodellist);
  90
  91
  92 /**
  93  * check if all data has been sent
  94  *
  95  * @param[in] cachemodel cache model
  96  * @return               true if sent all, false otherwise
  97  */
  98 OPJ_BOOL is_allsent(cachemodel_param_t cachemodel);
  99
 100
 101 /**
 102  * delete a cache model
 103  *
 104  * @param[in] cachemodel     address of the cachemodel pointer
 105  */
 106 void delete_cachemodel(cachemodel_param_t **cachemodel);
 107
 108 /**
 109  * delete cachemodel list
 110  *
 111  * @param[in,out] cachemodellist address of the cachemodel list pointer
 112  */
 113 void delete_cachemodellist(cachemodellist_param_t **cachemodellist);
 114
 115
 116 #endif      /* !CACHEMODEL_MANAGER_H_ */