yorickr/plezy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(emby): add Emby as a MediaBrowser backend alongside Jellyfin

Browse Source 
Emby is Jellyfin's upstream ancestor and speaks a near-identical MediaBrowser
API, so the existing Jellyfin stack is parameterised by a `MediaBrowserDialect`
rather than forked. `JellyfinClient`, its auth service, endpoint discovery, LAN
discovery, and the add/edit connection screens all take the dialect and keep one
implementation; `MediaBackend.emby` and `ConnectionKind.emby` carry it through
the neutral models, the Drift `kind` discriminator, downloads, and caches.

Every divergence below was measured against a live Emby 4.9.5 server, not
inferred from documentation, and each is documented at its capability getter.
Jellyfin's request strings stay byte-identical so nothing about its behaviour
changes.

Routes and auth
- Emby only accepts the pre-10.9 user-scoped item routes (`/Users/{id}/Items/…`,
  `/Users/{id}/PlayedItems/…`, `/Users/{id}/FavoriteItems/…`); the unprefixed
  forms Jellyfin 10.11 added return 404.
- The API is also served under a legacy `/emby` prefix, and both dialects accept
  the token as `X-Emby-Token` or `api_key=`.
- Emby answers only its own LAN discovery datagram ("who is EmbyServer?") and
  ignores Jellyfin's; its default HTTPS port is 8920.
- No `/QuickConnect` route exists, so Quick Connect stays Jellyfin-only.

Row fields Emby withholds
- `ProductionYear`, `OfficialRating`, `PremiereDate` and `DateCreated` are absent
  from list rows unless named in `Fields`, which would otherwise strip the year
  and age-rating badge from every card in the app.
- `UserData.LastPlayedDate` never appears on a list row under `Fields=UserData`,
  `EnableUserData=true` or the user-scoped `Ids=` form — only on the single-item
  detail route, or when the Emby-specific `UserDataLastPlayedDate` token is
  requested. Without it every recency-ordered surface silently degrades to
  library-add time, and `JellyfinApiCache.applyWatchState` stamps
  `DateTime.now()` on watched rows, so an offline watch-state pull would rewrite
  the cached play time of everything it walked.

Continue Watching and Next Up
- Emby computes Next Up per series only: the library-wide `/Shows/NextUp` query
  returns nothing under every parameter combination tried. The shelf is
  therefore reconstructed from a played-episode recency scan plus one
  `/Shows/NextUp?SeriesId=` per distinct series, bounded by a shared wall clock
  that covers the scan as well — per-request timeouts cannot bound the pass
  because `MediaServerHttpClient` times the connect and receive phases
  independently. Rows are stamped with their series' newest play from the same
  response that ordered them, so no per-series enrichment request is needed.
- `/Shows/NextUp` ignores `NextUpDateCutoff`, and no server-side played-date
  filter exists to delegate to (`MinDatePlayed` and `MinDateLastPlayed` are
  ignored; `MinDateLastSaved`, `MinDateCreated` and `MinPremiereDate` filter
  unrelated dates), so the 365-day window is applied to the scanned dates.
- The resume route returns items with no saved position, including plain next
  episodes, so the Emby resume leg reads from `/Items?Filters=IsResumable`.
- Emby is ahead of Jellyfin in one place: `/Users/{id}/Items/{id}/HideFromResume`
  makes Continue Watching removal a real capability.

Everything else
- `/Sessions/Playing` and `/Sessions/Playing/Progress` reject a body with no
  `PlaySessionId` (HTTP 400), so playback reporting always sends one.
- Passing any `MediaTypes` value to the playlist query returns an empty list.
- There is no aggregate `/Items/Filters` route; the four filter facets are
  reassembled from `/Genres`, `/OfficialRatings`, `/Studios` and `/Tags`.
- Metadata writes take name-pair lists (`Genres: [{'Name': 'Action'}]`); the
  plain string array is accepted and then silently discarded.
- Custom artwork uploads must be base64 text, not raw bytes — which was broken
  for Jellyfin too and is fixed for both.
- Trickplay, media segments and lyrics 404 on Emby, so scrub previews are absent
  and intro/credit markers fall back to chapter names.

Verified against a local Emby 4.9.5 and a Jellyfin 10.11.11 control server:
onboarding, browse, detail, playable stream URLs serving real bytes, subtitle
sidecars, watch-state write and restore, hubs, cross-server aggregation and
search across both backends simultaneously.
This commit is contained in:
edde746
2026-08-05 06:09:26 +02:00
parent f36e20bcad
commit 05fd622968
128 changed files with 4917 additions and 1429 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/services/jellyfin_lan_discovery_service_test.dart
+52 -5
View File
@@ -2,6 +2,7 @@ import 'dart:convert';
import 'dart:io';
import 'package:flutter_test/flutter_test.dart';
import 'package:plezy/media/media_browser_dialect.dart';
import 'package:plezy/services/jellyfin_lan_discovery_service.dart';
import 'package:plezy/utils/udp_broadcast_sockets.dart';
@@ -10,40 +11,86 @@ void main() {
test('parses Jellyfin UDP discovery responses', () {
final server = JellyfinLanDiscoveryService.parseDiscoveryResponse(
utf8.encode(jsonEncode({'Address': 'http://192.168.1.20:8096/', 'Id': 'srv-1', 'Name': 'Home'})),
dialect: MediaBrowserDialect.jellyfin,
);
expect(server, isNotNull);
expect(server!.address, 'http://192.168.1.20:8096');
expect(server.id, 'srv-1');
expect(server.name, 'Home');
expect(server.dialect, MediaBrowserDialect.jellyfin);
});
test('stamps the asked-for dialect onto an Emby reply', () {
// Emby 4.9.5 answers `who is EmbyServer?` with the same three keys, so
// the dialect can only come from which payload was sent.
final server = JellyfinLanDiscoveryService.parseDiscoveryResponse(
utf8.encode(jsonEncode({'Address': 'http://127.0.0.1:8096', 'Id': 'emby-1', 'Name': '7befeeb2e8c9'})),
dialect: MediaBrowserDialect.emby,
);
expect(server?.dialect, MediaBrowserDialect.emby);
expect(server?.address, 'http://127.0.0.1:8096');
expect(server?.name, '7befeeb2e8c9');
});
test('does not expand bare discovery addresses while parsing', () {
final server = JellyfinLanDiscoveryService.parseDiscoveryResponse(
utf8.encode(jsonEncode({'Address': '192.168.1.20', 'Id': 'srv-1', 'Name': 'Home'})),
dialect: MediaBrowserDialect.jellyfin,
);
expect(server?.address, '192.168.1.20');
});
test('ignores malformed discovery responses', () {
expect(JellyfinLanDiscoveryService.parseDiscoveryResponse(utf8.encode('not json')), isNull);
expect(
JellyfinLanDiscoveryService.parseDiscoveryResponse(utf8.encode(jsonEncode({'Address': 'http://x'}))),
JellyfinLanDiscoveryService.parseDiscoveryResponse(
utf8.encode('not json'),
dialect: MediaBrowserDialect.jellyfin,
),
isNull,
);
expect(
JellyfinLanDiscoveryService.parseDiscoveryResponse(
utf8.encode(jsonEncode({'Address': 'http://x'})),
dialect: MediaBrowserDialect.jellyfin,
),
isNull,
);
});
test('sorts discovered servers deterministically', () {
final sorted = JellyfinLanDiscoveryService.sortDiscoveredServers([
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-2', name: 'Home'),
DiscoveredJellyfinServer(address: 'http://192.168.1.10:8096', id: 'srv-3', name: 'Office'),
DiscoveredJellyfinServer(address: 'http://192.168.1.20:8096', id: 'srv-1', name: 'Home'),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-2',
name: 'Home',
dialect: MediaBrowserDialect.jellyfin,
),
DiscoveredJellyfinServer(
address: 'http://192.168.1.10:8096',
id: 'srv-3',
name: 'Office',
dialect: MediaBrowserDialect.jellyfin,
),
DiscoveredJellyfinServer(
address: 'http://192.168.1.20:8096',
id: 'srv-1',
name: 'Home',
dialect: MediaBrowserDialect.emby,
),
]);
expect(sorted.map((server) => server.id), ['srv-1', 'srv-2', 'srv-3']);
});
test('discovery messages are the two distinct measured payloads', () {
expect(MediaBrowserDialect.jellyfin.lanDiscoveryMessage, 'who is JellyfinServer?');
expect(MediaBrowserDialect.emby.lanDiscoveryMessage, 'who is EmbyServer?');
expect(JellyfinLanDiscoveryService.discoveryPort, 7359);
});
test('listenDatagrams receives queued loopback datagrams', () async {
final receiver = await RawDatagramSocket.bind(InternetAddress.loopbackIPv4, 0);
final sender = await RawDatagramSocket.bind(InternetAddress.loopbackIPv4, 0);