Cosmetic changes in fsdk_define.h
[pdfium.git] / third_party / libopenjpeg20 / image.h
1 /*
2  * The copyright in this software is being made available under the 2-clauses 
3  * BSD License, included below. This software may be subject to other third 
4  * party and contributor rights, including patent rights, and no such rights
5  * are granted under this license.
6  *
7  * Copyright (c) 2005, Herve Drolon, FreeImage Team
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #ifndef __IMAGE_H
32 #define __IMAGE_H
33 /**
34 @file image.h
35 @brief Implementation of operations on images (IMAGE)
36
37 The functions in IMAGE.C have for goal to realize operations on images.
38 */
39
40 struct opj_image;
41 struct opj_cp;
42
43 /** @defgroup IMAGE IMAGE - Implementation of operations on images */
44 /*@{*/
45
46 /**
47  * Create an empty image
48  *
49  * @return returns an empty image if successful, returns NULL otherwise
50  */
51 opj_image_t* opj_image_create0(void);
52
53
54
55 /**
56  * Updates the components characteristics of the image from the coding parameters.
57  *
58  * @param p_image_header                the image header to update.
59  * @param p_cp                                  the coding parameters from which to update the image.
60  */
61 void opj_image_comp_header_update(opj_image_t * p_image, const struct opj_cp* p_cp);
62
63 void opj_copy_image_header(const opj_image_t* p_image_src, opj_image_t* p_image_dest);
64
65 /*@}*/
66
67 #endif /* __IMAGE_H */
68