53 Commits

Author SHA1 Message Date
85f4104796 Also add a shell.nix 2021-11-04 16:58:13 +01:00
58a28c2715 Add Nix flake with devShell 2021-11-04 16:32:33 +01:00
1cc004ed52 Add links to charities in README 2021-08-20 15:59:56 +02:00
9427d184b8 Update README 2021-08-20 15:46:49 +02:00
236c3732f1 Suggest ecdsa or rsa key 2021-06-30 10:59:38 +02:00
13cdc47cd0 typto 2021-06-30 10:59:38 +02:00
a342187aea update fallback from ed25519 to ecdsa 2021-06-30 10:59:38 +02:00
4d1eb7924a README#Development: group in bullet points 2021-06-30 10:59:37 +02:00
0b919c7764 Add instructions to the README on how to build the restream binary using docker 2021-06-30 10:59:37 +02:00
1585869272 Moved the note about crypto policy changes to Troubleshooting section and changed it to be more generalized 2021-06-30 10:59:37 +02:00
55d3b2e80e Added more details around the Fedora 33+ change 2021-06-30 10:59:36 +02:00
7fe3e4e8da Add Fedora 33 specific instructions as a result of crypto policy changes 2021-06-30 10:59:35 +02:00
f1efbf6d22 Unsecure connection supports also ssh_config aliases. 2021-06-30 10:59:09 +02:00
edabacfb55 hflip: eventually restore the correct orientation of web cam 2021-06-30 10:59:09 +02:00
d85938b441 README.md: Internal broken link 2021-06-30 10:59:08 +02:00
57dcd7ca27 Fix links 2021-01-29 18:04:09 +01:00
49396e2811 Change order of Installation/reMarkable 2021-01-29 16:21:24 +01:00
AF
a5cf399e34 Apply suggestions from code review
Co-authored-by: Rien <rien.maertens@posteo.be>
2021-01-29 16:21:24 +01:00
66ab63cea2 Install reStream, downloading the latest release and not cloning this repo 2021-01-29 16:21:24 +01:00
cf04ee83c6 Updated README.md with missing documentation about unsecure-connection 2021-01-29 12:44:47 +01:00
8bc19b5b69 restream is now in stable 2021-01-28 23:30:32 +01:00
a459714694 Merge branch 'main' into support-rm2fb 2021-01-22 14:57:26 -05:00
e4080ede2a Windows installation instructions 2021-01-08 11:23:00 +01:00
632e1b391b Update README.md to reflect toltec install method 2021-01-05 15:12:14 -05:00
3187c03e88 Disable password auth, mention rM2 ed25519 issue
Fixes #38
2021-01-05 20:09:41 +01:00
a0248760bd Edit reStream.sh and README 2021-01-01 14:51:46 +01:00
7eb0143866 Change rM2 supported badge 🎉 2021-01-01 14:50:42 +01:00
eebf5e9880 Fix options in README 2020-12-31 15:44:04 +01:00
8ef4a6993b add description of option to README 2020-11-20 12:34:16 +01:00
db572cfcad rm2 unsupported badge
cf issue created earlier today
2020-10-16 23:53:22 +02:00
a1b14bdf41 Measure troughput with -t 2020-05-06 14:43:23 +02:00
9e9fbbc771 Add explaination about v4l2 2020-04-14 11:54:01 +02:00
e687816421 Add video4linux2 support 2020-04-14 10:59:49 +02:00
088d3732c4 Add examples to usage info 2020-04-07 11:48:46 +02:00
0c707af239 Merge branch 'master' into specify-output 2020-04-07 10:55:20 +02:00
52d0187d7e Don't use ~ in commands 2020-04-06 23:19:54 +02:00
49f20074f0 Allow choosing the video output
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).
2020-04-02 20:54:11 +02:00
382944058e Add parameters to README, ssh timeout to 1s
Changed the README to reflect the command line options added with
bcf62e3. Also incorporates the SSH timeout of 1 second added by the
initial PR (#10).

Co-authored-by: Aaron David Schneider <aaron.david.schneider@gmail.com>
2020-04-02 14:20:48 +02:00
2cc3f88274 Add -p flag functionality to README 2020-03-31 15:32:20 +02:00
e5edbed205 Simple troubleshooting stuff 2020-03-30 21:35:15 +02:00
1c917c1d14 Clarify SSH key setup 2020-03-30 21:33:44 +02:00
f3f5dd40fa SSH key and ssh-agent instructions 2020-03-30 14:54:16 +02:00
53051fbdf5 Add instructions to make lz4 executable 2020-03-25 16:33:22 +01:00
51d608cbd5 Update README with change to lz4 2020-03-18 00:19:28 +01:00
9f6ba5dd1d Use lz4 instead of zstd, add prebuilt static library 2020-03-17 23:44:55 +01:00
c9af230f3a Update README.md
Add instructions to fix zstd
2020-03-12 11:25:47 +01:00
726d0842f8 Update README
- add installation instructions
- remove mention of script copying zstd
2020-03-12 08:43:17 +01:00
d0c5ffe9e1 Search for zstd in home directory
This is possibly a solution for #2.
2020-03-12 08:29:19 +01:00
b2b37607f1 Add demo 2020-03-12 00:29:18 +01:00
eb034a63bd Better documentation 2020-03-12 00:17:13 +01:00