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