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