Skip to content

Commit 8d9e415

Browse files
authored
Merge pull request #980 from simoninns/readmefix-202512
Update to ld-decode readme to make it focused on ld-decode again
2 parents 0d422bf + bf70314 commit 8d9e415

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,53 @@
1-
# ld-decode
1+
# What is ld-decode?
22

3+
**ld-decode** is a software-defined decoder for LaserDisc RF captures made using modified LaserDisc players and capture devices such as the [DomesdayDuplicator](https://github.com/simoninns/DomesdayDuplicator)
34

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.
56

7+
Although ld-decode was originally dedicated to LaserDiscs it has become part of a larger ecosystem including:
68

7-
# Installation & Downloads
9+
- **[vhs-decode](https://github.com/oyvindln/vhs-decode)** (for videotape formats)
10+
- **[cvbs-decode](https://github.com/oyvindln/cvbs-decode)** (for composite video)
11+
- **[hifi-decode](https://github.com/oyvindln/hifi-decode)** (for audio processing)
812

13+
All sub-projects share common tools and techniques by being active forks of this repository.
914

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)
15+
ld-decode is a GPL3 open-source project run entirely by volunteers and provided for free (as in freedom).
1316

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.
1517

18+
# Installation & Downloads
1619

17-
> [!NOTE]
18-
> vhs-decode is not limited to VHS and supports many tape media formats!
20+
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).
1921

20-
> [!IMPORTANT]
21-
> The decoders and tools are CLI - Commandline Interface, only ld-analyse & hifi-decode have a GUI - Graphical User Interface.
22+
If you'd like to download binaries or compile the project from source please see the project's wiki for detailed instructions.
2223

2324

2425
# Documentation
2526

27+
> [!Important]
28+
> If in doubt read the wiki!
2629
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.
30+
You can find the wiki here: [ld-decode Wiki](https://github.com/happycube/ld-decode/wiki)
3031

31-
If you only care about Laserdiscs please read
3232

33-
- [LD-Decode Wiki](https://github.com/happycube/ld-decode/wiki)
33+
# The decoding tool-chain
3434

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.
35+
> [!IMPORTANT]
36+
> The decoders and tools are primarily command line based, only the ld-analyse tool provides a GUI (Graphical User Interface)
4137
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.
38+
# Want to get involved?
4339

40+
The wiki includes details of the ld-decode community's Discord / IRC Bridge and the now legacy Facebook group.
4441

45-
## *If in doubt - Read the Wiki!*
42+
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.
4643

44+
There is also a VHS specific subreddit [r/vhs-decode](https://new.reddit.com/r/vhsdecode/) that is fairly active.
4745

48-
# Source code locations
4946

47+
# Source code structure
5048

51-
The source is split roughly into three parts:
49+
The source is split roughly into three sections:
5250

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
51+
- 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
52+
- ld-decode-tools (under the tools/ directory) - The Qt based tool-chain for processing tbc files and associated metadata in various ways
53+
- scripts (under the scripts/ directory) - Various scripts to assist with development and decoding

0 commit comments

Comments
 (0)