doc: add exemples of folders/groups organization
[fgen.git] / fgen.sh
diff --git a/fgen.sh b/fgen.sh
index f50e000..7dc2bb2 100755 (executable)
--- a/fgen.sh
+++ b/fgen.sh
@@ -17,8 +17,16 @@ fps=8
 
 debug=0
 trames=1
+dry_run=0
+
 SED=sed
-FFMPEG_OPTS="-hide_banner -loglevel error -y"
+
+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:
+FFMPEG_OPTS="-hide_banner -loglevel error -y -nostdin"
 
 # -limit memory 5000mb -limit disk 5gb
 IM_OPS=""
@@ -55,11 +63,12 @@ function get_label()
     echo "${token}"
 }
 
-# Arg1: line
+# Arg1: label
 function get_frame_id()
 {
-    frame=$(echo "${1}" | grep -e "label:[0-9]\+" | ${SED} "s/.*label:\([0-9]\+\).*,geometry.*/\1/g")
-    echo "${frame}"
+    local token
+    token=$(echo "${1}" | grep -e "^[0-9]\+" | ${SED} "s/^\([0-9]\+\).*/\1/g")
+    echo "${token}"
 }
 
 # Arg1: line
@@ -70,6 +79,93 @@ function get_scene_id()
     echo "${token}"
 }
 
+# Arg1: label
+function get_group_id()
+{
+    local token
+    token=$(echo "${1}" | grep -e "^groupe" | ${SED} "s/^groupe-\(.*\)/\1/g")
+    echo "${token}"
+}
+
+# Arg1: group name
+function get_group_ref()
+{
+    local token
+    token=$(echo "${1}" | grep -e "^ref" | ${SED} "s/^\(ref\).*/\1/g")
+    echo "${token}"
+}
+
+# Get duplicate from. Ex: "dup1-7 planXYZ,geometry..." will return 1
+# Arg1: label
+function get_dup_from()
+{
+    local token
+    token=$(echo "${1}" | grep -e "^dup" | ${SED} "s/^dup\([0-9]\+\)-.*/\1/g")
+    echo "${token}"
+}
+
+# Get duplicate to. Ex: "dup1-7 planXYZ,geometry..." will return 7
+# Arg1: label
+function get_dup_to()
+{
+    local token
+    token=$(echo "${1}" | grep -e "^dup" | ${SED} "s/^dup[0-9]\+-\([0-9]\+\).*/\1/g")
+    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}/${group}-f${index}.png"
+}
+
+# Arg1: start frame
+# Arg1: end frame
+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)"
+
+        wfname=$(get_frame_name ${w})
+
+        cp ${dest}/background.png ${wfname}
+    done
+}
+
+function generate_video()
+{
+    local png_files
+
+    if which ffmpeg 1> /dev/null 2>&1; then
+        set +e
+        png_files=$(ls ${dest}/${group}-f*.png 2> /dev/null)
+        set -e
+
+        if [ x"${png_files}" != x"" ]; then
+            log_dbg "generate_video start"
+            if [ ${dry_run} -eq 1 ]; then
+                touch ${dest}/${group}.mp4
+            else
+                ffmpeg ${FFMPEG_OPTS} -r ${fps} -pattern_type glob -i "${dest}/${group}-f*.png" ${dest}/${group}.mp4
+            fi
+
+            log_dbg "generate_video: end"
+        fi
+    fi
+}
+
 print_usage()
 {
     echo "${PROG_NAME} -- Générateur de séquence d'images PNG à partir d'un fichier Photoshop (PSD)."
@@ -78,11 +174,12 @@ print_usage()
     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 "  -n   mode de test (dry-run)"
     echo "  -r   nombre de trames par seconde (FPS)"
     echo "  -h   affiche ce message d'aide"
 }
 
-while getopts "dhfr:" flag ;do
+while getopts "dhfnr:" flag ;do
     case ${flag} in
         d)
             debug="1"
@@ -90,6 +187,9 @@ while getopts "dhfr:" flag ;do
         f)
             trames=0
             ;;
+        n)
+            dry_run=1
+            ;;
         r)
             fps="${OPTARG}"
             ;;
@@ -161,26 +261,59 @@ if [ ${trames} -eq 1 ]; then
     # Remove background line:
     ${SED} -i -e /label:${bg_layer_name},.*/d ${layers}
 
-    # Remove reference lines:
-    ${SED} -i -e /label:${ref_layer_prefix}.*/d ${layers}
-
     # Create background frame:
     convert -size ${size} xc:none ${dest}/background.png
 
     nf=""
     oldnf=""
     files=""
+    group="default"
 
     while read l; do
         scene=$(get_scene_id "${l}")
         label=$(get_label "${l}")
         p=$(get_pos "${l}")
-        nf=$(get_frame_id "${l}")
+
+        nf=$(get_frame_id "${label}")
+        ng=$(get_group_id "${label}")
+        dup_from=$(get_dup_from "${label}")
+        dup_to=$(get_dup_to "${label}")
+
+        # Also indicate a new frame, but to be copied from..to:
+        if [ x"${dup_from}" != x"" ]; then
+            nf=${dup_from}
+        fi
 
         log_dbg "Layer ${scene}"
         log_dbg "  nom: ${label}"
         log_dbg "  pos: ${p}"
 
+        group_ref=$(get_group_ref "${group}")
+        log_dbg "  group_ref: ${group_ref}"
+
+        # Only change group if ng is set...
+        if [ x"${ng}" != x"" ]; then
+            if [ x"${group_ref}" != x"ref" ]; then
+                generate_video
+            fi
+
+            group="${ng}"
+            log_dbg "New group: ${ng}"
+
+            nf=""
+            oldnf=""
+            files=""
+
+            # Skip image from group ID...
+            continue
+        fi
+
+        if [ x"${group_ref}" != x"" ]; then
+            # Ignore all images in groupe-ref:
+            log_dbg "  ignore (groupe-ref)"
+            continue
+        fi
+
         files="${files} -page ${p} ${src}[${scene}]"
 
         if [ x"${nf}" != x"" ]; then
@@ -189,23 +322,45 @@ if [ ${trames} -eq 1 ]; then
                 expected_nf=$((${oldnf} + 1))
 
                 if [ ${expected_nf} -ne ${nf} ]; then
-                    echo "Error: invalid frame sequence: ${nf}"
+                    echo "Warning: non-sequential frame sequence: ${nf}"
                     echo "  previous: ${oldnf}"
                     echo "  expected: ${expected_nf}"
-                    files=""
-                    continue
+                    insert_empty_frames ${expected_nf} $((${nf} -1))
                 fi
             fi
 
             log_dbg "New frame ID: ${nf}"
-            convert -colorspace sRGB -page +0+0 ${dest}/background.png ${files} -background none -layers merge ${dest}/f${nf}.png
+
+            fname=$(get_frame_name ${nf})
+
+            if [ ${dry_run} -eq 1 ]; then
+                touch ${fname}
+            else
+                convert -colorspace sRGB -page +0+0 ${dest}/background.png \
+                        ${files} -background none -layers merge \
+                        ${fname}
+            fi
+
+            if [ x"${dup_from}" != x"" ]; then
+                log_dbg "  dup from: ${dup_from}"
+                log_dbg "  dup to:   ${dup_to}"
+
+                dup_start=$((${dup_from} + 1))
+                for w in $(seq ${dup_start} ${dup_to}); do
+                    log_dbg "New frame ID: ${w} (duplicate)"
+
+                    wfname=$(get_frame_name ${w})
+
+                    # Use symlink???
+                    cp ${fname} ${wfname}
+                done
+            fi
+
             files=""
             oldnf="${nf}"
         fi
     done <${layers}
 fi
 
-if which ffmpeg 1> /dev/null 2>&1; then
-    # Conversion vidéo:
-    ffmpeg ${FFMPEG_OPTS} -r ${fps} -start_number 1 -i ${dest}/f%d.png ${dest}/sequence.mp4
-fi
+# Special case for last group...
+generate_video