Joren/Stream-Mapparr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Pirates IRC
2025-10-09 11:46:18 -05:00
committed by GitHub
parent 6430fe0745
commit 85225fcf50
1 changed files with 137 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

248
README.md
View File

@@ -3,14 +3,16 @@ A Dispatcharr plugin that automatically matches and assigns streams to channels
## Features ## Features
* **Intelligent Stream Matching**: Automatically finds and assigns streams to channels using sophisticated name-matching algorithms * **Intelligent Stream Matching**: Automatically finds and assigns streams to channels using sophisticated name-matching algorithms
* **Quality Prioritization**: Sorts matched streams by quality (4K → FHD → HD → SD → Slow) * **OTA Callsign Matching**: Direct callsign extraction and matching for Over-The-Air broadcast channels
* **Multiple Streams Per Channel**: Assigns all matching streams to each channel, sorted by quality
* **Quality Prioritization**: Sorts matched streams by quality (4K → FHD → HD → (H) → (F) → (D) → SD → Slow)
* **Channel Visibility Management**: Automatically enables/disables channels based on stream assignments and duplicate detection
* **Timezone Filtering**: Automatically excludes West/Pacific coast feeds unless explicitly requested * **Timezone Filtering**: Automatically excludes West/Pacific coast feeds unless explicitly requested
* **OTA Channel Support**: Special handling for Over-The-Air broadcast channels using FCC network data * **Networks.json Integration**: FCC broadcast station database for OTA channel validation
* **Channels.txt Integration**: Distinguishes between similar channel names (e.g., FX vs FXX vs FX Movie Channel) * **Channels.txt Integration**: Distinguishes between similar channel names (e.g., FX vs FXX vs FX Movie Channel)
* **Customizable Ignore Tags**: Filter out unwanted tags during matching * **Customizable Ignore Tags**: Filter out unwanted tags during matching
* **Profile & Group Filtering**: Target specific channel profiles and groups * **Profile & Group Filtering**: Target specific channel profiles and groups
* **Preview Mode**: Dry-run CSV export to review matches before applying changes * **Preview Mode**: Dry-run CSV export to review matches before applying changes
* **Individual Channel Updates**: Updates channels one-by-one to avoid API errors
* **Comprehensive Logging**: Detailed matching logic and debug information * **Comprehensive Logging**: Detailed matching logic and debug information
## Requirements ## Requirements
@@ -21,8 +23,8 @@ A Dispatcharr plugin that automatically matches and assigns streams to channels
* `channels.txt` file (curated channel list) - included * `channels.txt` file (curated channel list) - included
* `networks.json` file (FCC broadcast station database) - included for OTA support * `networks.json` file (FCC broadcast station database) - included for OTA support
## Recommended Prerequisite ## Recommendation
It is **highly recommended** to standardize your channel names first using the [Channel Mapparr Plugin](https://github.com/PiratesIRC/Dispatcharr-Channel-Maparr-Plugin). Standardized channel names significantly improves matching accuracy. It is recommended to use the [Channel Mapparr Plugin](https://github.com/PiratesIRC/Dispatcharr-Channel-Maparr-Plugin) before using this plugin to standardize channel names. Standardized channel names significantly improve matching accuracy.
## Installation ## Installation
1. Log in to Dispatcharr's web UI 1. Log in to Dispatcharr's web UI
@@ -40,87 +42,134 @@ It is **highly recommended** to standardize your channel names first using the [
| **Profile Name** | `string` | - | Name of an existing Channel Profile to process (e.g., "Primary", "Sports") | | **Profile Name** | `string` | - | Name of an existing Channel Profile to process (e.g., "Primary", "Sports") |
| **Channel Groups** | `string` | - | Comma-separated group names to process, or leave empty for all groups | | **Channel Groups** | `string` | - | Comma-separated group names to process, or leave empty for all groups |
| **Ignore Tags** | `string` | - | Comma-separated tags to ignore during matching (e.g., `4K, [4K], [Dead]`) | | **Ignore Tags** | `string` | - | Comma-separated tags to ignore during matching (e.g., `4K, [4K], [Dead]`) |
| **Visible Channel Limit** | `number` | 1 | Number of channels per callsign group that will be visible and have streams added |
## Usage Guide ## Usage Guide
### Step-by-Step Workflow ### Step-by-Step Workflow
1. **Configure Settings** 1. **Configure Settings**
* Enter your Dispatcharr URL, username, and password    * Enter your Dispatcharr URL, username, and password
* Specify an existing **Profile Name** (cannot be "All")    * Specify an existing **Profile Name** (cannot be "All")
* Optionally specify **Channel Groups** (leave empty to process all)    * Optionally specify **Channel Groups** (leave empty to process all)
* Optionally configure **Ignore Tags** to filter out unwanted tags    * Optionally configure **Ignore Tags** to filter out unwanted tags
* Click **Save Settings**    * Set **Visible Channel Limit** (default: 1 channel per callsign group)
   * Click **Save Settings**
2. **Load and Process Channels** 2. **Load and Process Channels**
* Click **Run** on `Load/Process Channels`    * Click **Run** on `Load/Process Channels`
* The plugin loads channels from the specified profile and groups    * The plugin loads channels from the specified profile and groups
* Fetches all available streams (handles pagination automatically)    * Fetches all available streams (handles pagination automatically)
* Review the summary showing channel and stream counts    * Review the summary showing channel and stream counts
3. **Preview Changes (Dry Run)** 3. **Preview Changes (Dry Run)**
* Click **Run** on `Preview Changes (Dry Run)`    * Click **Run** on `Preview Changes (Dry Run)`
* Exports a CSV to `/data/exports/channel_addarr_preview_YYYYMMDD_HHMMSS.csv`    * Exports a CSV to `/data/exports/stream_mapparr_preview_YYYYMMDD_HHMMSS.csv`
* Review matched streams for each channel    * Review matched streams for each channel
* Identifies channels without matches    * Shows which channels will be updated vs skipped
   * Identifies channels without matches
4. **Add Streams to Channels** 4. **Add Streams to Channels**
* Click **Run** on `Add Stream(s) to Channels`    * Click **Run** on `Add Stream(s) to Channels`
* Replaces existing stream assignments with matched streams    * Adds all matched streams to each channel (sorted by quality)
* Updates channels individually to avoid bulk API errors    * Only updates channels within the visible channel limit
* Triggers M3U refresh to update the GUI    * Enables updated channels in the profile
* Exports results to `/data/exports/channel_addarr_results_YYYYMMDD_HHMMSS.csv`    * Triggers M3U refresh to update the GUI
   * Exports results to `/data/exports/stream_mapparr_results_YYYYMMDD_HHMMSS.csv`
5. **Manage Channel Visibility (Optional)**
   * Click **Run** on `Manage Channel Visibility`
   * Disables all channels in the profile
   * Enables only channels with 0-1 streams (not attached to other channels)
   * Enables only the highest priority channel per callsign group
   * Useful for cleaning up duplicate channels
   * Exports visibility report to `/data/exports/stream_mapparr_visibility_YYYYMMDD_HHMMSS.csv`
## Matching Logic ## Matching Logic
### Standard Channel Matching ### OTA Channel Matching (Priority Method)
The plugin uses a multi-stage matching process: For broadcast channels like "CBS - IN South Bend (WSBT) [HD]":
1. **Exact Match After Prefix**: Matches channel names that appear after prefixes like "US:", "USA:", etc. 1. **Callsign Extraction**: Parses channel name BEFORE any cleaning to extract callsign
* Example: "TBS [FHD]" → "US: TBS", "USA: TBS"    * Pattern: `NETWORK - STATE City (CALLSIGN) [Quality]`
   * Example: `CBS - IN South Bend (WSBT) [HD]` → Callsign: `WSBT`
2. **Direct Callsign Matching**: Searches all streams for the exact callsign using word boundaries
   * Matches: `US CBS 22 (WSBT) South Bend/Elkhart Area (H)`
   * Matches: `CBS: IN SOUTH BEND WSBT`
   * Excludes: `WSBTV` (different callsign)
3. **Fallback to Networks.json**: If direct matching fails, validates against FCC database
   * Confirms network affiliation
   * Validates state and callsign combination
   * Searches streams for validated callsign
4. **Quality Sorting**: All matched streams sorted by quality precedence
### Standard Channel Matching
For non-OTA channels, the plugin uses a multi-stage process:
1. **Exact Match After Cleaning**: Matches channel names after removing quality tags
   * Example: "TBS [FHD]" → "TBS" matches "US: TBS"
2. **Word Boundary Matching**: Ensures complete word matches to avoid false positives 2. **Word Boundary Matching**: Ensures complete word matches to avoid false positives
* Example: "FX" matches "US: FX" but NOT "FXX" or "WFXR"    * Example: "FX" matches "US: FX" but NOT "FXX" or "WFXR"
3. **Longer Channel Filtering**: Uses `channels.txt` to distinguish similar names 3. **Longer Channel Filtering**: Uses `channels.txt` to distinguish similar names
* Example: "FX" does NOT match "FX Movie Channel" (different channel)    * Example: "FX" does NOT match "FX Movie Channel" (different channel)
4. **Call Sign Filtering**: Excludes local TV station call signs 4. **Call Sign Filtering**: Excludes local TV station call signs
* Example: "FX" does NOT match "WBKB FX (WBKBDT4)" (local FOX affiliate)    * Example: "FX" does NOT match "WBKB FX (WBKBDT4)" (local FOX affiliate)
5. **Timezone Filtering**: Automatically excludes West/Pacific feeds 5. **Timezone Filtering**: Automatically excludes West/Pacific feeds
* Example: "SYFY [HD]" matches "US NBC SYFY (East)" but NOT "US NBC SYFY (West)"    * Example: "SYFY [HD]" matches "US NBC SYFY (East)" but NOT "US NBC SYFY (West)"
### OTA Channel Matching ### Channel Grouping and Priority
For broadcast channels like "ABC - TN Chattanooga (WTVC)": Channels are grouped by callsign (OTA) or cleaned name (regular):
* Within each group, channels are sorted by quality tag priority:
1. **Callsign Extraction**: Parses network, state, city, and callsign   * `[4K]` → `[FHD]` → `[HD]` → `[SD]` → `[Unknown]` → `[Slow]` → No tag
2. **Networks.json Lookup**: Matches against FCC broadcast database * Then by channel number (ascending)
3. **Exact Callsign Matching**: Uses word boundaries to prevent partial matches * Only the highest priority channels (up to Visible Channel Limit) receive streams
* Example: "KOB" matches "NBC (KOB)" but NOT "NBC (KOBI)"
4. **Network Validation**: Confirms stream contains the correct network affiliation
### Quality Sorting ### Quality Sorting
Matched streams are automatically sorted by quality precedence: Matched streams are automatically sorted by quality precedence:
4K → [4K] → (4K) → FHD → [FHD] → (FHD) → HD → [HD] → (HD) → SD → [SD] → (SD) → Slow → [Slow] → (Slow) * **4K**: `[4K]`, `(4K)`, `4K`
* **FHD**: `[FHD]`, `(FHD)`, `FHD`
* **HD**: `[HD]`, `(HD)`, `HD`, `(H)`
* **SD**: `[SD]`, `(SD)`, `SD`
* **Other**: `(F)`, `(D)`
* **Slow**: `Slow`, `[Slow]`, `(Slow)`
## Example Transformations ## Example Transformations
### OTA Channels (Callsign Matching)
**Channel**: `CBS - IN South Bend (WSBT) [HD]`  
**Matched Streams**: `US CBS 22 (WSBT) South Bend/Elkhart Area (H)`, `US CBS 22 (WSBT) South Bend/Elkhart Area (F)`, `CBS: IN SOUTH BEND WSBT`
**Channel**: `CBS - CA Monterey (KION) [FHD]`  
**Matched Streams**: `US CBS 46 (KION) Monterey (H)`, `US CBS 46 (KION) Monterey (F)`, `CBS: CA MONTEREY KION`, `US: FOX Monterey (KION)`
**Channel**: `CBS - NM Albuquerque (KRQE) [HD]`  
**Matched Streams**: `US FOX (KRQE) Albuquerque Santa Fe (H)`, `US CBS 13 (KRQE) Albuquerque Santa Fe (H)`, `US FOX (KRQE) Alburquerque (F)`, `US CBS (KRQE) Albuquerque (F)`, `CBS: NM ALBUQUERQUE KRQE`, `FOX: ALBUQUERQUE NM KRQE`, `US: CBS 13 Albuquerque (KRQE)`, `US: FOX 13 Albuquerque (KRQE)`
### Standard Channels ### Standard Channels
**Channel**: `TBS [FHD]` **Channel**: `TBS [FHD]`  
**Matched Streams**: `USA: TBS`, `US: TBS`, `US: TBS` **Matched Streams**: `USA: TBS`, `US: TBS`, `US: TBS`
**Channel**: `FX (East) [HD]` **Channel**: `FX (East) [HD]`  
**Matched Streams**: `US: FX`, `US: FX`, `US FX (East) (S)`, `US FX (East) (H)`, `US FX (East) (A)`, `US (F2) FX (East)` **Matched Streams**: `US: FX`, `US: FX`, `US FX (East) (S)`, `US FX (East) (H)`, `US FX (East) (A)`, `US (F2) FX (East)`  
**Excluded**: `US: FX Movie Channel`, `(US) (FOX1) WBKB FX (WBKBDT4)` **Excluded**: `US: FX Movie Channel`, `(US) (FOX1) WBKB FX (WBKBDT4)`
**Channel**: `SYFY [HD]` **Channel**: `SYFY [HD]`  
**Matched Streams**: `USA SYFY`, `US: SYFY`, `US: SYFY`, `US NBC SYFY (East) (D)` **Matched Streams**: `USA SYFY`, `US: SYFY`, `US: SYFY`, `US NBC SYFY (East) (D)`  
**Excluded**: `US NBC SYFY (West) (D)` **Excluded**: `US NBC SYFY (West) (D)`
### OTA Channels ### Duplicate Channel Handling
**Channel**: `NBC - NM Albuquerque (KOB)` **Channels in Profile**:
**Matched Streams**: `US NBC (KOB) Albuquerque, NM (D)`, `NBC: NM ALBURQUERQUE KOB` * `CBS - AL Birmingham (WIAT) [FHD]` ← Highest priority (enabled, receives streams)
**Excluded**: `US NBC (KOBI) Medford` (different callsign) * `CBS - AL Birmingham (WIAT) [HD]` ← Lower priority (skipped)
* `CBS - AL Birmingham (WIAT) [Slow] [HD]` ← Lower priority (skipped)
**Result**: Only the `[FHD]` channel receives streams and is visible
## Action Reference ## Action Reference
@@ -128,17 +177,19 @@ Matched streams are automatically sorted by quality precedence:
|:-------|:------------| |:-------|:------------|
| **Load/Process Channels** | Load channels from specified profile/groups and fetch all available streams | | **Load/Process Channels** | Load channels from specified profile/groups and fetch all available streams |
| **Preview Changes (Dry Run)** | Export CSV showing which streams will be matched to each channel | | **Preview Changes (Dry Run)** | Export CSV showing which streams will be matched to each channel |
| **Add Stream(s) to Channels** | Apply matched streams to channels, replacing existing assignments | | **Add Stream(s) to Channels** | Apply matched streams to channels, enabling highest priority channels in each group |
| **Manage Channel Visibility** | Disable all channels, then enable only channels with 0-1 streams (excluding duplicates and attached channels) |
## File Locations ## File Locations
* **Processing Cache**: `/data/channel_addarr_processed.json` * **Processing Cache**: `/data/stream_mapparr_processed.json`
* **Preview Export**: `/data/exports/channel_addarr_preview_YYYYMMDD_HHMMSS.csv` * **Preview Export**: `/data/exports/stream_mapparr_preview_YYYYMMDD_HHMMSS.csv`
* **Results Report**: `/data/exports/channel_addarr_results_YYYYMMDD_HHMMSS.csv` * **Results Report**: `/data/exports/stream_mapparr_results_YYYYMMDD_HHMMSS.csv`
* **Visibility Report**: `/data/exports/stream_mapparr_visibility_YYYYMMDD_HHMMSS.csv`
* **Plugin Files**: * **Plugin Files**:
* `/data/plugins/stream_mapparr/plugin.py`   * `/data/plugins/stream_mapparr/plugin.py`
* `/data/plugins/stream_mapparr/__init__.py`   * `/data/plugins/stream_mapparr/__init__.py`
* `/data/plugins/stream_mapparr/channels.txt`   * `/data/plugins/stream_mapparr/channels.txt`
* `/data/plugins/stream_mapparr/networks.json`   * `/data/plugins/stream_mapparr/networks.json`
## CSV Export Format ## CSV Export Format
@@ -151,6 +202,7 @@ Matched streams are automatically sorted by quality precedence:
| **matched_streams_count** | Number of streams matched | | **matched_streams_count** | Number of streams matched |
| **stream_names** | Pipe-separated list of matched stream names | | **stream_names** | Pipe-separated list of matched stream names |
| **stream_ids** | Comma-separated list of matched stream IDs | | **stream_ids** | Comma-separated list of matched stream IDs |
| **will_update** | `Yes` if channel will be updated, `No` if skipped |
### Results CSV ### Results CSV
| Column | Description | | Column | Description |
@@ -161,7 +213,17 @@ Matched streams are automatically sorted by quality precedence:
| **matched_streams_count** | Number of streams added | | **matched_streams_count** | Number of streams added |
| **stream_names** | Pipe-separated list of added stream names | | **stream_names** | Pipe-separated list of added stream names |
| **stream_ids** | Comma-separated list of added stream IDs | | **stream_ids** | Comma-separated list of added stream IDs |
| **status** | `Updated` or `No matches` | | **will_update** | `Yes` if channel was updated, `No` if skipped |
| **status** | `Updated`, `Skipped (over limit)`, `No matches`, or error details |
### Visibility Report CSV
| Column | Description |
|:-------|:------------|
| **channel_id** | Internal Dispatcharr channel ID |
| **channel_name** | Channel name |
| **stream_count** | Number of streams attached to channel |
| **reason** | Why channel was enabled/disabled |
| **enabled** | `Yes` if channel is visible, `No` if hidden |
## Troubleshooting ## Troubleshooting
@@ -177,6 +239,18 @@ Matched streams are automatically sorted by quality precedence:
* Check available groups in the error message * Check available groups in the error message
* Leave field empty to process all groups * Leave field empty to process all groups
**OTA channels not matching streams**
* Verify channel name format: `NETWORK - STATE City (CALLSIGN)`
* Example: `CBS - IN South Bend (WSBT) [HD]`
* Check that callsign exists in stream names
* Review logs for "Extracted callsign" and "Found callsign match" messages
* Ensure `networks.json` contains the station data (fallback method)
**Too many duplicate channels visible**
* Run "Manage Channel Visibility" action
* Adjust "Visible Channel Limit" setting (default: 1)
* Only highest priority channels per callsign group will remain visible
**Channels not matching streams** **Channels not matching streams**
* Run Channel Mapparr first to standardize channel names * Run Channel Mapparr first to standardize channel names
* Check that streams exist for your channels * Check that streams exist for your channels
@@ -188,12 +262,6 @@ Matched streams are automatically sorted by quality precedence:
* Use Ignore Tags to filter out quality indicators * Use Ignore Tags to filter out quality indicators
* Check logs for matching logic details * Check logs for matching logic details
**OTA channels not matching**
* Verify channel name format: `NETWORK - STATE City (CALLSIGN)`
* Check that callsign exists in `networks.json`
* Ensure network affiliation is correct
* Review logs for callsign extraction details
### Debugging Commands ### Debugging Commands
```bash ```bash
# Check plugin files # Check plugin files
@@ -203,52 +271,10 @@ docker exec dispatcharr ls -la /data/plugins/stream_mapparr/
docker logs -f dispatcharr | grep -i stream_mapparr docker logs -f dispatcharr | grep -i stream_mapparr
# View processing cache # View processing cache
docker exec dispatcharr cat /data/channel_addarr_processed.json | jq docker exec dispatcharr cat /data/stream_mapparr_processed.json | jq
```
### Data Sources # Check OTA callsign extraction
channels.txt Format docker logs -f dispatcharr | grep "Extracted callsign"
A plain text file with one channel name per line:
TBS
PixL
FX
FXX
FX Movie Channel
HBO
HBO2
### `networks.json` Format # Check stream matches
An FCC broadcast station database with fields: docker logs -f dispatcharr | grep "Found callsign match"
* `callsign`: Station identifier (e.g., WTVC, KABC-TV)
* `community_served_city`: City name
* `community_served_state`: Two-letter state code
* `network_affiliation`: Network name(s), may contain multiple values
* `tv_virtual_channel`: Virtual channel number
* `facility_id`: FCC facility identifier
**Network Affiliation Parsing Rules**:
* Multiple networks separated by comma, semicolon, or slash - only first is used
* Format like "CBS (12.1), CW (12.2)" - only CBS is used
* Format like "WTOV D1 - NBC; WTOV D2 - FOX" - only NBC is used
* Callsign suffixes after dash are removed (e.g., "WLNE-TV" → "WLNE")
## Performance Notes
* Handles pagination automatically (fetches all streams across multiple pages)
* Processes up to 3,600+ streams efficiently
* Updates channels individually to avoid bulk API errors
* Automatic M3U refresh triggers GUI updates
* Detailed logging for debugging and transparency
## Contributing
When reporting issues, please include:
* Dispatcharr version
* Sample channel names that fail to match
* Relevant container logs showing matching attempts
* Contents of the preview CSV (first 10 rows)
* Whether you're using Channel Mapparr for name standardization
## Related Projects
* [Channel Mapparr](https://github.com/PiratesIRC/Dispatcharr-Channel-Maparr-Plugin) - Standardize channel names before running Stream Mapparr
## License
This plugin integrates with Dispatcharr's plugin system and follows its licensing terms.