add changelog (#232)

CHANGELOG.md

@@ -0,0 +1,414 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+### Added
+- Add button to refresh list of Plex, Jellyfin, Emby libraries without restarting app
+- Add episodes to search index
+- Add director and writer metadata to episodes
+- Add unique id/provider id metadata, which will support future features
+- Allow grouping multi-part episodes with titles ending in `Part X`, `Part Y`, etc.
+
+### Fixed
+- Fix missing channel logos after restart
+- Fix multi-part episode grouping with missing episodes/parts
+
+## [0.0.40-prealpha] - 2021-05-28
+### Added
+- Add content rating metadata to movies and shows
+- Add director and writer metadata to movies
+- Sync tv show thumbnail artwork in Local, Jellyfin and Emby libraries (*not* Plex)
+- Prioritize tv show thumbnail artwork over tv show posters in XMLTV
+- Include tv show artwork in XMLTV when grouped items with custom title are all from the same show
+- Cache resized local artwork on disk
+
+### Fixed
+- Recursively retrieve Jellyfin and Emby items
+- Fix incorrect search item counts
+- Fix stack trace information in non-docker releases
+- Fix crash opening `Add to Schedule` dialog
+- Disable FFmpeg troubleshooting reports on Windows as they do not work properly
+
+## [0.0.39-prealpha] - 2021-05-25
+### Added
+- Show Jellyfin and Emby artwork in XMLTV
+
+### Fixed
+- Fix path replacements for Jellyfin and Emby, including UNC paths
+- Use Emby path replacements for playback
+- Fix playback when `fps` is the only required filter
+- Fix resources (images, fonts) required to display offline channel message
+
+## [0.0.38-prealpha] - 2021-05-23
+### Added
+- Add support for Emby
+- Use "single-file" deployments for releases
+    - Non-docker releases will have significantly fewer files
+    - It is recommended to empty your installation folder before copying in the latest release.
+
+### Fixed
+- Fix some cases where Jellyfin artwork would not display
+- Fix saving schedule items with duration less than one hour
+- Use ffmpeg 4.3 in docker images; there was a performance regression with 4.4 (only in docker)
+
+## [0.0.37-prealpha] - 2021-05-21
+### Added
+- Add option to keep multi-part episodes together when shuffling (i.e. two-part season finales)
+- Optimize Plex TV Scanner to quickly process shows that have not been updated since the last scan
+- Optimize local Movie, Show, Music Video scanners to quickly skip unchanged folders, and to notice any mtime change
+- Add server binding configuration to `appsettings.json` which lets non-docker installations bind to localhost or change the port number
+
+### Fixed
+- Properly ignore `Other` Jellyfin libraries
+- Fix bug where search index would try to re-initialize unnecessarily
+- Fix one cause of green line at bottom of some transcoded videos by forcing even scaling targets
+
+## [0.0.36-prealpha] - 2021-05-16
+### Added
+- Add support for Jellyfin
+- Add support for ffmpeg 4.4, and use ffmpeg 4.4 in all docker images
+- Add configurable library refresh interval
+- Add button to copy/clone ffmpeg profile
+
+## [0.0.35-prealpha] - 2021-04-27
+### Added
+- Add search button for each library in `Libraries` page to quickly filter content by library
+    - This requires rebuilding the search index and search results may be empty or incomplete until the rebuild is complete
+
+### Fixed
+- Fix ingesting actors and actor artwork from newly-added Plex media items
+- Only show `movie` and `show` libraries from Plex. Other library types are not supported at this time.
+- Fix local movie scanner missing replaced/updated files
+
+## [0.0.34-prealpha] - 2021-04-17
+### Added
+- Allow `enter` key to submit all dialogs
+- Add actors to movies and shows (Plex or NFO metadata is required)
+    - Note that this requires a one-time full library scan to ingest actor metadata, which may take a long time with large libraries.
+- Rework metadata list links in UI (languages, studios, genres, etc)
+
+### Fixed
+- Fix EPG generation with music video channels that do not use a custom title
+- Fix lag when typing in search bar, `Add To Collection` dialog
+- Fix collections paging
+- Fix padding odd resolutions (this bug caused some items to always fail playback)
+- Only update Plex episode artwork as needed
+
+## [0.0.33-prealpha] - 2021-04-11
+### Added
+- Add language buttons to movies, shows, artists
+- Show release notes on home page
+
+### Fixed
+- Re-import missing television metadata that was incorrectly removed with `v0.0.32`
+- Fix language indexing; language searches now use full english name
+- Fix synchronizing television studios, genres from Plex
+- Limit channels to one playout per channel
+    - Though more than one playout was previously possible it was unsupported and unlikely to work as expected, if at all
+    - A future release may make this possible again
+    
+## [0.0.32-prealpha] - 2021-04-09
+### Added
+- `Add All To Collection` button to quickly add all search results to a collection
+- Add Artists scanned from Music Video libraries
+    - Artist folders are now required, but music videos now have no naming requirements
+    - `artist.nfo` metadata is supported along with thumbnail and poster artwork
+- Save Collections table page size in local storage
+
+### Fixed
+- Fix audio stream language indexing for movies and music videos
+- Fix synchronizing list of Plex servers and connection addresses for each server
+- Fix `See All` link for music video search results
+
+## [0.0.31-prealpha] - 2021-04-06
+### Added
+- Add documentation link to UI
+- Add `language` search field
+- Minor log viewer improvements
+- Use fragment navigation with letter bar (clicking a letter will page and scroll until that letter is in view)
+- Send all audio streams with HLS when channel has no preferred language
+- Move FFmpeg settings to new `Settings` page
+- Add HDHR tuner count setting to new `Settings` page
+
+### Fixed
+- Fix poster width
+- Fix bug that would occasionally prevent items from being added to the search index
+- Automatically refresh the Plex Media Sources page after sign in or sign out
+
+## 0.0.30-prealpha [YANKED]
+
+## [0.0.29-prealpha] - 2021-04-04
+- No longer require NFO metadata for music videos
+    - Instead, the only requirement is that music video files be named `[artist] - [track].[extension]` where the three characters (space dash space) between artist and track are required
+- Add library scan progress detail
+- Optimize library scans after adding library path to only scan new library path
+- Fix bug replacing music videos
+- Scan Plex libraries and local libraries on different threads
+- Use English names for preferred languages in UI instead of ISO language code
+
+## [0.0.28-prealpha] - 2021-04-03
+- Apply audio normalization more consistently; this should further reduce program boundary errors
+- Replace unused audio volume setting with audio loudness normalization option
+    - This can be particularly helpful with music video channels if media items have inconsistent loudness
+    - This setting may be less desirable on movie channels where loudness is intended to be dynamic
+- Fix XMLTV containing music videos that do not use a custom title
+- Fix channels table sorting, add paging to channels table
+- Add sorting and paging to schedules table
+- Add paging to playouts table
+- Use table instead of cards for collections view
+
+## [0.0.27-prealpha] - 2021-04-02
+- Add ***basic*** music video library support
+    - **NFO metadata is required for music videos** - see [tags](https://kodi.wiki/view/NFO_files/Music_videos#Music_Video_Tags), [template](https://kodi.wiki/view/NFO_files/Music_videos#Template_nfo) and [sample](https://kodi.wiki/view/NFO_files/Music_videos#Sample_nfo)
+    - Artists can be searched using the `artist` field, like `artist:daft`
+- Clear search query when clicking `Movies` or `TV Shows` from paged search results
+- Add show title to playout details
+- Let ffmpeg determine thread count by default (signified by `0` threads in ffmpeg profile)
+- Save troubleshooting reports for ffmpeg concat process in addition to transcode process
+- Simplify ffmpeg normalization options
+- Add frame rate setting to ffmpeg profile
+    - When video normalization is enabled, all media items will have their frame rate converted to the same value
+- Fix some scenarios where streaming would freeze at program boundaries
+- Fix bug preventing some Plex libraries from scanning
+- Fix bug preventing some local libraries from scanning folders that were recently added
+
+## [0.0.26-prealpha] - 2021-03-30
+- Add `Custom Title` option to schedule items
+    - When a custom title is set, the schedule item will be grouped in the EPG with the custom title
+- Navigate to schedule items after creating new schedule
+- Fix channel editor so preferred language is no longer required on every channel
+- Fix bug with audio track selection during non-normalized playback
+- Fix bug with playout builds where `Multiple` or `Duration` items wouldn't respect the settings over time
+- Fix bug that prevented some television folders from scanning
+
+## [0.0.25-prealpha] - 2021-03-29
+- Add preferred language feature
+    - Global preference can be set in FFmpeg settings; channels can override global preference
+    - Preferences require [ISO 639-2](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) language codes
+    - Audio stream selection will attempt to respect these preferences and prioritize streams with the most channels
+    - English (`eng`) will be used as a fallback when no preferences have been configured
+    - ***This feature requires a one-time reanalysis of every media item which may take a long time for large libraries and playback may fail until this scan has completed***
+- Fix channel sorting in EPG
+- Fix mixed-platform path replacements (Plex on Windows with ErsatzTV on Linux, or Plex on Linux with ErsatzTV on Windows)
+- Fix local television library scanning; this was broken with `v0.0.23`
+- Optimize local library scanning; regular scans should be significantly faster
+- Add log warning when a zero-duration media item is encountered
+- Fix indexing local shows without NFO metadata.
+    - If you have this issue the best way to fix is to:
+        - Shutdown ErsatzTV
+        - Delete the `search-index` subfolder inside the ErsatzTV config folder
+        - Start ErsatzTV; the full search index will be rebuilt on startup
+- Fix updating search index when genres, tags, studios are updated in local libraries
+- Adjust artwork routes so all IPTV traffic can be proxied with a single path prefix of `/iptv`
+
+## [0.0.24-prealpha] - 2021-03-22
+- Fix a critical bug preventing library synchronization with Plex sign ins performed with `v0.0.22` or `v0.0.23`
+    - **If you are unable to sync libraries from Plex, please sign out and back in to apply this fix**
+- Fallback to `folder.jpg` when `poster.jpg` is not present
+- Attach episodes to correct show when adding NFO metadata to existing libraries
+
+## [0.0.23-prealpha] - 2021-03-21
+- Remove all Plex items from search index after sign out
+- Fix fallback metadata for local episodes (episode number was missing)
+- Improve television show year detection where year is missing from nfo metadata
+- Fix sorting for titles that start with `A` or `An` in addition to `The`
+- Properly escape search links containing special characters (genre, tag)
+- Add and index `Studio` metadata
+
+## [0.0.22-prealpha] - 2021-03-20
+- Log errors encountered during search index build; attempt to continue with partial index when errors are encountered
+- Only search `title` field by default; `genre` and `tag` can be searched with `field:query` syntax
+- Allow leading wildcards in searches
+- Keep search query in search field to allow easy modification
+- Fix default ffmpeg profile when creating new channels
+- Fix multiple bugs with updating Plex servers, libraries, path replacements
+- Add `release_date` to search index
+
+## [0.0.21-prealpha] - 2021-03-20
+- Optimize local library scanning to use less memory
+- Duplicate some documentation near the schedule item editor
+- Fix bug with updating `Normalize Video Codec` setting
+- Rework search functionality
+    - Search landing page will show up to 50 items of each type
+    - `See All` links can be used to page through all search results
+    - Complex search queries supported (`christmas OR santa`)
+    - Fields that are searched by default:
+        - `title`
+        - `genre`
+        - `tag`
+    - Fields that aren't searched by default, but can be included in queries with syntax like (`plot:whatever`):
+        - `plot`
+        - `library_name`
+        - `type` (`movie` or `show`)
+    - Add letter bar to all paged search results to quickly navigate to a particular letter
+
+## [0.0.20-prealpha] - 2021-03-17
+- Fix NVIDIA hardware acceleration in `develop-nvidia` and `latest-nvidia` Docker tags
+    - This may never have worked correctly in Docker with older releases
+- Fix occasional crash rebuilding playout from ui
+- Fix crash adding a channel when no channels exist
+- Fix playback for media containing attached pictures
+
+## [0.0.19-prealpha] - 2021-03-16
+- Regularly scan Plex libraries (same as local libraries)
+- Add ability to create new collection from `Add to Collection` dialog
+- Fix channel logos in XMLTV
+- Add episode posters (show posters) to XMLTV
+- Fix shuffled schedules from occasionally having repeated items when reshuffling
+    - This was more likely to happen with low-cardinality collections like A B C C A B B C A
+- Add optional FFmpeg troubleshooting reports
+- Allow synchronizing hidden Plex libraries
+
+## [0.0.18-prealpha] - 2021-03-14
+- Plex is now a supported media source
+    - Plex is **not** used for transcoding at this point, files are played directly from the filesystem using ErsatzTV transcoding
+    - Path replacements will be needed if your shared media folders are mounted differently in Plex and ErsatzTV
+
+## [0.0.17-prealpha] - 2021-03-13
+- Fix bug introduced with 0.0.16 that prevented some playouts from building
+- Properly set sort title on added tv shows
+- Fix loading season pages containing episodes that have incomplete metadata
+- Improve XMLTV guide data
+
+## [0.0.16-prealpha] - 2021-03-12
+- Fix infinite loop caused by incorrectly configured ffprobe path
+- Add more strict ffmpeg and ffprobe settings validation
+- Add custom playback order option to collections that contain only movies
+    - This custom playback order will override the schedule's configured playback order for the collection
+
+## [0.0.15-prealpha] - 2021-03-11
+- Update UI for tv shows
+- Fix tv show sorting
+- Fix editing channel numbers
+- Fix playout timezone bugs
+- Add searchable genres and tags from local NFO metadata
+- Add multi-select feature to movies, shows, search results and collection items pages
+
+## [0.0.14-prealpha] - 2021-03-09
+- New movie layout utilizing fan art (if available)
+- New dark UI
+- Fix offline stream (displayed when no media is scheduled for playback)
+- Add M3U codec hints for Channels DVR
+- Allow sub-channel numbers
+- Fix bug where ffmpeg wouldn't terminate after a media item completed playback
+- Fix time zone in new docker base images
+- Fix vaapi pipeline with mpeg4 content by using software decoder with hardware encoder
+- Enforce unique schedule name
+- Enforce unique channel number
+- Fix sorting of collection items in UI
+
+## [0.0.13-prealpha] - 2021-03-07
+- Remember selected Collection in `Add To Collection` dialog
+- Automatically rebuild Playouts referencing any Collection that has items added or removed from the UI
+- Remove Media Items from database when files are removed from disk
+- Add hardware-accelerated transcoding support (`qsv`, `nvenc`/`nvidia`, `vaapi`)
+    - All flavors support resolution normalization (scaling and padding)
+    - This requires support within ffmpeg; see README for new docker image tags
+
+## [0.0.12-prealpha] - 2021-03-02
+- Fix a database migration issue introduced with version 0.0.11
+- Shutdown app when database migration failures are encountered at startup
+
+## [0.0.11-prealpha] - 2021-03-01
+- Add Libraries and Library Paths under Media Sources
+    - Two local libraries exist: `Movies` and `Shows`
+    - Local Media Sources from prior versions are now found under Library Paths
+- Add `Rebuild Playout` buttons to quickly regenerate playouts after modifying collections
+- Add `Add to Collection` buttons to most media cards (movies, shows, seasons, episodes)
+- Add Search page for searching movies and shows
+
+## [0.0.10-prealpha] - 2021-02-21
+- Rework how television media is stored in the database
+- Rework how media is linked to a collection
+- Add season, episode and movie detail views to UI
+- Add media to collections and schedules from detail views
+- Easily add and remove media from a collection
+- Easily add and reorder schedule items
+
+## [0.0.9-prealpha] - 2021-02-15
+- Local media scanner has been rewritten and is much more performant
+- Ignore extras in the same folder as movies (`-behindthescenes`, `-trailer`, etc)
+- Support `movie.nfo` metadata in addition to matching filename nfo metadata
+- Changes to video files, metadata and posters are automatically detected and used
+
+## [0.0.8-prealpha] - 2021-02-14
+- Optimize scanning so playouts are only rebuilt when necessary (duration changes, or collection membership changes)
+- Automatically add new posters during scanning
+- Support more poster file types (jpg, jpeg, png, gif, tbn)
+- Add "Refresh All Metadata" button to media sources page; this should only be needed if NFO metadata or posters are modified
+- Add progress indicator for media sources that are being actively scanned
+- Prevent deleting media source during scan
+- Prevent creating playout with empty schedule
+
+## [0.0.7-prealpha] - 2021-02-13
+- Rework media items layout - table has been replaced with cards/posters
+- Fix bug preventing long folder names from being used as media sources
+- Use 24h time pickers in schedule editor
+
+## [0.0.6-prealpha] - 2021-02-12
+- Add version information to UI
+- Add basic log viewer to UI
+
+## [0.0.5-prealpha] - 2021-02-12
+- Fix bug where media scanner could stop prematurely and miss media items
+- Add database migrations
+
+## [0.0.4-prealpha] - 2021-02-11
+- **Fix HDHomeRun routes** - this version is required to use as a DVR with Plex, older versions will not work
+- Improve metadata parsing for tv, add fallback (filename) parsing for movies
+
+## [0.0.3-prealpha] - 2021-02-11
+- Fix incomplete XML issue introduced with v0.0.2-prealpha
+- Add `.ts` files to local media scanner
+- Change M3U, XMLTV, API icons to text links
+
+## 0.0.2-prealpha - 2021-02-11 [YANKED]
+- Relax some searches to be case-insensitive
+- Improve categorization of tv episodes without sidecar metadata
+- Properly escape XML content in XMLTV
+
+## [0.0.1-prealpha] - 2021-02-10
+- Initial release to facilitate testing outside of Docker.
+
+
+[Unreleased]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.40-prealpha...HEAD
+[0.0.40-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.39-prealpha...v0.0.40-prealpha
+[0.0.39-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.38-prealpha...v0.0.39-prealpha
+[0.0.38-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.37-prealpha...v0.0.38-prealpha
+[0.0.37-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.36-prealpha...v0.0.37-prealpha
+[0.0.36-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.35-prealpha...v0.0.36-prealpha
+[0.0.35-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.34-prealpha...v0.0.35-prealpha
+[0.0.34-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.33-prealpha...v0.0.34-prealpha
+[0.0.33-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.32-prealpha...v0.0.33-prealpha
+[0.0.32-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.31-prealpha...v0.0.32-prealpha
+[0.0.31-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.29-prealpha...v0.0.31-prealpha
+[0.0.29-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.28-prealpha...v0.0.29-prealpha
+[0.0.28-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.27-prealpha...v0.0.28-prealpha
+[0.0.27-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.26-prealpha...v0.0.27-prealpha
+[0.0.26-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.25-prealpha...v0.0.26-prealpha
+[0.0.25-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.24-prealpha...v0.0.25-prealpha
+[0.0.24-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.23-prealpha...v0.0.24-prealpha
+[0.0.23-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.22-prealpha...v0.0.23-prealpha
+[0.0.22-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.21-prealpha...v0.0.22-prealpha
+[0.0.21-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.20-prealpha...v0.0.21-prealpha
+[0.0.20-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.19-prealpha...v0.0.20-prealpha
+[0.0.19-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.18-prealpha...v0.0.19-prealpha
+[0.0.18-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.17-prealpha...v0.0.18-prealpha
+[0.0.17-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.16-prealpha...v0.0.17-prealpha
+[0.0.16-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.15-prealpha...v0.0.16-prealpha
+[0.0.15-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.14-prealpha...v0.0.15-prealpha
+[0.0.14-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.13-prealpha...v0.0.14-prealpha
+[0.0.13-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.12-prealpha...v0.0.13-prealpha
+[0.0.12-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.11-prealpha...v0.0.12-prealpha
+[0.0.11-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.10-prealpha...v0.0.11-prealpha
+[0.0.10-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.9-prealpha...v0.0.10-prealpha
+[0.0.9-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.8-prealpha...v0.0.9-prealpha
+[0.0.8-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.7-prealpha...v0.0.8-prealpha
+[0.0.7-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.6-prealpha...v0.0.7-prealpha
+[0.0.6-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.5-prealpha...v0.0.6-prealpha
+[0.0.5-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.4-prealpha...v0.0.5-prealpha
+[0.0.4-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.3-prealpha...v0.0.4-prealpha
+[0.0.3-prealpha]: https://github.com/jasongdove/ErsatzTV/compare/v0.0.1-prealpha...v0.0.3-prealpha
+[0.0.1-prealpha]: https://github.com/jasongdove/ErsatzTV/releases/tag/v0.0.1-prealpha