Add CLI option for global frames and disable by default
[fgen.git] / fgen.sh
diff --git a/fgen.sh b/fgen.sh
index 6cc7db6..2eb48cc 100755 (executable)
--- a/fgen.sh
+++ b/fgen.sh
@@ -18,9 +18,12 @@ fps=8
 debug=0
 trames=1
 dry_run=0
+global=0
 
 SED=sed
 
+F_FMT="%04d"
+
 # When reading a file line by line, if a command inside the loop
 # also reads stdin, it can exhaust the input file.
 # -nostdin: disable ffmpeg interaction on standard input:
@@ -35,22 +38,40 @@ case ${OSTYPE} in
         ;;
 esac
 
+COLOR_ERR="\033[0;31m"
+COLOR_WARN="\033[0;33m"
+COLOR_NONE="\033[0m"
+
+function log_info() {
+    echo -e "${COLOR_NONE}${*}"
+}
+
 function log_dbg() {
     if [ x"${debug}" = x"1" ]; then
         echo "${*}"
     fi
 }
 
+function log_warn() {
+    echo -e "${COLOR_WARN}${*}${COLOR_NONE}"
+}
+
+function log_err() {
+    echo -e "${COLOR_ERR}${*}${COLOR_NONE}"
+}
+
 # Arg1: layer
 function get_size()
 {
     cat ${layers} | grep -m 1 "${1}" | ${SED} "s/.*geometry:\([0-9]\+x[0-9]\+\).*/\1/g"
 }
 
-# Arg1: layer
+# Arg1: line
 function get_pos()
 {
-    cat ${layers} | grep "${1}" | ${SED} "s/.*geometry:[0-9]\+x[0-9]\+\(+[0-9]\++[0-9]\+\),.*/\1/g"
+    local token
+    token=$(echo "${1}" | ${SED} "s/.*geometry:[0-9]\+x[0-9]\+\([+-][0-9]\+[+-][0-9]\+\),.*/\1/g")
+    echo "${token}"
 }
 
 # Arg1: line
@@ -69,6 +90,26 @@ function get_frame_id()
     echo "${token}"
 }
 
+# Arg1: label
+function get_prefix_ref()
+{
+    local w
+    local token
+
+    for w in ${ref_layer_prefix}; do
+        token=$(echo "${1}" | grep -e "^${w}" || echo "")
+
+        if [ "${token}" != "" ]; then
+            # Ignore image.
+            echo "${token}"
+            return 0
+        fi
+    done
+
+    # Do not ignore image
+    echo ""
+}
+
 # Arg1: line
 function get_scene_id()
 {
@@ -111,6 +152,16 @@ function get_dup_to()
     echo "${token}"
 }
 
+# Generate frame index name with leading zeroes:
+# Arg1: frame number
+function get_frame_name()
+{
+    local index
+
+    index=$(printf "${F_FMT}" ${1})
+    echo "${dest}/${dest}-${group}-f${index}.png"
+}
+
 # Arg1: start frame
 # Arg1: end frame
 function insert_empty_frames()
@@ -118,25 +169,47 @@ function insert_empty_frames()
     local w
     local start
     local end
+    local wfname
 
     start=${1}
     end=${2}
 
     for w in $(seq ${start} ${end}); do
         log_dbg "New frame ID: ${w} (empty)"
-        cp ${dest}/background.png ${dest}/${group}-f${w}.png
+
+        wfname=$(get_frame_name ${w})
+
+        cp ${dest}/background.png ${wfname}
     done
 }
 
+function record_max_nf()
+{
+    if [ ${nf} -gt ${max_nf} ]; then
+        max_nf="${nf}"
+    fi
+}
+
 function generate_video()
 {
+    local png_files
+
     if which ffmpeg 1> /dev/null 2>&1; then
-        if [ -f ${dest}/${group}-f1.png ]; then
+        png_files=$(ls ${dest}/${dest}-${group}-f*.png 2> /dev/null || echo "")
+
+        if [ x"${png_files}" != x"" ]; then
+            group_list="${group_list} ${group}"
+
             log_dbg "generate_video start"
+
+            local outfile
+
+            outfile=${dest}/${dest}-${group}.mp4
+
             if [ ${dry_run} -eq 1 ]; then
-                touch ${dest}/${group}.mp4
+                touch ${outfile}
             else
-                ffmpeg ${FFMPEG_OPTS} -r ${fps} -start_number 1 -i ${dest}/${group}-f%d.png ${dest}/${group}.mp4
+                ffmpeg ${FFMPEG_OPTS} -r ${fps} -pattern_type glob -i "${dest}/${dest}-${group}-f*.png" ${outfile}
             fi
 
             log_dbg "generate_video: end"
@@ -144,20 +217,66 @@ function generate_video()
     fi
 }
 
+function generate_global()
+{
+    local g
+    local w
+    local files
+    local group
+    local fname
+
+    log_dbg "generate_global: start"
+    log_dbg "  list:   ${group_list}"
+    log_dbg "  max_nf: ${max_nf}"
+
+    for w in $(seq 1 ${max_nf}); do
+        files=""
+
+        for g in ${group_list}; do
+            group=${g}
+            fname=$(get_frame_name ${w})
+
+            if [ -f "${fname}" ]; then
+                files="${files} ${fname}"
+            fi
+        done
+
+        if [ "${files}" != "" ]; then
+            group="global"
+            fname=$(get_frame_name ${w})
+
+            if [ ${dry_run} -eq 1 ]; then
+                touch ${fname}
+            else
+                convert -colorspace sRGB -page +0+0 ${dest}/background-white.png \
+                        ${files} -background none -layers merge \
+                        PNG32:${fname}
+            fi
+        fi
+    done
+
+    group="global"
+    generate_video
+
+    log_dbg "generate_global: end"
+}
+
 print_usage()
 {
-    echo "${PROG_NAME} -- Générateur de séquence d'images PNG à partir d'un fichier Photoshop (PSD)."
-    echo "Usage: ${PROG_NAME} [OPTIONS...] FICHIER-PSD"
+    echo "${PROG_NAME} -- Générateur de séquence d'images PNG à partir d'un fichier Photoshop (PSD/PSB)."
+    echo "Usage: ${PROG_NAME} [OPTIONS...] FICHIER-PHOTOSHOP"
     echo
     echo "Options:"
     echo "  -d   affiche les informations de debug"
     echo "  -f   ne regénère pas les trames, mais uniquement la séquence vidéo"
+    echo "  -g   génère les fichiers globaux"
     echo "  -n   mode de test (dry-run)"
     echo "  -r   nombre de trames par seconde (FPS)"
+    echo "  -s   préfixe d'image à ignorer"
     echo "  -h   affiche ce message d'aide"
 }
 
-while getopts "dhfnr:" flag ;do
+while getopts "dhfgnr:s:" flag ;do
     case ${flag} in
         d)
             debug="1"
@@ -165,12 +284,18 @@ while getopts "dhfnr:" flag ;do
         f)
             trames=0
             ;;
+        g)
+            global=1
+            ;;
         n)
             dry_run=1
             ;;
         r)
             fps="${OPTARG}"
             ;;
+        s)
+            ref_layer_prefix="${ref_layer_prefix} ${OPTARG}"
+            ;;
        h)
            print_usage
             exit 0
@@ -192,20 +317,26 @@ if [ $# -eq 0 ]; then
     exit 1
 fi
 
-if [ $# -gt 1 ]; then
-    echo "${PROG_NAME}: Trop d'arguments."
-    echo "Essayez \`${PROG_NAME} -h' pour plus d'informations."
-    exit 1
-fi
+src="${*}"
 
-if [ ! -f "${1}" ]; then
-    echo "Error: PSD source file not found"
+if [ ! -f "${src}" ]; then
+    log_err "Erreur: fichier source non trouvé"
     exit 1
 fi
 
-src=${1}
+ext=$(echo "${src##*.}" | awk '{print tolower($0)}')
+
+case ${ext} in
+    psd|psb)
+        # Ok: PSD or PSB format detected
+        ;;
+    *)
+        log_err "Format non-supporté: ${ext}"
+        exit 1
+        ;;
+esac
 
-dest=$(basename -s .psd ${1})
+dest=$(basename -s .${ext} "${src}")
 layers=${dest}/layers.txt
 
 if [ ! -d ${dest} ]; then
@@ -221,7 +352,7 @@ done
 
 if [ ${trames} -eq 1 ]; then
     # %s: scene number
-    identify ${IM_OPS} -verbose -format "scene:%s,label:%l,geometry:%g,\n" ${src} > ${layers}
+    identify ${IM_OPS} -verbose -format "scene:%s,label:%l,geometry:%g,\n" "${src}" > ${layers}
 
     # Remove line(s) with empty label:
     ${SED} -i -e /label:,.*/d ${layers}
@@ -232,20 +363,25 @@ if [ ${trames} -eq 1 ]; then
     log_dbg "Background size: ${size}"
 
     if [ x"${size}" = x"" ]; then
-        echo "Error: background layer not found"
+        log_err "Error: background layer not found"
         exit 1
     fi
 
     # Remove background line:
     ${SED} -i -e /label:${bg_layer_name},.*/d ${layers}
 
-    # Create background frame:
+    # Create transparent background frame:
     convert -size ${size} xc:none ${dest}/background.png
 
+    # Create white background frame:
+    convert -size ${size} xc:white ${dest}/background-white.png
+
     nf=""
+    max_nf="0"
     oldnf=""
     files=""
     group="default"
+    group_list=""
 
     while read l; do
         scene=$(get_scene_id "${l}")
@@ -266,6 +402,7 @@ if [ ${trames} -eq 1 ]; then
         log_dbg "  nom: ${label}"
         log_dbg "  pos: ${p}"
 
+        prefix_ref=$(get_prefix_ref "${label}")
         group_ref=$(get_group_ref "${group}")
         log_dbg "  group_ref: ${group_ref}"
 
@@ -276,7 +413,7 @@ if [ ${trames} -eq 1 ]; then
             fi
 
             group="${ng}"
-            log_dbg "New group: ${ng}"
+            log_info "New group: ${ng}"
 
             nf=""
             oldnf=""
@@ -292,6 +429,13 @@ if [ ${trames} -eq 1 ]; then
             continue
         fi
 
+        # Ignore images beginning with a specific reference prefix:
+        if [ x"${prefix_ref}" != x"" ]; then
+            # Ignore all images in prefix-ref:
+            log_dbg "  ignore (prefix-ref)"
+            continue
+        fi
+
         files="${files} -page ${p} ${src}[${scene}]"
 
         if [ x"${nf}" != x"" ]; then
@@ -300,21 +444,24 @@ if [ ${trames} -eq 1 ]; then
                 expected_nf=$((${oldnf} + 1))
 
                 if [ ${expected_nf} -ne ${nf} ]; then
-                    echo "Warning: non-sequential frame sequence: ${nf}"
-                    echo "  previous: ${oldnf}"
-                    echo "  expected: ${expected_nf}"
+                    log_warn "Warning: non-sequential frame sequence: ${nf}"
+                    log_warn "  previous: ${oldnf}"
+                    log_warn "  expected: ${expected_nf}"
                     insert_empty_frames ${expected_nf} $((${nf} -1))
                 fi
             fi
 
             log_dbg "New frame ID: ${nf}"
+            record_max_nf
+
+            fname=$(get_frame_name ${nf})
 
             if [ ${dry_run} -eq 1 ]; then
-                touch ${dest}/${group}-f${nf}.png
+                touch ${fname}
             else
                 convert -colorspace sRGB -page +0+0 ${dest}/background.png \
                         ${files} -background none -layers merge \
-                        ${dest}/${group}-f${nf}.png
+                        PNG32:${fname}
             fi
 
             if [ x"${dup_from}" != x"" ]; then
@@ -325,8 +472,12 @@ if [ ${trames} -eq 1 ]; then
                 for w in $(seq ${dup_start} ${dup_to}); do
                     log_dbg "New frame ID: ${w} (duplicate)"
 
+                    wfname=$(get_frame_name ${w})
+
                     # Use symlink???
-                    cp ${dest}/${group}-f${nf}.png ${dest}/${group}-f${w}.png
+                    cp ${fname} ${wfname}
+
+                    nf=${w}
                 done
             fi
 
@@ -338,3 +489,7 @@ fi
 
 # Special case for last group...
 generate_video
+
+if [ x"${global}" = x"1" ]; then
+    generate_global
+fi