openerp/tools/image.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2012-today OpenERP s.a. (<http://openerp.com>).
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU Affero General Public License as
   9 #    published by the Free Software Foundation, either version 3 of the
  10 #    License, or (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU Affero General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU Affero General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 try:
  23     import cStringIO as StringIO
  24 except ImportError:
  25     import StringIO
  26
  27 from PIL import Image
  28 from PIL import ImageOps
  29 from random import randint
  30
  31 # ----------------------------------------
  32 # Image resizing
  33 # ----------------------------------------
  34
  35 def image_resize_image(base64_source, size=(1024, 1024), encoding='base64', filetype='PNG', avoid_if_small=False):
  36     """ Function to resize an image. The image will be resized to the given
  37         size, while keeping the aspect ratios, and holes in the image will be
  38         filled with transparent background. The image will not be stretched if
  39         smaller than the expected size.
  40         Steps of the resizing:
  41         - Compute width and height if not specified.
  42         - if avoid_if_small: if both image sizes are smaller than the requested
  43           sizes, the original image is returned. This is used to avoid adding
  44           transparent content around images that we do not want to alter but
  45           just resize if too big. This is used for example when storing images
  46           in the 'image' field: we keep the original image, resized to a maximal
  47           size, without adding transparent content around it if smaller.
  48         - create a thumbnail of the source image through using the thumbnail
  49           function. Aspect ratios are preserved when using it. Note that if the
  50           source image is smaller than the expected size, it will not be
  51           extended, but filled to match the size.
  52         - create a transparent background that will hold the final image.
  53         - paste the thumbnail on the transparent background and center it.
  54
  55         :param base64_source: base64-encoded version of the source
  56             image; if False, returns False
  57         :param size: 2-tuple(width, height). A None value for any of width or
  58             height mean an automatically computed value based respectivelly
  59             on height or width of the source image.
  60         :param encoding: the output encoding
  61         :param filetype: the output filetype
  62         :param avoid_if_small: do not resize if image height and width
  63             are smaller than the expected size.
  64     """
  65     if not base64_source:
  66         return False
  67     if size == (None, None):
  68         return base64_source
  69     image_stream = StringIO.StringIO(base64_source.decode(encoding))
  70     image = Image.open(image_stream)
  71
  72     asked_width, asked_height = size
  73     if asked_width is None:
  74         asked_width = int(image.size[0] * (float(asked_height) / image.size[1]))
  75     if asked_height is None:
  76         asked_height = int(image.size[1] * (float(asked_width) / image.size[0]))
  77     size = asked_width, asked_height
  78
  79     # check image size: do not create a thumbnail if avoiding smaller images
  80     if avoid_if_small and image.size[0] <= size[0] and image.size[1] <= size[1]:
  81         return base64_source
  82
  83     if image.size != size:
  84         # If you need faster thumbnails you may use use Image.NEAREST
  85         image = ImageOps.fit(image, size, Image.ANTIALIAS)
  86     if image.mode not in ["1", "L", "P", "RGB", "RGBA"]:
  87         image = image.convert("RGB")
  88
  89     background_stream = StringIO.StringIO()
  90     image.save(background_stream, filetype)
  91     return background_stream.getvalue().encode(encoding)
  92
  93 def image_resize_image_big(base64_source, size=(1204, 1204), encoding='base64', filetype='PNG', avoid_if_small=True):
  94     """ Wrapper on image_resize_image, to resize images larger than the standard
  95         'big' image size: 1024x1024px.
  96         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
  97     """
  98     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
  99
 100 def image_resize_image_medium(base64_source, size=(128, 128), encoding='base64', filetype='PNG', avoid_if_small=False):
 101     """ Wrapper on image_resize_image, to resize to the standard 'medium'
 102         image size: 180x180.
 103         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
 104     """
 105     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
 106
 107 def image_resize_image_small(base64_source, size=(64, 64), encoding='base64', filetype='PNG', avoid_if_small=False):
 108     """ Wrapper on image_resize_image, to resize to the standard 'small' image
 109         size: 50x50.
 110         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
 111     """
 112     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
 113
 114 # ----------------------------------------
 115 # Colors
 116 # ---------------------------------------
 117
 118 def image_colorize(original, randomize=True, color=(255, 255, 255)):
 119     """ Add a color to the transparent background of an image.
 120         :param original: file object on the original image file
 121         :param randomize: randomize the background color
 122         :param color: background-color, if not randomize
 123     """
 124     # create a new image, based on the original one
 125     original = Image.open(StringIO.StringIO(original))
 126     image = Image.new('RGB', original.size)
 127     # generate the background color, past it as background
 128     if randomize:
 129         color = (randint(32, 224), randint(32, 224), randint(32, 224))
 130     image.paste(color)
 131     image.paste(original, mask=original)
 132     # return the new image
 133     buffer = StringIO.StringIO()
 134     image.save(buffer, 'PNG')
 135     return buffer.getvalue()
 136
 137 # ----------------------------------------
 138 # Misc image tools
 139 # ---------------------------------------
 140
 141 def image_get_resized_images(base64_source, return_big=False, return_medium=True, return_small=True,
 142     big_name='image', medium_name='image_medium', small_name='image_small',
 143     avoid_resize_big=True, avoid_resize_medium=False, avoid_resize_small=False):
 144     """ Standard tool function that returns a dictionary containing the
 145         big, medium and small versions of the source image. This function
 146         is meant to be used for the methods of functional fields for
 147         models using images.
 148
 149         Default parameters are given to be used for the getter of functional
 150         image fields,  for example with res.users or res.partner. It returns
 151         only image_medium and image_small values, to update those fields.
 152
 153         :param base64_source: base64-encoded version of the source
 154             image; if False, all returnes values will be False
 155         :param return_{..}: if set, computes and return the related resizing
 156             of the image
 157         :param {..}_name: key of the resized image in the return dictionary;
 158             'image', 'image_medium' and 'image_small' by default.
 159         :param avoid_resize_[..]: see avoid_if_small parameter
 160         :return return_dict: dictionary with resized images, depending on
 161             previous parameters.
 162     """
 163     return_dict = dict()
 164     if return_big:
 165         return_dict[big_name] = image_resize_image_big(base64_source, avoid_if_small=avoid_resize_big)
 166     if return_medium:
 167         return_dict[medium_name] = image_resize_image_medium(base64_source, avoid_if_small=avoid_resize_medium)
 168     if return_small:
 169         return_dict[small_name] = image_resize_image_small(base64_source, avoid_if_small=avoid_resize_small)
 170     return return_dict
 171
 172
 173 if __name__=="__main__":
 174     import sys
 175
 176     assert len(sys.argv)==3, 'Usage to Test: image.py SRC.png DEST.png'
 177
 178     img = file(sys.argv[1],'rb').read().encode('base64')
 179     new = image_resize_image(img, (128,100))
 180     file(sys.argv[2], 'wb').write(new.decode('base64'))
 181