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