TODO

   1   - Update the RLEASING file
   2
   3   - Things to keep in mind if breaking ABI:
   4
   5       - There should be a guard #ifndef I_AM_EITHER_CAIRO_OR_THE_X_SERVER
   6
   7       - X server will require 16.16 essentially forever. Can we get
   8         the required precision by simply adding offset_x/y to the
   9         relevant rendering API?
  10
  11       - pixman_image_set_indexed() should copy its argument, and X
  12         should be ported over to use a pixman_image as the
  13         representation of a Picture, rather than creating one on each
  14         operation.
  15
  16       - We should get rid of pixman_set_static_pointers()
  17
  18       - We should get rid of the various trapezoid helper functions().
  19         (They only exist because they are theoretically available to
  20         drivers).
  21
  22       - Regions should become 32 bit
  23
  24       - There should only be one trap rasterization API.
  25
  26       - The PIXMAN_g8/c8/etc formats should use the A channel
  27         to indicate the actual depth. That way PIXMAN_x4c4 and PIXMAN_c8
  28         won't collide.
  29
  30   - Make pixman_region_point_in() survive a NULL box, then fix up
  31     pixman-compose.c
  32
  33   - Test suite
  34
  35   - Add a general way of dealing with architecture specific
  36     fast-paths.  The current idea is to have each operation that can
  37     be optimized is called through a function pointer that is
  38     initially set to an initialization function that is responsible for
  39     setting the function pointer to the appropriate fast-path.
  40
  41   - Go through things marked FIXME
  42
  43   - Add calls to prepare and finish access where necessary.  grep for
  44     ACCESS_MEM, and make sure they are correctly wrapped in prepare
  45     and finish.
  46
  47   - restore READ/WRITE in the fbcompose combiners since they sometimes
  48     store directly to destination drawables.
  49
  50   - It probably makes sense to move the more strange X region API
  51     into pixman as well, but guarded with PIXMAN_XORG_COMPATIBILITY
  52
  53   - Reinstate the FbBits typedef? At the moment we don't
  54     even have the FbBits type; we just use uint32_t everywhere.
  55
  56     Keith says in bug 2335:
  57
  58         The 64-bit code in fb (pixman) is probably broken; it hasn't been
  59         used in quite some time as PCI (and AGP) is 32-bits wide, so
  60         doing things 64-bits at a time is a net loss.  To quickly fix
  61         this, I suggest just using 32-bit datatypes by setting
  62         IC_SHIFT to 5 for all machines.
  63
  64   - Consider whether calling regions region16 is really such a great
  65     idea. Vlad wants 32 bit regions for Cairo. This will break X server
  66     ABI, but should otherwise be mostly harmless, though a
  67     pixman_region_get_boxes16() may be useful.
  68
  69   - Consider optimizing the 8/16 bit solid fills in pixman-util.c by
  70     storing more than one value at a time.
  71
  72   - Add an image cache to prevent excessive malloc/free. Note that pixman
  73     needs to be thread safe when used from cairo.
  74
  75   - Moving to 24.8 coordinates. This is tricky because X is still
  76     defined as 16.16 and will be basically forever. It's possible we
  77     could do this by adding extra offset_x/y parameters to the
  78     trapezoid calls. The X server could then just call the API with
  79     (0, 0). Cairo would have to make sure that the delta *within* a
  80     batch of trapezoids does not exceed 16 bit.
  81
  82   - Review the pixman_format_code_t enum to make sure it will support
  83     future formats. Some formats we will probably need:
  84
  85            ARGB/ABGR with 16/32/64 bit integer/floating channels
  86            YUV2,
  87            YV12
  88
  89     Also we may need the ability to distinguish between PICT_c8 and
  90     PICT_x4c4. (This could be done by interpreting the A channel as
  91     the depth for TYPE_COLOR and TYPE_GRAY formats).
  92
  93     A possibility may be to reserve the two top bits and make them
  94     encode "number of places to shift the channel widths given" Since
  95     these bits are 00 at the moment everything will continue to work,
  96     but these additional widths will be allowed:
  97
  98              All even widths between 18-32
  99              All multiples of four widths between 33 and 64
 100              All multiples of eight between 64 and 128
 101
 102     This means things like r21g22b21 won't work - is that worth
 103     worrying about? I don't think so. And of course the bpp field
 104     can't handle a depth of over 256, so > 64 bit channels arent'
 105     really all that useful.
 106
 107     We could reserve one extra bit to indicate floating point, but
 108     we may also just add
 109
 110            PIXMAN_TYPE_ARGB_FLOAT
 111            PIXMAN_TYPE_BGRA_FLOAT
 112            PIXMAN_TYPE_A_FLOAT
 113
 114     image types. With five bits we can support up to 32 different
 115     format types, which should be enough for everybody, even if we
 116     decide to support all the various video formats here:
 117
 118                 http://www.fourcc.org/yuv.php
 119
 120     It may make sense to have a PIXMAN_TYPE_YUV, and then use the
 121     channel bits to specify the exact subtype.
 122
 123     Another possibility is to add
 124
 125           PIXMAN_TYPE_ARGB_W
 126           PIXMAN_TYPE_ARGB_WW
 127
 128     where the channel widths would get 16 and 32 added to them,
 129     respectively.
 130
 131     What about color spaces such a linear vs. srGB etc.?
 132
 133 done:
 134
 135 - Get rid of the switch-of-doom; replace it with a big table
 136   describing the various fast paths.
 137
 138 - Make source clipping optional.
 139     - done: source clipping happens through an indirection.
 140         still needs to make the indirection settable. (And call it
 141         from X)
 142
 143 - Run cairo test suite; fix bugs
 144         - one bug in source-scale-clip
 145
 146  - Remove the warning suppression in the ACCESS_MEM macro and fix the
 147     warnings that are real
 148         - irrelevant now.
 149
 150 - make the wrapper functions global instead of image specific
 151         - this won't work since pixman is linked to both fb and wfb
 152
 153 - Add non-mmx solid fill
 154
 155 - Make sure the endian-ness macros are defined correctly.
 156
 157 - The rectangles in a region probably shouldn't be returned const as
 158   the X server will be changing them.
 159
 160 - Right now we _always_ have a clip region, which is empty by default.
 161   Why does this work at all? It probably doesn't. The server
 162   distinguishes two cases, one where nothing is clipped (CT_NONE), and
 163   one where there is a clip region (CT_REGION).
 164
 165 - Default clip region should be the full image
 166
 167   - Test if pseudo color still works. It does, but it also shows that
 168     copying a pixman_indexed_t on every composite operation is not
 169     going to fly. So, for now set_indexed() does not copy the
 170     indexed table.
 171
 172     Also just the malloc() to allocate a pixman image shows up pretty
 173     high.
 174
 175     Options include
 176
 177       - Make all the setters not copy their arguments
 178
 179       - Possibly combined with going back to the stack allocated
 180         approach that we already use for regions.
 181
 182       - Keep a cached pixman_image_t around for every picture. It would
 183         have to be kept uptodate every time something changes about the
 184         picture.
 185
 186       - Break the X server ABI and simply have the relevant parameter
 187         stored in the pixman image. This would have the additional benefits
 188         that:
 189
 190           - We can get rid of the annoying repeat field which is duplicated
 191             elsewhere.
 192
 193           - We can use pixman_color_t and pixman_gradient_stop_t
 194             etc. instead of the types that are defined in
 195             renderproto.h
 196