TODO

   1   - SSE 2 issues:
   2
   3       - Use MM_HINT_NTA instead of MM_HINT_T0
   4
   5       - Use of fbCompositeOver_x888x8x8888sse2()
   6
   7   - Update the RLEASING file
   8
   9   - Things to keep in mind if breaking ABI:
  10
  11       - There should be a guard #ifndef I_AM_EITHER_CAIRO_OR_THE_X_SERVER
  12
  13       - X server will require 16.16 essentially forever. Can we get
  14         the required precision by simply adding offset_x/y to the
  15         relevant rendering API?
  16
  17       - pixman_image_set_indexed() should copy its argument, and X
  18         should be ported over to use a pixman_image as the
  19         representation of a Picture, rather than creating one on each
  20         operation.
  21
  22       - We should get rid of pixman_set_static_pointers()
  23
  24       - We should get rid of the various trapezoid helper functions().
  25         (They only exist because they are theoretically available to
  26         drivers).
  27
  28       - 16 bit regions should be deleted
  29
  30       - There should only be one trap rasterization API.
  31
  32       - The PIXMAN_g8/c8/etc formats should use the A channel
  33         to indicate the actual depth. That way PIXMAN_x4c4 and PIXMAN_c8
  34         won't collide.
  35
  36   - Maybe bite the bullet and make configure.ac generate a pixman-types.h
  37     file that can be included from pixman.h to avoid the #ifdef magic
  38     in pixman.h
  39
  40   - Make pixman_region_point_in() survive a NULL box, then fix up
  41     pixman-compose.c
  42
  43       - Possibly look into inlining the fetch functions
  44
  45   - There is a bug with source clipping demonstrated by clip-test in the
  46     test directory. If we interprete source clipping as given in
  47     destination coordinates, which is probably the only sane choice,
  48     then the result should have two red bars down the sides.
  49
  50   - Test suite
  51
  52   - Add a general way of dealing with architecture specific
  53     fast-paths.  The current idea is to have each operation that can
  54     be optimized is called through a function pointer that is
  55     initially set to an initialization function that is responsible for
  56     setting the function pointer to the appropriate fast-path.
  57
  58   - Go through things marked FIXME
  59
  60   - Add calls to prepare and finish access where necessary.  grep for
  61     ACCESS_MEM, and make sure they are correctly wrapped in prepare
  62     and finish.
  63
  64   - restore READ/WRITE in the fbcompose combiners since they sometimes
  65     store directly to destination drawables.
  66
  67   - It probably makes sense to move the more strange X region API
  68     into pixman as well, but guarded with PIXMAN_XORG_COMPATIBILITY
  69
  70   - Reinstate the FbBits typedef? At the moment we don't
  71     even have the FbBits type; we just use uint32_t everywhere.
  72
  73     Keith says in bug 2335:
  74
  75         The 64-bit code in fb (pixman) is probably broken; it hasn't been
  76         used in quite some time as PCI (and AGP) is 32-bits wide, so
  77         doing things 64-bits at a time is a net loss.  To quickly fix
  78         this, I suggest just using 32-bit datatypes by setting
  79         IC_SHIFT to 5 for all machines.
  80
  81   - Consider optimizing the 8/16 bit solid fills in pixman-util.c by
  82     storing more than one value at a time.
  83
  84   - Add an image cache to prevent excessive malloc/free. Note that pixman
  85     needs to be thread safe when used from cairo.
  86
  87   - Moving to 24.8 coordinates. This is tricky because X is still
  88     defined as 16.16 and will be basically forever. It's possible we
  89     could do this by adding extra offset_x/y parameters to the
  90     trapezoid calls. The X server could then just call the API with
  91     (0, 0). Cairo would have to make sure that the delta *within* a
  92     batch of trapezoids does not exceed 16 bit.
  93
  94   - Consider adding actual backends. Brain dump:
  95
  96     A backend is something that knows how to
  97
  98       - Create images
  99       - Composite three images
 100       - Rasterize trapezoids
 101       - Do solid fills and blits
 102
 103     These operations are provided by a vtable that the backend will
 104     create when it is initialized. Initial backends:
 105
 106       - VMX
 107       - SSE2
 108       - MMX
 109       - Plain Old C
 110
 111     When the SIMD backends are initialized, they will be passed a
 112     pointer to the Plain Old C backend that they can use for fallback
 113     purposes.
 114
 115     Images would gain a vtable as well that would contain things like
 116
 117       - Read scanline
 118       - Write scanline
 119
 120     (Or even read_patch/write_patch as suggested by Keith a while
 121     back).
 122
 123     This could simplify the compositing code considerably.
 124
 125   - Review the pixman_format_code_t enum to make sure it will support
 126     future formats. Some formats we will probably need:
 127
 128            ARGB/ABGR with 16/32/64 bit integer/floating channels
 129            YUV2,
 130            YV12
 131
 132     Also we may need the ability to distinguish between PICT_c8 and
 133     PICT_x4c4. (This could be done by interpreting the A channel as
 134     the depth for TYPE_COLOR and TYPE_GRAY formats).
 135
 136     A possibility may be to reserve the two top bits and make them
 137     encode "number of places to shift the channel widths given" Since
 138     these bits are 00 at the moment everything will continue to work,
 139     but these additional widths will be allowed:
 140
 141              All even widths between 18-32
 142              All multiples of four widths between 33 and 64
 143              All multiples of eight between 64 and 128
 144
 145     This means things like r21g22b21 won't work - is that worth
 146     worrying about? I don't think so. And of course the bpp field
 147     can't handle a depth of over 256, so > 64 bit channels arent'
 148     really all that useful.
 149
 150     We could reserve one extra bit to indicate floating point, but
 151     we may also just add
 152
 153            PIXMAN_TYPE_ARGB_FLOAT
 154            PIXMAN_TYPE_BGRA_FLOAT
 155            PIXMAN_TYPE_A_FLOAT
 156
 157     image types. With five bits we can support up to 32 different
 158     format types, which should be enough for everybody, even if we
 159     decide to support all the various video formats here:
 160
 161                 http://www.fourcc.org/yuv.php
 162
 163     It may make sense to have a PIXMAN_TYPE_YUV, and then use the
 164     channel bits to specify the exact subtype.
 165
 166     Another possibility is to add
 167
 168           PIXMAN_TYPE_ARGB_W
 169           PIXMAN_TYPE_ARGB_WW
 170
 171     where the channel widths would get 16 and 32 added to them,
 172     respectively.
 173
 174     What about color spaces such a linear vs. srGB etc.?
 175
 176
 177 done:
 178
 179 - Use pixmanFillsse2 and pixmanBltsse2
 180
 181 - Be consistent about calling sse2 sse2
 182
 183 - Rename "SSE" to "MMX_EXTENSIONS". (Deleted mmx extensions).
 184
 185 - Commented-out uses of fbCompositeCopyAreasse2()
 186
 187 - Consider whether calling regions region16 is really such a great
 188   idea. Vlad wants 32 bit regions for Cairo. This will break X server
 189   ABI, but should otherwise be mostly harmless, though a
 190   pixman_region_get_boxes16() may be useful.
 191
 192 - Altivec signal issue (Company has fix, there is also a patch by
 193   dwmw2 in rawhide).
 194
 195 - Behdad's MMX issue - see list
 196
 197 - SSE2 issues:
 198     - Crashes in Mozilla because of unaligned stack. Possible fixes
 199         - Make use of gcc 4.2 feature to align the stack
 200         - Write some sort of trampoline that aligns the stack
 201           before calling SSE functions.
 202
 203 - Get rid of the switch-of-doom; replace it with a big table
 204   describing the various fast paths.
 205
 206 - Make source clipping optional.
 207     - done: source clipping happens through an indirection.
 208         still needs to make the indirection settable. (And call it
 209         from X)
 210
 211 - Run cairo test suite; fix bugs
 212         - one bug in source-scale-clip
 213
 214  - Remove the warning suppression in the ACCESS_MEM macro and fix the
 215     warnings that are real
 216         - irrelevant now.
 217
 218 - make the wrapper functions global instead of image specific
 219         - this won't work since pixman is linked to both fb and wfb
 220
 221 - Add non-mmx solid fill
 222
 223 - Make sure the endian-ness macros are defined correctly.
 224
 225 - The rectangles in a region probably shouldn't be returned const as
 226   the X server will be changing them.
 227
 228 - Right now we _always_ have a clip region, which is empty by default.
 229   Why does this work at all? It probably doesn't. The server
 230   distinguishes two cases, one where nothing is clipped (CT_NONE), and
 231   one where there is a clip region (CT_REGION).
 232
 233 - Default clip region should be the full image
 234
 235   - Test if pseudo color still works. It does, but it also shows that
 236     copying a pixman_indexed_t on every composite operation is not
 237     going to fly. So, for now set_indexed() does not copy the
 238     indexed table.
 239
 240     Also just the malloc() to allocate a pixman image shows up pretty
 241     high.
 242
 243     Options include
 244
 245       - Make all the setters not copy their arguments
 246
 247       - Possibly combined with going back to the stack allocated
 248         approach that we already use for regions.
 249
 250       - Keep a cached pixman_image_t around for every picture. It would
 251         have to be kept uptodate every time something changes about the
 252         picture.
 253
 254       - Break the X server ABI and simply have the relevant parameter
 255         stored in the pixman image. This would have the additional benefits
 256         that:
 257
 258           - We can get rid of the annoying repeat field which is duplicated
 259             elsewhere.
 260
 261           - We can use pixman_color_t and pixman_gradient_stop_t
 262             etc. instead of the types that are defined in
 263             renderproto.h
 264