summaryrefslogtreecommitdiff
path: root/README.md
blob: a17ac27c1d76b85c9508069097fb1bc472b6b063 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Aerial Screensaver for Linux (GNOME)

Idle screensaver that plays Apple Aerial–style clips with **mpv**, on **every connected monitor**. Quiet defaults: AC-only, lid-aware, VAAPI decode, low CPU niceness.

Works on AMD (Framework) and **Intel** laptops (e.g. **ThinkPad T480** / UHD 620).

> Player + tooling are MIT. Apple’s video assets stay Apple’s — install them with the helpers or the optional LocalSend video pack.

## Requirements

| Package | Why |
|---|---|
| GNOME (Wayland) | IdleMonitor + DisplayConfig |
| `python3` + PyGObject | Daemon |
| `mpv` | Playback |
| `ffmpeg` | Optional encode |
| `aria2c`, `curl`, `unzip` | Optional fetch / video zip |
| `systemd --user` | Autostart |

### Fedora / CachyOS (ThinkPad T480)

```bash
sudo dnf install mpv ffmpeg python3-gobject aria2 curl unzip \
  intel-media-driver libva libva-utils
```

### Debian / Ubuntu

```bash
sudo apt install mpv ffmpeg python3-gi aria2 curl unzip \
  intel-media-va-driver-non-free
```

Verify VAAPI: `vainfo` (should list Intel entrypoints).

## Install

```bash
unzip aerial-screensaver-linux.zip
cd aerial-screensaver-linux
./install.sh
```

### Get the videos (pick one)

**A. LocalSend video pack (best for T480)** — no multi-GB Apple download / long encode:

```bash
./install.sh --videos-zip ~/Downloads/aerial-videos-lite.zip
# or later:
install-aerial-videos --from-zip ~/Downloads/aerial-videos-lite.zip
```

**B. Download from Apple + encode on this machine** (slower on T480):

```bash
./install.sh --fetch-videos
# or later:
install-aerial-videos
```

**C. Your own files** — drop `.mp4` / `.mov` / `.mkv` in:

```text
~/Videos/Screensavers/Aerial
```

## What gets installed

| Path | Role |
|---|---|
| `~/.local/bin/aerial-screensaver` | Idle daemon |
| `~/.local/bin/install-aerial-videos` | Install / fetch clips |
| `~/.local/bin/fetch-aerial-recent` | Download Apple recent pack |
| `~/.local/bin/encode-aerial-lite` | 1080p24 lite encoder |
| `~/.config/systemd/user/aerial-screensaver.service` | Autostart |
| `~/.config/aerial-screensaver/config` | Settings |
| `~/Videos/Screensavers/Aerial` | Clip library |

## Config

`~/.config/aerial-screensaver/config`:

```ini
VIDEO_DIR=/home/YOU/Videos/Screensavers/Aerial
IDLE_TIMEOUT_SECONDS=300
REQUIRE_AC=1
VAAPI_DEVICE=/dev/dri/renderD128
```

On hybrid GPUs, leave `VAAPI_DEVICE` on the **iGPU** (Intel on T480, AMD display-class on Framework). `install.sh` auto-detects.

## Sharing (LocalSend)

Send **two** files:

| File | Size | Contents |
|---|---|---|
| `aerial-screensaver-linux.zip` | ~15KB | Code + installer |
| `aerial-videos-lite.zip` | ~1GB | 12 ready-to-play 1080p clips |

Recipient:

```bash
unzip aerial-screensaver-linux.zip && cd aerial-screensaver-linux
./install.sh --videos-zip ~/Downloads/aerial-videos-lite.zip
```

## Uninstall

```bash
./uninstall.sh
```

## Tests

```bash
python3 test_screensaver.py -v
```

## License

MIT for this software. Aerial footage remains Apple’s; we only provide download/install helpers and an optional private LocalSend pack of already-encoded lite clips.