241 lines
7.2 KiB
Bash
Executable File
241 lines
7.2 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
# default values for arguments
|
|
ssh_host="root@10.11.99.1" # remarkable connected through USB
|
|
landscape=true # rotate 90 degrees to the right
|
|
output_path=- # display output through ffplay
|
|
format=- # automatic output format
|
|
webcam=false # not to a webcam
|
|
measure_throughput=false # measure how fast data is being transferred
|
|
window_title=reStream # stream window title is reStream
|
|
|
|
# loop through arguments and process them
|
|
while [ $# -gt 0 ]; do
|
|
case "$1" in
|
|
-p | --portrait)
|
|
landscape=false
|
|
shift
|
|
;;
|
|
-s | --source)
|
|
ssh_host="$2"
|
|
shift
|
|
shift
|
|
;;
|
|
-o | --output)
|
|
output_path="$2"
|
|
shift
|
|
shift
|
|
;;
|
|
-f | --format)
|
|
format="$2"
|
|
shift
|
|
shift
|
|
;;
|
|
-m | --measure)
|
|
measure_throughput=true
|
|
shift
|
|
;;
|
|
-w | --webcam)
|
|
webcam=true
|
|
format="v4l2"
|
|
|
|
# check if there is a modprobed v4l2 loopback device
|
|
# use the first cam as default if there is no output_path already
|
|
cam_path=$(v4l2-ctl --list-devices \
|
|
| sed -n '/^[^\s]\+platform:v4l2loopback/{n;s/\s*//g;p;q}')
|
|
|
|
# fail if there is no such device
|
|
if [ -e "$cam_path" ]; then
|
|
if [ "$output_path" = "-" ]; then
|
|
output_path="$cam_path"
|
|
fi
|
|
else
|
|
echo "Could not find a video loopback device, did you"
|
|
echo "sudo modprobe v4l2loopback"
|
|
exit 1
|
|
fi
|
|
shift
|
|
;;
|
|
-t | --title)
|
|
window_title="$2"
|
|
shift
|
|
shift
|
|
;;
|
|
-h | --help | *)
|
|
echo "Usage: $0 [-p] [-s <source>] [-o <output>] [-f <format>] [-t <title>]"
|
|
echo "Examples:"
|
|
echo " $0 # live view in landscape"
|
|
echo " $0 -p # live view in portrait"
|
|
echo " $0 -s 192.168.0.10 # connect to different IP"
|
|
echo " $0 -o remarkable.mp4 # record to a file"
|
|
echo " $0 -o udp://dest:1234 -f mpegts # record to a stream"
|
|
echo " $0 -w # write to a webcam (yuv420p + resize)"
|
|
exit 1
|
|
;;
|
|
esac
|
|
done
|
|
|
|
ssh_cmd() {
|
|
ssh -o ConnectTimeout=1 "$ssh_host" "$@"
|
|
}
|
|
|
|
# check if we are able to reach the remarkable
|
|
if ! ssh_cmd true; then
|
|
echo "$ssh_host unreachable"
|
|
exit 1
|
|
fi
|
|
|
|
rm_version="$(ssh_cmd cat /sys/devices/soc0/machine)"
|
|
|
|
# We cannot read the framebuffer directory in the reMarkable 2, but we know the
|
|
# address of the pointer to the framebuffer for some reMarkable 2 versions.
|
|
# This will need to be changed each time xochitl updates.
|
|
rm2_getpointer() {
|
|
xochitl_version="$(ssh_cmd "sed -n 's/^REMARKABLE_RELEASE_VERSION=//p' /usr/share/remarkable/update.conf")"
|
|
case "$xochitl_version" in
|
|
"2.3.*")
|
|
echo "4121024"
|
|
;;
|
|
"2.4.*")
|
|
# TODO
|
|
echo "???"
|
|
;;
|
|
*) # use last known version if we cannot find a match
|
|
echo "WARNING: unknown reMarkable 2 release version" >&2
|
|
echo "consider updating if reStream doesn't work" >&2
|
|
echo "???"
|
|
;;
|
|
esac
|
|
}
|
|
|
|
case "$rm_version" in
|
|
"reMarkable 1.0")
|
|
width=1408
|
|
height=1872
|
|
bytes_per_pixel=2
|
|
pixel_format="rgb565le"
|
|
# calculate how much bytes the window is
|
|
window_bytes="$((width * height * bytes_per_pixel))"
|
|
# read the first $window_bytes of the framebuffer
|
|
head_fb0="dd if=/dev/fb0 count=1 bs=$window_bytes 2>/dev/null"
|
|
;;
|
|
"reMarkable 2.0")
|
|
width=1404
|
|
height=1872
|
|
bytes_per_pixel=1
|
|
pixel_format="gray8"
|
|
pid="$(ssh_cmd pidof xochitl)"
|
|
pointer="$(rm2_getpointer)"
|
|
read_address="addr=\$(dd if=/proc/$pid/mem bs=1 count=4 skip=$pointer 2>/dev/null | hexdump | awk '{print \$3\$2\}') && printf '%d' \$((16#\$addr))"
|
|
skipbytes="$(ssh_cmd "$read_address")"
|
|
# calculate how much bytes the window is
|
|
window_bytes="$((width * height * bytes_per_pixel))"
|
|
# carve the framebuffer out of the process memory
|
|
head_fb0="dd if=/proc/$pid/mem bs=1 count=$window_bytes skip=$skipbytes 2>/dev/null"
|
|
;;
|
|
*)
|
|
echo "Unsupported reMarkable version: $rm_version."
|
|
echo "Please visit https://github.com/rien/reStream/ for updates."
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
# technical parameters
|
|
loop_wait="true"
|
|
loglevel="info"
|
|
|
|
fallback_to_gzip() {
|
|
echo "Falling back to gzip, your experience may not be optimal."
|
|
echo "Go to https://github.com/rien/reStream/#sub-second-latency for a better experience."
|
|
compress="gzip"
|
|
decompress="gzip -d"
|
|
sleep 2
|
|
}
|
|
|
|
# check if lz4 is present on remarkable
|
|
if ssh_cmd "[ -f /opt/bin/lz4 ]"; then
|
|
compress="/opt/bin/lz4"
|
|
elif ssh_cmd "[ -f ~/lz4 ]"; then
|
|
compress="\$HOME/lz4"
|
|
fi
|
|
|
|
# gracefully degrade to gzip if is not present on remarkable or host
|
|
if [ -z "$compress" ]; then
|
|
echo "Your remarkable does not have lz4."
|
|
fallback_to_gzip
|
|
elif ! lz4 -V >/dev/null; then
|
|
echo "Your host does not have lz4."
|
|
fallback_to_gzip
|
|
else
|
|
decompress="lz4 -d"
|
|
fi
|
|
|
|
# use pv to measure throughput if desired, else we just pipe through cat
|
|
if $measure_throughput; then
|
|
if ! pv --version >/dev/null; then
|
|
echo "You need to install pv to measure data throughput."
|
|
exit 1
|
|
else
|
|
loglevel="error" # verbose ffmpeg output interferes with pv
|
|
host_passthrough="pv"
|
|
fi
|
|
else
|
|
host_passthrough="cat"
|
|
fi
|
|
|
|
# list of ffmpeg filters to apply
|
|
video_filters=""
|
|
|
|
# store extra ffmpeg arguments in $@
|
|
set --
|
|
|
|
# rotate 90 degrees if landscape=true
|
|
$landscape && video_filters="$video_filters,transpose=1"
|
|
|
|
# Scale and add padding if we are targeting a webcam because a lot of services
|
|
# expect a size of exactly 1280x720 (tested in Firefox, MS Teams, and Skype for
|
|
# for business). Send a PR is you can get a heigher resolution working.
|
|
if $webcam; then
|
|
video_filters="$video_filters,format=pix_fmts=yuv420p"
|
|
video_filters="$video_filters,scale=-1:720"
|
|
video_filters="$video_filters,pad=1280:0:-1:0:#eeeeee"
|
|
fi
|
|
|
|
# set each frame presentation time to the time it is received
|
|
video_filters="$video_filters,setpts=(RTCTIME - RTCSTART) / (TB * 1000000)"
|
|
|
|
# loop that keeps on reading and compressing, to be executed remotely
|
|
read_loop="while $head_fb0; do $loop_wait; done | $compress"
|
|
|
|
set -- "$@" -vf "${video_filters#,}"
|
|
|
|
if [ "$output_path" = - ]; then
|
|
output_cmd=ffplay
|
|
|
|
window_title_option="-window_title $window_title"
|
|
else
|
|
output_cmd=ffmpeg
|
|
|
|
if [ "$format" != - ]; then
|
|
set -- "$@" -f "$format"
|
|
fi
|
|
|
|
set -- "$@" "$output_path"
|
|
fi
|
|
|
|
set -e # stop if an error occurs
|
|
|
|
# shellcheck disable=SC2086
|
|
ssh_cmd "$read_loop" \
|
|
| $decompress \
|
|
| $host_passthrough \
|
|
| "$output_cmd" \
|
|
-vcodec rawvideo \
|
|
-loglevel "$loglevel" \
|
|
-f rawvideo \
|
|
-pixel_format "$pixel_format" \
|
|
-video_size "$width,$height" \
|
|
$window_title_option \
|
|
-i - \
|
|
"$@"
|