49f20074f0
Instead of simply playing back the frames through `ffplay`, I thought it might be interesting to be able to record the sequence to a video file or to use it as part of a stream. I have in mind the use case of making educational videos/live streams where the tablet can be used as a kind of remote blackboard by teachers, which is especially relevant currently. But there are certainly other use cases! Changes ======= This commit adds two new options to that effect: * `-o --output`: Path of the output as understood by `ffmpeg` (usually a file name). If this is `-` (as it is by default), the existing behavior of playing the stream through `ffplay` is restored. * `-f --format`: When recording to an output, this option can be used to force the encoding format. If this is `-` (again, the default), `ffmpeg`’s auto format detection is used (based on the file extension). Because of the possible confusion between the newly added `--output` option and the existing `--destination` option for specifying the source address, I suggest renaming the `--destination` option to `--source` (this is implemented in this commit). Examples ======== Record to a file ---------------- ```sh ./reStream.sh -o remarkable.mp4 ``` Caveat: The recorded file plays back too fast. I am not sure how to fix this. Create an UDP MPEG-TS stream ---------------------------- ```sh ./reStream.sh -o "udp://127.0.0.1:1234" -f "mpegts" ``` This sends frames over UDP to the specified port using the MPEG-TS format (see <https://trac.ffmpeg.org/wiki/StreamingGuide>). This stream can then be connected, for example, to OBS for live streaming (see <https://connect.ed-diamond.com/Linux-Pratique/LP-096/Enrichir-sa-diffusion-de-contenus-multimedias-avec-OBS> in French).
reStream
reMarkable screen sharing over SSH.
Installation
- Clone this repository:
git clone https://github.com/rien/reStream. - (Optional but recommended) Install lz4 on your host and reMarkable.
- Set up an SSH key and add it to the ssh-agent, then add your key to the reMarkable with
ssh-copy-id root@10.11.99.1.
Usage
- Connect your reMarkable with the USB cable.
- Make sure you can open an SSH connection.
- Run
./reStream.sh - A screen will pop-up on your local machine, with a live view of your reMarkable!
Options
-p --portrait: shows the reMarkable screen in portrait mode (the default is landscape mode, 90 degrees rotated tot the right)-s --source: the ssh destination of the reMarkable (default:root@10.11.99.1)-o --output: path of the output where the video should be recorded, as understood byffmpeg; if this is-, the video is displayed in a new window and not recorded anywhere (default:-)-f --format: when recording to an output, this option is used to force the encoding format; if this is-,ffmpeg’s auto format detection based on the file extension is used (default:-).
If you have problems, don't hesitate to open an issue or send me an email.
Requirements
On your host machine:
- Any POSIX-shell (e.g. bash)
- ffmpeg (with ffplay)
- ssh
On your reMarkable nothing is needed, unless you want...
Sub-second latency
To achieve sub-second latency, you'll need lz4 on your host and on your reMarkable.
You can install lz4 on your host with your usual package manager. On Ubuntu,
apt install liblz4-tool will do the trick.
On your reMarkable you'll need a binary of lz4 build for the arm platform,
you can do this yourself by installing the reMarkable toolchain
and compiling lz4 from source with the toolchain enabled, or you can use the
statically linked binary I have already built and put in this repo.
Copy the lz4 program to your reMarkable with
scp lz4.arm.static root@10.11.99.1:~/lz4, make it executable with
ssh root@10.11.99.1 'chmod +x ~/lz4' and you're ready to go.
Troubleshooting
Steps you can try if the script isn't working:
- Set up an SSH key
- Update
ffmpegto version 4.