|
1 | | -# ld-decode |
| 1 | +# What is ld-decode? |
2 | 2 |
|
| 3 | +**ld-decode** is a software-defined decoder for LaserDisc RF captures made using modified LaserDisc players and capture devices such as the DomesdayDuplicator |
3 | 4 |
|
4 | | -This is the GitHub repo for ld-decode. This is the (hopefully stable) merged development branch. |
| 5 | +ld-decode recovers video, analog audio, digital audio and metadata content from raw RF samples captured directly from LaserDisc players, bypassing the analog signal chain to achieve preservation-quality digital transfers. |
5 | 6 |
|
| 7 | +Although ld-decode was originally dedicated to LaserDiscs it has become part of a larger ecosystem including **vhs-decode** (for videotape formats), **cvbs-decode** (for composite video), and **hifi-decode** (for audio processing), amongst others. All sharing common tools and techniques by being active forks of this repository. |
6 | 8 |
|
7 | | -# Installation & Downloads |
| 9 | +ld-decode is a GPL3 open-source project run entirely by volunteers and provided for free (as in freedom). |
8 | 10 |
|
| 11 | +--- |
9 | 12 |
|
10 | | -- [Linux](https://github.com/happycube/ld-decode/wiki/Installation) |
11 | | -- [Windows](https://github.com/oyvindln/vhs-decode/wiki/Windows-Build) |
12 | | -- [MacOS](https://github.com/oyvindln/vhs-decode/wiki/MacOS-Build) |
| 13 | +This is the GitHub repository for ld-decode - the (hopefully stable) merged development branch. |
13 | 14 |
|
14 | | -You will find self-contained binary bundled ready-to-use packages of current and future builds of the decoders and ld-x tools in the [vhs-decode repository](https://github.com/oyvindln/vhs-decode/wiki/), combining `ld-decode`, `vhs-decode`, `cvbs-decode` & `hifi-decode` into one package, alongside [tbc-video-export](https://github.com/JuniorIsAJitterbug/tbc-video-export/releases) a more fluid cross format export tool to make CVBS/S-Video type TBC files into video files. |
15 | 15 |
|
| 16 | +# Installation & Downloads |
16 | 17 |
|
17 | | -> [!NOTE] |
18 | | -> vhs-decode is not limited to VHS and supports many tape media formats! |
| 18 | +Note that the main repo is under constant development and, while we strive to keep it stable, it is a part of the active development cycle. Contributors maintain read-made binary builds which are far more suitable for end-users and are available for platforms such as Windows and Apple MacOS. The main repo targets only Ubuntu (generally the current LTS version). |
19 | 19 |
|
20 | | -> [!IMPORTANT] |
21 | | -> The decoders and tools are CLI - Commandline Interface, only ld-analyse & hifi-decode have a GUI - Graphical User Interface. |
| 20 | +If you'd like to download binaries or compile the project from source please see the project's wiki for detailed instructions. |
22 | 21 |
|
23 | 22 |
|
24 | 23 | # Documentation |
25 | 24 |
|
| 25 | +> [!Important] |
| 26 | +> If in doubt read the wiki! |
26 | 27 |
|
27 | | -Documentation is available via the GitHub wiki's. This includes installation and usage instructions. |
28 | | - |
29 | | -Start with the wiki if you have any questions. |
| 28 | +You can find the wiki here: [ld-decode Wiki](https://github.com/happycube/ld-decode/wiki) |
30 | 29 |
|
31 | | -If you only care about Laserdiscs please read |
32 | 30 |
|
33 | | -- [LD-Decode Wiki](https://github.com/happycube/ld-decode/wiki) |
| 31 | +# The decoding tool-chain |
34 | 32 |
|
35 | | -If you want to learn about FM RF archival overall and other media formats such as tape or RAW Composite/CVBS decoding then please read: |
36 | | - |
37 | | -- [VHS-Decode Wiki](https://github.com/oyvindln/vhs-decode/wiki/) |
38 | | - |
39 | | - |
40 | | -The wiki also includes details of the decode community's Discord / IRC Bridge and the now legacy Facebook group. |
| 33 | +> [!IMPORTANT] |
| 34 | +> The decoders and tools are primarily command line based, only the ld-analyse tool provides a GUI (Graphical User Interface) |
41 | 35 |
|
42 | | -If you intend on contributing or have general questions please join the [Discord server](https://discord.gg/pVVrrxd) which has the entire family of decode projects developers on it (or IRC if you must) as the Facebook group is mostly inactive there is also the [r/vhs-decode](https://new.reddit.com/r/vhsdecode/) subreddit that is fairly active. |
| 36 | +# Want to get involved? |
43 | 37 |
|
| 38 | +The wiki includes details of the ld-decode community's Discord / IRC Bridge and the now legacy Facebook group. |
44 | 39 |
|
45 | | -## *If in doubt - Read the Wiki!* |
| 40 | +If you are interested in contributing or have general questions please join the [Discord server](https://discord.gg/pVVrrxd) which has the entire family of decode projects developers on it (or IRC if you must) as the Facebook group is mostly inactive. |
46 | 41 |
|
| 42 | +There is a VHS specific subreddit [r/vhs-decode](https://new.reddit.com/r/vhsdecode/) that is fairly active. |
47 | 43 |
|
48 | | -# Source code locations |
49 | 44 |
|
| 45 | +# Source code structure |
50 | 46 |
|
51 | | -The source is split roughly into three parts: |
| 47 | +The source is split roughly into three sections: |
52 | 48 |
|
53 | | -- ld-decode - The main Python application responsible for decoding lds/ldf LaserDisc RF samples into tbc files (time-base corrected framed video) |
54 | | -- ld-decode-tools (under the tools/ directory) - The tool-chain for processing tbc files in various ways |
55 | | -- scripts (under the scripts/ directory) - Various scripts to assist with dev and decoding |
| 49 | +- ld-decode - The main Python application responsible for decoding lds/ldf LaserDisc RF samples into tbc files (time-base corrected framed video) and generating the initial metadata |
| 50 | +- ld-decode-tools (under the tools/ directory) - The Qt based tool-chain for processing tbc files and associated metadata in various ways |
| 51 | +- scripts (under the scripts/ directory) - Various scripts to assist with development and decoding |
0 commit comments