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