synfig_fileformat.py 6.97 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
#!/usr/bin/env python
"""
synfig_fileformat.py
Synfig file format utilities

Copyright (C) 2011 Nikita Kitaev

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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
"""

###### Constants ##########################################
kux = 60.0 # Number of SVG units (pixels) per Synfig "unit"
gamma = 2.2
tangent_scale = 3.0 # Synfig tangents are scaled by a factor of 3



###### Layer parameters, types, and default values ########
layers = {}

# Layer_Composite is the parent of most layers
default_composite = {
    "z_depth": ["real", 0.0],
    "amount": ["real", 1.0],
    "blend_method": ["integer", 0],
    }

layers["PasteCanvas"] = default_composite.copy()
layers["PasteCanvas"].update({
        "origin": ["vector", [0.0, 0.0]],
        "canvas": ["canvas", None],
        "zoom": ["real", 0.0],
        "time_offset": ["time", "0s"],
        "children_lock": ["bool", False],
        "focus": ["vector", [0.0, 0.0]]
        })


## Layers in mod_geometry

layers["circle"] = default_composite.copy()
layers["circle"].update({
        "color": ["color", [0,0,0,1]],
        "radius": ["real", 1.0],
        "feather": ["real", 0.0],
        "origin": ["vector", [0.0, 0.0]],
        "invert": ["bool", False],
        "falloff": ["integer", 2]
        })

layers["rectangle"] = default_composite.copy()
layers["rectangle"].update({
        "color": ["color", [0,0,0,1]],
        "point1": ["vector", [0,0]],
        "point2": ["vector", [1,1]],
        "expand": ["real", 0.0],
        "invert": ["bool", False]
        })

default_shape = default_composite.copy()
default_shape.update({
        "color": ["color", [0,0,0,1]],
        "origin": ["vector", [0.0, 0.0]],
        "invert": ["bool", False],
        "antialias": ["bool", True],
        "feather": ["real",  0.0],
        "blurtype": ["integer",  1],
        "winding_style": ["integer", 0]
        })

layers["region"] = default_shape.copy()
layers["region"].update({
        "bline": ["bline", None]
        })

layers["outline"] = default_shape.copy()
layers["outline"].update({
        "bline": ["bline", None],
        "round_tip[0]": ["bool", True],
        "round_tip[1]": ["bool", True],
        "sharp_cusps": ["bool", True],
        "width": ["real", 1.0],
        "loopyness": ["real", 1.0],
        "expand": ["real", 0.0],
        "homogeneous_width": ["bool", True]
        })


## Layers in mod_gradient

layers["linear_gradient"] = default_composite.copy()
layers["linear_gradient"].update({
        "p1": ["vector", [0,0]],
        "p2": ["vector", [1,1]],
        "gradient": ["gradient", {0.0:[0,0,0,1], 1.0:[1,1,1,1]} ],
        "loop": ["bool", False],
        "zigzag": ["bool", False]
        })

layers["radial_gradient"] = default_composite.copy()
layers["radial_gradient"].update({
        "gradient": ["gradient", {0.0:[0,0,0,1], 1.0:[1,1,1,1]} ],
        "center": ["vector", [0,0]],
        "radius": ["real", 1.0],
        "loop": ["bool", False],
        "zigzag": ["bool", False]
        })


## Layers in lyr_std

layers["import"] = default_composite.copy()
layers["import"].update({
        "tl": ["vector", [-1,1]],
        "br": ["vector", [1,-1]],
        "c": ["integer", 1],
        "gamma_adjust": ["real", 1.0],
        "filename": ["string", ""],   # <string>foo</string>
        "time_offset": ["time", "0s"]
        })

# transforms are not blending
layers["warp"] = {
    "src_tl": ["vector", [-1,1]],
    "src_br": ["vector", [1,-1]],
    "dest_tl": ["vector", [-1,1]],
    "dest_tr": ["vector", [1,1]],
    "dest_br": ["vector", [1,-1]],
    "dest_bl": ["vector", [-1,-1]],
    "clip": ["bool", False],
    "horizon": ["real", 4.0]
    }

layers["rotate"] = {
    "origin": ["vector", [0.0, 0.0]],
    "amount": ["angle", 0] # <angle value=.../>
    }

layers["translate"] = {
    "origin": ["vector", [0.0, 0.0]]
    }

## Layers in mod_filter
layers["blur"] = default_composite.copy()
layers["blur"].update({
        "size": ["vector", [1,1]],
        "type": ["integer", 3] # 1 is fast gaussian, 3 is regular
        })


###### Layer versions #####################################
layer_versions = {
    "outline" : "0.2",
    "rectangle" : "0.2",
    "linear_gradient" : "0.0",
    "blur" : "0.2",
    None : "0.1" # default
    }

###### Blend Methods ######################################
blend_method_names = {
    0  : "composite",
    1  : "straight",
    13 : "onto",
    21 : "straight onto",
    12 : "behind",
    16 : "screen",
    20 : "overlay",
    17 : "hand light",
    6  : "multiply",
    7  : "divide",
    4  : "add",
    5  : "subtract",
    18 : "difference",
    2  : "brighten",
    3  : "darken",
    8  : "color",
    9  : "hue",
    10 : "saturation",
    11 : "luminance",
    14 : "alpha brighten", #deprecated
    15 : "alpha darken",   #deprecated
    19 : "alpha over"      #deprecated
    }

Thomas Holder's avatar
Thomas Holder committed
198
blend_methods = dict((v, k) for (k, v) in blend_method_names.items())
199 200 201 202 203 204 205 206

###### Functions ##########################################
def paramType(layer, param, value=None):
    if layer in layers.keys():
        layer_params = layers[layer]
        if param in layer_params.keys():
            return layer_params[param][0]
        else:
207
            raise Exception("Invalid parameter type for layer")
208 209 210
    else:
        # Unknown layer, try to determine parameter type based on value
        if value is None:
211
            raise Exception("No information for given layer")
212 213 214 215 216 217 218 219 220 221 222 223
        if type(value) == int:
            return "integer"
        elif type(value) == float:
            return "real"
        elif type(value) == bool:
            return "bool"
        elif type(value) == dict:
            if "points" in value.keys():
                return "bline"
            elif 0.0 in value.keys():
                return "gradient"
            else:
224
                raise Exception("Could not automatically determine parameter type")
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        elif type(value) == list:
            if len(value) == 2:
                return "vector"
            elif len(value) == 3 or len(value) == 4:
                return "color"
            else:
                # The first two could also be canvases
                return "canvas"
        elif type(value) == str:
            return "string"

def defaultLayerVersion(layer):
    if layer in layer_versions.keys():
        return layer_versions[layer]
    else:
        return layer_versions[None]

def defaultLayerParams(layer):
    if layer in layers.keys():
        return layers[layer].copy()
    else:
        return {}