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