applications/jpip/libopenjpip/target_manager.h

   1 /*
   2  * $Id: target_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         TARGET_MANAGER_H_
  32 # define        TARGET_MANAGER_H_
  33
  34 #include "bool.h"
  35 #include "index_manager.h"
  36
  37 //! maximum length of target identifier
  38 #define MAX_LENOFTID 30
  39
  40 //! target parameters
  41 typedef struct target_param{
  42   char tid[MAX_LENOFTID];         //!< taregt identifier
  43   char *filename;                 //!< file name
  44   int fd;                         //!< file descriptor
  45   int csn;                        //!< codestream number
  46   index_param_t *codeidx;         //!< index information of codestream
  47   int num_of_use;                 //!< numbers of sessions refering to this target
  48   bool jppstream;                 //!< if this target can return JPP-stream
  49   bool jptstream;                 //!< if this target can return JPP-stream
  50   struct target_param *next;      //!< pointer to the next target
  51 } target_param_t;
  52
  53
  54 //! Target list parameters
  55 typedef struct targetlist_param{
  56   target_param_t *first; //!< first target pointer of the list
  57   target_param_t *last;  //!< last  target pointer of the list
  58 } targetlist_param_t;
  59
  60
  61
  62 /**
  63  * generate a target list
  64  *
  65  * @return pointer to the generated target list
  66  */
  67 targetlist_param_t * gene_targetlist();
  68
  69
  70 /**
  71  * generate a target
  72  *
  73  * @param[in] targetlist target list to insert the generated target
  74  * @param[in] targetpath file path or URL of the target
  75  * @return               pointer to the generated target
  76  */
  77 target_param_t * gene_target( targetlist_param_t *targetlist, char *targetpath);
  78
  79
  80 /**
  81  * refer a target, used to make a new cache model
  82  *
  83  * @param[in]  reftarget reference target pointer
  84  * @param[out] ptr       address of feeding target pointer
  85  */
  86 void refer_target( target_param_t *reftarget, target_param_t **ptr);
  87
  88
  89 /**
  90  * refer a target, used to make a new cache model
  91  *
  92  * @param[in]  target reference pointer to the target
  93  */
  94 void unrefer_target( target_param_t *target);
  95
  96 /**
  97  * delete a target
  98  *
  99  * @param[in,out] target address of the deleting target pointer
 100  */
 101 void delete_target( target_param_t **target);
 102
 103
 104 /**
 105  * delete a target in list
 106  *
 107  * @param[in,out] target     address of the deleting target pointer
 108  * @param[in] targetlist target list pointer
 109  */
 110 void delete_target_in_list( target_param_t **target, targetlist_param_t *targetlist);
 111
 112
 113 /**
 114  * delete target list
 115  *
 116  * @param[in,out] targetlist address of the target list pointer
 117  */
 118 void delete_targetlist(targetlist_param_t **targetlist);
 119
 120
 121 /**
 122  * print target parameters
 123  *
 124  * @param[in] target target pointer
 125  */
 126 void print_target( target_param_t *target);
 127
 128 /**
 129  * print all target parameters
 130  *
 131  * @param[in] targetlist target list pointer
 132  */
 133 void print_alltarget( targetlist_param_t *targetlist);
 134
 135
 136 /**
 137  * search a target by filename
 138  *
 139  * @param[in] targetname target filename
 140  * @param[in] targetlist target list pointer
 141  * @return               found target pointer
 142  */
 143 target_param_t * search_target( char targetname[], targetlist_param_t *targetlist);
 144
 145
 146 /**
 147  * search a target by tid
 148  *
 149  * @param[in] tid        target identifier
 150  * @param[in] targetlist target list pointer
 151  * @return               found target pointer
 152  */
 153 target_param_t * search_targetBytid( char tid[], targetlist_param_t *targetlist);
 154
 155 #endif      /* !TARGET_MANAGER_H_ */
 156