Add extension to set attributes for bitmap images (bug #1357808)

Inkscape >= 0.91 adds the attribute 'preserveAspectRatio'
to imported bitmap images, and sets it to 'none' (to support
non-uniform scaling). Unlike older versions it also respects the
attribute for rendering. This change may break Inkscape documents
with embedded or linked bitmap images which had been created with
older versions of Inkscape (the images do not have the attribute
set, and thus default to 'xMidYMid' with enforced uniform scaling).

The extension allows to add the attribute to selected or all bitmap
images in the current document (including bitmap images used as
masks, which are stored in the <defs> section).

Fixed bugs:
  - https://launchpad.net/bugs/1357808

(bzr r14164)

2 files changed, 251 insertions, 0 deletions

diff --git a/share/extensions/image_attributes.inx b/share/extensions/image_attributes.inx
new file mode 100644
index 000000000..d0c00f6a2
--- /dev/null
+++ b/share/extensions/image_attributes.inx
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
+
+    <_name>Set Image Attributes</_name>
+    <id>org.inkscape.effect.image_attributes</id>
+
+    <dependency type="executable" location="extensions">image_attributes.py</dependency>
+    <dependency type="executable" location="extensions">inkex.py</dependency>
+
+    <param name="tab_main" type="notebook">
+
+        <!-- render images like in 0.48 -->
+        <page name="tab_basic" _gui-text="Basic">
+            <param name="basic_desc1" type="description">Render all bitmap images like in older Inskcape versions.
+
+Available options:</param>
+            <param name="fix_scaling" type="boolean" _gui-text="Support non-unifom scaling">true</param>
+            <param name="fix_rendering" type="boolean" _gui-text="Render images blocky">false</param>
+        </page>
+
+        <!-- image aspect ratio -->
+        <page name="tab_aspectRatio" _gui-text="Image Aspect Ratio">
+            <param name="aspect_ratio" type="enum" _gui-text="preserveAspectRatio attribute:">
+                <item value="none">none</item>
+                <item value="unset">Unset</item>
+                <item value="xMinYMin">xMinYMin</item>
+                <item value="xMidYMin">xMidYMin</item>
+                <item value="xMaxYMin">xMaxYMin</item>
+                <item value="xMinYMid">xMinYMid</item>
+                <item value="xMidYMid">xMidYMid</item>
+                <item value="xMaxYMid">xMaxYMid</item>
+                <item value="xMinYMax">xMinYMax</item>
+                <item value="xMidYMax">xMidYMax</item>
+                <item value="xMaxYMax">xMaxYMax</item>
+            </param>
+            <param name="aspect_clip" type="enum" _gui-text="meetOrSlice:">
+                <item value="unset">-</item>
+                <item value="meet">meet</item>
+                <item value="slice">slice</item>
+            </param>
+            <param name="aspect_ratio_scope" type="enum" _gui-text="Scope:">
+                <item value="selected_only">Change only selected image(s)</item>
+                <item value="in_selection">Change all images in selection</item>
+                <item value="in_document">Change all images in document</item>
+            </param>
+        </page>
+
+        <!-- image-rendering -->
+        <page name="tab_image_rendering" _gui-text="Image Rendering Quality">
+            <param name="image_rendering" type="enum" _gui-text="Image rendering attribute:">
+                <item value="unset">Unset</item>
+                <item value="auto">auto</item>
+                <item value="optimizeQuality">optimizeQuality</item>
+                <item value="optimizeSpeed">optimizeSpeed</item>
+                <item value="inherit">inherit</item>
+            </param>
+            <param name="image_rendering_scope" type="enum" _gui-text="Scope:">
+                <item value="selected_only">Change only selected image(s)</item>
+                <item value="in_selection">Change all images in selection</item>
+                <item value="in_document">Change all images in document</item>
+                <item value="on_parent_group">Apply attribute to parent group of selection</item>
+                <item value="on_root_only" >Apply attribute to SVG root</item>
+            </param>
+        </page>
+
+    </param>
+
+    <effect needs-document="true" needs-live-preview="true">
+        <object-type>all</object-type>
+        <effects-menu>
+            <submenu _name="Images"/>
+        </effects-menu>
+    </effect>
+
+    <script>
+        <command reldir="extensions" interpreter="python">image_attributes.py</command>
+    </script>
+
+    <options silent="false"></options>
+
+</inkscape-extension>
+
diff --git a/share/extensions/image_attributes.py b/share/extensions/image_attributes.py
new file mode 100755
index 000000000..ddd5a8b87
--- /dev/null
+++ b/share/extensions/image_attributes.py
@@ -0,0 +1,169 @@
+#!/usr/bin/env python
+'''
+image_attributes.py - adjust image attributes which don't have global
+GUI options yet
+
+Tool for Inkscape 0.91 to adjust rendering of drawings with linked
+or embedded bitmap images created with older versions of Inkscape
+or third-party applications.
+
+Copyright (C) 2015, ~suv <suv-sf@users.sf.net>
+
+This program 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 2 of the License, or
+(at your option) any later version.
+
+This program 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 this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+'''
+
+# local library
+import inkex
+import simplestyle
+
+try:
+    inkex.localize()
+except:
+    import gettext
+    _ = gettext.gettext
+
+
+class SetAttrImage(inkex.Effect):
+    def __init__(self):
+        inkex.Effect.__init__(self)
+        # main options
+        self.OptionParser.add_option("--fix_scaling",
+                                     action="store", type="inkbool",
+                                     dest="fix_scaling", default=True,
+                                     help="")
+        self.OptionParser.add_option("--fix_rendering",
+                                     action="store", type="inkbool",
+                                     dest="fix_rendering", default=False,
+                                     help="")
+        self.OptionParser.add_option("--aspect_ratio",
+                                     action="store", type="string",
+                                     dest="aspect_ratio", default="none",
+                                     help="Value for attribute 'preserveAspectRatio'")
+        self.OptionParser.add_option("--aspect_clip",
+                                     action="store", type="string",
+                                     dest="aspect_clip", default="unset",
+                                     help="optional 'meetOrSlice' value")
+        self.OptionParser.add_option("--aspect_ratio_scope",
+                                     action="store", type="string",
+                                     dest="aspect_ratio_scope", default="selected_only",
+                                     help="scope within which to edit 'preserveAspectRatio' attribute")
+        self.OptionParser.add_option("--image_rendering",
+                                     action="store", type="string",
+                                     dest="image_rendering", default="unset",
+                                     help="Value for attribute 'image-rendering'")
+        self.OptionParser.add_option("--image_rendering_scope",
+                                     action="store", type="string",
+                                     dest="image_rendering_scope", default="selected_only",
+                                     help="scope within which to edit 'image-rendering' attribute")
+        # tabs
+        self.OptionParser.add_option("--tab_main",
+                                     action="store", type="string",
+                                     dest="tab_main")
+
+    # core method
+
+    def change_attribute(self, node, attribute):
+        for key, value in attribute.items():
+            if key == 'preserveAspectRatio':
+                # set presentation attribute
+                if value != "unset":
+                    node.set(key, str(value))
+                else:
+                    if node.get(key):
+                        del node.attrib[key]
+            elif key == 'image-rendering':
+                node_style = simplestyle.parseStyle(node.get('style'))
+                if key not in node_style:
+                    # set presentation attribute
+                    if value != "unset":
+                        node.set(key, str(value))
+                    else:
+                        if node.get(key):
+                            del node.attrib[key]
+                else:
+                    # set style property
+                    if value != "unset":
+                        node_style[key] = str(value)
+                    else:
+                        del node_style[key]
+                    node.set('style', simplestyle.formatStyle(node_style))
+            else:
+                pass
+
+    def change_all_images(self, node, attribute):
+        path = 'descendant-or-self::svg:image'
+        for img in node.xpath(path, namespaces=inkex.NSS):
+            self.change_attribute(img, attribute)
+
+    # methods called via dispatcher
+
+    def change_selected_only(self, selected, attribute):
+        if selected:
+            for node_id, node in selected.iteritems():
+                if node.tag == inkex.addNS('image', 'svg'):
+                    self.change_attribute(node, attribute)
+
+    def change_in_selection(self, selected, attribute):
+        if selected:
+            for node_id, node in selected.iteritems():
+                self.change_all_images(node, attribute)
+
+    def change_in_document(self, selected, attribute):
+        self.change_all_images(self.document.getroot(), attribute)
+
+    def change_on_parent_group(self, selected, attribute):
+        if selected:
+            for node_id, node in selected.iteritems():
+                self.change_attribute(node.getparent(), attribute)
+
+    def change_on_root_only(self, selected, attribute):
+        self.change_attribute(self.document.getroot(), attribute)
+
+    # main
+
+    def effect(self):
+        attr_val = []
+        attr_dict = {}
+        cmd_scope = None
+        if self.options.tab_main == '"tab_basic"':
+            cmd_scope = "in_document"
+            attr_dict['preserveAspectRatio'] = ("none" if self.options.fix_scaling else "unset")
+            attr_dict['image-rendering'] = ("optimizeSpeed" if self.options.fix_rendering else "unset")
+        elif self.options.tab_main == '"tab_aspectRatio"':
+            attr_val = [self.options.aspect_ratio]
+            if self.options.aspect_clip != "unset":
+                attr_val.append(self.options.aspect_clip)
+            attr_dict['preserveAspectRatio'] = ' '.join(attr_val)
+            cmd_scope = self.options.aspect_ratio_scope
+        elif self.options.tab_main == '"tab_image_rendering"':
+            attr_dict['image-rendering'] = self.options.image_rendering
+            cmd_scope = self.options.image_rendering_scope
+        else:  # help tab
+            pass
+        # dispatcher
+        if cmd_scope is not None:
+            try:
+                change_cmd = getattr(self, 'change_{0}'.format(cmd_scope))
+                change_cmd(self.selected, attr_dict)
+            except AttributeError:
+                inkex.errormsg('Scope "{0}" not supported'.format(cmd_scope))
+
+
+if __name__ == '__main__':
+    e = SetAttrImage()
+    e.affect()
+
+
+# vim: expandtab shiftwidth=4 tabstop=8 softtabstop=4 fileencoding=utf-8 textwidth=99