Update youtube-dl readme
This commit is contained in:
parent
2420ea34a9
commit
647e78575c
GPG Key ID:
D3C7172E0A70F8CF
@ -118,182 +118,12 @@ youtube-dl-viewer supports playing the videos by clicking on them, there are mul
|
||||
This is mostly the same as **VLC protocol link (stream)** but it adds the local file path to your VLC playlist and not the video URL.
|
||||
This is preferable if youtube-dl-viewer is running on your machine, because then the VLC Player doesn't have to yo through web requests to get the file and can simply read it from your hard drive, but of course this only works if VLC can access the original video file path (eg if its not running on a server)
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
|
||||
#### - Multiple Paths
|
||||
|
||||
|
||||
You can supply multiple `--path="{path}"` arguments, the first one will be used by default and you can switch to a different path in the top left area of the website.
|
||||
|
||||
#### - Reload
|
||||
|
||||
Via the reload button in the top right you can force a re-scan of all the video and metadata on the filesystem, this is usually only done on application startup.
|
||||
|
||||
#### - Live transcode with ffmpeg
|
||||
|
||||
youtube-dl-viewer can use [ffmpeg](https://ffmpeg.org/) to transcode the video file to a webm file and stream it directly to the user.
|
||||
A working ffmpeg installation is required and needs to be accessible. Youtube-dl-viewer will simply call the ffmpeg command with the appropriate parameters.
|
||||
Simply select **Transcoded webm stream** in the top right corner as your playback mode to choose this.
|
||||
|
||||
If you do not have (and do not want) a ffmpeg installation you can start youtube-dl-viewer with the command `--no-ffmpeg` to disable all ffmpeg dependent functionality.
|
||||
You can tweak the ffmpeg parameters with the parameter `--webm-convert-params`, the default values are optimized for fast transcoding, if you want you can change that to a more quality-oriented approach.
|
||||
Depending on the video, the parameter and you machine ffmpeg may not be able to encode the video fast enough for a smooth playback.
|
||||
To fix this prolem (at least a bit) you can supply youtube-dl-viewer with a `--cache` path where past converted videos will be saved.
|
||||
The next time you want to play that specific video the cached files will be used.
|
||||
You can limit the maximum amount of parallel ffmpeg conversion jobs with the `--max-parallel-convert` parameter.
|
||||
|
||||
> **[!] Note**
|
||||
> If you already have your files in .webm format (or an appropriate .mp4) you can skip all this complexity and simply serve the files directly via the **Seekable raw file** playback mode.
|
||||
> And if you only use youtube-dl-viewer on a single computer you control it would also be easier (and yield better results) to install the VLC URL protocol and use that playback mode.
|
||||
|
||||
#### - Generated Thumbnails (ffmpeg)
|
||||
|
||||
By default youtube-dl-viewer uses the thumbnails that it finds with the video file (either referenced in the info.json file, or a image file with the same filename as the video).
|
||||
But if there isn't a suitable thumbnail it uses ffmpeg to generate one from the video file.
|
||||
This uses the same behavior as ffmpeg generated previews, we simply generate the preview images (see below) and use the second preview image as our thumbnail.
|
||||
For more information see the following section.
|
||||
|
||||
This can be deactivated (as all ffmpeg dependent functionality with the `--no-ffmpeg` parameter)
|
||||
|
||||
#### - Generated Previews (ffmpeg)
|
||||
|
||||
In `Grid` and `Detailed` mode you can hover over a video thumbnail and see an animation consisting of multiple frames from the video.
|
||||
These frames are extracted using ffmpeg at regular intervals. Because it can take a few seconds to get the images (depending on your machine and the video) it is recommended to specify a `--cache` directory where the preview files will be cached.
|
||||
|
||||
You can modify this behavior with the following program arguments:
|
||||
- `--preview-width`: The width of the generated image files (the height is automatically calculated)
|
||||
- `--max-parallel-genprev`: The maximum amount of parallel preview-generation jobs.
|
||||
- `--previewcount-min`: The minimum amount of preview frames per video file (can still be less if the video is too short)
|
||||
- `--previewcount-max`: The maximum amount of preview frames per video file
|
||||
- `--thumnail-ex-mode`: Choose one of the three ways to extract the frames:
|
||||
* `0`: **Sequential:** Call ffmpeg multiple times for each frame, one call after the other
|
||||
* `1`: **Parallel:** Call ffmpeg multiple times for each frame, all calls parallel (can lead to many simultaneous ffmpeg processes)
|
||||
* `2`: **SingleCommand:** Call ffmpeg oce with the appropriate filter arguments, leads to frames that are more precisely positioned (at the exact timestamps), but takes longer.
|
||||
|
||||
If the video does not have a provided thumbnail the second (!) preview frame is also used as an thumbnail
|
||||
|
||||
> **[!] Note**
|
||||
> If a cache directory is specified youtube-dl-viewer will try to generate previews for all videos in the background so that for all videos cached previews will exist.
|
||||
> To disable this use the `--no-auto-previews` option
|
||||
|
||||
This can be deactivated (as all ffmpeg dependent functionality with the `--no-ffmpeg` parameter)
|
||||
|
||||
#### - VLC Protocol links
|
||||
|
||||
The playback modes **VLC protocol link (stream)** and **VLC protocol link (local)** use "VLC URL protocol" links (`vlc://...`).
|
||||
This means they try to launch your locally installed VLC player with a specific URI (either a local file or a streamable link).
|
||||
Your client needs to support these links, the easiest way is to use the ready-made scripts from [stefansundin](https://github.com/stefansundin/vlc-protocol).
|
||||
|
||||
#### - Cache directory
|
||||
|
||||
As soon as you intend to do anything work intensive (ffmpeg live transcode, generated thumbnails, preview frames) it is **very** recommended to specify a cache directory to cache the results of these jobs.
|
||||
Files in the cache directory normally contain the sha256sum of video file path in their filename to identify them (under windows its the relative path to support removable media).
|
||||
You can at any time delete some or all files in the cache directory (e.g. only keep the newest x files) and the files will be re-created the next time they are needed.
|
||||
|
||||
#### - Thumbnail mode
|
||||
|
||||
In the top right corner you can choose the thumbnail loading mode (you can also specify the default as an program argument).
|
||||
|
||||
1. **Off**
|
||||
Do not load thumbnails (or preview frames)
|
||||
|
||||
2. **On (sequential)**
|
||||
Load all currently visible thumbnails one after the other
|
||||
|
||||
3. **On (parallel)**
|
||||
Load all currently visible thumbnails in parallel
|
||||
|
||||
4. **On (intelligent)**
|
||||
Load the currently visible thumbnails in parallel *and* pre-load non-visible thumbnails sequentially in the background
|
||||
|
||||
#### - Extended --path specifications
|
||||
|
||||
By specifying one (or more) `--path` arguments you can set the directori(es) where the program looks for video files.
|
||||
But instead of a simple directory-path you can also supply a json object in the `--path` argument for more fine-tuning, eg: `--path="{path:'/home/me/videos', name:'My Videos'}"`.
|
||||
|
||||
Every path json object *must* have a `path` property, and can have the following optional peroperties:
|
||||
- `name`: The display string, used eg in the top-left dropwdown menu. (default = use value of `path`)
|
||||
- `use_filename_as_title`: Use the filename as the video title instead of value in the info.json file (default = **false**)
|
||||
- `recursion`: The maximum recursion depth when searching for videos (default = 0, aka "do not recurse into subfolders")
|
||||
- `filter`: The filter for the files (default = "*", aka every file). Supported video extensions are filtered in a secondary step.
|
||||
|
||||
> **[!] Note**
|
||||
> Under windows (and linux if there are any) do not forget to escape your backslashes:
|
||||
> `--path="{path:'C:\\Users\\Me\\Videos', name:'My Videos'}`
|
||||
|
||||
|
||||
## Commandline manual
|
||||
|
||||
You can run `youtube-dl-viewer --help` to get a list of all available commandline arguments.
|
||||
Here are some common and useful arguments:
|
||||
|
||||
- `--port=<value>`:
|
||||
Specify the used port for the webserver (use a random one if not specified)
|
||||
- `--cache=<value>`:
|
||||
The cache directory for transcoded webm files, generated thumbnails and preview frames
|
||||
- `--display=<value>`, `--order=<value>`, `--width=<value>`, `--thumbnailmode=<value>`, `--videomode=<value>`:
|
||||
Set default values for the display/playback options in the top-right
|
||||
- `--max-parallel-convert=<value>`, `--max-parallel-genprev=<value>`:
|
||||
Limit the amount of parallel (potentially long-runnnig) jobs
|
||||
- `--preview-width=<value>`, `--thumnail-ex-mode=<value>`, `--previewcount-max=<value>`, `--previewcount-min=<value>`, `--no-auto-previews`, `--no-ffmpeg`:
|
||||
Options for the preview frames extraction
|
||||
- `--webm-convert-params=<value>`, `--no-ffmpeg`:
|
||||
Options for the webm live transcode
|
||||
- `--autorefresh-interval=<seconds>`:
|
||||
Automatically trigger a refresh (reload data from filesytem) if the last refresh is longer than <t> seconds ago.
|
||||
Only tests the condition on web requests, if the webapp is not used the interval can be longer.
|
||||
The default value is to never refresh (can still be triggered via the manual refresh button)
|
||||
- `--version`:
|
||||
Output program version
|
||||
- `--help`:
|
||||
Output help screen
|
||||
|
||||
## FAQ
|
||||
|
||||
|
||||
#### - Can't play video
|
||||
|
||||
If your browser tells you `No video with supported format and MIME type found` that means that the specified playback mode (button in top right corner) failed.
|
||||
|
||||
If you are on `Seekable raw file` or `Raw file` that means that the video files on your hard drive are not supported by your browser (generally only webm and mp4 are supported and in my experience only webm works good).
|
||||
|
||||
If you are on `Transcoded Webm stream` that means that youtube-dl-viewer could not live transcode your video file.
|
||||
First please look at the output of youtube-dl-viewer to see what exactly happened.
|
||||
|
||||
Common problems are:
|
||||
|
||||
1. You don't have ffmpeg installed or it's not in your PATH so youtube-dl-viewer cannot execute it.
|
||||
2. The (source) video is in a format that your ffmpeg installation cannot read
|
||||
3. youtube-dl-viewer (or the spawned ffmpeg process) has no permission to write to your temp directory
|
||||
|
||||
#### - Debugging ffmpeg output
|
||||
|
||||
By specifying a dirctory in the `--ffmpeg-debug-dir` argument you can inspect the ffmpeg output.
|
||||
For every ffmpeg call we make a new file is created with the invoked command, ffmpeg output and exit code.
|
||||
This is especially useful for cases where some specific codec is not supported by your ffmpeg version
|
||||
|
||||
#### - realpath(): Permission denied
|
||||
|
||||
If you get the following error on start (on linux):
|
||||
~~~
|
||||
realpath(): Permission denied
|
||||
Failure processing application bundle.
|
||||
Failed to determine location for extracting embedded files
|
||||
DOTNET_BUNDLE_EXTRACT_BASE_DIR is not set, and a read-write temp-directory couldn't be created.
|
||||
A fatal error was encountered. Could not extract contents of the bundle
|
||||
~~~
|
||||
|
||||
You need to set `DOTNET_BUNDLE_EXTRACT_BASE_DIR` to a valid path in your run script (or somewhere else such that the environment variable is set)
|
||||
|
||||
~~~bash
|
||||
#!/bin/bash
|
||||
|
||||
DOTNET_BUNDLE_EXTRACT_BASE_DIR=/tmp/dot_net_cache/
|
||||
export DOTNET_BUNDLE_EXTRACT_BASE_DIR
|
||||
|
||||
./youtube-dl-viewer
|
||||
~~~
|
||||
|
||||
|
||||
#### - The tabular view looks strange
|
||||
|
||||
The view mode `Tabular` uses the css subgrid feature which is currently [only supported in firefox](https://caniuse.com/#feat=css-subgrid). Which is great because I generally recommend people to not support that other company that tries to have a monopoly of every internet related thing...
|
||||
> **[!] See github README for a more in-depth manual**
|
||||
>
|
||||
> https://github.com/Mikescher/youtube-dl-viewer/blob/master/README.md
|
||||
>
|
||||
>
|
||||
Loading…
Reference in New Issue
Block a user