]> de.git.xonotic.org Git - xonotic/xonotic-maps.pk3dir.git/blobdiff - scripts/shader-audit.sh
fix alpha channel auditing
[xonotic/xonotic-maps.pk3dir.git] / scripts / shader-audit.sh
index 0abbd1b0122abda9f6c109e0374fea97bc2630ac..85d0e2adf3ef8151181b26754eb5236a1822dada 100755 (executable)
@@ -25,6 +25,47 @@ normalize()
 allowed_prefixes=
 forbidden_prefixes=
 
+getstats_e()
+{
+       identify -verbose -alpha set -alpha extract -depth 8 "$1" | {
+               pix=0
+               while read -r L V R; do
+                       case "$L" in
+                               Geometry:)
+                                       V=${V%%[-+]*}
+                                       pix=$(( (${V%%x*} * ${V#*x}) / 2 ))
+                                       ;;
+                               min:)
+                                       min=$V
+                                       ;;
+                               max:)
+                                       max=$V
+                                       ;;
+                               [0-9]*:)
+                                       pix=$(( $pix - ${L%:} ))
+                                       if [ $pix -le 0 ]; then
+                                               median=`echo "$V $R" | cut -d , -f 1 | tr -cd 0-9`
+                                               break
+                                       fi
+                       esac
+               done
+               cat >/dev/null
+               echo "min=$min"
+               echo "max=$max"
+               echo "median=$median"
+               echo "error=false"
+       }
+}
+getstats()
+{
+       min=255
+       max=255
+       median=255
+       error=true
+       [ -f "$1" ] || return 1
+       eval `getstats_e "$1"`
+}
+
 textures_used=
 # $1 = shader
 # $2 = texture
@@ -46,6 +87,40 @@ use_texture()
        fi
        textures_used="$textures_used$LF$2"
 
+       if [ x"$3" = x"map" ]; then
+               lasttex=$2
+               if [ -n "$AUDIT_ALPHACHANNELS" ]; then
+                       if [ -f "../${2}_norm.tga" ]; then
+                               case "$offsetmapping_match8" in
+                                       '') # no dpoffsetmapping keyword
+                                               getstats "../${2}_norm.tga" || getstats "../${2}_norm.png" || getstats "../${2}_norm.jpg"
+                                               if [ "$min" -eq "$max" ]; then
+                                                       echo "(EE) shader $1 uses broken normalmap ${2}_norm.tga (add dpoffsetmapping none)"; seterror
+                                               else
+                                                       echo "(EE) shader $1 uses ${2}_norm.tga but lacks median (add dpoffsetmapping - 1 match8 $median)"; seterror
+                                               fi
+                                               ;;
+                                       none) # offsetmapping turned off explicitly
+                                               ;;
+                                       default) # offsetmapping keyword without bias
+                                               getstats "../${2}_norm.tga"
+                                               if [ "$min" -eq "$max" ]; then
+                                                       echo "(EE) shader $1 uses broken normalmap ${2}_norm.tga, maybe use dpoffsetmapping none?"; seterror
+                                               else
+                                                       echo "(EE) shader $1 uses ${2}_norm.tga but lacks median (add to dpoffsetmapping: match8 $median)"; seterror
+                                               fi
+                                               ;;
+                                       *) # offsetmapping keyword with bias
+                                               ;;
+                               esac
+                       else
+                               if [ -n "$offsetmapping_match8" ]; then
+                                       echo "(EE) shader $1 specifies offsetmapping, but texture $2 does not have a normalmap"
+                               fi
+                       fi
+               fi
+       fi
+
        if [ -n "$allowed_prefixes" ]; then
                ok=false
                for p in $allowed_prefixes; do
@@ -149,7 +224,7 @@ use_texture()
                        esac
                        ;;
                ## RULE: textures/FOO/* must use textures/FOO/*, for FOO in decals, liquids_water, liquids_slime, liquids_lava
-               textures/decals/*|textures/liquids_*/*|textures/effects_*/*)
+               textures/decals/*|textures/liquids_*/*|textures/effects_*/*|textures/screens/*|textures/logos/*)
                        pre=`echo "$1" | cut -d / -f 1-2`
                        case "$2" in
                                "$pre"/*)
@@ -195,14 +270,24 @@ use_texture()
 parsing_shader=
 parse_shaderstage()
 {
+       ss_blendfunc=none
+       ss_alphafunc=none
+       ss_map=
        while read L A1 Aother; do
                case "`echo "$L" | tr A-Z a-z`" in
-                       map)
+                       blendfunc)
+                               ss_blendfunc=`echo $A1 $Aother | tr A-Z a-z`
+                               ;;
+                       alphafunc)
+                               ss_alphafunc=`echo $A1 | tr A-Z a-z`
+                               ;;
+                       map|clampmap)
                                case "$A1" in
                                        '$lightmap')
                                                ;;
                                        *)
                                                use_texture "$parsing_shader" "`normalize "$A1"`" map
+                                               ss_map="`normalize "$A1"`"
                                                ;;
                                esac
                                ;;
@@ -210,6 +295,13 @@ parse_shaderstage()
                                for X in $Aother; do
                                        use_texture "$parsing_shader" "`normalize "$X"`" animmap
                                done
+                               for X in $Aother; do
+                                       ss_map="`normalize "$X"`"
+                                       break
+                               done
+                               ;;
+                       '{')
+                               echo "(EE) brace nesting error in $parsing_shader"; seterror
                                ;;
                        '}')
                                break
@@ -218,13 +310,68 @@ parse_shaderstage()
                                ;;
                esac
        done
+
+       if [ -n "$AUDIT_ALPHACHANNELS" ] && [ -n "$ss_map" ]; then
+               getstats "../$ss_map.tga" || getstats "../$ss_map.png" || getstats "../$ss_map.jpg"
+               case "$ss_blendfunc" in
+                       *src_alpha*|*blend*)
+                               # texture must have alpha
+                               if [ $min -eq 255 ]; then
+                                       echo "(EE) $parsing_shader uses alpha-less texture $ss_map with blendfunc $ss_blendfunc"; seterror
+                               fi
+                               ;;
+                       add|"gl_one gl_one")
+                               # texture must not have alpha (engine bug)
+                               if [ $min -lt 255 ]; then
+                                       echo "(EE) $parsing_shader uses alpha-using texture $ss_map with blendfunc $ss_blendfunc"; seterror
+                               fi
+                               ;;
+                       *)
+                               case "$ss_alphafunc" in
+                                       g*)
+                                               # texture must have alpha
+                                               if [ $min -eq 255 ]; then
+                                                       echo "(EE) $parsing_shader uses alpha-less texture $ss_map with alphafunc $ss_alphafunc"; seterror
+                                               fi
+                                               ;;
+                                       *)
+                                               # texture should not have alpha (no bug if not)
+                                               if [ $min -lt 255 ]; then
+                                                       echo "(WW) $parsing_shader uses alpha-using texture $ss_map with blendfunc $ss_blendfunc and alphafunc $ss_alphafunc"
+                                               fi
+                                               ;;
+                               esac
+                               ;;
+               esac
+       fi
 }
 
 parse_shader()
 {
        use_texture "$parsing_shader" "$parsing_shader" shader
+       offsetmapping_match8=
        while read L A1 Aother; do
                case "`echo "$L" | tr A-Z a-z`" in
+                       dpoffsetmapping)
+                               set -- $Aother
+                               if [ x"$A1" = x"none" ]; then
+                                       offsetmapping_match8=none
+                               elif [ x"$A1" = x"off" ]; then
+                                       offsetmapping_match8=none
+                               elif [ x"$A1" = x"disabled" ]; then
+                                       offsetmapping_match8=none
+                               elif [ x"$2" = x"match8" ]; then
+                                       offsetmapping_match8=`echo "($3 + 0.5) / 1" | bc`
+                               elif [ x"$2" = x"match16" ]; then
+                                       offsetmapping_match8=`echo "($3 / 257 + 0.5) / 1" | bc`
+                               elif [ x"$2" = x"match" ]; then
+                                       offsetmapping_match8=`echo "($3 * 255 + 0.5) / 1" | bc`
+                               elif [ x"$2" = x"bias" ]; then
+                                       offsetmapping_match8=`echo "((1 - $3) * 255 + 0.5) / 1" | bc`
+                               else
+                                       offsetmapping_match8=default
+                               fi
+                               ;;
                        qer_editorimage)
                                use_texture "$parsing_shader" "`normalize "$A1"`" editorimage
                                ;;
@@ -301,7 +448,7 @@ for X in *.shader; do
 done
 rm -f "$t"
 
-textures_avail=`( cd ..; find textures/ -type f -not -name '*_norm.*' -not -name '*_glow.*' -not -name '*_gloss.*' -not -name '*_reflect.*' -not -name '*.xcf' ) | while IFS= read -r T; do normalize "$T"; done | sort -u`
+textures_avail=`( cd ..; find textures/ -type f -not -name '*.sh' -not -name '*_norm.*' -not -name '*_glow.*' -not -name '*_gloss.*' -not -name '*_reflect.*' -not -name '*.xcf' ) | while IFS= read -r T; do normalize "$T"; done | sort -u`
 textures_used=`echo "${textures_used#$LF}" | sort -u`
 
 echo "$textures_used$LF$textures_used$LF$textures_avail" | sort | uniq -u | while IFS= read -r L; do