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