misc/tools/encode-demos.sh

   1 #!/bin/bash
   2 # name: encode-demos.sh
   3 # version: 0.6.2
   4 # author: Tyler "-z-" Mulligan <z@xnz.me>
   5 # license: GPL & MIT
   6 # date: 26-02-2017
   7 # description: headless encoding of demo files to HD video concurrently with Xfvb and parallel
   8 #
   9 # The encoding is done with a full Xonotic client inside Xfvb.
  10 # parallel is acting as a job queue.
  11 # You may want to create a new userdir such as `~/.xonotic-clean` for encoding.
  12 # If you don't want certain details of your player config carrying over.
  13 #
  14 # The following is a good starting point for 1080p videos:
  15 #
  16 # ```
  17 # // autoexec.cfg
  18 # bgmvolume 1
  19 #
  20 # vid_height 1080
  21 # vid_width 1920
  22 # scr_screenshot_gammaboost 1
  23 # cl_capturevideo_width 1920
  24 # cl_capturevideo_height 1080
  25 # cl_capturevideo_fps 60
  26 # cl_capturevideo_ogg 1
  27 # cl_capturevideo_ogg_theora_quality 63
  28 # cl_capturevideo_ogg_theora_bitrate -1
  29 # cl_capturevideo_ogg_theora_keyframe_bitrate_multiplier 2
  30 # cl_capturevideo_ogg_theora_keyframe_maxinterval 500
  31 # cl_capturevideo_ogg_theora_keyframe_mininterval 1
  32 # cl_capturevideo_ogg_theora_keyframe_auto_threshold 80
  33 # cl_capturevideo_ogg_theora_noise_sensitivity 0
  34 # cl_capturevideo_ogg_vorbis_quality 10
  35 #
  36 # // HUD stuff
  37 # defer 5 "menu_watermark \"\""
  38 # set cl_allow_uid2name 0; set cl_allow_uidtracking 0
  39 # con_notify 0; con_notifysize 0; con_notifytime 0; showspeed 0; showfps 0
  40 # ```
  41 #
  42
  43 # Customize
  44 USERDIR=${HOME}/.xonotic-clean                      # path to Xonotic userdir for client that does encoding
  45 GAMEDIR=${USERDIR}/data                             # path to Xonotic userdir for client that does encoding
  46 XONOTIC_BIN="./all"                                 # binary used to launch Xonotic
  47 JOB_TIMEOUT="4h"                                    # if demo doesn't quit itself or hangs
  48 JOBS=4                                              # number of concurrent jobs
  49 DEFAULT_DEMO_LIST_FILE="demos.txt"                  # for batch
  50 DISPLAY=:1.0                                        # display for Xvfb
  51 DIMENSIONS=1920x1080                                # dimensions of virtual display
  52 COMPRESS=false                                      # whether to compress by default
  53 KILLER_KEYWORD_WATCHER=true                         # watch server logs for keyword, kill worker if true
  54 KILLER_KEYWORD="Server Disconnected"                # keyword
  55 KILLER_KEYWORD_WAIT="10s"                           # time to wait between polling watchers
  56 LIST_JOBS_FOLLOW_WAIT="10s"                         # how often to poll the job list with -f
  57
  58 # Internal Constants
  59 SCRIPT_NAME=$(basename $0 .sh)
  60 VERSION=$(awk 'NR == 3 {print $3; exit}' $0)
  61 FFMPEG=$(which ffmpeg)
  62 QUEUE_FILE_DEMOS="/tmp/${SCRIPT_NAME}.jobqueue"
  63 QUEUE_FILE_COMPRESSING="/tmp/${SCRIPT_NAME}_compress.jobqueue"
  64 LOCK_FILE="/tmp/${SCRIPT_NAME}.lock"
  65 LOCK_FILE_COMPRESSING="/tmp/${SCRIPT_NAME}.lock"
  66 LOG_FILE="${SCRIPT_NAME}.log"
  67 REGEX_DEMOLIST_FILE="^[[:alnum:]]+\.txt$"
  68 REGEX_DURATION="^[0-9]+(d|h|m|s)$"
  69 REGEX_VIDEO_TYPES="^(mp4|webm)$"
  70
  71 # State
  72 export KILLER_KEYWORD_WATCHING=true
  73
  74 # Xonotic Helpers
  75
  76 _check_xonotic_dir() {
  77     local xon_dir=$1
  78     if [[ ! -d ${xon_dir} ]]; then
  79         echo "[ ERROR ] Unable to locate Xonotic"; exit 1
  80     fi
  81 }
  82
  83 _get_xonotic_dir() {
  84     relative_dir=$(dirname $0)/../..
  85     _check_xonotic_dir ${relative_dir}
  86     export XONOTIC_DIR=$(cd ${relative_dir}; pwd)
  87 }
  88
  89 _kill_xonotic() {
  90     pkill -f "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_"
  91 }
  92
  93 # Data Helpers
  94 ###############
  95
  96 _get_compression_command() {
  97     if [[ ${FFMPEG} == "" ]]; then
  98         echo "[ ERROR ] ffmpeg or avconv required"
  99         exit 1
 100     fi
 101     if [[ ! $1 ]]; then
 102         echo "[ ERROR ] Video name required"
 103         exit 1
 104     fi
 105     local video_file=$1
 106     local type="mp4"
 107     if [[ $2 =~ ${REGEX_VIDEO_TYPES} ]]; then
 108         type=$2
 109     fi
 110     # compress
 111     if [[ ${type} == "mp4" ]]; then
 112         local output_video_file=$(echo ${video_file} | sed 's/\.ogv$/\.mp4/')
 113         command="${FFMPEG} -i ${video_file} -y -codec:v libx264 -crf 21 -bf 2 -flags +cgop -pix_fmt yuv420p -codec:a aac -strict -2 -b:a 384k -r:a 48000 -movflags faststart ${output_video_file}"
 114     elif [[ ${type} == "webm" ]]; then
 115         local output_video_file=$(echo ${video_file} | sed 's/\.ogv$/\.webm/')
 116         command="${FFMPEG} -i ${video_file} -y -acodec libvorbis -aq 5 -ac 2 -qmax 25 -threads 2 ${output_video_file}"
 117     fi
 118     echo ${command}
 119 }
 120
 121 _get_demo_command() {
 122     local demo_file=$1
 123     local index=$2
 124     name_format=$(basename "${demo_file}" .dem)
 125     command="${XONOTIC_DIR}/${XONOTIC_BIN} run sdl -simsound -sessionid xonotic_${SCRIPT_NAME}_${index} -userdir \"${USERDIR}\" \
 126         +log_file \"xonotic_${SCRIPT_NAME}_${index}_${name_format}.log\" \
 127         +cl_capturevideo_nameformat \"${name_format}_\" \
 128         +cl_capturevideo_number 0 \
 129         +playdemo \"${demo_file}\" \
 130         +toggle cl_capturevideo \
 131         +alias cl_hook_shutdown quit \
 132         > /dev/null 2>&1"
 133     echo ${command}
 134 }
 135
 136 _get_demos_from_file() {
 137     local file=$1
 138     if [[ -f ${file} ]]; then
 139         local lines
 140         OLD_IFS=${IFS}
 141         IFS=$'\n' read -d '' -r -a lines < ${file}
 142         IFS=${OLD_IFS}
 143         echo ${lines[@]}
 144     fi
 145 }
 146
 147 # Queue Helpers
 148 ################
 149
 150 _queue_add_job() {
 151     local queue_file=$1;
 152     local command=$2;
 153     local nice_name=${command};
 154     local nice_queue_name=${queue_file##*/};
 155     if [[ $3 ]]; then
 156         nice_name=$3
 157     fi
 158     echo "[ INFO ] '${nice_queue_name/.jobqueue/}' new job: ${nice_name}"
 159     echo "${command}" >> ${queue_file}
 160 }
 161
 162 _queue_add_compression_jobs() {
 163     local queue_file=$1; shift
 164     local type=$1; shift
 165     local videos="$@"
 166     for video_file in ${videos[@]}; do
 167         local command=$(_get_compression_command ${GAMEDIR}/${video_file} ${type})
 168         _queue_add_job ${queue_file} "${command}" ${video_file}
 169     done
 170 }
 171
 172 _queue_add_demo_jobs() {
 173     local queue_file=$1; shift
 174     local timeout=$1; shift
 175     local demos=$@
 176     local i=0
 177     for demo_file in ${demos[@]}; do
 178         local command=$(_get_demo_command ${demo_file} ${i})
 179         command="timeout ${timeout} ${command}"
 180         _queue_add_job ${queue_file} "${command}" ${demo_file}
 181         ((i++))
 182     done
 183 }
 184
 185 _get_active_demo_jobs() {
 186     if [[ $(pgrep -caf "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_") -gt 0 ]]; then
 187         pgrep -af "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_" |grep "dev/null" |awk '{ print $17 }' |sed 's/"//g;s/_$/\.dem/'
 188     else
 189         echo ""
 190     fi
 191 }
 192
 193 _get_active_demo_workers() {
 194     if [[ $(pgrep -caf "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_") -gt 0 ]]; then
 195         pgrep -af "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_" |grep "dev/null" |awk '{ print $11"_"$17 }' |sed 's/"//g;s/_$//'
 196     else
 197         echo ""
 198     fi
 199 }
 200
 201 _get_queue_jobs() {
 202     local queue_file=$1
 203     if [[ -f ${queue_file} ]]; then
 204         cat ${queue_file} |awk '{ print $14 }'|sed 's/"//g;s/_$/\.dem/'
 205     else
 206         echo ""
 207     fi
 208 }
 209
 210 _get_completed_jobs() {
 211     if [[ -f ${LOG_FILE} ]]; then
 212         cat ${LOG_FILE} |awk '{ print $22 }'|sed 's/"//g;s/_$/\.dem/'
 213     else
 214         echo ""
 215     fi
 216 }
 217
 218 _run_compress_jobs() {
 219     local queue_file=${QUEUE_FILE_COMPRESSING}
 220     if [[ $1 ]]; then
 221         queue_file=$1
 222     fi
 223     local start=$(date +%s)
 224     (
 225         flock -n 9 || exit 99
 226         trap _cleanup_compress EXIT
 227         if [[ -f ${queue_file} ]]; then
 228             parallel -j${JOBS} --progress --eta --joblog "${LOG_FILE}" < ${queue_file}
 229         else
 230             echo "[ ERROR ] No jobs found"
 231         fi
 232     ) 9>${LOCK_FILE_COMPRESSING}
 233     if [[ $? -eq 99 ]]; then
 234         echo "[ ERROR ] lockfile exists, remove if you're sure jobs aren't running: ${LOCK_FILE_COMPRESSING}"
 235         exit 1
 236     fi
 237     local end=$(date +%s)
 238     local runtime=$((end-start))
 239     printf 'Video Compression Time: %02dh:%02dm:%02ds\n' $((runtime/3600)) $((runtime%3600/60)) $((runtime%60))
 240 }
 241
 242 _run_demo_jobs() {
 243     local queue_file=${QUEUE_FILE_DEMOS}
 244     if [[ $1 ]]; then
 245         queue_file=$1
 246     fi
 247     local start=$(date +%s)
 248     if [[ ${KILLER_KEYWORD_WATCHER} ]]; then
 249         (sleep 5 && _log_killer_keyword_watcher ${KILLER_KEYWORD}) > /dev/null 2>&1 &
 250     fi
 251     if [[ $2 == "summary" ]]; then
 252         (sleep 5 && echo && list_jobs) &
 253     fi
 254     (
 255         flock -n 9 || exit 99
 256         trap _cleanup EXIT
 257         if [[ -f ${queue_file} ]]; then
 258             parallel -j${JOBS} --progress --eta --joblog "${LOG_FILE}" < ${queue_file}
 259         else
 260             echo "[ ERROR ] No jobs found"
 261         fi
 262     ) 9>${LOCK_FILE}
 263     if [[ $? -eq 99 ]]; then
 264         echo "[ ERROR ] lockfile exists, remove if you're sure jobs aren't running: ${LOCK_FILE}"
 265         exit 1
 266     fi
 267     local end=$(date +%s)
 268     local runtime=$((end-start))
 269     printf 'Demo Encoding Time: %02dh:%02dm:%02ds\n' $((runtime/3600)) $((runtime%3600/60)) $((runtime%60))
 270 }
 271
 272 # Cleanup Helpers
 273 ##################
 274
 275 _cleanup() {
 276     rm -f ${QUEUE_FILE_DEMOS}
 277     rm -f ${LOCK_FILE}
 278     rm -f ${GAMEDIR}/*.log
 279     export KILLER_KEYWORD_WATCHING=false
 280     sleep 1
 281     _kill_xonotic
 282 }
 283
 284 _cleanup_children() {
 285     kill $(jobs -pr)
 286 }
 287
 288 _cleanup_compress() {
 289     rm -f ${QUEUE_FILE_COMPRESSING}
 290 }
 291
 292 # Application Helpers
 293 ######################
 294
 295 _check_if_compress() {
 296     local compress=$1; shift
 297     local videos=$@
 298     trap _cleanup_children SIGINT SIGTERM EXIT
 299     if [[ ${compress} == "true" ]]; then
 300         _run_compress_jobs ${QUEUE_FILE_COMPRESSING}
 301     fi
 302 }
 303
 304 _log_killer_keyword_watcher() {
 305     local keyword="$@"
 306     until [[ ${KILLER_KEYWORD_WATCHING} != "true" ]]; do
 307         log_killer_keyword ${keyword}
 308         sleep ${KILLER_KEYWORD_WAIT}
 309     done
 310 }
 311
 312 # Commands
 313 ###########
 314
 315 _run_xvfb() {
 316     if [[ ! -f /tmp/.X1-lock ]]; then
 317         /usr/bin/Xvfb :1 -screen 0 ${DIMENSIONS}x16 +extension RENDER & xvfb_pid=$!
 318     else
 319         xvfb_pid=$(pgrep -f Xvfb)
 320     fi
 321     echo "[ INFO ] Xvfb PID: ${xvfb_pid}"
 322 }
 323
 324 compress() {
 325     if [[ ${FFMPEG} == "" ]]; then
 326         echo "[ ERROR ] ffmpeg or avconv required"
 327         exit 1
 328     fi
 329     if [[ ! $1 ]]; then
 330         echo "[ ERROR ] Video name required"
 331         exit 1
 332     fi
 333     local video_file=$1; shift
 334     local type="mp4"
 335     local cleanup=""
 336     if [[ $1 =~ ${REGEX_VIDEO_TYPES} ]]; then
 337         type=$2
 338         if [[ $2 == "--cleanup" ]]; then
 339             cleanup=$2
 340         fi
 341     elif [[ $1 == "--cleanup" ]]; then
 342         cleanup=$1
 343     else
 344         echo "[ ERROR ] Invalid type specified"
 345     fi
 346
 347     # compress
 348     local command=$(_get_compression_command ${GAMEDIR}/${video_file} ${type})
 349     echo ${command}
 350     echo "[ INFO ] Compressing '${video_file}'"
 351     _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} ${type} ${video_file[@]}
 352     cat ${QUEUE_FILE_COMPRESSING}
 353     _run_compress_jobs ${QUEUE_FILE_COMPRESSING}
 354
 355     if [[ ${cleanup} == "--cleanup" ]]; then
 356         echo "[ INFO ] Cleaning up"
 357         echo rm ${video_file}
 358     fi
 359 }
 360
 361 list_jobs() {
 362     completed_jobs=$(_get_completed_jobs)
 363     active_jobs=$(_get_active_demo_jobs)
 364     all_jobs=$(_get_queue_jobs ${QUEUE_FILE_DEMOS})
 365
 366     echo -e "\nActive Jobs:\n-----------"
 367     if [[ ${active_jobs} == "" ]]; then
 368         echo "<None>"
 369     else
 370         echo ${active_jobs} |tr ' ' '\n' |sort |uniq -u
 371     fi
 372
 373     echo -e "\nQueued Jobs:\n-----------"
 374     if [[ ${#all_jobs[@]} -eq 0 ]]; then
 375         echo "<None>"
 376     else
 377         if [[ ${active_jobs} == "" ]]; then
 378             echo "<None>"
 379         else
 380             non_queued_jobs=$(echo "${active_jobs[@]}" "${completed_jobs[@]}" |tr ' ' '\n' |sort |uniq -u)
 381             queued_jobs=$(echo "${all_jobs[@]}" "${non_queued_jobs[@]}" |tr ' ' '\n' |sort |uniq -u)
 382             if [[ ${queued_jobs} == "" ]]; then
 383                 echo "<None>"
 384             else
 385                 echo ${queued_jobs} | tr ' ' '\n' | sort | uniq -u
 386             fi
 387         fi
 388     fi
 389
 390     echo -e "\nCompleted Jobs:\n--------------"
 391     if [[ ${completed_jobs} == "" ]]; then
 392         echo "<None>"
 393     else
 394         echo ${completed_jobs} | tr ' ' '\n' | sort | uniq -u
 395     fi
 396
 397     echo
 398
 399     if  [[ $1 == "-f" ]]; then
 400         sleep ${LIST_JOBS_FOLLOW_WAIT}
 401         clear
 402         date
 403         list_jobs $1
 404     fi
 405 }
 406
 407 log_completed_jobs() {
 408     local extra_flags=""
 409     if [[ $1 ]]; then
 410         extra_flags=$1
 411     fi
 412     tail ${extra_flags} ${LOG_FILE}
 413 }
 414
 415 log_killer_keyword() {
 416     local keyword="$@"
 417     local workers=$(log_keyword_grep "worker" "${keyword}")
 418     for z in ${workers[@]}; do
 419         local process=${z[0]}
 420         local pid=$(pgrep -fo ${process})
 421         echo "killing PID: ${pid} | ${process}"
 422         kill ${pid}
 423      done
 424 }
 425
 426 log_keyword_grep() {
 427     if [[ ! $2 ]]; then
 428         echo "[ ERROR ] Keyword required"
 429         exit 1
 430     fi
 431     local type=${1:-worker}; shift
 432     local keyword="$@"
 433     for worker in $(_get_active_demo_workers); do
 434         local log_file="${worker}.log"
 435         local keyword_count=$(grep -c "${keyword}" "${GAMEDIR}/${log_file}")
 436         if [[ ${keyword_count} > 0 ]]; then
 437             if [[ ${type} == "worker" ]]; then
 438                 echo "${worker}"
 439             else
 440                 echo "[ worker ] ${worker}"
 441                 grep "${keyword}" "${GAMEDIR}/${log_file}"
 442             fi
 443         fi
 444     done
 445 }
 446
 447 process_batch() {
 448     local demo_list_file=${DEFAULT_DEMO_LIST_FILE}
 449     local timeout=${JOB_TIMEOUT}
 450     local -a videos=()
 451     if [[ $1 =~ ${REGEX_DEMOLIST_FILE} ]]; then
 452         demo_list_file=$1; shift
 453     fi
 454     if [[ $1 =~ ${REGEX_DURATION} ]]; then
 455         timeout=$1; shift
 456     fi
 457     local compress=${COMPRESS}
 458     if [[ $1 == "--compress" ]]; then
 459         compress="true"
 460     fi
 461     echo "[ INFO ] Using '${demo_list_file}' with a timeout of ${timeout}"
 462     local demos=$(_get_demos_from_file ${demo_list_file})
 463     _queue_add_demo_jobs ${QUEUE_FILE_DEMOS} ${timeout} ${demos[@]}
 464     if [[ ${compress} == "true" ]]; then
 465         for v in ${demos[@]}; do
 466             videos+=("video/$(basename ${v} | sed 's/.dem$/_000.ogv/')")
 467         done
 468         _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} "mp4" "${videos[@]}"
 469     fi
 470     _run_demo_jobs ${QUEUE_FILE_DEMOS} "summary" && \
 471         _check_if_compress ${compress} "${videos[@]}"
 472 }
 473
 474 process_single() {
 475     if [[ ! $1 ]]; then
 476         echo "[ ERROR ] Demo name required"
 477         exit 1
 478     fi
 479     local demo_file=$1
 480     local timeout=${JOB_TIMEOUT}
 481     if [[ $2 =~ ${REGEX_DURATION} ]]; then
 482         timeout=$2; shift
 483     fi
 484     local compress=${COMPRESS}
 485     if [[ $2 == "--compress" ]]; then
 486         compress="true"
 487     fi
 488     echo "[ INFO ] Using '${demo_file}' with a timeout of ${timeout}"
 489     _queue_add_demo_jobs ${QUEUE_FILE_DEMOS} ${timeout} ${demo_file}
 490     if [[ ${compress} == "true" ]]; then
 491         local video_file="video/$(basename "${demo_file}" .dem)_000.ogv"
 492         _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} "mp4" "${video_file}"
 493     fi
 494     _run_demo_jobs ${QUEUE_FILE_DEMOS} "summary" && \
 495         _check_if_compress ${compress} ${video_file}
 496 }
 497
 498 _version() {
 499     echo ${VERSION}
 500 }
 501
 502 _help() {
 503     echo "./encode-demos.sh
 504
 505 FLAGS
 506
 507     --version                                   prints the version string
 508
 509 COMMANDS
 510
 511     Encoding
 512     --------
 513     batch  [demos.txt] [timeout] [--compress]   batch process a list of demos from file relative to \$USERDIR/data
 514     single <demo> [timeout] [--compress]        process a single demo file in \$USERDIR/data. ex: demos/cool.dem
 515                                                 'timeout' does not include '--compress', compress starts a new job
 516     Compression
 517     -----------
 518     compress <video> [mp4|webm] [--cleanup]     compress an encoded ogv in \$USERDIR/data, ex: video/cool.ogv
 519
 520     Job Management
 521     --------------
 522     grep <keyword>                              grep the server logs of the workers
 523     kkill <keyword>                             keyword kill, kill a worker if string is matched
 524     list [-f]                                   list currently active/queued/completed jobs
 525     log [-f]                                    tail the current log (-f follows log)
 526
 527 EXAMPLES
 528
 529     # outputs \$USERDIR/data/video/2015-06-11_00-26_solarium.ogv (very large)
 530     ./encode-demos.sh single demos/2015-06-11_00-26_solarium.dem
 531
 532     # outputs \$USERDIR/data/video/2015-06-11_00-26_solarium.mp4 (optimal for youtube)
 533     ./encode-demos.sh single demos/2015-06-11_00-26_solarium.dem --compress
 534
 535     # batch
 536     ./encode-demos.sh batch demos.txt --compress
 537
 538     # compress a video in \$USERDIR/data (outputs test.mp4, and deletes the original)
 539     ./encode-demos.sh compress video/test.ogv --cleanup
 540
 541     # list jobs
 542     ./encode-demos.sh list
 543
 544     # inspect worker server logs
 545     ./encode-demos.sh grep \"connected\"
 546
 547     # follow a completed job log
 548     ./encode-demos.sh log -f
 549
 550     # Override the path to Xonotic (assumed from relative location of this script)
 551     XONOTIC_DIR=\$HOME/some/other/dir; ./misc/tools/encode-demos.sh --version
 552 "
 553 }
 554
 555 # Init
 556 ######
 557
 558 # Allow for overriding the path assumption
 559 # XONOTIC_DIR=$HOME/some/other/dir; ./misc/tools/encode-demos.sh --version
 560 if [[ -z ${XONOTIC_DIR} ]]; then
 561     _get_xonotic_dir
 562 else
 563     _check_xonotic_dir ${XONOTIC_DIR}
 564 fi
 565
 566 case $1 in
 567     # flags
 568     '--version')        _version;;
 569     ## commands
 570     # encoding
 571     'batch')            _run_xvfb; process_batch $2 $3 $4;;
 572     'single')           _run_xvfb; process_single $2 $3 $4;;
 573     # compression
 574     'compress')         compress $2 $3 $4;;
 575     # monitoring/management
 576     'grep')             log_keyword_grep 'normal' $2;;
 577     'kkill')            log_killer_keyword $2;;
 578     'list')             list_jobs $2;;
 579     'log')              log_completed_jobs $2;;
 580     # default
 581     *)                  _help; exit 0;;
 582 esac