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