src/lib/openjpip/manfbox_manager.h

   1 /*
   2  * $Id: manfbox_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         MANFBOX_MANAGER_H_
  32 # define        MANFBOX_MANAGER_H_
  33
  34 #include "byte_manager.h"
  35 #include "box_manager.h"
  36 #include "boxheader_manager.h"
  37
  38
  39 /** manifest box parameters*/
  40 /** I.3.2.3 Manifest box*/
  41 typedef struct manfbox_param{
  42   boxheader_param_t *first; /**< top of the box header list*/
  43 } manfbox_param_t;
  44
  45
  46 /**
  47  * generate manifest box
  48  *
  49  * @param[in] box pointer to the reference manf box
  50  * @return        generated manfbox
  51  */
  52 manfbox_param_t * gene_manfbox( box_param_t *box);
  53
  54
  55 /**
  56  * delete manifest box
  57  *
  58  * @param[in,out] manf addressof the manfbox pointer
  59  */
  60 void delete_manfbox( manfbox_param_t **manf);
  61
  62
  63 /**
  64  * print manf box parameters
  65  *
  66  * @param[in] manf manf box pointer
  67  */
  68 void print_manfbox( manfbox_param_t *manf);
  69
  70
  71 /**
  72  * search a boxheader by box type from manifest box
  73  *
  74  * @param[in]     type box type
  75  * @param[in]     manf manf box pointer
  76  * @return             found box pointer
  77  */
  78 boxheader_param_t * search_boxheader( const char type[], manfbox_param_t *manf);
  79
  80
  81 #endif      /* !MANFBOX_MANAGER_H_ */