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