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
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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.
31 #ifndef CACHE_MANAGER_H_
32 # define CACHE_MANAGER_H_
34 #include "metadata_manager.h"
35 #include "ihdrbox_manager.h"
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*/
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*/
57 * generate a cache list
59 * @return pointer to the generated cache list
61 cachelist_param_t * gene_cachelist(void);
66 * @param[in,out] cachelist address of the cache list pointer
68 void delete_cachelist(cachelist_param_t **cachelist);
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
79 cache_param_t * gene_cache(const char *targetname, int csn, char *tid,
85 * @param[in] cache address of the cache pointer
87 void delete_cache(cache_param_t **cache);
90 * insert a cache into list
92 * @param[in] cache cache pointer
93 * @param[in] cachelist cache list pointer
95 void insert_cache_into_list(cache_param_t *cache, cachelist_param_t *cachelist);
99 * search a cache by target name
101 * @param[in] targetname target filename
102 * @param[in] cachelist cache list pointer
103 * @return found cache pointer
105 cache_param_t * search_cache(const char targetname[],
106 cachelist_param_t *cachelist);
110 * search a cache by csn
112 * @param[in] csn codestream number
113 * @param[in] cachelist cache list pointer
114 * @return found cache pointer
116 cache_param_t * search_cacheBycsn(int csn, cachelist_param_t *cachelist);
120 * search a cache by cid
122 * @param[in] cid channel identifer
123 * @param[in] cachelist cache list pointer
124 * @return found cache pointer
126 cache_param_t * search_cacheBycid(const char cid[],
127 cachelist_param_t *cachelist);
131 * search a cache by tid
133 * @param[in] tid target identifer
134 * @param[in] cachelist cache list pointer
135 * @return found cache pointer
137 cache_param_t * search_cacheBytid(const char tid[],
138 cachelist_param_t *cachelist);
141 * add cid into a cache
143 * @param[in] cid channel identifier
144 * @param[in] cache cache pointer
146 void add_cachecid(const char *cid, cache_param_t *cache);
150 * update tid of a cache
152 * @param[in] tid target identifier
153 * @param[in] cache cache pointer
155 void update_cachetid(const char *tid, cache_param_t *cache);
159 * remove cid in cache
161 * @param[in] cid channel identifier
162 * @param[in] cachelist cachelist pointer
164 void remove_cachecid(const char *cid, cachelist_param_t *cachelist);
168 * print cache parameters
170 * @param[in] cache cache pointer
172 void print_cache(cache_param_t *cache);
175 * print all cache parameters
177 * @param[in] cachelist cache list pointer
179 void print_allcache(cachelist_param_t *cachelist);
181 #endif /* !CACHE_MANAGER_H_ */