doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / imbuf / intern / IMB_metadata.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2005 Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Austin Benesh. Ton Roosendaal.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef _IMB_IMGINFO_H
31 #define _IMB_IMGINFO_H
32
33 struct ImBuf;
34
35 typedef struct ImMetaData {
36         struct ImMetaData *next, *prev;
37         char* key;
38         char* value;
39         int len;
40 } ImMetaData;
41
42 /** The metadata is a list of key/value pairs (both char*) that can me 
43         saved in the header of several image formats.
44         Apart from some common keys like 
45         'Software' and 'Description' (png standard) we'll use keys within the 
46         Blender namespace, so should be called 'Blender::StampInfo' or 'Blender::FrameNum'
47         etc... 
48 */
49
50
51 /* free blender ImMetaData struct */
52 void IMB_metadata_free(struct ImBuf* img);
53
54 /** read the field from the image info into the field 
55  *  @param img - the ImBuf that contains the image data
56  *  @param key - the key of the field
57  *  @param value - the data in the field, first one found with key is returned, 
58                                   memory has to be allocated by user.
59  *  @param len - length of value buffer allocated by user.
60  *  @return    - 1 (true) if ImageInfo present and value for the key found, 0 (false) otherwise
61  */
62 int IMB_metadata_get_field(struct ImBuf* img, const char* key, char* value, int len);
63
64 /** set user data in the ImMetaData struct, which has to be allocated with IMB_metadata_create
65  *  before calling this function.
66  *  @param img - the ImBuf that contains the image data
67  *  @param key - the key of the field
68  *  @param value - the data to be written to the field. zero terminated string
69  *  @return    - 1 (true) if ImageInfo present, 0 (false) otherwise
70  */
71 int IMB_metadata_add_field(struct ImBuf* img, const char* key, const char* field);
72
73 /** delete the key/field par in the ImMetaData struct.
74  * @param img - the ImBuf that contains the image data
75  * @param key - the key of the field
76  * @return - 1 (true) if delete the key/field, 0 (false) otherwise
77  */
78 int IMB_metadata_del_field(struct ImBuf *img, const char *key);
79
80 #endif /* _IMB_IMGINFO_H */