TD-e.com

Frame it

A script-fu for The Gimp

Example

image framed with the script-fu 'frame it'

Zoom image

Description

"Frame it" is a script-fu for the Gimp. It generates a frame around an image. The width of the frame can be set to your taste. You choose if you would like a plain color frame, a gradient between 2 colors or one of the predefined gradients of The Gimp involving more than 2 colors. You could even define a new complex gradient with The Gimp and then build a frame with this special gradient using this script. Like usual you can choose to have the layers merged (or not) at the end of the operation.

The script has been tested with The Gimp version 2.2.9 on Linux SuSE and with The Gimp version 2.2.10 on Windoze.
The script version 1.10 has been tested with The Gimp version 2.4.0 on Linux Ubuntu 7.10 Gutsy Gibbon.

Versions

2007.07.12 : A precision error of 1 pixel in 2 of the 4 corners has been corrected thanks to a proposition of Harald, a user.
2007.10.25 : The current version is 1.10 and has been adapted to The Gimp 2.4. It is now under the menu "Filters" and not anymore under the menu "script-Fu".

Download:

Click into the blue frame below where the script is listed.
Type Control-A to select the complete text of the script.
Type Control-C to copy the script to the clipboard.
Go to your text editor (gedit, Kate, Aedix, Notepad, etc) and type Control-V to paste the script.
Save it as a file named frame-it.scm

Linux Ubuntu or other Gnome:   use the text editor gedit or bluefish

Linux Kubuntu or other KDE:   use the text editor Kate or Quanta

Mac OS X:   use the text editor Smultron

Windoze:   use the text editor Aedix (free), or Notepad (but beware of the file extension .txt which is unwanted, the script file must have the extension .scm and not .scm.txt)

Other text editors are ok too, but word processors are not. Do not use Word, OpenOffice or similar tools.

Installation:

Copy frame-it.scm into one of the directories registered in the Gimp preferences under Folders/Scripts.

Linux Ubuntu and many others:
  /home/[username]/.gimp-2.n/scripts   or   /usr/share/gimp/2.0/scripts

Linux SuSE:
  /home/[username]/.gimp-2.n/scripts   or   /opt/gnome/share/gimp/2.0/scripts

Windoze:
  C:\.gimp-2.n\scripts   or   C:\program-files\gimp2.n\share\gimp\scripts

Then go to the menu Xtns (in The Gimp) and select Xtns / Script-Fu / Refresh Scripts. That's it.
The script can be called in the menu Script-Fu / Decor / Frame it...

ATTENTION : The version 1.10 can be called in the menu Filters / Decor / Frame it.... For mysterious reasons, the group "Decor" did refuse to appear under the menu "Script-Fu", at least in my Gimp 2.4.0, so I did put the script under the menu Filters/Decor.

Script-fu frame-it.scm for The Gimp

Notice: Undefined index: isbrowser in /home/photowp/domains/td-e.com/public_html/pbin/func/piphost.php on line 58

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; SCRIPT-FU-FRAME-IT
; version 1.02  2006.07.02
; version 1.03  2007.07.12 one pixel precision error in 2 corners corrected
; version 1.10  2007.10.25, migration to Gimp 2.4
; Copyright (c) 2006-2007 Tharsice Demand <www.td-e.com>
;
;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.
;
;Copy of the license at http://td-e.com/site/gpl.php

(define (deltacolor col delta)
  (let* ((newcol (+ col delta)))
    (if (< newcol 0) (set! newcol 0))
    (if (> newcol 255) (set! newcol 255))
    newcol)
)

(define (adjcolor col delta)
  (mapcar (lambda (x) (deltacolor x delta)) col)
)

(define (gen_top_array xsize ysize owidth oheight width height)
  (let* ((n_array (cons-array 10 'double)))
    (aset n_array 0 0 )
    (aset n_array 1 0 )
    (aset n_array 2 xsize)
    (aset n_array 3 ysize)
    (aset n_array 4 (+ xsize owidth))
    (aset n_array 5 ysize)
    (aset n_array 6 width)
    (aset n_array 7 0 )
    (aset n_array 8 0 )
    (aset n_array 9 0 )
    n_array)
)

(define (gen_left_array xsize ysize owidth oheight width height)
  (let* ((n_array (cons-array 10 'double)))
    (aset n_array 0 0 )
    (aset n_array 1 0 )
    (aset n_array 2 xsize)
    (aset n_array 3 ysize)
    (aset n_array 4 xsize)
    (aset n_array 5 (+ ysize oheight))
    (aset n_array 6 0 )
    (aset n_array 7 height )
    (aset n_array 8 0 )
    (aset n_array 9 0 )
    n_array)
)

(define (gen_right_array xsize ysize owidth oheight width height)
  (let* ((n_array (cons-array 10 'double)))
    (aset n_array 0 width )
    (aset n_array 1 0 )
    (aset n_array 2 (+ xsize owidth))
    (aset n_array 3 ysize)
    (aset n_array 4 (+ xsize owidth))
    (aset n_array 5 (+ ysize oheight))
    (aset n_array 6 width)
    (aset n_array 7 height)
    (aset n_array 8 width )
    (aset n_array 9 0 )
    n_array)
)

(define (gen_bottom_array xsize ysize owidth oheight width height)
  (let* ((n_array (cons-array 10 'double)))
    (aset n_array 0 0 )
    (aset n_array 1 height)
    (aset n_array 2 xsize)
    (aset n_array 3 (+ ysize oheight))
    (aset n_array 4 (+ xsize owidth))
    (aset n_array 5 (+ ysize oheight))
    (aset n_array 6 width)
    (aset n_array 7 height)
    (aset n_array 8 0 )
    (aset n_array 9 height)
    n_array)
)

(define *border-color*
  '(
    ("Gradient above"           0)
    ("Gradient color 1/color 2" 1)
    ("Plain color 1 with Delta" 2)
   )
)

(define (script-fu-frame-it aimg adraw xsize ysize fcolor1 fcolor2 fgradient revgradient dvalue bordercol flatten)
  (let* 
    (
      (img (car (gimp-drawable-get-image adraw)))
      (owidth (car (gimp-image-width img)))
      (oheight (car (gimp-image-height img)))
      (width (+ owidth (* 2 xsize)))
      (height (+ oheight (* 2 ysize)))
      (layer (car (gimp-layer-new img
                                  width height
                                  (car (gimp-drawable-type-with-alpha adraw))
                                  "Border-Layer" 100 NORMAL-MODE)))
      (blendmode (if (= bordercol 0) CUSTOM-MODE FG-BG-RGB-MODE))

(topout (if (= revgradient FALSE) 0 (- ysize 1) ))
      (topin  (if (= revgradient FALSE) (- ysize 1) 0 ))
      (bottomout  (if (= revgradient FALSE) (- height 1) (- height ysize) ))
      (bottomin  (if (= revgradient FALSE) (- height ysize) (- height 1) ))
      (leftout  (if (= revgradient FALSE) 0 (- xsize 1) ))
      (leftin  (if (= revgradient FALSE) (- xsize 1) 0 ))
      (rightout  (if (= revgradient FALSE) (- width 1) (- width xsize) ))
      (rightin  (if (= revgradient FALSE) (- width xsize) (- width 1) ))
    )

(gimp-context-push)
    (gimp-image-undo-group-start img)

(gimp-image-resize img
                       width
                       height
                       xsize
                       ysize)

(gimp-image-add-layer img layer 0)
    (gimp-drawable-fill layer TRANSPARENT-FILL)
    (if (<= bordercol 1) (gimp-context-set-background fcolor1))
    (if (<= bordercol 1) (gimp-context-set-foreground fcolor2))
    (if (= bordercol 0) (gimp-context-set-gradient fgradient))

;---TOP---
    (gimp-context-set-background (adjcolor fcolor1 (- 0 dvalue)))
    (gimp-free-select img
                      10
                      (gen_top_array xsize ysize owidth oheight width height)
                      CHANNEL-OP-REPLACE
                      0
                      0
                      0.0)

(if (>= bordercol 0) (gimp-edit-fill layer BACKGROUND-FILL))
    (if (<= bordercol 1) (gimp-edit-blend
      layer
      blendmode
      NORMAL-MODE
      GRADIENT-LINEAR
      100
      0
      REPEAT-NONE
      FALSE
      FALSE
      0 0
      FALSE
      (/ width 2) topout
      (/ width 2) topin)
    )

;---LEFT---
    (gimp-context-set-background (adjcolor fcolor1 (- 0 (/ dvalue 2))))
    (gimp-free-select img
                      10
                      (gen_left_array xsize ysize owidth oheight width height)
                      CHANNEL-OP-REPLACE
                      0
                      0
                      0.0)
    (if (>= bordercol 0) (gimp-edit-fill layer BACKGROUND-FILL))
    (if (<= bordercol 1) (gimp-edit-blend
      layer
      blendmode
      NORMAL-MODE
      GRADIENT-LINEAR
      100
      0
      REPEAT-NONE
      FALSE
      FALSE
      0 0
      FALSE
      leftout (/ height 2)
      leftin (/ height 2))
    )

;---RIGHT---
    (gimp-context-set-background (adjcolor fcolor1 (/ dvalue 2)))
    (gimp-free-select img
                      10
                      (gen_right_array xsize ysize owidth oheight width height)
                      CHANNEL-OP-REPLACE
                      0
                      0
                      0.0)
    (if (>= bordercol 0) (gimp-edit-fill layer BACKGROUND-FILL))
    (if (<= bordercol 1) (gimp-edit-blend
      layer
      blendmode
      NORMAL-MODE
      GRADIENT-LINEAR
      100
      0
      REPEAT-NONE
      FALSE
      FALSE
      0 0
      FALSE
      rightout (/ height 2)
      rightin (/ height 2))
    )

;---BOTTOM---
    (gimp-context-set-background (adjcolor fcolor1 dvalue))
    (gimp-free-select img
                      10
                      (gen_bottom_array xsize ysize owidth oheight width height)
                      CHANNEL-OP-REPLACE
                      0
                      0
                      0.0)

;---FINISHING---
    (gimp-selection-none img)
    (if (= flatten 1) (gimp-image-flatten img) ())
    (gimp-displays-flush)

(gimp-image-undo-group-end img)
    (gimp-context-pop)
  )
)

(script-fu-register "script-fu-frame-it"
                    "<Image>/Filters/Decor/Frame it..."
                    "Frame an image."
                    "Tharsice Demand <td-e.com>"
                    "Tharsice Demand"
                    "2007.10.25"
                    "RGB RGBA GRAY GRAYA"
                    SF-IMAGE       "Image"                0
                    SF-DRAWABLE    "Drawable"             0
                    SF-ADJUSTMENT  "Border X size"        '(40 1 250 1 10 0 1)
                    SF-ADJUSTMENT  "Border Y size"        '(40 1 250 1 10 0 1)
                    SF-COLOR       "Border color 1"       '(116 72 24)
                    SF-COLOR       "Border color 2"       '(204 150 40)
                    SF-GRADIENT    "Border gradient"      "Golden"
                    SF-TOGGLE      "Reverse gradient"     TRUE
                    SF-ADJUSTMENT  "Delta value on color" '(25 1 255 1 10 0 1)
                    SF-OPTION      "Border color"         (mapcar car *border-color*)
                    SF-TOGGLE      "Flatten image"        FALSE
)

Sponsorship

If you find the script 'Frame it' useful and want to support the developer, you can

License

The GNU general public license applies to the script-fu frame-it.scm above.

Blog of TD-e.com
Add a comment

... ...
.. ..
. .