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