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