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