Files
tdarr-plugs/README.md
2026-01-30 05:55:22 -08:00

62 lines
3.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## Tdarr Plugin Suite
Custom, modular Tdarr plugin stack for media transcoding and library hygiene.
### Recommended Plugin Stack (Preprocessing → Encoding)
1. **Tdarr_Plugin_00_file_audit** (v1.x) Readonly audit
- Logs container, streams, and potential issues for MKV/MP4.
2. **Tdarr_Plugin_01_container_remux** (v2.x) Container & timestamp fixes
- Remux to MKV/MP4, fixes legacy TS/AVI/MPG timestamp issues.
3. **Tdarr_Plugin_02_stream_cleanup** (v1.x) Stream removal
- Drops image/data/corrupt streams and containerincompatible tracks.
4. **Tdarr_Plugin_03_stream_ordering** (v1.x) Stream ordering
- Ensures `Video → Audio → Subtitles`, prioritizes English, optional dispositions.
5. **Tdarr_Plugin_04_subtitle_conversion** (v2.x) Containeraware subs
- MKV→SRT, MP4→mov_text, keeps image subs asis.
6. **Tdarr_Plugin_05_subtitle_extraction** (v1.x, optional) External .srt
- Extracts selected subtitle languages to sidecar files.
7. **Tdarr_Plugin_06_cc_extraction** (v1.x, optional) Closed captions
- Uses CCExtractor to pull EIA608 style captions when enabled.
8. **Tdarr_Plugin_combined_audio_standardizer** (v1.24) Audio standardizer
- Opus/AAC conversion, **always preserves original channels**, adds downmix tracks,
containeraware Opus mapping, quality presets.
9. **Tdarr_Plugin_av1_svt_converter** (v3.19) AV1 video encoder
- SVTAV1 v3.x, CRF/VBR modes, resolution caps, bitrate & sourcecodec awareness.
Legacy monolithic plugins `Tdarr_Plugin_misc_fixes` and `Tdarr_Plugin_stream_organizer`
have been **fully replaced** by the numbered modular plugins above and are kept only
for historical reference under `agent_notes/archive/` and `agent-notes/archived/`.
### Directory Structure
```text
tdarr_plugs/
├── Local/ # Active Tdarr plugin files (mount this in Tdarr)
│ ├── Tdarr_Plugin_00_file_audit.js
│ ├── Tdarr_Plugin_01_container_remux.js
│ ├── Tdarr_Plugin_02_stream_cleanup.js
│ ├── Tdarr_Plugin_03_stream_ordering.js
│ ├── Tdarr_Plugin_04_subtitle_conversion.js
│ ├── Tdarr_Plugin_05_subtitle_extraction.js
│ ├── Tdarr_Plugin_06_cc_extraction.js
│ ├── Tdarr_Plugin_combined_audio_standardizer.js
│ └── Tdarr_Plugin_av1_svt_converter.js
├── JobReports/ # Saved Tdarr job reports for analysis
├── agent_notes/ # Detailed design notes, analyses, and plans
│ └── archive/ # Archived legacy plugin files, old experiments
├── agent-notes/ # Additional consolidated notes/archives
├── PLUGIN_DOCUMENTATION.md # Indepth perplugin documentation
├── COMPREHENSIVE_REVIEW_REPORT.md
├── OPTIMIZATION_REPORT.md
└── README.md
```
### Usage
- Mount the `Local/` directory as your **Local Plugins** folder in Tdarr.
- Apply the plugins in the order above for best results (failfast audits and cleanup
before any expensive video encoding).
- Refer to `PLUGIN_DOCUMENTATION.md` and `COMPREHENSIVE_REVIEW_REPORT.md` for
deeper technical details and rationale.