TODO

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