2 # name: encode-demos.sh
4 # author: Tyler "-z-" Mulligan
7 # description: headless encoding of demo files to HD video concurrently with Xfvb and parallel
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.
14 # The following is a good starting point for 1080p videos:
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
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
44 XONDIR=${HOME}/xonotic/xonotic # path to ./all
45 USERDIR=${HOME}/.xonotic-clean # path to Xonotic userdir for client that does encoding
46 XONOTIC_BIN="./all" # binary used to launch Xonotic
47 JOB_TIMEOUT="1h" # 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
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)$"
72 export KILLER_KEYWORD_WATCHING=true
77 _get_compression_command() {
78 if [[ ${FFMPEG} == "" ]]; then
79 echo "[ ERROR ] ffmpeg or avconv required"
83 echo "[ ERROR ] Video name required"
88 if [[ $2 =~ ${REGEX_VIDEO_TYPES} ]]; then
92 if [[ ${type} == "mp4" ]]; then
93 local output_video_file=$(echo ${video_file} | sed 's/\.ogv$/\.mp4/')
94 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}"
95 elif [[ ${type} == "webm" ]]; then
96 local output_video_file=$(echo ${video_file} | sed 's/\.ogv$/\.webm/')
97 command="${FFMPEG} -i ${video_file} -y -acodec libvorbis -aq 5 -ac 2 -qmax 25 -threads 2 ${output_video_file}"
102 _get_demo_command() {
105 name_format=$(basename "${demo_file}" .dem)
106 command="${XONDIR}/${XONOTIC_BIN} run sdl -simsound -sessionid xonotic_${SCRIPT_NAME}_${index} -userdir \"${USERDIR}\" \
107 +log_file \"xonotic_${SCRIPT_NAME}_${index}_${name_format}.log\" \
108 +cl_capturevideo_nameformat \"${name_format}_\" \
109 +cl_capturevideo_number 0 \
110 +playdemo \"${demo_file}\" \
111 +toggle cl_capturevideo \
112 +alias cl_hook_shutdown quit \
117 _get_demos_from_file() {
119 if [[ -f ${file} ]]; then
122 IFS=$'\n' read -d '' -r -a lines < ${file}
134 local nice_name=${command};
135 local nice_queue_name=${queue_file##*/};
139 echo "[ INFO ] '${nice_queue_name/.jobqueue/}' new job: ${nice_name}"
140 echo "${command}" >> ${queue_file}
143 _queue_add_compression_jobs() {
144 local queue_file=$1; shift
147 for video_file in ${videos[@]}; do
148 local command=$(_get_compression_command ${USERDIR}/data/${video_file} ${type})
149 _queue_add_job ${queue_file} "${command}" ${video_file}
153 _queue_add_demo_jobs() {
154 local queue_file=$1; shift
155 local timeout=$1; shift
158 for demo_file in ${demos[@]}; do
159 local command=$(_get_demo_command ${demo_file} ${i})
160 command="timeout ${timeout} ${command}"
161 _queue_add_job ${queue_file} "${command}" ${demo_file}
166 _get_active_demo_jobs() {
167 if [[ $(pgrep -caf "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_") -gt 0 ]]; then
168 pgrep -af "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_" |grep "dev/null" |awk '{ print $17 }' |sed 's/"//g;s/_$/\.dem/'
174 _get_active_demo_workers() {
175 if [[ $(pgrep -caf "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_") -gt 0 ]]; then
176 pgrep -af "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_" |grep "dev/null" |awk '{ print $11"_"$17 }' |sed 's/"//g;s/_$//'
184 if [[ -f ${queue_file} ]]; then
185 cat ${queue_file} |awk '{ print $14 }'|sed 's/"//g;s/_$/\.dem/'
191 _get_completed_jobs() {
192 if [[ -f ${LOG_FILE} ]]; then
193 cat ${LOG_FILE} |awk '{ print $22 }'|sed 's/"//g;s/_$/\.dem/'
199 _run_compress_jobs() {
200 local queue_file=${QUEUE_FILE_COMPRESSING}
204 local start=$(date +%s)
206 flock -n 9 || exit 99
207 trap _cleanup_compress EXIT
208 if [[ -f ${queue_file} ]]; then
209 parallel -j${JOBS} --progress --eta --joblog "${LOG_FILE}" < ${queue_file}
211 echo "[ ERROR ] No jobs found"
213 ) 9>${LOCK_FILE_COMPRESSING}
214 if [[ $? -eq 99 ]]; then
215 echo "[ ERROR ] lockfile exists, remove if you're sure jobs aren't running: ${LOCK_FILE_COMPRESSING}"
218 local end=$(date +%s)
219 local runtime=$((end-start))
220 printf 'Video Compression Time: %02dh:%02dm:%02ds\n' $((runtime/3600)) $((runtime%3600/60)) $((runtime%60))
224 local queue_file=${QUEUE_FILE_DEMOS}
228 local start=$(date +%s)
229 if [[ ${KILLER_KEYWORD_WATCHER} ]]; then
230 (sleep 5 && _log_killer_keyword_watcher ${KILLER_KEYWORD}) > /dev/null 2>&1 &
232 if [[ $2 == "summary" ]]; then
233 (sleep 5 && echo && list_jobs) &
236 flock -n 9 || exit 99
238 if [[ -f ${queue_file} ]]; then
239 parallel -j${JOBS} --progress --eta --joblog "${LOG_FILE}" < ${queue_file}
241 echo "[ ERROR ] No jobs found"
244 if [[ $? -eq 99 ]]; then
245 echo "[ ERROR ] lockfile exists, remove if you're sure jobs aren't running: ${LOCK_FILE}"
248 local end=$(date +%s)
249 local runtime=$((end-start))
250 printf 'Demo Encoding Time: %02dh:%02dm:%02ds\n' $((runtime/3600)) $((runtime%3600/60)) $((runtime%60))
257 rm -f ${QUEUE_FILE_DEMOS}
259 rm -f ${USERDIR}/data/*.log
260 export KILLER_KEYWORD_WATCHING=false
265 _cleanup_children() {
269 _cleanup_compress() {
270 rm -f ${QUEUE_FILE_COMPRESSING}
274 pkill -f "\-simsound \-sessionid xonotic_${SCRIPT_NAME}_"
277 # Application Helpers
278 ######################
280 _check_if_compress() {
281 local compress=$1; shift
283 trap _cleanup_children SIGINT SIGTERM EXIT
284 if [[ ${compress} == "true" ]]; then
285 _run_compress_jobs ${QUEUE_FILE_COMPRESSING}
289 _log_killer_keyword_watcher() {
291 until [[ ${KILLER_KEYWORD_WATCHING} != "true" ]]; do
292 log_killer_keyword ${keyword}
293 sleep ${KILLER_KEYWORD_WAIT}
301 if [[ ! -f /tmp/.X1-lock ]]; then
302 /usr/bin/Xvfb :1 -screen 0 ${DIMENSIONS}x16 +extension RENDER & xvfb_pid=$!
304 xvfb_pid=$(pgrep -f Xvfb)
306 echo "[ INFO ] Xvfb PID: ${xvfb_pid}"
310 if [[ ${FFMPEG} == "" ]]; then
311 echo "[ ERROR ] ffmpeg or avconv required"
315 echo "[ ERROR ] Video name required"
318 local video_file=$1; shift
321 if [[ $1 =~ ${REGEX_VIDEO_TYPES} ]]; then
323 if [[ $2 == "--cleanup" ]]; then
326 elif [[ $1 == "--cleanup" ]]; then
329 echo "[ ERROR ] Invalid type specified"
333 local command=$(_get_compression_command ${USERDIR}/data/${video_file} ${type})
335 echo "[ INFO ] Compressing '${video_file}'"
336 _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} ${type} ${video_file[@]}
337 cat ${QUEUE_FILE_COMPRESSING}
338 _run_compress_jobs ${QUEUE_FILE_COMPRESSING}
340 if [[ ${cleanup} == "--cleanup" ]]; then
341 echo "[ INFO ] Cleaning up"
342 echo rm ${video_file}
347 completed_jobs=$(_get_completed_jobs)
348 active_jobs=$(_get_active_demo_jobs)
349 all_jobs=$(_get_queue_jobs ${QUEUE_FILE_DEMOS})
351 echo -e "\nActive Jobs:\n-----------"
352 if [[ ${active_jobs} == "" ]]; then
355 echo ${active_jobs} |tr ' ' '\n' |sort |uniq -u
358 echo -e "\nQueued Jobs:\n-----------"
359 if [[ ${#all_jobs[@]} -eq 0 ]]; then
362 if [[ ${active_jobs} == "" ]]; then
365 non_queued_jobs=$(echo "${active_jobs[@]}" "${completed_jobs[@]}" |tr ' ' '\n' |sort |uniq -u)
366 queued_jobs=$(echo "${all_jobs[@]}" "${non_queued_jobs[@]}" |tr ' ' '\n' |sort |uniq -u)
367 if [[ ${queued_jobs} == "" ]]; then
370 echo ${queued_jobs} | tr ' ' '\n' | sort | uniq -u
375 echo -e "\nCompleted Jobs:\n--------------"
376 if [[ ${completed_jobs} == "" ]]; then
379 echo ${completed_jobs} | tr ' ' '\n' | sort | uniq -u
384 if [[ $1 == "-f" ]]; then
385 sleep ${LIST_JOBS_FOLLOW_WAIT}
392 log_completed_jobs() {
397 tail ${extra_flags} ${LOG_FILE}
400 log_killer_keyword() {
402 local workers=$(log_keyword_grep "worker" "${keyword}")
403 for z in ${workers[@]}; do
404 local process=${z[0]}
405 local pid=$(pgrep -fo ${process})
406 echo "killing PID: ${pid} | ${process}"
413 echo "[ ERROR ] Keyword required"
416 local type=${1:-worker}; shift
418 for worker in $(_get_active_demo_workers); do
419 local log_file="${worker}.log"
420 local keyword_count=$(grep -c "${keyword}" "${USERDIR}/data/${log_file}")
421 if [[ ${keyword_count} > 0 ]]; then
422 if [[ ${type} == "worker" ]]; then
425 echo "[ worker ] ${worker}"
426 grep "${keyword}" "${USERDIR}/data/${log_file}"
433 local demo_list_file=${DEFAULT_DEMO_LIST_FILE}
434 local timeout=${JOB_TIMEOUT}
436 if [[ $1 =~ ${REGEX_DEMOLIST_FILE} ]]; then
437 demo_list_file=$1; shift
439 if [[ $1 =~ ${REGEX_DURATION} ]]; then
442 local compress=${COMPRESS}
443 if [[ $1 == "--compress" ]]; then
446 echo "[ INFO ] Using '${demo_list_file}' with a timeout of ${timeout}"
447 local demos=$(_get_demos_from_file ${demo_list_file})
448 _queue_add_demo_jobs ${QUEUE_FILE_DEMOS} ${timeout} ${demos[@]}
449 if [[ ${compress} == "true" ]]; then
450 for v in ${demos[@]}; do
451 videos+=("video/$(basename ${v} | sed 's/.dem$/_000.ogv/')")
453 _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} "mp4" "${videos[@]}"
455 _run_demo_jobs ${QUEUE_FILE_DEMOS} "summary" && \
456 _check_if_compress ${compress} "${videos[@]}"
461 echo "[ ERROR ] Demo name required"
465 local timeout=${JOB_TIMEOUT}
466 if [[ $2 =~ ${REGEX_DURATION} ]]; then
469 local compress=${COMPRESS}
470 if [[ $2 == "--compress" ]]; then
473 echo "[ INFO ] Using '${demo_file}' with a timeout of ${timeout}"
474 _queue_add_demo_jobs ${QUEUE_FILE_DEMOS} ${timeout} ${demo_file}
475 if [[ ${compress} == "true" ]]; then
476 local video_file="video/$(basename "${demo_file}" .dem)_000.ogv"
477 _queue_add_compression_jobs ${QUEUE_FILE_COMPRESSING} "mp4" "${video_file}"
479 _run_demo_jobs ${QUEUE_FILE_DEMOS} "summary" && \
480 _check_if_compress ${compress} ${video_file}
488 echo "./encode-demos.sh
492 --version prints the version string
498 batch [demos.txt] [timeout] [--compress] batch process a list of demos from file relative to \$USERDIR/data
499 single <demo> [timeout] [--compress] process a single demo file in \$USERDIR/data. ex: demos/cool.dem
500 'timeout' does not include '--compress', compress starts a new job
503 compress <video> [mp4|webm] [--cleanup] compress an encoded ogv in \$USERDIR/data, ex: video/cool.ogv
507 grep <keyword> grep the server logs of the workers
508 kkill <keyword> keyword kill, kill a worker if string is matched
509 list [-f] list currently active/queued/completed jobs
510 log [-f] tail the current log (-f follows log)
514 # outputs \$USERDIR/data/video/2015-06-11_00-26_solarium.ogv (very large)
515 ./encode-demos.sh single demos/2015-06-11_00-26_solarium.dem
517 # outputs \$USERDIR/data/video/2015-06-11_00-26_solarium.mp4 (optimal for youtube)
518 ./encode-demos.sh single demos/2015-06-11_00-26_solarium.dem --compress
521 ./encode-demos.sh batch demos.txt --compress
523 # compress a video in \$USERDIR/data (outputs test.mp4, and deletes the original)
524 ./encode-demos.sh compress video/test.ogv --cleanup
527 ./encode-demos.sh list
529 # inspect worker server logs
530 ./encode-demos.sh grep \"connected\"
532 # follow a completed job log
533 ./encode-demos.sh log -f
539 '--version') _version;;
542 'batch') _run_xvfb; process_batch $2 $3 $4;;
543 'single') _run_xvfb; process_single $2 $3 $4;;
545 'compress') compress $2 $3 $4;;
546 # monitoring/management
547 'grep') log_keyword_grep 'normal' $2;;
548 'kkill') log_killer_keyword $2;;
549 'list') list_jobs $2;;
550 'log') log_completed_jobs $2;;