libopenjpeg/image.h

   1 /*
   2  * Copyright (c) 2005, Herv� Drolon, FreeImage Team
   3  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 #ifndef __IMAGE_H
  28 #define __IMAGE_H
  29 /**
  30 @file image.h
  31 @brief Implementation of operations on images (IMAGE)
  32
  33 The functions in IMAGE.C have for goal to realize operations on images.
  34 */
  35 struct opj_image;
  36 struct opj_cp;
  37 /** @defgroup IMAGE IMAGE - Implementation of operations on images */
  38 /*@{*/
  39
  40 /**
  41 Create an empty image
  42 @todo this function should be removed
  43 @return returns an empty image if successful, returns NULL otherwise
  44 */
  45 struct opj_image* opj_image_create0(void);
  46
  47 /**
  48  * Updates the components of the image from the coding parameters.
  49  *
  50  * @param p_image               the image to update.
  51  * @param p_cp                  the coding parameters from which to update the image.
  52  */
  53 void opj_image_comp_update(struct opj_image * p_image,const struct opj_cp * p_cp);
  54
  55 /*@}*/
  56
  57 #endif /* __IMAGE_H */
  58