zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

foamCreateVideo: added options to pause the video at beginning and/or end,

Browse Source 
updated video options for ffmpeg and enabled the -start option with mencoder
This commit is contained in:
Chris Greenshields
2022-07-10 15:08:05 +01:00
parent 58fee9c3e4
commit c70a7b83d6
1 changed files with 144 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
bin/foamCreateVideo
View File

@ -3,7 +3,7 @@
# ========= | # ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration | Website: https://openfoam.org # \\ / O peration | Website: https://openfoam.org
# \\ / A nd | Copyright (C) 2015-2020 OpenFOAM Foundation # \\ / A nd | Copyright (C) 2015-2022 OpenFOAM Foundation
# \\/ M anipulation | # \\/ M anipulation |
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
# License # License
@ -27,7 +27,7 @@
# #
# Description # Description
# Creates a video file from PNG images # Creates a video file from PNG images
# - requires mencoder or ffmpeg # - requires ffmpeg or mencoder installed
# #
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
@ -36,12 +36,14 @@ usage() {
Usage: ${0##*/} [OPTIONS] ... Usage: ${0##*/} [OPTIONS] ...
options: options:
-begin-pause | -b <time> pause at beginning of the video by <time> seconds
-dir | -d <dir> directory containing png images (default local dir) -dir | -d <dir> directory containing png images (default local dir)
-end-pause | -e <time> pause at the end of the video by <time> seconds
-fps | -f <fps> frames per second (default = 10) -fps | -f <fps> frames per second (default = 10)
-help | -h print the usage -help | -h print the usage
-image | -i <name> name of image sequence (default = image) -image | -i <name> name of image sequence (default = image)
-out | -o <name> name of output video file (default = video) -out | -o <name> name of output video file (default = video)
-start | -s <frame> specify the start frame number for ffmpeg -start | -s <frame> specify the start image
-webm | -w WebM output video file format -webm | -w WebM output video file format
Creates a video file from a sequence of PNG images Creates a video file from a sequence of PNG images
@ -50,67 +52,123 @@ Creates a video file from a sequence of PNG images
- The default file name, using MPEG-4 compression, is video.mp4 - The default file name, using MPEG-4 compression, is video.mp4
- By default the video codec is high resolution - By default the video codec is high resolution
Requires mencoder or ffmpeg for MPEG-4 output, ffmpeg for WebM output Requires 'ffmpeg' or 'mencoder' to be installed. 'ffmpeg' is preferred since
'mencoder' does not support the '-begin-pause', '-end-pause' & '-webm' options.
USAGE USAGE
} }
error() { error() {
exec 1>&2 exec 1>&2
while [ "$#" -ge 1 ]; do echo "$1"; shift; done while [ "$#" -ge 1 ]
do
[ "$#" -eq 1 ] && printf "%s\n" "$1" || printf "%s" "$1"
shift
done
usage usage
exit 1 exit 1
} }
isInstalled () {
command -v "$1" >/dev/null 2>&1
}
isInteger () {
[ "$1" -eq "$1" ] 2> /dev/null
}
isNumber () {
printf "%f" "$1" > /dev/null 2>&1 || isInteger "$1"
}
# Default settings # Default settings
dir=. dir=.
image=image image=image
video=video video=video
fps=10 fps=10
fmt=mp4 fmt=mp4
start= start=1
begin_pause=
end_pause=
image_list="$(mktemp /tmp/temp.XXXXXX)" || exit
echo "Creating temporary file $image_list"
trap 'rm -f "$image_list"' EXIT
# Check whether ffmpeg or mencoder are installed to create video
isInstalled ffmpeg && app="ffmpeg"
! [ "$app" ] && isInstalled mencoder && app="mencoder"
[ "$app" ] || \
usage "Neither ffmpeg nor mencoder are installed." \
"Install one of them to use foamCreateVideo."
echo "Running foamCreateVideo with $app"
while [ "$#" -gt 0 ] while [ "$#" -gt 0 ]
do do
case "$1" in case "$1" in
-h | -help) -b | -begin-pause)
usage && exit 0 [ "$app" = "mencoder" ] && \
error "The '$1' option is invalid when using mencoder to create " \
"the video. Either do not use the option, or install ffmpeg."
[ "$#" -ge 2 ] || error "The '$1' option requires an argument."
begin_pause=$2
isNumber "$begin_pause" || \
error "The '$1' option requires a numeric argument."
shift 2
;; ;;
-d | -dir) -d | -dir)
[ "$#" -ge 2 ] || error "'$1' option requires an argument" [ "$#" -ge 2 ] || error "The '$1' option requires an argument."
dir=$2 dir=$2
shift 2 shift 2
;; ;;
-f | -fps) -e | -end-pause)
[ "$#" -ge 2 ] || error "'$1' option requires an argument" [ "$app" = "mencoder" ] && \
fps=$2 error "The '$1' option is invalid when using mencoder to create " \
"the video. Either do not use the option, or install ffmpeg."
[ "$#" -ge 2 ] || error "The '$1' option requires an argument."
end_pause=$2
isNumber "$begin_pause" || \
error "The '$1' option requires a numeric argument."
shift 2 shift 2
;; ;;
-f | -fps)
[ "$#" -ge 2 ] || error "The '$1' option requires an argument."
fps=$2
isInteger "$fps" || \
error "The '$1' option requires an integer argument."
shift 2
;;
-h | -help)
usage && exit 0
;;
-i | -image) -i | -image)
[ "$#" -ge 2 ] || error "'$1' option requires an argument" [ "$#" -ge 2 ] || error "The '$1' option requires an argument."
image=$2 image=$2
shift 2 shift 2
;; ;;
-o | -out) -o | -out)
[ "$#" -ge 2 ] || error "'$1' option requires an argument" [ "$#" -ge 2 ] || error "The '$1' option requires an argument."
video=$2 video=$2
shift 2 shift 2
;; ;;
-s | -start) -s | -start)
[ "$#" -ge 2 ] || error "'$1' option requires an argument" [ "$#" -ge 2 ] || error "The '$1' option requires an argument."
start=$2 start=$2
echo "Selected start frame, requires ffmpeg..." echo "Selected start frame, requires ffmpeg..."
[ "$start" -eq "$start" ] 2> /dev/null || \ isInteger "$start" || \
error "'$1' option requires an integer argument" error "The '$1' option requires an integer argument."
shift 2 shift 2
;; ;;
-w | -webm) -w | -webm)
[ "$app" = "mencoder" ] && \
error "The '$1' option is invalid when using mencoder to create " \
"the video. Either do not use the option, or install ffmpeg."
fmt=webm fmt=webm
echo "Selected $fmt format, requires ffmpeg..." echo "Selected $fmt format, requires ffmpeg..."
shift shift
;; ;;
-*) -*)
error "invalid option '$1'" error "invalid option '$1'."
;; ;;
*) *)
break break
@ -119,38 +177,47 @@ do
done done
ffmpegCreateVideo () { ffmpegCreateVideo () {
_dir="$1" _image_list="$1"
_image="$2" _out="$2"
_fps="$3" _fmt="$3"
_out="$4"
_fmt="$5"
_start="$6"
_pwd="$(pwd)"
[ "$_start" ] && _start="-start_number $_start" _video_output="\
-c:v libx264 \
-b:v 5M \
-r:v 40 \
-vf format=yuv420p,pad=ceil(iw/2)*2:ceil(ih/2)*2 \
-flags +cgop \
-threads 2 \
-crf 18 \
-bf 2 \
-preset medium \
-profile:v baseline \
-shortest \
-movflags faststart"
cd "$_dir" || return 1 [ "$_fmt" = webm ] && \
_video_output="\
-vf format=yuv420p,pad=ceil(iw/2)*2:ceil(ih/2)*2"
#shellcheck disable=SC2086 #shellcheck disable=SC2086
ffmpeg \ ffmpeg \
-framerate "$_fps" \ -f concat \
$_start \ -safe 0 \
-i "$_image".%04d.png \ -i "$_image_list" \
-vf "format=yuv420p,pad=ceil(iw/2)*2:ceil(ih/2)*2" \ $_video_output \
"$_pwd/$_out.$_fmt" "$_out.$_fmt"
return 0 return 0
} }
mencoderCreateVideo () { mencoderCreateVideo () {
_dir="$1" _image_list="$1"
_image="$2" _fps="$2"
_fps="$3" _out="$3"
_out="$4" _fmt="$4"
_fmt="$5"
mencoder \ mencoder \
"mf://$_dir/$_image.*.png" \ "mf://@$image_list" \
-mf fps="$_fps" \ -mf fps="$_fps" \
-o "$_out.$_fmt" \ -o "$_out.$_fmt" \
-ovc x264 -ovc x264
@ -158,21 +225,42 @@ mencoderCreateVideo () {
return 0 return 0
} }
isInstalled () {
command -v "$1" >/dev/null 2>&1
}
# #
# MAIN # MAIN
# #
[ -f "$(find "$dir" -name "$image.*.png" | sort | head -1)" ] || \ images="$(find "$dir" -maxdepth 1 -name "$image.*.png" -type f -print0 | \
error "Cannot find first file in image sequence" xargs -0 realpath | sort | xargs -n 1)"
first_image="$(echo "$images" | sed "$start!d")"
last_image="$(echo "$images" | tail -1)"
! [ "$fmt" = "webm" ] && ! [ "$start" ] && isInstalled mencoder && \ [ -f "$first_image" ] || error "Cannot find first file in image sequence."
mencoderCreateVideo "$dir" "$image" "$fps" "$video" "$fmt" && \
exit 0
isInstalled ffmpeg && \ delay="$(awk -v f="$fps" 'BEGIN {print 1/f}')"
ffmpegCreateVideo "$dir" "$image" "$fps" "$video" "$fmt" "$start" || \ write=""
echo "ffmpeg not installed."
echo "$images" | while read -r line
do
[ "$line" = "$first_image" ] && write=on
[ "$write" = on ] || continue
[ "$app" = mencoder ] && echo "$line" >> "$image_list" && continue
# ffmpeg settings
echo "file $line" >> "$image_list"
[ "$line" = "$first_image" ] && \
[ "$begin_pause" ] && \
echo "duration $begin_pause" >> "$image_list" && continue
[ "$line" = "$last_image" ] && \
[ "$end_pause" ] && \
echo "duration $end_pause" >> "$image_list" && \
echo "file $line" >> "$image_list" && continue
echo "duration $delay" >> "$image_list"
done
[ "$app" = ffmpeg ] && \
ffmpegCreateVideo "$image_list" "$video" "$fmt" && exit 0
mencoderCreateVideo "$image_list" "$fps" "$video" "$fmt"