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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
########################################################################
##
## Copyright (C) 2008-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave 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 3 of the License, or
## (at your option) any later version.
##
## Octave 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 Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## This function does all the work of imwrite. It exists here as private
## function so that imwrite can use other functions if imformats is
## configured to. It is also needed so that imformats can create a
## function handle for it.
function __imwrite__ (img, varargin)
if (nargin < 2 || ! (isnumeric (img) || islogical (img)))
print_usage ("imwrite");
endif
[filename, ext, map, param_list] = imwrite_filename (varargin{:});
if (isempty (img))
error ("imwrite: invalid empty image");
elseif (issparse (img) || issparse (map))
error ("imwrite: sparse images are not supported");
endif
if (rem (numel (param_list), 2) != 0)
error ("imwrite: no pair for all arguments (odd number left)");
endif
## set default for options
options = struct ("writemode", "overwrite",
"disposalmethod", {repmat({"doNotSpecify"}, 1, size (img, 4))},
"quality", 75,
"delaytime", ones (1, size (img, 4)) *500, # 0.5 seconds
"loopcount", 0, ## this is actually Inf
"alpha", cast ([], class (img)),
"compression", "none");
for idx = 1:2:numel (param_list)
switch (lower (param_list{idx}))
case "alpha"
options.alpha = param_list{idx+1};
if (! isnumeric (options.alpha))
error ("imwrite: value for %s option must be a numeric matrix",
param_list{idx});
elseif (size (options.alpha, 3) != 1)
error ("imwrite: 3rd dimension of matrix for %s must be singleton",
param_list{idx});
elseif (ndims (options.alpha) > 4
|| any (size (options.alpha)([1 2]) != size (img)([1 2]))
|| size (options.alpha, 4) != size (img, 4))
error ("imwrite: matrix for %s must have same dimension as image",
param_list{idx});
endif
case "compression"
options.compression = param_list{idx+1};
if (! ischar (options.compression))
error ("imwrite: value for %s option must be a string",
param_list{idx});
endif
options.compression = lower (options.compression);
if (! any (strcmp (options.compression, {"none", "bzip", "fax3", ...
"fax4", "jpeg", "lzw", ...
"rle", "deflate"})))
error ("imwrite: invalid compression '%s'", options.compression);
endif
case "delaytime"
options.delaytime = param_list{idx+1};
if (! isnumeric (options.delaytime))
error ("imwrite: value for %s option must be numeric",
param_list{idx});
endif
options.delaytime *= 100; # convert to 1/100ths of second
if (isscalar (options.delaytime))
options.delaytime(1:size (img, 4)) = options.delaytime;
elseif (size (img, 4) != numel (options.delaytime))
error ("imwrite: value for %s must either be a scalar or the number of frames",
param_list{idx});
endif
if (any (options.delaytime(:) < 0)
|| any (options.delaytime(:) > 65535))
error ("imwrite: value for %s must be between 0 and 655.35 seconds",
param_list{idx});
endif
case "disposalmethod"
options.disposalmethod = param_list{idx+1};
if (! ischar (options.disposalmethod)
&& ! iscellstr (options.disposalmethod))
error ("imwrite: value for %s must be a string or cell array of strings",
param_list{idx});
elseif (! iscell (options.disposalmethod))
options.disposalmethod = {options.disposalmethod};
endif
options.disposalmethod = lower (options.disposalmethod);
matches = ismember (options.disposalmethod,
{"donotspecify", "leaveinplace", ...
"restorebg", "restoreprevious"});
if (any (! matches))
error ("imwrite: unknown method %s for option %s",
options.disposalmethod{find (! matches, 1)},
param_list{idx});
endif
if (isscalar (options.disposalmethod))
options.disposalmethod = repmat (options.disposalmethod, ...
1, size (img, 4));
elseif (numel (options.disposalmethod) != size (img, 4))
error ("imwrite: if value %s is a cell array must have same length as number of frames",
param_list{idx});
endif
case "loopcount"
options.loopcount = param_list{idx+1};
if (! isscalar (options.loopcount) || ! isnumeric (options.loopcount)
|| (! isinf (options.loopcount)
&& (options.loopcount < 0 || options.loopcount > 65535)))
error ("imwrite: value for %s must be Inf or between 0 and 65535",
param_list{idx});
endif
## Graphics Magick is a bit weird here. A value of 0 will be an
## infinite loop, a value of 1, will really be no loop, while a
## value of 2 or more will be that number of loops (checked
## with GNOME image viewer). This means that there is no way
## to make it loop only once. See
## https://sourceforge.net/p/graphicsmagick/bugs/249/
## There is also the problem of setting this when there is only
## a single frame. See
## https://sourceforge.net/p/graphicsmagick/bugs/248/
if (isinf (options.loopcount))
options.loopcount = 0;
elseif (options.loopcount == 0 || options.loopcount == 1)
options.loopcount += 1;
endif
options.loopcount = floor (options.loopcount);
case "quality",
options.quality = param_list{idx+1};
if (! isnumeric (options.quality) || ! isscalar (options.quality)
|| options.quality < 0 || options.quality > 100)
error ("imwrite: value for %s option must be a scalar between 0 and 100",
param_list{idx});
endif
options.quality = round (options.quality);
case "writemode",
options.writemode = param_list{idx+1};
if (! ischar (options.writemode)
|| ! any (strcmpi (options.writemode, {"append", "overwrite"})))
error ('imwrite: value for %s option must be "append" or "overwrite"',
param_list{idx});
endif
options.writemode = lower (options.writemode);
otherwise
error ("imwrite: invalid PARAMETER '%s'", param_list{idx});
endswitch
endfor
if (! isempty (map))
if (! iscolormap (map))
error ("imwrite: invalid MAP for indexed image");
elseif (ndims (img) != 2 && ndims (img) != 4)
error ("imwrite: indexed image must have 2 or 4 dimensions (found %i)", ndims (img));
endif
## Fill in the colormap as required with rgb (0, 0, 0) (bug #33615)
nColors = rows (map);
if (any (strcmp (class (img), {"uint8", "uint16", "logical"})))
required_colors = max (img(:)) +1;
else
required_colors = max (img(:));
endif
if (nColors < required_colors)
warning ("imwrite: MAP has not enough colors. Filling with black");
map(nColors+1:required_colors,:) = 0;
endif
## If the image is floating point, then we convert it to integer (makes
## it easier in __magick_write__ since it only handles integers. Also,
## if it's floating point, it has an offset of 1
if (isfloat (img))
if (rows (map) <= 256)
img = uint8 (img - 1);
else
img = uint16 (img - 1);
endif
endif
endif
if (ndims (img) > 4)
error ("imwrite: invalid %d-dimensional image data", ndims (img));
elseif (all (size (img, 3) != [1 3 4]))
## 1, 3, or 4 for grayscle, RGB, and CMYK respectively
error ("imwrite: IMG 3rd dimension must be 1, 3, or 4");
endif
__magick_write__ (filename, ext, img, map, options);
endfunction
|
