Improvements and fixes to Cycles metadata
[blender.git] / source / blender / imbuf / intern / metadata.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2005 Blender Foundation
17  * All rights reserved.
18  */
19
20 /** \file \ingroup imbuf
21  */
22
23
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "BLI_utildefines.h"
28 #include "BLI_string.h"
29
30 #include "BKE_idprop.h"
31
32 #include "MEM_guardedalloc.h"
33
34 #include "IMB_imbuf_types.h"
35 #include "IMB_imbuf.h"
36
37 #include "IMB_metadata.h"
38
39 #define METADATA_MAX_VALUE_LENGTH 1024
40
41
42 void IMB_metadata_ensure(struct IDProperty **metadata)
43 {
44         if (*metadata != NULL) {
45                 return;
46         }
47
48         IDPropertyTemplate val;
49         *metadata = IDP_New(IDP_GROUP, &val, "metadata");
50 }
51
52 void IMB_metadata_free(struct IDProperty *metadata)
53 {
54         if (metadata == NULL) {
55                 return;
56         }
57
58         IDP_FreeProperty(metadata);
59         MEM_freeN(metadata);
60 }
61
62 bool IMB_metadata_get_field(struct IDProperty *metadata, const char *key, char *field, const size_t len)
63 {
64         IDProperty *prop;
65
66         if (metadata == NULL) {
67                 return false;
68         }
69
70         prop = IDP_GetPropertyFromGroup(metadata, key);
71
72         if (prop && prop->type == IDP_STRING) {
73                 BLI_strncpy(field, IDP_String(prop), len);
74                 return true;
75         }
76         return false;
77 }
78
79 void IMB_metadata_copy(struct ImBuf *dimb, struct ImBuf *simb)
80 {
81         BLI_assert(dimb != simb);
82         if (simb->metadata) {
83                 IMB_metadata_free(dimb->metadata);
84                 dimb->metadata = IDP_CopyProperty(simb->metadata);
85         }
86 }
87
88 void IMB_metadata_set_field(struct IDProperty *metadata, const char *key, const char *value)
89 {
90         BLI_assert(metadata);
91         IDProperty *prop = IDP_GetPropertyFromGroup(metadata, key);
92
93         if (prop != NULL && prop->type != IDP_STRING) {
94                 IDP_FreeFromGroup(metadata, prop);
95                 prop = NULL;
96         }
97
98         if (prop == NULL) {
99                 prop = IDP_NewString(value, key, METADATA_MAX_VALUE_LENGTH);
100                 IDP_AddToGroup(metadata, prop);
101         }
102
103         IDP_AssignString(prop, value, METADATA_MAX_VALUE_LENGTH);
104 }
105
106 void IMB_metadata_foreach(struct ImBuf *ibuf, IMBMetadataForeachCb callback, void *userdata)
107 {
108         for (IDProperty *prop = ibuf->metadata->data.group.first; prop != NULL; prop = prop->next) {
109                 callback(prop->name, IDP_String(prop), userdata);
110         }
111 }