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