- minor changes to Imager::Transformations
[imager.git] / TODO
CommitLineData
b921d414 1 *** TODO ***
b921d414 2
b8a4504c
TC
3Release Plans (subject to change)
4-------------
5
6brown-bag bugs may add intermediate releases. The dates are goals,
7not commitments.
8
ee5d34a5 90.46: (September 2005)
106844eb 10
7a8f05fb
TC
11- check remaining memory allocation calls for integer overflows
12 http://rt.cpan.org/NoAuth/Bug.html?id=8213
ad809a28
TC
13 - check *alloc() calls
14 - check llist_push() calls
7a8f05fb
TC
15
16- fix Imager::Color warning when $ENV{HOME} isn't set from
77157728 17 _get_gimp_color() (done)
7a8f05fb
TC
18 http://rt.cpan.org/NoAuth/Bug.html?id=13143
19
77157728
TC
20- module version numbers (done)
21 http://rt.cpan.org/NoAuth/Bug.html?id=13047
7a8f05fb 22
b8a4504c
TC
23- allow limits to be set on the size of an image read from a file. This is
24 to prevent an attacker supplying huge images that consume all of
77157728 25 memory causing a denial of service attack. (done)
106844eb 26
7a8f05fb 27- implement gsamp()/gsampf()/plin() etc methods for those low level image
f75c1aeb
TC
28 interfaces which don't yet have methods. (done)
29 - code (done)
30 - test (done)
31 - document (done)
7a8f05fb 32
985bda61 33- add Imager::Tutorial (see Tk::UserGuide for a structure) (done)
b8a4504c
TC
34 don't cover installation - belongs in README or INSTALL
35 it doesn't need to cover everything - read/write/create/simple drawing
36 and simple text - other stuff belongs in the cookbook or in sample code
106844eb 37
1611d101
TC
38- rename lib/Imager/Cookbook.pm to lib/Imager/Cookbook.pod (done)
39
b8a4504c 40- add 5 more recipes to Imager::Cookbook
106844eb 41
b8a4504c 42- implement i_incomplete for png and gif files.
106844eb 43
1a19d068
TC
44- documentation audit, check:
45 - every method has at least one example, but if the method is complex
46 (like transform2, to_paletted, string() for example) it should include
47 a range of examples
48 - check each method description to ensure it's reasonably clear.
49 - check POD sections (SEE ALSO in particular)
84960c16 50 - multiple examples for writing GIF images.
75237d28
TC
51 - name arguments and use those names in the documentation
52 http://nntp.perl.org/group/perl.perl5.porters/102434
77c06476 53 (#1521, #5608, #8231, #11429, #13058(done))
106844eb 54
f1adece7 55- have $img->read() act like ($img) = Imager->read_multi() on GIFs (done)
84960c16 56
ad809a28
TC
57- figure out what the nearest_color filter does, and document it
58
f75c1aeb 59- remove image.h dependency on t1lib.h (done)
ca4d914e
TC
60
61- make sure dynfilt/Makefile.PL gets the same includes that
62 Makefile.PL does.
63
84960c16
TC
640.47:
65
66- rework handling of antialiasing and other transparency against
67 transparent images
68
69 Places to check:
70 - text AA rendering
71 - AA line drawing
72 - anything that uses combine (fills in particular)
73 - image scaling? and matrix_transform()'s interpolation
74 http://rt.cpan.org/NoAuth/Bug.html?id=11972
75
08b5cf78
TC
760.48:
77
78- fill out handling of large sample (16/double per sample) images
79 - filters
80 - rendering:
81 - lines
82 - text
83 - boxes
84 - polygons
85 - engines
86 - matrix transform
87 - transform()
88 - transform2()
89 - files:
90 - png
91 - tiff
92 - pnm
84960c16 93
b8a4504c
TC
94Speculation
95-----------
96
97Some of what's listed below has been implemented.
98
99- should i_incomplete be optional? ie. reading a short image results in
100 an error unless the user requests incomplete images.
403946c6 101
b921d414
AMH
102Iolayer:
103- Add scalar/mmap to iolayer
a106216b 104- Add close() code to iolayer for fakeseek sources.
b921d414 105- Merge callback interface into iolayer
a106216b
AMH
106- and raw
107- Implment the maxread threshold (Indicates how much can
108 be read from a source before it stops reading from its
109 underlying source. For making sure only the relevant
110 data is read from a socket for example.
111
b921d414
AMH
112Enhanched internal structure:
113
114MultiImage & metadata support:
115- Figure what interface should be between C and perl?
116- How to store data in the C interface for tags/metadata?
117 Support tiff's madness, i.e. tags and options.
118- Error handling, make a general i_errstr object and arrange
119 such that each image has an i_errstr object to hold its
120 local errors?
121- SEE design/represent.txt for proposed new structure and
122 interface design that takes these factors into account.
faa9b3e7
TC
123- define common i_* tags for specifying attribute common among images
124 like spatial resolution (implement for other image types, especially
10461f9a
TC
125 TIFF) (Spatial resolution is supported for all types that support
126 it - are there any other common properties we can add?)
faa6fa9b 127- implement the i_incomplete tag for other formats
b921d414
AMH
128
129New Features:
a106216b 130- Add mng support, pcx and aalib support.
13db6021
TC
131 - Windows icon files (.ico)
132 - ILBM (Amiga) images
133 - photoshop files (I think I've seen docs)
134 - XBM
135 - FITS
136 - WMF (extract bitmap data on read)
137 - gzip or bzip2 compressed raw
10461f9a 138 - postscript for output
ee6f9750 139 - PAM file support (man pam in recent PNM tools)
5f5fe73e 140
b921d414
AMH
141- Transforms, interpolated multidimensional lookup tables.
142 Usefull for CMYK <-> RGB table lookup.
143
a106216b 144- advanced font layout (spacing, kerning, alignment) (Artur?)
faa9b3e7 145
bf9dd17c 146- ways to check if characters are present in a font, eg. checking if
9c5ed9a7 147 ligatures are present (done for FreeType2)
bf9dd17c 148
faa9b3e7
TC
149- font synthesis - synthesize a bold or slanted font from a normal font
150 (or even from an existing bold or slanted font)
bf9dd17c 151
faa9b3e7 152- utf8 support for text output
9a71bc09 153 (available for FT1, freetype2, should be easy for Win32)
c855ad0e
TC
154
155- easy interfaces for text output:
156 - align text around point, including:
157 - left, center, right horizontal alignment
158 - top, center, baseline, bottom alignment
159 - choose whether to base alignment upon character cells or font
160 metrics to avoid spacing problems between lines
161 - fill a box from text, with newline handling
162 - an option to just return the information that would be used to
163 output the text, so it can be used for sizing calculations
164 - how much text fit in the box/how much space is left in the box
165 - fill a box with rich text (size and font changes)
166 - as above
167 - wrapping around boxes/images
168 - pod2Imager :)
169
170- tools to get more information about fonts/characters:
171 - name of font "Arial Bold Italic" vs "arialbi.ttf"
172 - ABC widths for characters (currently the only way to get the C width
173 for a character is to get the width with a following space and without
174 and then compare)
175 - character names
176
177- encodings for text output (maybe using the Encode module to work
178 between encodings)
faa9b3e7
TC
179
180- image rotation, 3 ways of doing rotation:
faa9b3e7
TC
181 - rotation by shearing, which produces makes lengths in the image larger,
182 but could be useful
a010a7d3 183 (2 of the 3 have been done)
faa9b3e7 184
9c5ed9a7
TC
185- read_multi() needs to handle other multi-image types,
186 (handles TIFF and GIF)
b921d414 187
9c5ed9a7 188- write_multi() to save other multi-image types, (handles TIFF and GIF)
8b695554 189 - pnm binary formats support multiple images per file
f62b2d84 190
362e7486
TC
191- compose channels - build a new image based on channels from several
192 images
193
da77e827
TC
194- arc outlines
195
9a71bc09
TC
196- complex lines/curves:
197 - thick lines:
198 - dotted/dashed lines
199 - doubled lines?
200 - end-point controls (butt-end, square-end, round-end, pointy, arrows)
201 - brush-lines (as with the Gimp, or Photoshop)
202 - more complex with multiple strokes and various randomness as with
203 Fractal Design Painter (or later versions of Corel Photo Paint)
204 - complex line shapes:
205 - lines
206 - general curves (cubic or bezier, whichever is more general)
207 - easy access to general curves:
208 - points to make a nice curve from
209 - various circular curves (centre, radii, start/end angles,
210 direction)
211 - Complex thick lines are probably more useful than brush-lines for
212 the things I expect Imager to be used for.
213 - http://www.develop-help.com/imager/strokes.png (.jpg for smaller version)
214
ea9e6c3f
TC
215- have Imager::Color{::Float}? use Graphics::ColorNames if present.
216
b921d414
AMH
217Clean up:
218- Make sure everything is doable with the OO interface
5f5fe73e 219 i_flood_fill() for example.
45a1d9d2 220 - include low-level functions like gsamp() and so on
f1ac5027 221
b921d414
AMH
222- Compile with memory debugging enabled and fix all leaks
223
a106216b 224- Add mycalloc() memory allocation wrappers.
b921d414
AMH
225
226- should we overload <=> or cmp for Imager::Color objects?
227 too many worms, leave it out
228
229- should the interlace option for reading raw images have
230 symbolic names in the OO interface?
231
f2bc9b80
TC
232- improve consistency in the interfaces, both in trying to use named
233 parameters where possible but also in using consistent names, eg.
234 (tx, ty) vs (left, top) in rubthrough() vs paste(). Do we want a (simple)
235 standard for this (suggested names)? Remember to preserve the old
236 interface where possible.
b921d414 237
c855ad0e
TC
238- try to clean up the inconsistencies between font types:
239 - utf8 (even if we just treat characters over 0xFF as missing for T1)
3799c4d1 240 (done for FT2, FT1, T1)
eeaa33fd 241 - transformations (done for FT2)
3799c4d1 242 - has_char() method (done for FT2, FT1, T1)
c855ad0e 243
b921d414 244Format specific issues:
b921d414
AMH
245- provide patches for libgif and libungif that fix their bugs
246 and give a useful extension interface. Probe for the
247 installation of the patches in Makefile.PL to let gif.c
248 know what features it can use.
249
a106216b 250- Add options for pnm writer to save in any of the p1..P6
b921d414
AMH
251 formats. Even if the input has 1 channel, write 3 and such
252 cases. Also allow ascii mode. Need to be able to write
253 pbm images which needs ties to the quantization code.
254
a106216b 255- save paletted images as paletted where that's supported. Done
f62b2d84 256 for gif/tga/bmp/tiff. Not done for png yet.
f873cb01 257
a106216b 258- read other format paletted images as paletted images. This has
f62b2d84
TC
259 been done for gif/tga/bmp/tiff formats but not for png.
260
261- read/write 16-bit/sample images as such for tiff
27d9683e 262
faa6fa9b
TC
263- read more metadata from images, esp tiff tags, EXIF format information
264 from TIFF and JPEG.
265
7ac6a2e9
TC
266- handle 16-bit/sample pgm/ppm files
267
fca19321
TC
268- "jpeg lossless rotation" - directly manipulates the JPEG
269 representation to rotate, scale or in some limited cases, crop an
270 image.
271
b921d414
AMH
272Documentation:
273- Add to the documentation
274- Write a tutorial?
faa9b3e7
TC
275- sample code and Imager/Samples.pod describing them
276- Imager/Cookbook.pod
b921d414
AMH
277- Write a guide to installing the helper libraries
278- Go through the entire project and add comments in pod
279 so doco.perl can be used to read them.
faa6fa9b 280- see the IRC log in design/doclayout.txt
6d0ed98a
TC
281- method index?
282- concept index?
ea9e6c3f
TC
283
284Build/configure:
285- use prompt() (from ExtUtils::MakeMaker) for questions in Makefile.PL
286- use the library's mechanism's to find the library if needed, for
287 example, freetype-config for FT2
288- the freetype2 library is built as "freetype.lib" on Win32 and needs
289 to be renamed to be found by the configuration process and included
290 with -lfreetype. Try to work around that.
291- freetype2 and freetype1 tend to be installed in /usr/include/freetype2
292 and /usr/include/freetype directories, or similarly named (somedir/freetype
293 for example), instead of putting these directly into the search path
294 search for the freetype{2}?/someheader and then add the subdirectory if
295 we find the file in that directory.
7ac6a2e9 296- switch to Test::More
5e9890e1 297- change headers to use more unique re-include protection macros
6b64de41
TC
298
299Old release checklists
300----------------------
301
3020.44: (december 2004)
303- set i_format for every file type on read and test for it:
304 - bmp - done
305 - jpeg - done
306 - tiff - done
307 - tga - done
308 - rgb - no read function anyway
309 - png - done
310 - gif - done
311 - pnm - done
312 - raw - done
313- check each file reader for possible integer overflows
314 - bmp - done
315 - tiff
316 - tga
317 - rgb
318 - png
319 - gif
320 - pnm
321- check bmp code uses image data offset correctly - done
322- check quant code for integer overflows - done
323- check for old URLs (umich and imager.perl.org/~addi/...) - done
324
ee5d34a5
TC
3250.45: (march 2005?)
326- resolve fills test failure under 5.8.6/darwin
327 http://www.nntp.perl.org/group/perl.cpan.testers/202802
328 add tests to check if the same problem occurs with other ?: operators
329- stop tga_header_verify() from spewing junk to stdout (done)
330- fix i_setcolors_p bug (done)
331- audit pnm.c (done)
332- audit tga.c (done)
333- audit rgb.c and add tests
334- add META.yml (bypass EU::MM's limited mechanism) (done)
335- implement i_incomplete for bmp files
336- check if freetype 2 is faster/slower than freetype 1 with Imager's glyph
337 caching. If FT1 is faster, add caching as a TODO for FT2.
338- add XS for i_tags_get_string() and test it. It has an apparent problem
339 in C<< sprintf(value, "%d", entry->data); >> since data is a pointer
340 (done)
341- test and fix problem with fallback value for
342 Imager::Font::BBox->advance_width. (done)
343- check handling of string() method align parameter. (done, fixed)
344- i_tt_bbox_inst in font.c uses variable i without ever setting it. (fixed)
345- add sample CGI that handles an uploaded image (done)
346- examples for fountain filter in Imager::Filters (done)
347- allow Imager::Fountain to take color descriptions (eg. blue, FF000)
348 instead of color objects for c0 and c1 (done)
349- support newer GIMP gradient files with the Name line (done)
350- provide access to right-side bearing information from the bounding box
351 function (done for all drivers)
352- capture TIFF read warnings (i_warnings tag?) (done)
353- Imager::Matrix2d rotate method only applies offset if both x and y
354 are non-zero, it should do it if either is non-zero (done)
355- add Imager::Cookbook with at least 5 recipes (done)
356- store floating point tags in an appropriate precision (done)
357- allow image creation to fail on malloc() failure for the image data
358 rather than aborting. The current behaviour could be a denial of
359 service attack. This has limited utility because of the way memory
360 over commitment works on Linux (done but reverted)
361- eliminate unused variable warning (especially the RETVAL ones in Imager.xs)
362 (done)
363- handle probing for libraries better (use pkg-config or I<library>-config
364 where possible (freetype2 and libpng)) (done)
365- add concept index to Imager.pm pod (done, still working it)
366- replace testimg/penguin-base.ppm with a smaller image (done)
367- add a sample CGI HTML and image generation scripts that work together,
368 with appropriate security management (done)
369