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