https://github.com/donteatoreo/dis
dis is a simple and fast tool to compress videos for Discord and other platforms.
https://github.com/donteatoreo/dis
agplv3 cli command-line-tool compression csharp discord dotnet dotnet-core dotnet6 dotnetcore ffmpeg open-source video-compression youtube-dl yt-dlp
Last synced: about 1 year ago
JSON representation
dis is a simple and fast tool to compress videos for Discord and other platforms.
- Host: GitHub
- URL: https://github.com/donteatoreo/dis
- Owner: DontEatOreo
- License: agpl-3.0
- Created: 2022-10-12T23:13:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-07T21:25:48.000Z (over 1 year ago)
- Last Synced: 2025-01-29T04:09:09.464Z (over 1 year ago)
- Topics: agplv3, cli, command-line-tool, compression, csharp, discord, dotnet, dotnet-core, dotnet6, dotnetcore, ffmpeg, open-source, video-compression, youtube-dl, yt-dlp
- Language: C#
- Homepage:
- Size: 460 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# dis 🎥
[](https://github.com/DontEatOreo/dis/blob/master/LICENSE)
[](https://github.com/DontEatOreo/dis/releases)
[](https://github.com/DontEatOreo/dis/issues)
**dis** 🎥 is a simple CLI tool to compress videos for platforms like Discord
and likewise. It uses [YT-DLP](https://github.com/yt-dlp/yt-dlp) to download
videos from all sites that `yt-dlp` supports, such as YouTube, Twitter, Reddit,
and more, and [FFmpeg](https://ffmpeg.org/download.html) for compression. It
comes with a rich and easy to use TUI mode for trimming videos
## Nix Dev Environment
**dis** 🎥 comes with a `nix develop` environment that carries all the
dependencies (dotnet, ffmpeg, and yt-dlp), allowing you to work on the project
without having to manually install them. To activate this environment, all you
need to do is:
1. Have `nix` installed
2. Have `flakes` and `nix-command` experimental features enabled
3. Be in the same directory
4. Run `nix develop --impure`
## Building
### .NET
All you need to do is run `dotnet build`, then a `bin/` folder will be created
that will contain all the build artifacts
### Building a Single File Executable
You can build a single file executable which you can run without having dotnet
preinstalled and that you can place anywhere. To do that all you need to do is:
1. `dotnet publish dis.csproj -p:PublishSingleFile=true
-p:IncludeNativeLibrariesForSelfExtract=true --self-contained
true --configuration Release --runtime `
([KnowRIDs](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids))
2. Then you can find the executable at `bin/Release/net8.0//`
### Nix
### Simply run `nix build .#default`
Alternatively you can also invoke a `nix shell github:DontEatOreo/dis` with the
required packages to build **dis** 🎥
### Updating dependencies on Nix
1. Run `nix run nixpkgs#dotnet-sdk -- restore --packages out`
2. Run the script `nix-shell -p dotnet-sdk nuget-to-nix --run "nuget-to-nix out > deps.nix"`
3. Run formatter `nix run nixpkgs#nixfmt-rfc-style -- deps.nix`
## Installation
To install **dis** 🎥, you need to have
[FFmpeg](https://ffmpeg.org/download.html) and
[YT-DLP](https://github.com/yt-dlp/yt-dlp) installed on your system. You can
download them from their official websites or use your package manager of
choice.
You can then download the latest release of **dis** 🎥 from
the [Releases](https://github.com/DontEatOreo/dis/releases)
tab on GitHub. Alternatively, you can clone this
repository and build the project yourself using [dotnet
publish](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish)
### If you're using Nix
### Using `nix profile`
```bash
nix profile install github:DontEatOreo/dis
```
### Using flakes
You will need to add **dis** 🎥 to your inputs and pass it down your outputs
```nix
{
# ...
inputs = {
# ...
dis.url = "github:DontEatOreo/dis";
dis.inputs.nixpkgs.follows = "nixpkgs";
# ...
};
outputs = {
# ...
dis,
# ...
}
}
```
After that in whichever `.nix` file is responsible for your packages you will
need to add **dis** 🎥
Example:
```nix
{ pkgs, dis, ... }: {
environment = {
# ...
systemPackages = builtins.attrValues {
# ...
dis = dis.packages.${pkgs.system}.default;
# ...
};
};
}
```
## Usage
To use **dis** 🎥, you need to provide an input video source using the `-i`
(`--input`) option. The input source can be either a local file or an online URL
(e.g., Discord Server, YouTube, Twitter, Reddit, etc...).
You can also specify various options to customize the output video, such as:
| Option | Description | Default Value |
|-------------------------------------|-------------------------------------------------------------------------------------------------------|---------------|
| `-i`, `--input` `` | Input video source | None |
| `-o`, `--output` `` | Output directory for the compressed video | Current Path |
| `-c`, `--crf` `` | Constant Rate Factor (CRF) Higher values mean lower quality, Lower values mean higher quality | `25` |
| `-r`, `--resolution` `` | Output video resolution | None |
| `-t`, `--trim` | Enable video trimming | `false` |
| `--video-codec` `` | Output video codec | None |
| `--audio-bitrate` `` | Output audio bitrate (in kbit/s) (only divisible by 2) | `128k` |
| `--multi-thread` | Use all available threads (for faster compression) | true |
| `--random` | Randomize the output filename | `false` |
| `--sponsor` | Remove the sponsor segments from the output video using [SponsorBlock](https://sponsor.ajay.app/) API | `False` |
The CRF is a video compression method that grants users control over the output
video quality, with higher values resulting in lower quality and vice versa. It
is recommended to avoid values below 22 or above 38.
## Here are some examples of how to use **dis** 🎥
### Compressing a video from a website
### Compressing a local file while adjusting its resolution to `480p` and saving it to a designated directory
### Compressing a video from YouTube and change the video codec to `h265`, resolution to `720p`, and audio bitrate to `128`, with a custom CRF value
### Compressing a video from YouTube and trimming from 10 seconds to 20 seconds
## Contributing
If you want to contribute to **dis** 🎥, you are welcome to do so. You can
report issues, request features, or submit pull requests on GitHub.
## License
**dis** is licensed under the
[AGPLv3](https://github.com/DontEatOreo/dis/blob/master/LICENSE).