1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
// *****************************************************************************
/*
* Copyright (C) 2006-2008 Olivier Tilloy <olivier@tilloy.net>
*
* This file is part of the pyexiv2 distribution.
*
* pyexiv2 is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* pyexiv2 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with pyexiv2; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
*/
/*
File: libpyexiv2.hpp
Author(s): Olivier Tilloy <olivier@tilloy.net>
*/
// *****************************************************************************
#ifndef __libpyexiv2_wrapper__
#define __libpyexiv2_wrapper__
#include <string>
#include "exiv2/image.hpp"
#include "exiv2/exif.hpp"
#include "exiv2/iptc.hpp"
#include <boost/python.hpp>
namespace LibPyExiv2
{
class Image
{
public:
// Constructors
Image(std::string filename);
Image(const Image& image);
void readMetadata();
void writeMetadata();
// Read and write access to the EXIF tags.
// For a complete list of the available EXIF tags, see
// libexiv2's documentation (http://exiv2.org/tags.html).
// Return a list of all the keys of available EXIF tags set in the
// image.
boost::python::list exifKeys();
// Return a tuple containing the type (as a string) and the value
// (as a string as well) of the required EXIF tag.
// Throw an exception if the tag is not set.
boost::python::tuple getExifTag(std::string key);
// Return a human-readable string containing the value of the
// required EXIF tag.
// Throw an exception if the tag is not set.
std::string getExifTagToString(std::string key);
// Set the EXIF tag's value and return a tuple containing the
// type and previous value of the tag (an empty string for the value if
// not previously set). If the tag was not previously set, it is
// created.
boost::python::tuple setExifTag(std::string key, std::string value);
// Delete the required EXIF tag and return a tuple containing the
// type and previous value.
// Throw an exception if the tag was not set.
boost::python::tuple deleteExifTag(std::string key);
// Read and write access to the IPTC tags.
// For a complete list of the available IPTC tags, see
// libexiv2's documentation (http://exiv2.org/iptc.html).
// Returns a list of all the keys of available IPTC tags set in the
// image. This list has no duplicates: each of its items is unique,
// even if a tag is present more than once.
boost::python::list iptcKeys();
// Return a list of tuples, each containing the type (as a string) and
// the value (as a string as well) of the required IPTC tag.
// Throw an exception if the tag is not set.
boost::python::list getIptcTag(std::string key);
// Set the IPTC tag's value and return a tuple containing the
// type and previous value of the tag (an empty string for the value if
// not previously set). If the tag was not previously set, it is
// created. If the key references a repeatable tag, the parameter index
// (starting from 0 like a list index) is used to determine which of the
// repetitions is to be set. In case of an index greater than the
// highest existing one, adds a repetition of the tag.
boost::python::tuple setIptcTag(std::string key, std::string value, unsigned int index);
// Delete the required IPTC tag and return a tuple containing the
// type and previous value.
// If the key references a repeatable tag, the parameter index (starting
// from 0 like a list index) is used to determine which of the
// repetitions is to be deleted.
// Throw an exception if the tag was not set or if the index is greater
// than the highest existing one.
boost::python::tuple deleteIptcTag(std::string key, unsigned int index);
// Return a tuple containing the name of the tag and its description.
boost::python::tuple tagDetails(std::string key);
// Read and write access to the thumbnail embedded in the image.
// Return a tuple containing the format of the thumbnail ("TIFF" or
// "JPEG") and the thumbnail raw data as a string buffer.
// Throw an exception if the thumbnail data cannot be accessed.
boost::python::tuple getThumbnailData();
// Set the thumbnail of the image. The parameter is the thumbnail raw
// jpeg data as a string buffer.
void setThumbnailData(std::string data);
// Delete the thumbnail embedded in the image.
void deleteThumbnail();
// Write the thumbnail to an image file.
// A filename extension is appended to the given path according to the
// image type of the thumbnail, so it should not include an extension.
// Throw an exception if the image does not contain a thumbnail.
void dumpThumbnailToFile(const std::string path);
// Set the image contained in the jpeg file passed as a parameter as
// the thumbnail of the image.
void setThumbnailFromJpegFile(const std::string path);
// Read and write access to the JPEG comment embedded in the image.
// Get the JPEG comment contained in the image as a string.
const std::string getComment() const;
// Set the JPEG comment of the image.
void setComment(const std::string& comment);
// Clear the JPEG comment of the image (set it to an empty string).
void clearComment();
private:
std::string _filename;
Exiv2::Image::AutoPtr _image;
Exiv2::ExifData _exifData;
Exiv2::IptcData _iptcData;
// true if the image's internal metadata has already been read,
// false otherwise
bool _dataRead;
};
// Translate an Exiv2 generic exception into a Python exception
void translateExiv2Error(Exiv2::Error const& e);
} // End of namespace LibPyExiv2
#endif
|
