OSDN Git Service

tablet detection: workaround for laptop touchpad
[mypaint-anime/master.git] / lib / document.py
index f2875a5..0c3f561 100644 (file)
@@ -17,7 +17,11 @@ from gettext import gettext as _
 import helpers, tiledsurface, pixbufsurface, backgroundsurface, mypaintlib
 import command, stroke, layer
 import brush
+
 N = tiledsurface.N
+LOAD_CHUNK_SIZE = 64*1024
+
+from layer import DEFAULT_COMPOSITE_OP, VALID_COMPOSITE_OPS
 
 class SaveLoadError(Exception):
     """Expected errors on loading or saving, like missing permissions or non-existing files."""
@@ -40,14 +44,72 @@ class Document():
     #   or discarded as empty before any other action is possible.
     #   (split_stroke)
 
-    def __init__(self):
-        self.brush = brush.Brush()
+    def __init__(self, brushinfo=None):
+        if not brushinfo:
+            brushinfo = brush.BrushInfo()
+            brushinfo.load_defaults()
+        self.brush = brush.Brush(brushinfo)
         self.stroke = None
         self.canvas_observers = []
         self.stroke_observers = [] # callback arguments: stroke, brush (brush is a temporary read-only convenience object)
         self.doc_observers = []
+        self.frame_observers = []
+        self.command_stack_observers = []
         self.clear(True)
 
+        self._frame = [0, 0, 0, 0]
+        self._frame_enabled = False
+        # Used by move_frame() to accumulate values
+        self._frame_dx = 0.0
+        self._frame_dy = 0.0
+
+    def get_frame(self):
+        return self._frame
+
+    def move_frame(self, dx=0.0, dy=0.0):
+        """Move the frame. Accumulates changes and moves the frame once
+        the accumulated change reaches the minimum move step."""
+        # FIXME: Should be 1 (pixel aligned), not tile aligned
+        # This is due to PNG saving having to be tile aligned
+        min_step = N
+
+        def round_to_n(value, n):
+            return int(round(value/n)*n)
+
+        x, y, w, h = self.get_frame()
+
+        self._frame_dx += dx
+        self._frame_dy += dy
+        step_x = round_to_n(self._frame_dx, min_step)
+        step_y = round_to_n(self._frame_dy, min_step)
+
+        if step_x:
+            self.set_frame(x=x+step_x)
+            self._frame_dx -= step_x
+
+        if step_y:
+            self.set_frame(y=y+step_y)
+            self._frame_dy -= step_y
+
+    def set_frame(self, x=None, y=None, width=None, height=None):
+        """Set the size of the frame. Pass None to indicate no-change."""
+
+        for i, var in enumerate([x, y, width, height]):
+            if not var is None:
+                # FIXME: must be aligned to tile size due to PNG saving
+                assert not var % N, "Frame size must be aligned to tile size"
+                self._frame[i] = var
+
+        for f in self.frame_observers: f()
+
+    def get_frame_enabled(self):
+        return self._frame_enabled
+
+    def set_frame_enabled(self, enabled):
+        self._frame_enabled = enabled
+        for f in self.frame_observers: f()
+    frame_enabled = property(get_frame_enabled)
+
     def call_doc_observers(self):
         for f in self.doc_observers:
             f(self)
@@ -58,7 +120,9 @@ class Document():
         if not init:
             bbox = self.get_bbox()
         # throw everything away, including undo stack
+
         self.command_stack = command.CommandStack()
+        self.command_stack.stack_observers = self.command_stack_observers
         self.set_background((255, 255, 255))
         self.layers = []
         self.layer_idx = None
@@ -91,34 +155,46 @@ class Document():
     def select_layer(self, idx):
         self.do(command.SelectLayer(self, idx))
 
-    def move_layer(self, was_idx, new_idx):
-        self.do(command.MoveLayer(self, was_idx, new_idx))
+    def move_layer(self, was_idx, new_idx, select_new=False):
+        self.do(command.MoveLayer(self, was_idx, new_idx, select_new))
+
+    def duplicate_layer(self, insert_idx=None, name=''):
+        self.do(command.DuplicateLayer(self, insert_idx, name))
+
+    def reorder_layers(self, new_layers):
+        self.do(command.ReorderLayers(self, new_layers))
 
     def clear_layer(self):
-        if not self.layer.surface.is_empty():
+        if not self.layer.is_empty():
             self.do(command.ClearLayer(self))
 
-    def stroke_to(self, dtime, x, y, pressure, xtilt,ytilt):
+    def stroke_to(self, dtime, x, y, pressure, xtilt, ytilt):
         if not self.stroke:
             self.stroke = stroke.Stroke()
             self.stroke.start_recording(self.brush)
             self.snapshot_before_stroke = self.layer.save_snapshot()
-        self.stroke.record_event(dtime, x, y, pressure, xtilt,ytilt)
+        self.stroke.record_event(dtime, x, y, pressure, xtilt, ytilt)
 
-        l = self.layer
-        l.surface.begin_atomic()
-        split = self.brush.stroke_to (l.surface, x, y, pressure, xtilt,ytilt, dtime)
-        l.surface.end_atomic()
+        split = self.layer.stroke_to(self.brush, x, y,
+                                pressure, xtilt, ytilt, dtime)
 
         if split:
             self.split_stroke()
 
+    def redo_last_stroke_with_different_brush(self, brush):
+        cmd = self.get_last_command()
+        if not isinstance(cmd, command.Stroke):
+            return
+        cmd = self.undo()
+        assert isinstance(cmd, command.Stroke)
+        new_stroke = cmd.stroke.copy_using_different_brush(brush)
+        snapshot_before = self.layer.save_snapshot()
+        new_stroke.render(self.layer._surface)
+        self.do(command.Stroke(self, new_stroke, snapshot_before))
+
     def straight_line(self, src, dst):
         self.split_stroke()
-        # TODO: undo last stroke if it was very short... (but not at document level?)
-        real_brush = self.brush
-        self.brush = brush.Brush()
-        self.brush.copy_settings_from(real_brush)
+        self.brush.reset() # reset dynamic states (eg. filtered velocity)
 
         duration = 3.0
         pressure = 0.3
@@ -132,7 +208,7 @@ class Document():
         for i in xrange(N):
             self.stroke_to(duration/N, x[i], y[i], pressure, 0.0, 0.0)
         self.split_stroke()
-        self.brush = real_brush
+        self.brush.reset()
 
 
     def layer_modified_cb(self, *args):
@@ -166,19 +242,21 @@ class Document():
         self.split_stroke()
         return self.command_stack.get_last_command()
 
-    def set_brush(self, brush):
-        self.split_stroke()
-        self.brush.copy_settings_from(brush)
-
     def get_bbox(self):
         res = helpers.Rect()
         for layer in self.layers:
             # OPTIMIZE: only visible layers...
             # careful: currently saving assumes that all layers are included
-            bbox = layer.surface.get_bbox()
+            bbox = layer.get_bbox()
             res.expandToIncludeRect(bbox)
         return res
 
+    def get_effective_bbox(self):
+        """Return the effective bounding box of the document.
+        If the frame is enabled, this is the bounding box of the frame, 
+        else the (dynamic) bounding box of the document."""
+        return self.get_frame() if self.frame_enabled else self.get_bbox()
+
     def blit_tile_into(self, dst_8bit, tx, ty, mipmap_level=0, layers=None, background=None):
         if layers is None:
             layers = self.layers
@@ -191,8 +269,11 @@ class Document():
         background.blit_tile_into(dst, tx, ty, mipmap_level)
 
         for layer in layers:
-            surface = layer.surface
-            surface.composite_tile_over(dst, tx, ty, mipmap_level=mipmap_level, opacity=layer.effective_opacity)
+            surface = layer._surface
+            surface.composite_tile(dst, tx, ty,
+                    mipmap_level=mipmap_level,
+                    opacity=layer.effective_opacity,
+                    mode=layer.compositeop)
 
         mypaintlib.tile_convert_rgb16_to_rgb8(dst, dst_8bit)
 
@@ -222,6 +303,12 @@ class Document():
             self.undo()
         self.do(command.SetLayerVisibility(self, visible, layer))
 
+    def set_layer_locked(self, locked, layer):
+        cmd = self.get_last_command()
+        if isinstance(cmd, command.SetLayerLocked) and cmd.layer is layer:
+            self.undo()
+        self.do(command.SetLayerLocked(self, locked, layer))
+
     def set_layer_opacity(self, opacity, layer=None):
         """Sets the opacity of a layer. If layer=None, works on the current layer"""
         cmd = self.get_last_command()
@@ -229,6 +316,15 @@ class Document():
             self.undo()
         self.do(command.SetLayerOpacity(self, opacity, layer))
 
+    def set_layer_compositeop(self, compositeop, layer=None):
+        """Sets the composition-operation of a layer. If layer=None, works on the current layer"""
+        if compositeop not in VALID_COMPOSITE_OPS:
+            compositeop = DEFAULT_COMPOSITE_OP
+        cmd = self.get_last_command()
+        if isinstance(cmd, command.SetLayerCompositeOp):
+            self.undo()
+        self.do(command.SetLayerCompositeOp(self, compositeop, layer))
+
     def set_background(self, obj):
         # This is not an undoable action. One reason is that dragging
         # on the color chooser would get tons of undo steps.
@@ -240,25 +336,27 @@ class Document():
         self.invalidate_all()
 
     def load_from_pixbuf(self, pixbuf):
+        """Load a document from a pixbuf."""
         self.clear()
         self.load_layer_from_pixbuf(pixbuf)
+        self.set_frame(*self.get_bbox())
 
     def is_layered(self):
         count = 0
         for l in self.layers:
-            if not l.surface.is_empty():
+            if not l.is_empty():
                 count += 1
         return count > 1
 
     def is_empty(self):
-        return len(self.layers) == 1 and self.layer.surface.is_empty()
+        return len(self.layers) == 1 and self.layer.is_empty()
 
     def save(self, filename, **kwargs):
         self.split_stroke()
-        trash, ext = os.path.splitext(filename)
+        junk, ext = os.path.splitext(filename)
         ext = ext.lower().replace('.', '')
         save = getattr(self, 'save_' + ext, self.unsupported)
-        try:        
+        try:
             save(filename, **kwargs)
         except gobject.GError, e:
             traceback.print_exc()
@@ -272,16 +370,16 @@ class Document():
             raise SaveLoadError, _('Unable to save: %s') % e.strerror
         self.unsaved_painting_time = 0.0
 
-    def load(self, filename):
+    def load(self, filename, **kwargs):
         if not os.path.isfile(filename):
             raise SaveLoadError, _('File does not exist: %s') % repr(filename)
         if not os.access(filename,os.R_OK):
             raise SaveLoadError, _('You do not have the necessary permissions to open file: %s') % repr(filename)
-        trash, ext = os.path.splitext(filename)
+        junk, ext = os.path.splitext(filename)
         ext = ext.lower().replace('.', '')
         load = getattr(self, 'load_' + ext, self.unsupported)
         try:
-            load(filename)
+            load(filename, **kwargs)
         except gobject.GError, e:
             traceback.print_exc()
             raise SaveLoadError, _('Error while loading: GError %s') % e
@@ -292,48 +390,86 @@ class Document():
         self.unsaved_painting_time = 0.0
         self.call_doc_observers()
 
-    def unsupported(self, filename):
+    def unsupported(self, filename, *args, **kwargs):
         raise SaveLoadError, _('Unknown file format extension: %s') % repr(filename)
 
     def render_as_pixbuf(self, *args, **kwargs):
         return pixbufsurface.render_as_pixbuf(self, *args, **kwargs)
 
-    def save_png(self, filename, alpha=False, multifile=False):
+    def render_thumbnail(self):
+        t0 = time.time()
+        x, y, w, h = self.get_effective_bbox()
+        if w == 0 or h == 0:
+            # workaround to save empty documents
+            x, y, w, h = 0, 0, tiledsurface.N, tiledsurface.N
+        mipmap_level = 0
+        while mipmap_level < tiledsurface.MAX_MIPMAP_LEVEL and max(w, h) >= 512:
+            mipmap_level += 1
+            x, y, w, h = x/2, y/2, w/2, h/2
+
+        pixbuf = self.render_as_pixbuf(x, y, w, h, mipmap_level=mipmap_level)
+        assert pixbuf.get_width() == w and pixbuf.get_height() == h
+        pixbuf = helpers.scale_proportionally(pixbuf, 256, 256)
+        print 'Rendered thumbnail in', time.time() - t0, 'seconds.'
+        return pixbuf
+
+    def save_png(self, filename, alpha=False, multifile=False, **kwargs):
+        doc_bbox = self.get_effective_bbox()
         if multifile:
-            self.save_multifile_png(filename)
+            self.save_multifile_png(filename, **kwargs)
         else:
             if alpha:
                 tmp_layer = layer.Layer()
                 for l in self.layers:
                     l.merge_into(tmp_layer)
-                tmp_layer.surface.save(filename)
+                tmp_layer.save_as_png(filename, *doc_bbox)
             else:
-                pixbufsurface.save_as_png(self, filename, alpha=False)
+                pixbufsurface.save_as_png(self, filename, *doc_bbox, alpha=False, **kwargs)
 
-    def save_multifile_png(self, filename, alpha=False):
+    def save_multifile_png(self, filename, alpha=False, **kwargs):
         prefix, ext = os.path.splitext(filename)
         # if we have a number already, strip it
         l = prefix.rsplit('.', 1)
         if l[-1].isdigit():
             prefix = l[0]
-        doc_bbox = self.get_bbox()
+        doc_bbox = self.get_effective_bbox()
         for i, l in enumerate(self.layers):
             filename = '%s.%03d%s' % (prefix, i+1, ext)
-            l.surface.save(filename, *doc_bbox)
-
-    def load_png(self, filename):
-        self.load_from_pixbuf(gdk.pixbuf_new_from_file(filename))
-
-    def load_jpg(self, filename):
-        self.load_from_pixbuf(gdk.pixbuf_new_from_file(filename))
-    load_jpeg = load_jpg
-
-    def save_jpg(self, filename, quality=90):
-        pixbuf = self.render_as_pixbuf()
+            l.save_as_png(filename, *doc_bbox, **kwargs)
+
+    @staticmethod
+    def _pixbuf_from_stream(fp, feedback_cb=None):
+        loader = gdk.PixbufLoader()
+        while True:
+            if feedback_cb is not None:
+                feedback_cb()
+            buf = fp.read(LOAD_CHUNK_SIZE)
+            if buf == '':
+                break
+            loader.write(buf)
+        loader.close()
+        return loader.get_pixbuf()
+
+    def load_from_pixbuf_file(self, filename, feedback_cb=None):
+        fp = open(filename, 'rb')
+        pixbuf = self._pixbuf_from_stream(fp, feedback_cb)
+        fp.close()
+        self.load_from_pixbuf(pixbuf)
+
+    load_png = load_from_pixbuf_file
+    load_jpg = load_from_pixbuf_file
+    load_jpeg = load_from_pixbuf_file
+
+    def save_jpg(self, filename, quality=90, **kwargs):
+        x, y, w, h = self.get_effective_bbox()
+        if w == 0 or h == 0:
+            x, y, w, h = 0, 0, N, N # allow to save empty documents
+        pixbuf = self.render_as_pixbuf(x, y, w, h, **kwargs)
         pixbuf.save(filename, 'jpeg', options={'quality':str(quality)})
+
     save_jpeg = save_jpg
 
-    def save_ora(self, filename, options=None):
+    def save_ora(self, filename, options=None, **kwargs):
         print 'save_ora:'
         t0 = time.time()
         tempdir = tempfile.mkdtemp('mypaint')
@@ -347,7 +483,7 @@ class Document():
         write_file_str('mimetype', 'image/openraster') # must be the first file
         image = ET.Element('image')
         stack = ET.SubElement(image, 'stack')
-        x0, y0, w0, h0 = self.get_bbox()
+        x0, y0, w0, h0 = self.get_effective_bbox()
         a = image.attrib
         a['w'] = str(w0)
         a['h'] = str(h0)
@@ -363,12 +499,12 @@ class Document():
         def store_surface(surface, name, rect=[]):
             tmp = join(tempdir, 'tmp.png')
             t1 = time.time()
-            surface.save(tmp, *rect)
+            surface.save_as_png(tmp, *rect, **kwargs)
             print '  %.3fs surface saving %s' % (time.time() - t1, name)
             z.write(tmp, name)
             os.remove(tmp)
 
-        def add_layer(x, y, opac, surface, name, layer_name, visible=True, rect=[]):
+        def add_layer(x, y, opac, surface, name, layer_name, visible=True, compositeop=DEFAULT_COMPOSITE_OP, rect=[]):
             layer = ET.Element('layer')
             stack.append(layer)
             store_surface(surface, name, rect)
@@ -379,6 +515,9 @@ class Document():
             a['x'] = str(x)
             a['y'] = str(y)
             a['opacity'] = str(opac)
+            if compositeop not in VALID_COMPOSITE_OPS:
+                compositeop = DEFAULT_COMPOSITE_OP
+            a['composite-op'] = compositeop
             if visible:
                 a['visibility'] = 'visible'
             else:
@@ -386,11 +525,11 @@ class Document():
             return layer
 
         for idx, l in enumerate(reversed(self.layers)):
-            if l.surface.is_empty():
+            if l.is_empty():
                 continue
             opac = l.opacity
-            x, y, w, h = l.surface.get_bbox()
-            el = add_layer(x-x0, y-y0, opac, l.surface, 'data/layer%03d.png' % idx, l.name, l.visible, rect=(x, y, w, h))
+            x, y, w, h = l.get_bbox()
+            el = add_layer(x-x0, y-y0, opac, l._surface, 'data/layer%03d.png' % idx, l.name, l.visible, l.compositeop, rect=(x, y, w, h))
             # strokemap
             sio = StringIO()
             l.save_strokemap_to_file(sio, -x, -y)
@@ -402,7 +541,9 @@ class Document():
         # save background as layer (solid color or tiled)
         bg = self.background
         # save as fully rendered layer
-        l = add_layer(0, 0, 1.0, bg, 'data/background.png', 'background', rect=(x0, y0, w0, h0))
+        x, y, w, h = self.get_bbox()
+        l = add_layer(x-x0, y-y0, 1.0, bg, 'data/background.png', 'background',
+                      DEFAULT_COMPOSITE_OP, rect=(x,y,w,h))
         x, y, w, h = bg.get_pattern_bbox()
         # save as single pattern (with corrected origin)
         store_surface(bg, 'data/background_tile.png', rect=(x+x0, y+y0, w, h))
@@ -412,22 +553,8 @@ class Document():
         t2 = time.time()
         print '  starting to render full image for thumbnail...'
 
-        x, y, w, h = x0, y0, w0, h0
-        mipmap_level = 0
-        while mipmap_level < tiledsurface.MAX_MIPMAP_LEVEL and max(w, h) >= 512:
-            mipmap_level += 1
-            x, y, w, h = x/2, y/2, w/2, h/2
-
-        pixbuf = self.render_as_pixbuf(x, y, w, h, mipmap_level=mipmap_level)
-        assert pixbuf.get_width() == w and pixbuf.get_height() == h
-        if w > h:
-            w, h = 256, max(h*256/w, 1)
-        else:
-            w, h = max(w*256/h, 1), 256
-        t1 = time.time()
-        pixbuf = pixbuf.scale_simple(w, h, gdk.INTERP_BILINEAR)
-        print '  %.3fs scaling thumbnail' % (time.time() - t1)
-        store_pixbuf(pixbuf, 'Thumbnails/thumbnail.png')
+        thumbnail_pixbuf = self.render_thumbnail()
+        store_pixbuf(thumbnail_pixbuf, 'Thumbnails/thumbnail.png')
         print '  total %.3fs spent on thumbnail' % (time.time() - t2)
 
         helpers.indent_etree(image)
@@ -442,33 +569,41 @@ class Document():
 
         print '%.3fs save_ora total' % (time.time() - t0)
 
-    def load_ora(self, filename):
+        return thumbnail_pixbuf
+
+    def load_ora(self, filename, feedback_cb=None):
         """Loads from an OpenRaster file"""
         print 'load_ora:'
         t0 = time.time()
-        tempdir = tempfile.mkdtemp('mypaint')
         z = zipfile.ZipFile(filename)
         print 'mimetype:', z.read('mimetype').strip()
         xml = z.read('stack.xml')
         image = ET.fromstring(xml)
         stack = image.find('stack')
 
+        w = int(image.attrib['w'])
+        h = int(image.attrib['h'])
+
+        def round_up_to_n(value, n):
+            assert value >= 0, "function undefined for negative numbers"
+
+            residual = value % n
+            if residual:
+                value = value - residual + n
+            return int(value)
+
         def get_pixbuf(filename):
             t1 = time.time()
-            tmp = join(tempdir, 'tmp.png')
-            f = open(tmp, 'wb')
 
             try:
-                data = z.read(filename)
+                fp = z.open(filename, mode='r')
             except KeyError:
                 # support for bad zip files (saved by old versions of the GIMP ORA plugin)
-                data = z.read(filename.encode('utf-8'))
+                fp = z.open(filename.encode('utf-8'), mode='r')
                 print 'WARNING: bad OpenRaster ZIP file. There is an utf-8 encoded filename that does not have the utf-8 flag set:', repr(filename)
 
-            f.write(data)
-            f.close()
-            res = gdk.pixbuf_new_from_file(tmp)
-            os.remove(tmp)
+            res = self._pixbuf_from_stream(fp, feedback_cb)
+            fp.close()
             print '  %.3fs loading %s' % (time.time() - t1, filename)
             return res
 
@@ -491,6 +626,9 @@ class Document():
 
         self.clear() # this leaves one empty layer
         no_background = True
+        # FIXME: don't require tile alignment for frame
+        self.set_frame(width=round_up_to_n(w, N), height=round_up_to_n(h, N))
+
         for layer in get_layers_list(stack):
             a = layer.attrib
 
@@ -513,6 +651,10 @@ class Document():
             x = int(a.get('x', '0'))
             y = int(a.get('y', '0'))
             opac = float(a.get('opacity', '1.0'))
+            compositeop = str(a.get('composite-op', DEFAULT_COMPOSITE_OP))
+            if compositeop not in VALID_COMPOSITE_OPS:
+                compositeop = DEFAULT_COMPOSITE_OP
+
             visible = not 'hidden' in a.get('visibility', 'visible')
             self.add_layer(insert_idx=0, name=name)
             last_pixbuf = pixbuf
@@ -521,6 +663,7 @@ class Document():
             layer = self.layers[0]
 
             self.set_layer_opacity(helpers.clamp(opac, 0.0, 1.0), layer)
+            self.set_layer_compositeop(compositeop, layer)
             self.set_layer_visibility(visible, layer)
             print '  %.3fs converting pixbuf to layer format' % (time.time() - t1)
             # strokemap
@@ -533,17 +676,16 @@ class Document():
                     layer.load_strokemap_from_file(sio, x, y)
                     sio.close()
 
-        os.rmdir(tempdir)
-
         if len(self.layers) == 1:
-            raise ValueError, 'Could not load any layer.'
+            # no assertion (allow empty documents)
+            print 'Warning: Could not load any layer, document is empty.'
 
         if no_background:
             # recognize solid or tiled background layers, at least those that mypaint <= 0.7.1 saves
             t1 = time.time()
             p = last_pixbuf
             if not p.get_has_alpha() and p.get_width() % N == 0 and p.get_height() % N == 0:
-                tiles = self.layers[0].surface.tiledict.values()
+                tiles = self.layers[0]._surface.tiledict.values()
                 if len(tiles) > 1:
                     all_equal = True
                     for tile in tiles[1:]: