src/lib/openjpip/cache_manager.h

   1 /*
   2  * $Id: cache_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         CACHE_MANAGER_H_
  32 # define        CACHE_MANAGER_H_
  33
  34 #include "metadata_manager.h"
  35 #include "ihdrbox_manager.h"
  36
  37 /** cache parameters*/
  38 typedef struct cache_param{
  39   char *filename;                     /**< file name*/
  40   char *tid;                          /**< taregt identifier*/
  41   int csn;                            /**< codestream number*/
  42   char **cid;                         /**< dynamic array of channel identifiers*/
  43   int numOfcid;                       /**< number of cids*/
  44   metadatalist_param_t *metadatalist; /**< metadata-bin list*/
  45   ihdrbox_param_t *ihdrbox;           /**< ihdrbox*/
  46   struct cache_param *next;           /**< pointer to the next cache*/
  47 } cache_param_t;
  48
  49 /**< cache list parameters*/
  50 typedef struct cachelist_param{
  51   cache_param_t *first; /**< first cache pointer of the list*/
  52   cache_param_t *last;  /**< last  cache pointer of the list*/
  53 } cachelist_param_t;
  54
  55
  56 /**
  57  * generate a cache list
  58  *
  59  * @return pointer to the generated cache list
  60  */
  61 cachelist_param_t * gene_cachelist(void);
  62
  63 /**
  64  * delete cache list
  65  *
  66  * @param[in,out] cachelist address of the cache list pointer
  67  */
  68 void delete_cachelist(cachelist_param_t **cachelist);
  69
  70 /**
  71  * generate a cache
  72  *
  73  * @param[in] targetname target file name
  74  * @param[in] csn        codestream number
  75  * @param[in] tid        target identifier
  76  * @param[in] cid        channel identifier
  77  * @return               pointer to the generated cache
  78  */
  79 cache_param_t * gene_cache( const char *targetname, int csn, char *tid, char *cid);
  80
  81 /**
  82  * delete a cache
  83  *
  84  * @param[in] cache address of the cache pointer
  85  */
  86 void delete_cache( cache_param_t **cache);
  87
  88 /**
  89  * insert a cache into list
  90  *
  91  * @param[in] cache     cache pointer
  92  * @param[in] cachelist cache list pointer
  93  */
  94 void insert_cache_into_list( cache_param_t *cache, cachelist_param_t *cachelist);
  95
  96
  97 /**
  98  * search a cache by target name
  99  *
 100  * @param[in] targetname target filename
 101  * @param[in] cachelist  cache list pointer
 102  * @return               found cache pointer
 103  */
 104 cache_param_t * search_cache( const char targetname[], cachelist_param_t *cachelist);
 105
 106
 107 /**
 108  * search a cache by csn
 109  *
 110  * @param[in] csn        codestream number
 111  * @param[in] cachelist  cache list pointer
 112  * @return               found cache pointer
 113  */
 114 cache_param_t * search_cacheBycsn( int csn, cachelist_param_t *cachelist);
 115
 116
 117 /**
 118  * search a cache by cid
 119  *
 120  * @param[in] cid        channel identifer
 121  * @param[in] cachelist  cache list pointer
 122  * @return               found cache pointer
 123  */
 124 cache_param_t * search_cacheBycid( const char cid[], cachelist_param_t *cachelist);
 125
 126
 127 /**
 128  * search a cache by tid
 129  *
 130  * @param[in] tid        target identifer
 131  * @param[in] cachelist  cache list pointer
 132  * @return               found cache pointer
 133  */
 134 cache_param_t * search_cacheBytid( const char tid[], cachelist_param_t *cachelist);
 135
 136 /**
 137  * add cid into a cache
 138  *
 139  * @param[in] cid   channel identifier
 140  * @param[in] cache cache pointer
 141  */
 142 void add_cachecid( const char *cid, cache_param_t *cache);
 143
 144
 145 /**
 146  * update tid of a cache
 147  *
 148  * @param[in] tid   target identifier
 149  * @param[in] cache cache pointer
 150  */
 151 void update_cachetid( const char *tid, cache_param_t *cache);
 152
 153
 154 /**
 155  * remove cid in cache
 156  *
 157  * @param[in] cid       channel identifier
 158  * @param[in] cachelist cachelist pointer
 159  */
 160 void remove_cachecid( const char *cid, cachelist_param_t *cachelist);
 161
 162
 163 /**
 164  * print cache parameters
 165  *
 166  * @param[in] cache cache pointer
 167  */
 168 void print_cache( cache_param_t *cache);
 169
 170 /**
 171  * print all cache parameters
 172  *
 173  * @param[in] cachelist cache list pointer
 174  */
 175 void print_allcache( cachelist_param_t *cachelist);
 176
 177 #endif /* !CACHE_MANAGER_H_ */