1# glancecast
2
3glancecast is a script that converts a video file into an MP3 with chapters that have sampled video frames as cover art.
4
5This allows you to listen to a video in an audio-only podcast player, but glance at the screen if you need some visual context.
6
7## Installation
8
9Clone the Git repository, create a Python virtualenv, and install dependencies:
10
11```console
12$ git clone git://alexwlchan.net/projects/glancecast.git
13$ cd glancecast
14$ python3 -m venv .venv
15$ source .venv/bin/activate
16$ pip install -e .
17```
18
19You also need [FFmpeg](https://ffmpeg.org) installed, which is not included with the pip installer.
20
21## Usage
22
23Run the `glancecast.py` script, passing your video file as a single argument.
24It prints the path to the MP3 file:
25
26```console
27$ python3 glancecast.py tests/fixtures/lego_age_picker.mp4
28tests/fixtures/lego_age_picker.mp3
29```
30
31There are three optional flags:
32
33*   `--interval=INTERVAL_SEC` sets the time interval between captured frames in seconds.
34*   `--max-dimension=MAX_DIMENSION` sets the maximum width/height in pixels for captured frames.
35*   `--out-dir=OUT_DIR` sets the output directory where the MP3 file will be saved.
36
37You can see these options by running `python3 glancecast.py --help`.
38
39## Versioning and stability
40
41This library is monotonically versioned (releases simply go up sequentially).
42
43## License
44
45This project is shared under the [MIT license](./LICENSE).