- the BMP reader now validates the bfOffBits value from the BMP header
[imager.git] / TODO
1                          *** TODO ***
2
3 PRE-0.44:
4 - set i_format for every file type on read and test for it:
5   - bmp - done
6   - jpeg - done
7   - tiff
8   - tga
9   - rgb
10   - png - done
11   - gif
12   - pnm
13 - check each file reader for possible integer overflows
14   - bmp
15   - tiff
16   - tga
17   - rgb
18   - png
19   - gif
20   - pnm
21 - check bmp code uses image data offset correctly - done
22 - check quant code for integer overflows
23 - check for old URLs (umich and imager.perl.org/~addi/...)
24
25 Iolayer:
26 - Add scalar/mmap to iolayer
27 - Add close() code to iolayer for fakeseek sources.
28 - Merge callback interface into iolayer
29 - and raw
30 - Implment the maxread threshold (Indicates how much can
31   be read from a source before it stops reading from its
32   underlying source.  For making sure only the relevant
33   data is read from a socket for example. 
34
35
36 Enhanched internal structure:
37
38 MultiImage & metadata support:
39 - Figure what interface should be between C and perl?
40 - How to store data in the C interface for tags/metadata?
41   Support tiff's madness, i.e. tags and options.
42 - Error handling, make a general i_errstr object and arrange
43   such that each image has an i_errstr object to hold its
44   local errors?
45 - SEE design/represent.txt for proposed new structure and
46   interface design that takes these factors into account.
47 - define common i_* tags for specifying attribute common among images
48   like spatial resolution (implement for other image types, especially 
49   TIFF)  (Spatial resolution is supported for all types that support 
50   it - are there any other common properties we can add?)
51 - implement the i_incomplete tag for other formats  
52
53 New Features:
54 - Add mng support, pcx and aalib support.
55   - Windows icon files (.ico)
56   - ILBM (Amiga) images
57   - photoshop files (I think I've seen docs)
58   - XBM
59   - FITS
60   - WMF (extract bitmap data on read)
61   - gzip or bzip2 compressed raw
62   - postscript for output
63   - PAM file support (man pam in recent PNM tools)
64
65 - Transforms, interpolated multidimensional lookup tables.
66   Usefull for CMYK <-> RGB table lookup.
67
68 - advanced font layout (spacing, kerning, alignment) (Artur?)
69
70 - ways to check if characters are present in a font, eg. checking if
71   ligatures are present (done for FreeType2)
72
73 - font synthesis - synthesize a bold or slanted font from a normal font
74   (or even from an existing bold or slanted font)
75
76 - utf8 support for text output
77   (available for FT1, freetype2, should be easy for Win32)
78
79 - easy interfaces for text output:
80   - align text around point, including:
81     - left, center, right horizontal alignment
82     - top, center, baseline, bottom alignment
83     - choose whether to base alignment upon character cells or font 
84       metrics to avoid spacing problems between lines
85   - fill a box from text, with newline handling
86     - an option to just return the information that would be used to 
87       output the text, so it can be used for sizing calculations
88     - how much text fit in the box/how much space is left in the box
89   - fill a box with rich text (size and font changes)
90     - as above
91     - wrapping around boxes/images
92   - pod2Imager :)
93
94 - tools to get more information about fonts/characters:
95   - name of font "Arial Bold Italic" vs "arialbi.ttf"
96   - ABC widths for characters (currently the only way to get the C width 
97     for a character is to get the width with a following space and without
98     and then compare)
99   - character names
100
101 - encodings for text output (maybe using the Encode module to work 
102   between encodings)
103
104 - image rotation, 3 ways of doing rotation:
105   - rotation by shearing, which produces makes lengths in the image larger,
106     but could be useful
107   (2 of the 3 have been done)
108
109 - read_multi() needs to handle other multi-image types,
110    (handles TIFF and GIF)
111
112 - write_multi() to save other multi-image types, (handles TIFF and GIF)
113   - pnm binary formats support multiple images per file
114
115 - compose channels - build a new image based on channels from several
116   images
117
118 - arc outlines
119
120 - complex lines/curves:
121   - thick lines:
122     - dotted/dashed lines
123     - doubled lines?
124     - end-point controls (butt-end, square-end, round-end, pointy, arrows)
125   - brush-lines (as with the Gimp, or Photoshop)
126     - more complex with multiple strokes and various randomness as with
127       Fractal Design Painter (or later versions of Corel Photo Paint)
128   - complex line shapes:
129     - lines
130     - general curves (cubic or bezier, whichever is more general)
131     - easy access to general curves:
132       - points to make a nice curve from
133       - various circular curves (centre, radii, start/end angles, 
134         direction)
135   - Complex thick lines are probably more useful than brush-lines for 
136     the things I expect Imager to be used for.
137   - http://www.develop-help.com/imager/strokes.png (.jpg for smaller version)
138
139 - have Imager::Color{::Float}? use Graphics::ColorNames if present.
140
141 Clean up:
142 - Make sure everything is doable with the OO interface
143   i_flood_fill() for example.
144   - include low-level functions like gsamp() and so on
145
146 - Compile with memory debugging enabled and fix all leaks
147
148 - Add mycalloc() memory allocation wrappers.
149
150 - should we overload <=> or cmp for Imager::Color objects?
151   too many worms, leave it out
152
153 - should the interlace option for reading raw images have 
154   symbolic names in the OO interface?
155
156 - improve consistency in the interfaces, both in trying to use named
157   parameters where possible but also in using consistent names, eg.
158   (tx, ty) vs (left, top) in rubthrough() vs paste().  Do we want a (simple)
159   standard for this (suggested names)?  Remember to preserve the old 
160   interface where possible.
161
162 - try to clean up the inconsistencies between font types:
163   - utf8 (even if we just treat characters over 0xFF as missing for T1)
164     (done for FT2, FT1, T1)
165   - transformations (done for FT2)
166   - has_char() method (done for FT2, FT1, T1)
167
168 Format specific issues:
169 - provide patches for libgif and libungif that fix their bugs
170   and give a useful extension interface.  Probe for the 
171   installation of the patches in Makefile.PL to let gif.c
172   know what features it can use.
173
174 - Add options for pnm writer to save in any of the p1..P6
175   formats.  Even if the input has 1 channel, write 3 and such
176   cases.  Also allow ascii mode.  Need to be able to write 
177   pbm images which needs ties to the quantization code.
178
179 - save paletted images as paletted where that's supported.  Done
180   for gif/tga/bmp/tiff.  Not done for png yet.
181
182 - read other format paletted images as paletted images.  This has 
183   been done for gif/tga/bmp/tiff formats but not for png.
184
185 - read/write 16-bit/sample images as such for tiff
186
187 - read more metadata from images, esp tiff tags, EXIF format information 
188   from TIFF and JPEG.
189
190 - handle 16-bit/sample pgm/ppm files
191
192 Documentation:
193 - Add to the documentation
194 - Write a tutorial?
195 - sample code and Imager/Samples.pod describing them
196 - Imager/Cookbook.pod
197 - Write a guide to installing the helper libraries
198 - Go through the entire project and add comments in pod
199   so doco.perl can be used to read them.
200 - see the IRC log in design/doclayout.txt
201 - method index?
202 - concept index?
203
204 Build/configure:
205 - use prompt() (from ExtUtils::MakeMaker) for questions in Makefile.PL
206 - use the library's mechanism's to find the library if needed, for
207   example, freetype-config for FT2
208 - the freetype2 library is built as "freetype.lib" on Win32 and needs
209   to be renamed to be found by the configuration process and included
210   with -lfreetype.  Try to work around that.
211 - freetype2 and freetype1 tend to be installed in /usr/include/freetype2
212   and /usr/include/freetype directories, or similarly named (somedir/freetype
213   for example), instead of putting these directly into the search path
214   search for the freetype{2}?/someheader and then add the subdirectory if
215   we find the file in that directory.
216 - switch to Test::More