From 5a19b8b375049cf59ee88a0eb62233e5c4c9da89 Mon Sep 17 00:00:00 2001 From: Aaron Griffith Date: Sat, 23 Oct 2010 12:57:37 -0400 Subject: [PATCH] Added a PIL alpha_over extension in C, and code to setup.py to build it I needed a way to let py2exe options be provided only when py2exe is available. My solution (maybe not the best) was to put all the arguments for the final setup() call into a dictionary, that is filled in conditionally during the script's execution. This is why the file is completely changed; however, it still does what it used to do (when py2exe is available). --- .gitignore | 7 ++ _composite.c | 217 +++++++++++++++++++++++++++++++++++++++++++++++++++ setup.py | 77 +++++++++++++++--- 3 files changed, 290 insertions(+), 11 deletions(-) create mode 100644 _composite.c diff --git a/.gitignore b/.gitignore index 0d20b64..ec813ce 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,8 @@ *.pyc +build + +# various forms of compiled _composite extensions +_composite.so +_composite.pyd +_composite_d.pyd +_composite.dylib diff --git a/_composite.c b/_composite.c new file mode 100644 index 0000000..93c2c69 --- /dev/null +++ b/_composite.c @@ -0,0 +1,217 @@ +/* + * This file is part of the Minecraft Overviewer. + * + * Minecraft Overviewer is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License as published + * by the Free Software Foundation, either version 3 of the License, or (at + * your option) any later version. + * + * Minecraft Overviewer is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General + * Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with the Overviewer. If not, see . + */ + +/* + * This file implements a custom alpha_over function for (some) PIL + * images. It's designed to be used through composite.py, which + * includes a proxy alpha_over function that falls back to the default + * PIL paste if this extension is not found. + */ + +#include +#include + +/* like (a * b + 127) / 255), but much faster on most platforms + from PIL's _imaging.c */ +#define MULDIV255(a, b, tmp) \ + (tmp = (a) * (b) + 128, ((((tmp) >> 8) + (tmp)) >> 8)) + +typedef struct +{ + PyObject_HEAD + Imaging image; +} ImagingObject; + +static Imaging imaging_python_to_c(PyObject* obj) +{ + /* first, get the 'im' attribute */ + PyObject* im = PyObject_GetAttrString(obj, "im"); + if (!im) + return NULL; + + /* make sure 'im' is the right type */ + if (strcmp(im->ob_type->tp_name, "ImagingCore") != 0) + { + /* it's not -- raise an error and exit */ + PyErr_SetString(PyExc_TypeError, "image attribute 'im' is not a core Imaging type"); + return NULL; + } + + Imaging image = ((ImagingObject*)im)->image; + Py_DECREF(im); + return image; +} + +static PyObject* _composite_alpha_over(PyObject* self, PyObject* args) +{ + PyObject* dest, * src, * pos, * mask; + + if (!PyArg_ParseTuple(args, "OOOO", &dest, &src, &pos, &mask)) + return NULL; + + Imaging imDest = imaging_python_to_c(dest); + Imaging imSrc = imaging_python_to_c(src); + Imaging imMask = imaging_python_to_c(mask); + + if (!imDest || !imSrc || !imMask) + return NULL; + + /* check the various image modes, make sure they make sense */ + if (strcmp(imDest->mode, "RGBA") != 0) + { + PyErr_SetString(PyExc_ValueError, "given destination image does not have mode \"RGBA\""); + return NULL; + } + + if (strcmp(imSrc->mode, "RGBA") != 0 && strcmp(imSrc->mode, "RGB") != 0) + { + PyErr_SetString(PyExc_ValueError, "given source image does not have mode \"RGBA\" or \"RGB\""); + return NULL; + } + + if (strcmp(imMask->mode, "RGBA") != 0 && strcmp(imMask->mode, "L") != 0) + { + PyErr_SetString(PyExc_ValueError, "given mask image does not have mode \"RGBA\" or \"L\""); + return NULL; + } + + /* make sure mask size matches src size */ + if (imSrc->xsize != imMask->xsize || imSrc->ysize != imMask->ysize) + { + PyErr_SetString(PyExc_ValueError, "mask and source image sizes do not match"); + return NULL; + } + + /* set up flags for the src/mask type */ + int src_has_alpha = (imSrc->pixelsize == 4 ? 1 : 0); + /* how far into image the first alpha byte resides */ + int mask_offset = (imMask->pixelsize == 4 ? 3 : 0); + /* how many bytes to skip to get to the next alpha byte */ + int mask_stride = imMask->pixelsize; + + /* destination position read */ + int dx, dy, xsize, ysize; + if (!PyArg_ParseTuple(pos, "iiii", &dx, &dy, &xsize, &ysize)) + { + PyErr_SetString(PyExc_TypeError, "given blend destination rect is not valid"); + return NULL; + } + + /* set up the source position, size and destination position */ + int sx, sy; + + /* handle negative dest pos */ + if (dx < 0) + { + sx = -dx; + dx = 0; + } else { + sx = 0; + } + + if (dy < 0) + { + sy = -dy; + dy = 0; + } else { + sy = 0; + } + + /* set up source dimensions */ + xsize -= sx; + ysize -= sy; + + /* clip dimensions, if needed */ + if (dx + xsize > imDest->xsize) + xsize = imDest->xsize - dx; + if (dy + ysize > imDest->ysize) + ysize = imDest->ysize - dy; + + /* check that there remains any blending to be done */ + if (xsize <= 0 || ysize <= 0) + { + /* nothing to do, return */ + Py_INCREF(dest); + return dest; + } + + /* iteration variables */ + unsigned int x, y, i; + + /* temporary calculation variables */ + int tmp1, tmp2, tmp3; + + for (y = 0; y < ysize; y++) + { + UINT8* out = (UINT8*) imDest->image[dy + y] + dx*4; + UINT8* outmask = (UINT8*) imDest->image[dy + y] + dx*4 + 3; + UINT8* in = (UINT8*) imSrc->image[sy + y] + sx*(imSrc->pixelsize); + UINT8* inmask = (UINT8*) imMask->image[sy + y] + sx*mask_stride + mask_offset; + + for (x = 0; x < xsize; x++) + { + /* special cases */ + if (*inmask == 255 || *outmask == 0) + { + *outmask = *inmask; + + *out = *in; + out++, in++; + *out = *in; + out++, in++; + *out = *in; + out++, in++; + } else if (*inmask == 0) { + /* do nothing -- source is fully transparent */ + out += 3; + in += 3; + } else { + /* general case */ + int alpha = *inmask + MULDIV255(*outmask, 255 - *inmask, tmp1); + for (i = 0; i < 3; i++) + { + /* general case */ + *out = MULDIV255(*in, *inmask, tmp1) + MULDIV255(MULDIV255(*out, *outmask, tmp2), 255 - *inmask, tmp3); + *out = (*out * 255) / alpha; + out++, in++; + } + + *outmask = alpha; + } + + out++; + if (src_has_alpha) + in++; + outmask += 4; + inmask += mask_stride; + } + } + + Py_INCREF(dest); + return dest; +} + +static PyMethodDef _CompositeMethods[] = +{ + {"alpha_over", _composite_alpha_over, METH_VARARGS, "alpha over composite function"}, + {NULL, NULL, 0, NULL} +}; + +PyMODINIT_FUNC init_composite(void) +{ + (void) Py_InitModule("_composite", _CompositeMethods); +} diff --git a/setup.py b/setup.py index 49d1d22..95bba2a 100644 --- a/setup.py +++ b/setup.py @@ -1,13 +1,68 @@ -from distutils.core import setup -import py2exe +from distutils.core import setup, Extension +from distutils.command.build import build +from distutils.command.clean import clean +from distutils.dir_util import remove_tree +from distutils import log +import os, os.path -setup(console=['gmap.py'], - data_files=[('textures', ['textures/lava.png', 'textures/water.png']), - ('', ['template.html'])], - zipfile = None, - options = {'py2exe': { - 'bundle_files': 1, - }}, +try: + import py2exe +except ImportError: + py2exe = None + +# now, setup the keyword arguments for setup +# (because we don't know until runtime if py2exe is available) +setup_kwargs = {} +setup_kwargs['options'] = {} +setup_kwargs['ext_modules'] = [] +setup_kwargs['cmdclass'] = {} + +# +# py2exe options +# + +if py2exe != None: + setup_kwargs['console'] = ['gmap.py'] + setup_kwargs['data_files'] = [('textures', ['textures/lava.png', 'textures/water.png']), + ('', ['template.html'])] + setup_kwargs['zipfile'] = None + setup_kwargs['options']['py2exe'] = {'bundle_files' : 1} + +# +# _composite.c extension +# + +setup_kwargs['ext_modules'].append(Extension('_composite', ['_composite.c'])) +# tell build_ext to build the extension in-place +# (NOT in build/) +setup_kwargs['options']['build_ext'] = {'inplace' : 1} +# tell the build command to only run build_ext +build.sub_commands = [('build_ext', None)] + +# custom clean command to remove in-place extension +class CustomClean(clean): + def run(self): + # do the normal cleanup + clean.run(self) - - ) + # try to remove '_composite.{so,pyd,...}' extension, + # regardless of the current system's extension name convention + build_ext = self.get_finalized_command('build_ext') + fname = build_ext.get_ext_fullpath('_composite') + pretty_fname = os.path.split(fname)[1] + if os.path.exists(fname): + try: + if not self.dry_run: + os.remove(fname) + log.info("removing '%s'", pretty_fname) + except OSError: + log.warn("'%s' could not be cleaned -- permission denied", + pretty_fname) + else: + log.debug("'%s' does not exist -- can't clean it", + pretty_fname) +setup_kwargs['cmdclass']['clean'] = CustomClean + +### + +setup(**setup_kwargs)