TD-e.com

Watermark it and Watermark batch

Two script-fu for The Gimp

Example

image watermarked with the script-fu 'watermark it'

Zoom image

Description

"Watermark it" is a script-fu for the Gimp. It adds an image watermark and/or a text watermark to a digital photo. A watermark can be placed at the center and/or in any corner of the photo.

To add watermarks to a single image, you need only 'Watermark-it'. To add watermarks to many images in a batch process, you need both scripts 'Watermark-it' and 'Watermark-batch'.

The field 'Watermark image' must contain a valid path to an existing image if you do place a watermark image at any of the five positions. If the path is not valid you will get an error message. If you do place text watermarks only (and no image watermark), the path does not need to be valid.

An x and y border margin can be set for the corner positions. The margin is irrelevant for the center position.

The most important factors for the final aspect of the watermarks are the image opacity, the text opacity, the text perimeter opacity and the font color. The font color is important even with the choice 'no color'. When 'no color' is selected, the hue of the font color is irrelevant, but the saturation and value of the font color do have an influence on the result. That's why I recommend to think in terms of HSV (hue, saturation, value) rather than RGB (red, green, blue) when you choose a font color.

Last but no least, if you keep the default settings to 'No watermark' for all the five positions, the script will just do... nothing !

The 'Watermark-batch' script has more fields than the 'Watermark-it' script. The two additional fields are the path to the source images and the path to the destination images, which must contain a valid path, each, of course.

The scripts have been tested with The Gimp version 2.4.2 on Linux Ubuntu 7.10 Gutsy Gibbon.

Versions

Watermark-it
2007.11.12 : Version 1.00

Watermark-batch
2007.11.12 : Version 1.00 for Gimp 2.4.0
2008.06.13 : Version 1.01 for Gimp 2.4.2, a variable conversion is necessary, which wasn't before.
2008.08.06 : Version 1.02 for Gimp 2.4.5, new while loop, since 2.4.5 doesn't like the old one. The version works well with Gimp 2.4.5 under Ubuntu. Windows users, please read the bottom of this page.

Download:

Click into the blue frames below where the scripts are 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 the upper one as a file named watermark-it.scm
Save the lower one as a file named watermark-batch.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 watermark-it.scm and optionally watermark-batch.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 watermark-it.scm can be called in the menu Filters / Decor / Watermark it...
The script watermark-batch.scm can be called in the menu Xtns / Batch / Watermark batch...

Script-fu watermark-it.scm for The Gimp

The script to watermark a single photo.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; SCRIPT-FU-WATERMARK-IT
; version 1.00  2007.11.12 for Gimp 2.4
; Copyright (c) 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 (onewatermark 
img mainlayer wmposition floatinglayer textlayer textbglayer ximg yimg xtext ytext xtextbg ytextbg opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)
  ;---1=TOP-LEFT---;---2=TOP-RIGHT---;---3=BOTTOM-LEFT---;---4=BOTTOM-RIGHT---;---5=CENTER---
  ;---0=none---;---1=img---;---2=text---
  (if (= wmposition 1)
    (begin 
      (set! floatinglayer (car (gimp-edit-paste mainlayer TRUE)))
      (gimp-layer-set-offsets floatinglayer ximg yimg)
      (gimp-layer-set-mode floatinglayer VALUE-MODE)
      (gimp-layer-set-opacity floatinglayer opai)
      (gimp-floating-sel-anchor floatinglayer)
    )
  )
  (if (= wmposition 2)
    (begin
      (if (> opatb 1)
        (begin
          (set! textbglayer (car (gimp-layer-new img textbgwid textbghei 1 "textbglayer" opatb NORMAL-MODE)))
          (gimp-image-add-layer img textbglayer 0)
          (gimp-layer-set-offsets textbglayer xtextbg ytextbg)
          (gimp-edit-fill textbglayer 0)
          (gimp-invert textbglayer)
          (if (= wmnocolor 1) (gimp-layer-set-mode textbglayer VALUE-MODE))
        )
      )
      (set! textlayer (car (gimp-text-fontname img -1 xtext ytext wmtext -1 TRUE wmfontsize 0 wmfont)))
      (if (= wmemboss 1) (plug-in-bump-map 1 img textlayer textlayer 135 30 3 0 0 0 0 1 0 0))
      (if (= wmnocolor 1) (gimp-layer-set-mode textlayer VALUE-MODE))
      (gimp-layer-set-opacity textlayer opat)
    )
  )
)

(define (script-fu-watermark-it 
aimg adraw wmfile xmargini ymargini opai wmtext xmargint ymargint opat opatb wmfont wmfontsize wmfontcolor wmnocolor wmemboss toplef toprig botlef botrig centered)
  (let* 
    (
      (flatten 1)
      (fontheifac 1.1)
      (fontheifacbg 1.2)
      (old-fg (car (gimp-palette-get-foreground)))
      (img (car (gimp-drawable-get-image adraw)))
      (wid (car (gimp-image-width img)))
      (hei (car (gimp-image-height img)))

(imgused (if (or (= toplef 1) (or (= toprig 1) (or (= botlef 1) (or (= botrig 1) (= centered 1))))) 1 0))
      (dirs (strbreakup wmfile "/"))
      (depthofpath (length dirs))
      (wmfilename (nth (- depthofpath 1) dirs))
      (lenfullname (string-length wmfile))
      (lenfilename (string-length wmfilename))
      (wmpathname (substring wmfile 0 (- lenfullname lenfilename)))

(wmimage (if (= imgused 1) (car (gimp-file-load RUN-NONINTERACTIVE wmfile wmfilename)) 0))
      (wmdrawable (if (= imgused 1) (car (gimp-image-get-active-layer wmimage)) 0))
      (copied (if (= imgused 1) (gimp-edit-copy wmdrawable) 0))
      (imgwid (if (= imgused 1) (car (gimp-image-width wmimage)) 0))
      (imghei (if (= imgused 1) (car (gimp-image-height wmimage)) 0))
      (ximg1 xmargini)
      (yimg1 ymargini)
      (ximg2 (- wid (+ xmargini imgwid)))
      (yimg2 ymargini)
      (ximg3 xmargini)
      (yimg3 (- hei (+ ymargini imghei)))
      (ximg4 (- wid (+ xmargini imgwid)))
      (yimg4 (- hei (+ ymargini imghei)))
      (ximg5 (/ (- wid imgwid) 2))
      (yimg5 (/ (- hei imghei) 2))

(textwid (car (gimp-text-get-extents-fontname wmtext wmfontsize 0 wmfont)))
      (xtext1 xmargint)
      (ytext1 (- ymargint (* wmfontsize 0.1)))
      (xtext2 (- wid (+ xmargint textwid)))
      (ytext2 (- ymargint (* wmfontsize 0.1)))
      (xtext3 xmargint)
      (ytext3 (- hei (+ ymargint (* wmfontsize fontheifac))))
      (xtext4 (- wid (+ xmargint textwid)))
      (ytext4 (- hei (+ ymargint (* wmfontsize fontheifac))))
      (xtext5 (/ (- wid textwid) 2))
      (ytext5 (/ (- hei (* wmfontsize fontheifac)) 2))
      (textbgwidpadding (* wmfontsize (- fontheifacbg fontheifac)))
      (textbgwid (+ textwid textbgwidpadding))
      (textbghei (* wmfontsize fontheifacbg))

(xtextbg1 (- xtext1 (/ textbgwidpadding 2)))
      (ytextbg1 (- ytext1 textbgwidpadding))
      (xtextbg2 (- xtext2 (/ textbgwidpadding 2)))
      (ytextbg2 (- ytext2 textbgwidpadding))
      (xtextbg3 (- xtext3 (/ textbgwidpadding 2)))
      (ytextbg3 (- ytext3 textbgwidpadding))
      (xtextbg4 (- xtext4 (/ textbgwidpadding 2)))
      (ytextbg4 (- ytext4 textbgwidpadding))
      (xtextbg5 (- xtext5 (/ textbgwidpadding 2)))
      (ytextbg5 (- ytext5 textbgwidpadding))

(textlayer1 0)
      (textlayer2 0)
      (textlayer3 0)
      (textlayer4 0)
      (textlayer5 0)

(textbglayer1 0)
      (textbglayer2 0)
      (textbglayer3 0)
      (textbglayer4 0)
      (textbglayer5 0)

(floatinglayer1 0)
      (floatinglayer2 0)
      (floatinglayer3 0)
      (floatinglayer4 0)
      (floatinglayer5 0)
    )

(gimp-context-push)
    (gimp-image-undo-group-start img)
    (gimp-palette-set-foreground wmfontcolor)

;---1=TOP-LEFT---
    (onewatermark 
     img adraw toplef floatinglayer1 textlayer1 textbglayer1 ximg1 yimg1 xtext1 ytext1 xtextbg1 ytextbg1 opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)

;---2=TOP-RIGHT---
    (onewatermark 
     img adraw toprig floatinglayer2 textlayer2 textbglayer2 ximg2 yimg2 xtext2 ytext2 xtextbg2 ytextbg2 opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)

;---3=BOTTOM-LEFT---
    (onewatermark 
     img adraw botlef floatinglayer3 textlayer3 textbglayer3 ximg3 yimg3 xtext3 ytext3 xtextbg3 ytextbg3 opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)

;---4=BOTTOM-RIGHT---
    (onewatermark 
     img adraw botrig floatinglayer4 textlayer4 textbglayer4 ximg4 yimg4 xtext4 ytext4 xtextbg4 ytextbg4 opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)

;---5=CENTER---
    (onewatermark 
     img adraw centered floatinglayer5 textlayer5 textbglayer5 ximg5 yimg5 xtext5 ytext5 xtextbg5 ytextbg5 opai opat opatb wmtext wmfont wmfontsize wmemboss wmnocolor textbgwid textbghei)

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

(gimp-palette-set-foreground old-fg)
    (gimp-image-undo-group-end img)
    (gimp-context-pop)
  )
)

(script-fu-register 
  "script-fu-watermark-it"
  "<Image>/Filters/Decor/Watermark it..."
  "Apply image and text watermarks to any corner and/or to the center of an image."
  "Tharsice Demand <td-e.com>"
  "Tharsice Demand"
  "2007.11.12"
  "RGB RGBA GRAY GRAYA"
  SF-IMAGE       "Image"              0
  SF-DRAWABLE    "Drawable"           0
  SF-STRING      "Watermark image--------------" "/home/~username/Pictures/wm/c104.png"
  SF-ADJUSTMENT  "Image X margin"     '(10 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Image Y margin"     '(10 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Image opacity"      '(60 1 100 1 10 0 1)
  SF-STRING      "Watermark text------------------" "(c)2007 Author Name"
  SF-ADJUSTMENT  "Text X margin"      '(20 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Text Y margin"      '(20 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Text opacity"       '(90 1 100 1 10 0 1)
  SF-ADJUSTMENT  "Text perimeter opacity" '(40 0 100 1 10 0 1)
  SF-FONT        "Font"               "FreeSans Bold"
  SF-ADJUSTMENT  "Font Size (pixels)" '(20 6 1000 1 10 0 1)
  SF-COLOR       "Font color"         '(255 208 128)
  SF-TOGGLE      "No color i.e. lighten or darken image" FALSE
  SF-TOGGLE      "Emboss Text"        TRUE
  SF-OPTION      "TOP-LEFT"           '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "TOP-RIGHT"          '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "BOTTOM-LEFT"        '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "BOTTOM-RIGHT"       '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "CENTER"             '("No Watermark" "Image Watermark" "Text Watermark")
)

Script-fu watermark-batch.scm for The Gimp

The script to watermark many photos in a batch.
'Watermark-batch' needs 'Watermark-it' to be installed too.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; SCRIPT-FU-WATERMARK-BATCH
; Copyright (c) 2007-2008 Tharsice Demand <www.td-e.com>
; version 1.00  2007.11.12 for Gimp 2.4.0
; version 1.01  2008.06.13 for Gimp 2.4.2  a variable conversion is necessary, which wasn't b4
; version 1.02  2008.06.26 for Gimp 2.4.5  new while loop since 2.4.5 does not like the old one
;
;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 (script-fu-watermark-batch 
srcpath destpath wmfile xmargini ymargini opai wmtext xmargint ymargint opat opatb wmfont wmfontsize wmfontcolor wmnocolor wmemboss toplef toprig botlef botrig centered)
  (let* 
    (
      (flatten 1)
      (filepattern "*.jpg")
      (pathpattern (string-append srcpath filepattern))
      (filelist (cadr (file-glob pathpattern 1)))
    )
    (while (not (null? filelist))
      (let* 
        (
          (filename (car filelist))
          (dirs (strbreakup filename "/"))
          (depthofpath (length dirs))
          (shortfilename (nth (- depthofpath 1) dirs))
          (destfilename (string-append destpath shortfilename))

(imagelist (gimp-file-load RUN-NONINTERACTIVE filename filename))
          (image (if (not (null? imagelist)) (car imagelist) 0))
          (drawablelist (gimp-image-get-active-layer image))
          (drawable (if (not (null? drawablelist)) (car drawablelist) 0))
        )

(if (> drawable 0)
          (begin
            (script-fu-watermark-it 
             image drawable wmfile xmargini ymargini opai wmtext xmargint ymargint opat opatb wmfont wmfontsize wmfontcolor wmnocolor wmemboss toplef toprig botlef botrig centered)
            (set! drawable (car (gimp-image-get-active-layer image)))
            (gimp-file-save RUN-NONINTERACTIVE image drawable destfilename shortfilename)
            (gimp-image-delete image)
          )
        )
      )
      (set! filelist (cdr filelist))
    )
  )
)

(script-fu-register 
  "script-fu-watermark-batch"
  "<Toolbox>/Xtns/Batch/Watermark Batch..."
  "Batch processes the jpg files located at 'Source Path' with the script-fu Watermark-it. 
  Saves the results at 'Destination Path'."
  "T. Demand <td-e.com>"
  "T. Demand"
  "2007.11.12"
  ""
  SF-STRING      "Source Path"        "/home/~username/Pictures/source/"
  SF-STRING      "Destination Path"   "/home/~username/Pictures/dest/"
  SF-STRING      "Watermark image--------------" "/home/~username/Pictures/wm/c104.png"
  SF-ADJUSTMENT  "Image X margin"     '(10 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Image Y margin"     '(10 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Image opacity"      '(60 1 100 1 10 0 1)
  SF-STRING      "Watermark text------------------" "(c)2007 Author Name"
  SF-ADJUSTMENT  "Text X margin"      '(20 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Text Y margin"      '(20 0 250 1 10 0 1)
  SF-ADJUSTMENT  "Text opacity"       '(90 1 100 1 10 0 1)
  SF-ADJUSTMENT  "Text perimeter opacity" '(40 0 100 1 10 0 1)
  SF-FONT        "Font"               "FreeSans Bold"
  SF-ADJUSTMENT  "Font Size (pixels)" '(20 6 1000 1 10 0 1)
  SF-COLOR       "Font color"         '(255 208 128)
  SF-TOGGLE      "No color i.e. lighten or darken image" FALSE
  SF-TOGGLE      "Emboss Text"        TRUE
  SF-OPTION      "TOP-LEFT"           '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "TOP-RIGHT"          '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "BOTTOM-LEFT"        '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "BOTTOM-RIGHT"       '("No Watermark" "Image Watermark" "Text Watermark")
  SF-OPTION      "CENTER"             '("No Watermark" "Image Watermark" "Text Watermark")
)

Sponsorship

If you find the scripts 'Watermark it' and 'Watermark Batch' useful and want to support the developer, you can

License

The GNU general public license applies to the script-fu watermark-it.scm and to the script-fu watermark-batch.scm above.

Watermark image

You can use the following image as a watermark image. Create a new folder called wm under your Pictures folder. Right click on the image below and select 'save picture as...'. Save the watermark image to the folder wm.

If you have a logo and would like me to make a watermark image with it, I can do it for a small fee. Just contact me through the contact form.

Watermark-batch and Windows

Some reports have shown that Watermark-batch does not do anything when run in Windows. One report told that watermark-batch does work under Windows if the destination path is kept empty (I could not verify it, since I have no Windows). That would mean that the batch watermarked images will be stored in the source path and the source images would be replaced, thus you must save your sources elsewhere before running the batch (or lose them).

My advice for Windows users : Do use watermark-it when you work on single images. Watermark-it has been reported several times to work well under Windows. Do use Phatch for batch works on images.

Phatch : a free, stand-alone, user friendly python software that works under Linux, Mac OS-X and Windows. Phatch means Photo-Batch. It can do much more than just watermarks, quite any thinkable work on images, resizing, cropping, leveling and much more. A plus is that Phatch keeps the IPTC metadata of the images, while The Gimp keeps only the EXIF metadata, but loses the IPTC metadata. You can download Phatch at photobatch.stani.be .

Comments
Add a comment to this page
Read the comments about this page

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