]> de.git.xonotic.org Git - xonotic/xonotic-maps.pk3dir.git/blobdiff - scripts/shader-audit.sh
more for the audit script
[xonotic/xonotic-maps.pk3dir.git] / scripts / shader-audit.sh
index a203d037ebdbb52dc5f8e4825efb24c57854bd5f..4a0bb3710c52f81b473653e1592420f1cf1359f8 100755 (executable)
@@ -6,6 +6,14 @@ case "$0" in
                ;;
 esac
 
+pid=$$
+status=true
+trap 'status=false' USR1
+seterror()
+{
+       kill -USR1 "$pid"
+}
+
 LF="
 "
 
@@ -17,6 +25,47 @@ normalize()
 allowed_prefixes=
 forbidden_prefixes=
 
+getstats_e()
+{
+       identify -verbose -depth 8 -alpha set -alpha extract "$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
@@ -33,11 +82,45 @@ use_texture()
                if [ "$3" = "shader" ]; then
                        return
                else
-                       echo "(EE) shader $1 uses non-existing texture $2"
+                       echo "(EE) shader $1 uses non-existing texture $2"; seterror
                fi
        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
@@ -58,7 +141,7 @@ use_texture()
                esac
        done
        if ! $ok; then
-               echo "(EE) shader $1 is not allowed in this shader file (allowed: $allowed_prefixes, forbidden: $forbidden_prefixes)"
+               echo "(EE) shader $1 is not allowed in this shader file (allowed: $allowed_prefixes, forbidden: $forbidden_prefixes)"; seterror
        fi
 
        case "$3" in
@@ -68,7 +151,7 @@ use_texture()
                                env/*)
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, $3 textures must be in env/"
+                                       echo "(EE) texture $2 of shader $1 is out of place, $3 textures must be in env/"; seterror
                                        ;;
                        esac
                        ;;
@@ -76,7 +159,7 @@ use_texture()
                *)
                        case "$2" in
                                env/*)
-                                       echo "(EE) texture $2 of shader $1 is out of place, $3 textures must not be in env/"
+                                       echo "(EE) texture $2 of shader $1 is out of place, $3 textures must not be in env/"; seterror
                                        ;;
                                *)
                                        ;;
@@ -95,7 +178,7 @@ use_texture()
                                "$pre"/*/*)
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/$suf"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/$suf"; seterror
                                        ;;
                        esac
                        ;;
@@ -107,7 +190,7 @@ use_texture()
                                "$pre"/*/*)
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/base/$suf"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/base/$suf"; seterror
                                        ;;
                        esac
                        ;;
@@ -121,7 +204,7 @@ use_texture()
                                        ;;
                                textures/map_*)
                                        # protect one map's textures from the evil of other maps :P
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/map_$map/*"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/map_$map/*"; seterror
                                        ;;
                                *)
                                        # using outside stuff is permitted
@@ -136,19 +219,19 @@ use_texture()
                                textures/common/*/*)
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1 or textures/common/*/*"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1 or textures/common/*/*"; seterror
                                        ;;
                        esac
                        ;;
-               ## RULE: textures/FOO/* must use textures/FOO/*, for FOO in decals, liquids_water, liquids_slime, liquids_lava, warpzone
-               textures/decals/*|textures/liquids_water/*|textures/liquids_slime/*|textures/liquids_lava/*|textures/warpzone/*)
-                       pre=${1%/*}
+               ## RULE: textures/FOO/* must use textures/FOO/*, for FOO in decals, liquids_water, liquids_slime, liquids_lava
+               textures/decals/*|textures/liquids_*/*|textures/effects_*/*|textures/screens/*|textures/logos/*)
+                       pre=`echo "$1" | cut -d / -f 1-2`
                        case "$2" in
                                "$pre"/*)
                                        # I _suppose_ this is fine, as tZork committed this pack
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1"; seterror
                                        ;;
                        esac
                        ;;
@@ -164,7 +247,7 @@ use_texture()
                                        # typical place for skybox
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1"; seterror
                                        ;;
                        esac
                        ;;
@@ -174,12 +257,12 @@ use_texture()
                                models/*)
                                        ;;
                                *)
-                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1 or models/*"
+                                       echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $1 or models/*"; seterror
                                        ;;
                        esac
                        ;;
                *)
-                       echo "(EE) no shader name pattern for $1"
+                       echo "(EE) no shader name pattern for $1"; seterror
                        ;;
        esac
 }
@@ -187,14 +270,24 @@ use_texture()
 parsing_shader=
 parse_shaderstage()
 {
+       ss_blendfunc=none
+       ss_alphafunc=none
+       ss_map=
        while read L A1 Aother; do
-               case "$L" in
-                       map)
+               case "`echo "$L" | tr A-Z a-z`" in
+                       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
                                ;;
@@ -202,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
@@ -210,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 "$L" in
+               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
                                ;;
@@ -286,36 +441,26 @@ strip_comments()
        sed 's,//.*,,g; s,\r, ,g; s,\t, ,g; s,  *, ,g; s, $,,; s,^ ,,; /^$/ d'
 }
 
-{
-       t=`mktemp || echo ".temp"`
-       for X in *.shader; do
-               strip_comments < "$X" > "$t"
-               parse_shaderfile "${X%.shader}" < "$t"
-       done
-       rm -f "$t"
+t=`mktemp || echo ".temp"`
+for X in *.shader; do
+       strip_comments < "$X" > "$t"
+       parse_shaderfile "${X%.shader}" < "$t"
+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_used=`echo "${textures_used#$LF}" | 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
-               case "$L" in
-                       textures/radiant/*)
-                               ;;
-                       textures/map_*/*)
-                               ;;
-                       *)
-                               echo "(EE) texture $L is not referenced by any shader"
-                               ;;
-               esac
-       done
-} | {
-       return=true
-       while IFS= read -r STATUS TEXT; do
-               case "$STATUS" in
-                       '(EE)')
-                               return=false
-                               ;;
-               esac
-       done
-       $return
-}
+echo "$textures_used$LF$textures_used$LF$textures_avail" | sort | uniq -u | while IFS= read -r L; do
+       case "$L" in
+               textures/radiant/*)
+                       ;;
+               textures/map_*/*)
+                       ;;
+               *)
+                       echo "(EE) texture $L is not referenced by any shader"; seterror
+                       ;;
+       esac
+done
+
+$status