Compare commits

..
39 changed files with 410 additions and 603 deletions

No files matched your search

+2 -2
View File
@@ -59,8 +59,8 @@ func runShadow[T any](op, path string, goLatency time.Duration, fast T, legacy L
ffStart := time.Now()
legacyVal, ffOK := legacy()
ffLatency := time.Since(ffStart)
shadowLogf("go-media shadow %s for %s: go-media=%.2fms legacy(ffmpeg/dhowden)=%.2fms diff(go-legacy)=%+.2fms",
op, path, ms(goLatency), ms(ffLatency), ms(goLatency)-ms(ffLatency))
shadowLogf("go-media shadow %s for %s: go-media=%.2fms legacy(ffmpeg/dhowden)=%.2fms diff(legacy-go)=%+.2fms legacy_ok=%t",
op, path, ms(goLatency), ms(ffLatency), ms(ffLatency)-ms(goLatency), ffOK)
if !ffOK {
// go-media read the file but the legacy path failed. That is an outcome
+10 -20
View File
@@ -14,21 +14,14 @@ const (
var (
mediaSettingsMu sync.RWMutex
mediaSettingsDefault settings.FullAdminMedia
mediaSettingsDefault settings.MediaSettings
)
// saveMediaSettings is the only write path for media settings. It clears derived
// fields (EnabledProfiles, ImagePreview) so read-time values are never persisted.
func saveMediaSettings(key string, ms settings.FullAdminMedia) error {
settings.ClearMediaDerived(&ms)
return sqlDb.SaveSetting(key, ms)
}
// InitMediaSettings loads persisted runtime media settings from SQLite and seeds from config when missing.
func InitMediaSettings() error {
if _, err := sqlDb.GetSetting(mediaSettingsDefaultKey); err != nil {
seed := settings.SanitizeMediaSettings(settings.CurrentMediaSettings())
if saveErr := saveMediaSettings(mediaSettingsDefaultKey, seed); saveErr != nil {
if saveErr := sqlDb.SaveSetting(mediaSettingsDefaultKey, seed); saveErr != nil {
return fmt.Errorf("seed media settings: %w", saveErr)
}
}
@@ -50,7 +43,7 @@ func InitMediaSettings() error {
// sanitize, so clamps (e.g. the readRate floor) must run again.
overlaid = settings.SanitizeMediaSettings(overlaid)
if !settings.MediaSettingsEqual(loaded, overlaid) {
if saveErr := saveMediaSettings(mediaSettingsDefaultKey, overlaid); saveErr != nil {
if saveErr := sqlDb.SaveSetting(mediaSettingsDefaultKey, overlaid); saveErr != nil {
return fmt.Errorf("save config-synced media settings: %w", saveErr)
}
loaded = overlaid
@@ -64,22 +57,22 @@ func InitMediaSettings() error {
return nil
}
func loadMediaSettingsSetting(key string) (settings.FullAdminMedia, error) {
func loadMediaSettingsSetting(key string) (settings.MediaSettings, error) {
raw, err := sqlDb.GetSetting(key)
if err != nil {
return settings.FullAdminMedia{}, err
return settings.MediaSettings{}, err
}
var ms settings.FullAdminMedia
var ms settings.MediaSettings
if err := json.Unmarshal(raw, &ms); err != nil {
return settings.FullAdminMedia{}, fmt.Errorf("parse %s: %w", key, err)
return settings.MediaSettings{}, fmt.Errorf("parse %s: %w", key, err)
}
return ms, nil
}
// GetMediaSettings returns the stored runtime media settings. The value is deep-copied
// GetMediaSettings returns the runtime media settings. The value is deep-copied
// so callers cannot mutate the stored settings (or the live config they are
// applied to) through the conversion maps.
func GetMediaSettings() settings.FullAdminMedia {
func GetMediaSettings() settings.MediaSettings {
mediaSettingsMu.RLock()
defer mediaSettingsMu.RUnlock()
return settings.CloneMediaSettings(mediaSettingsDefault)
@@ -97,11 +90,8 @@ func PatchMediaSettings(patchJSON []byte) error {
return mergeErr
}
merged = settings.SanitizeMediaSettings(merged)
// A patch may echo derived fields back (e.g. imagePreview from the admin UI).
// Clear them before the value reaches memory or the database.
settings.ClearMediaDerived(&merged)
if saveErr := saveMediaSettings(mediaSettingsDefaultKey, merged); saveErr != nil {
if saveErr := sqlDb.SaveSetting(mediaSettingsDefaultKey, merged); saveErr != nil {
mediaSettingsMu.Unlock()
return fmt.Errorf("save media settings: %w", saveErr)
}
@@ -1,7 +1,6 @@
package state
import (
"encoding/json"
"testing"
"github.com/gtsteffaniak/filebrowser/backend/pkg/settings"
@@ -35,56 +34,6 @@ func TestGetMediaSettingsReturnsIndependentCopy(t *testing.T) {
}
}
// Derived read-time values must never reach the database, even when a caller
// passes a struct that has them populated.
func TestSaveMediaSettingsNeverPersistsDerivedFields(t *testing.T) {
initSidebarLinkTestDB(t)
ms := GetMediaSettings()
ms.Transcode.EnabledProfiles = []string{"quality"}
ms.ImagePreview = map[settings.ImagePreviewType]bool{settings.JPEGImagePreview: true}
if err := saveMediaSettings(mediaSettingsDefaultKey, ms); err != nil {
t.Fatalf("saveMediaSettings: %v", err)
}
raw, err := sqlDb.GetSetting(mediaSettingsDefaultKey)
if err != nil {
t.Fatalf("GetSetting: %v", err)
}
var stored map[string]any
if err := json.Unmarshal(raw, &stored); err != nil {
t.Fatalf("decode stored settings: %v", err)
}
transcode, ok := stored["transcode"].(map[string]any)
if !ok {
t.Fatalf("stored transcode = %T, want object", stored["transcode"])
}
if _, ok := transcode["enabledProfiles"]; ok {
t.Fatal("enabledProfiles (derived) was persisted")
}
if _, ok := stored["imagePreview"]; ok {
t.Fatal("imagePreview (derived) was persisted")
}
}
// The admin UI echoes its whole payload back on PATCH, derived fields included.
// Those must be dropped before the value reaches memory, not only before the database.
func TestPatchMediaSettingsDropsEchoedDerivedFields(t *testing.T) {
initSidebarLinkTestDB(t)
patch := []byte(`{"imagePreview":{"jpeg":true},"transcode":{"enabledProfiles":["quality"]}}`)
if err := PatchMediaSettings(patch); err != nil {
t.Fatalf("PatchMediaSettings: %v", err)
}
got := GetMediaSettings()
if got.ImagePreview != nil {
t.Fatal("echoed imagePreview stayed in memory")
}
if got.Transcode.EnabledProfiles != nil {
t.Fatal("echoed enabledProfiles stayed in memory")
}
}
// A fresh install seeds the stored media settings from config.
func TestMediaSettingsSeedFromConfigOnFirstInit(t *testing.T) {
initSidebarLinkTestDB(t)
@@ -4,7 +4,6 @@ import (
"encoding/json"
"net/http"
"net/http/httptest"
"sort"
"testing"
"github.com/gtsteffaniak/filebrowser/backend/internal/database/users"
@@ -20,13 +19,11 @@ func withMediaHandlerSettings(t *testing.T) {
settings.Env.FFmpegAvailable = originalFFmpeg
})
settings.Env.FFmpegAvailable = true
settings.Config.Integrations.Media.Transcode = settings.FullAdminTranscode{
UserTranscode: settings.UserTranscode{
Enabled: true,
MaxConcurrentPerUser: 2,
},
MaxConcurrent: 3,
Profiles: settings.DefaultTranscodeProfiles(),
settings.Config.Integrations.Media.Transcode = settings.MediaTranscode{
Enabled: true,
MaxConcurrent: 3,
MaxConcurrentPerUser: 2,
Profiles: settings.DefaultTranscodeProfiles(),
}
}
@@ -55,99 +52,52 @@ func callMediaGet(t *testing.T, admin bool) map[string]any {
return body
}
// objectField returns obj[key] as a JSON object, failing the test if it is missing or not an object.
func objectField(t *testing.T, obj map[string]any, key string) map[string]any {
t.Helper()
child, ok := obj[key].(map[string]any)
if !ok {
t.Fatalf("%s is %T, want object", key, obj[key])
}
return child
}
// keysOf returns the sorted keys of a JSON object.
func keysOf(obj map[string]any) []string {
keys := make([]string, 0, len(obj))
for k := range obj {
keys = append(keys, k)
}
sort.Strings(keys)
return keys
}
func assertKeys(t *testing.T, path string, got []string, want []string) {
t.Helper()
sort.Strings(want)
if len(got) != len(want) {
t.Fatalf("%s keys = %v, want %v", path, got, want)
}
for i := range got {
if got[i] != want[i] {
t.Fatalf("%s keys = %v, want %v", path, got, want)
}
}
}
// Non-admin users receive exactly the PUBLIC payload. Any new key fails this test,
// which forces a conscious decision about whether it belongs in UserMedia.
// Non-admin users must be able to read the effective media values for the
// player, but only the player-relevant subset.
func TestSettingsMediaHandlerPlayerPayloadForNonAdmin(t *testing.T) {
withMediaHandlerSettings(t)
body := callMediaGet(t, false)
assertKeys(t, "top-level", keysOf(body), []string{"transcode", "imagePreview"})
transcode := objectField(t, body, "transcode")
assertKeys(t, "transcode", keysOf(transcode), []string{"enabled", "maxConcurrentPerUser", "enabledProfiles"})
if enabled, ok := transcode["enabled"].(bool); !ok || !enabled {
t.Fatalf("transcode.enabled = %v, want true", transcode["enabled"])
if _, ok := body["transcode"]; ok {
t.Fatal("non-admin must not receive the full transcode settings")
}
if limit, ok := transcode["maxConcurrentPerUser"].(float64); !ok || limit != 2 {
t.Fatalf("transcode.maxConcurrentPerUser = %v, want 2", transcode["maxConcurrentPerUser"])
if _, ok := body["lockedFromConfigPaths"]; ok {
t.Fatal("non-admin must not receive config lock metadata")
}
profiles, ok := transcode["enabledProfiles"].([]any)
if _, ok := body["lockMessage"]; ok {
t.Fatal("non-admin must not receive the config lock message")
}
if enabled, ok := body["enabled"].(bool); !ok || !enabled {
t.Fatalf("enabled = %v, want true", body["enabled"])
}
if limit, ok := body["maxConcurrentPerUser"].(float64); !ok || limit != 2 {
t.Fatalf("maxConcurrentPerUser = %v, want 2", body["maxConcurrentPerUser"])
}
profiles, ok := body["profiles"].([]any)
if !ok || len(profiles) != 3 {
t.Fatalf("transcode.enabledProfiles = %v, want 3 enabled ids", transcode["enabledProfiles"])
t.Fatalf("profiles = %v, want 3 enabled ids", body["profiles"])
}
}
// Admins receive the full stored config. The keys shared with users must have the
// same names, so the admin payload is a strict superset of the user payload.
func TestSettingsMediaHandlerFullPayloadForAdmin(t *testing.T) {
withMediaHandlerSettings(t)
admin := callMediaGet(t, true)
user := callMediaGet(t, false)
// lockedFromConfigPaths is omitted when config pins nothing, so it is not required here.
for _, key := range []string{"transcode", "imagePreview", "convert", "debug", "hardwareAcceleration", "accelDevice"} {
if _, ok := admin[key]; !ok {
body := callMediaGet(t, true)
transcode, ok := body["transcode"].(map[string]any)
if !ok {
t.Fatalf("admin must receive the full transcode settings, got %T", body["transcode"])
}
if _, ok := transcode["profiles"].(map[string]any); !ok {
t.Fatalf("admin transcode payload must include profiles, got %v", transcode["profiles"])
}
// Admin payload exposes the full settings surface, not the player subset.
for _, key := range []string{"convert", "debug", "hardwareAcceleration"} {
if _, ok := body[key]; !ok {
t.Fatalf("admin payload missing %q", key)
}
}
if _, ok := admin["enabled"]; ok {
t.Fatal("admin payload must not repeat transcode.enabled at the top level")
}
adminTranscode := objectField(t, admin, "transcode")
for _, key := range []string{"maxConcurrent", "profiles", "cacheMaxSizeMB", "encoderBackend", "readRate"} {
if _, ok := adminTranscode[key]; !ok {
t.Fatalf("admin transcode missing %q", key)
}
}
if _, ok := adminTranscode["profiles"].(map[string]any); !ok {
t.Fatalf("admin transcode.profiles must be an object, got %T", adminTranscode["profiles"])
}
// Superset rule: every key a user receives must also exist for admins. Values may
// differ by design: admins see stored config (so the UI can save it back unchanged),
// users see effective values (for example enabled is false when ffmpeg is missing).
for key := range objectField(t, user, "transcode") {
if _, ok := adminTranscode[key]; !ok {
t.Fatalf("admin transcode missing shared key %q", key)
}
}
if admin["imagePreview"] == nil {
t.Fatal("imagePreview must be present for admins")
if _, ok := body["enabled"]; ok {
t.Fatal("the admin payload uses the full settings shape, not the player subset")
}
}
@@ -156,8 +106,8 @@ func TestSettingsMediaHandlerReflectsDisabledTranscode(t *testing.T) {
withMediaHandlerSettings(t)
settings.Config.Integrations.Media.Transcode.Enabled = false
transcode := objectField(t, callMediaGet(t, false), "transcode")
if enabled, ok := transcode["enabled"].(bool); !ok || enabled {
t.Fatalf("transcode.enabled = %v, want false", transcode["enabled"])
body := callMediaGet(t, false)
if enabled, ok := body["enabled"].(bool); !ok || enabled {
t.Fatalf("enabled = %v, want false", body["enabled"])
}
}
+28 -15
View File
@@ -455,26 +455,31 @@ func settingsShareDefaultsPatchHandler(w http.ResponseWriter, r *http.Request, d
// settingsMediaGetHandler returns the runtime media settings.
// @Summary Get runtime media settings
// @Description Returns the media settings the caller is allowed to see.
// @Description Admins get the full settings, including ffmpeg and hardware options, so they can edit them.
// @Description Everyone else gets a small read-only view: whether transcoding is on, how many
// @Description transcodes they can run at once, which quality presets are enabled, and which image
// @Description previews the server can generate. Keys in the view are the same for admins and users.
// @Description Admins receive the DB-backed media integration settings; every authenticated user
// @Description receives the player-relevant subset (transcode enabled, profiles, per-user limit).
// @Tags Settings
// @Produce json
// @Success 200 {object} mediaSettingsResponse "Media settings"
// @Router /api/settings/media [get]
// mediaSettingsResponse is the ADMIN ONLY media payload: the full stored settings
// (FullAdminMedia, which embeds the public UserTranscode fields) plus config-lock
// metadata and ffmpeg option lists. Non-admins never receive this type.
// mediaSettingsResponse is the runtime media settings plus config-lock metadata.
type mediaSettingsResponse struct {
settings.FullAdminMedia
settings.MediaSettings
LockedFromConfigPaths []string `json:"lockedFromConfigPaths,omitempty"`
LockMessage string `json:"lockMessage,omitempty"`
AccelDeviceOptions []ffmpeg.AccelDeviceOption `json:"accelDeviceOptions,omitempty"`
EncoderBackendOptions []ffmpeg.EncoderBackendOption `json:"encoderBackendOptions,omitempty"`
}
// mediaPlayerSettings is the player-relevant subset of the runtime media
// settings. It is safe to expose to any authenticated user so the player can
// reflect admin changes without a page reload.
type mediaPlayerSettings struct {
Enabled bool `json:"enabled"`
Profiles []string `json:"profiles"`
MaxConcurrentPerUser int `json:"maxConcurrentPerUser"`
HardwareAcceleration bool `json:"hardwareAcceleration"`
}
func mediaSettingsLockMeta() (paths []string, message string) {
paths = settings.ConfigSpecifiedMediaPaths()
if len(paths) == 0 {
@@ -487,14 +492,11 @@ func mediaSettingsLockMeta() (paths []string, message string) {
// metadata, subtitles, and video thumbnails without it. ffmpeg-only controls
// (transcoding, hardware acceleration) report their own availability.
func settingsMediaGetHandler(w http.ResponseWriter, r *http.Request, d *Context) (int, error) {
// PUBLIC payload: non-admins get only what the player and general UI read.
if !d.User.Permissions.Admin {
return RenderJSON(w, r, settings.CurrentUserMedia())
return RenderJSON(w, r, currentMediaPlayerSettings())
}
// ADMIN payload: full stored settings with effective and derived values filled in
// by PrepMediaForFrontend (a read-only copy; never saved).
media := settings.PrepMediaForFrontend(state.GetMediaSettings())
lockedPaths, lockMessage := mediaSettingsLockMeta()
media := state.GetMediaSettings()
svc := ffmpeg.Get()
var accelDeviceOptions []ffmpeg.AccelDeviceOption
var encoderBackendOptions []ffmpeg.EncoderBackendOption
@@ -504,7 +506,7 @@ func settingsMediaGetHandler(w http.ResponseWriter, r *http.Request, d *Context)
encoderBackendOptions = svc.EncoderBackendOptions()
}
return RenderJSON(w, r, mediaSettingsResponse{
FullAdminMedia: media,
MediaSettings: media,
LockedFromConfigPaths: lockedPaths,
LockMessage: lockMessage,
AccelDeviceOptions: accelDeviceOptions,
@@ -512,6 +514,17 @@ func settingsMediaGetHandler(w http.ResponseWriter, r *http.Request, d *Context)
})
}
// currentMediaPlayerSettings reads the live media settings for the player UI.
func currentMediaPlayerSettings() mediaPlayerSettings {
media := state.GetMediaSettings()
return mediaPlayerSettings{
Enabled: settings.TranscodeEnabled(),
Profiles: settings.EnabledTranscodeProfiles(),
MaxConcurrentPerUser: settings.TranscodeMaxConcurrentPerUser(),
HardwareAcceleration: media.HardwareAcceleration,
}
}
// settingsMediaPatchHandler merges a partial update into the runtime media settings.
// @Summary Update runtime media settings
// @Description Merges a partial JSON patch into the DB-backed media settings and applies them at runtime.
+9 -10
View File
@@ -151,14 +151,7 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *requestCont
externalLinks = newExternalLinks
}
// Single source for the instance default dark mode. It drives the server-rendered
// <html> class (htmlVars.defaultDarkMode), the theme-color meta, and globalVars.darkMode,
// so the first paint and the SPA agree.
defaultDark := settings.DefaultDarkMode()
defaultThemeColor := settings.Config.Frontend.Styling.LightBackground
if defaultDark {
defaultThemeColor = settings.Config.Frontend.Styling.DarkBackground
}
defaultThemeColor := settings.DefaultBackgroundColor()
staticURL := settings.Config.Http.BaseURL + "public/static"
description := settings.Config.Frontend.Description
title := settings.Config.Frontend.Name
@@ -257,7 +250,7 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *requestCont
"title": title,
"customCSS": template.CSS(settings.Config.Frontend.Styling.CustomCSSRaw),
"userSelectedTheme": template.CSS(userSelectedTheme),
"defaultDarkMode": defaultDark,
"defaultDarkMode": settings.DefaultDarkMode(),
"lightBackground": settings.Config.Frontend.Styling.LightBackground,
"darkBackground": settings.Config.Frontend.Styling.DarkBackground,
"staticURL": staticURL,
@@ -286,7 +279,7 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *requestCont
"minSearchLength": settings.Config.Server.MinSearchLength,
"searchResultsLimit": settings.Config.Server.SearchResultsLimit,
"disableExternal": settings.Config.Frontend.DisableDefaultLinks,
"darkMode": defaultDark,
"darkMode": settings.Config.UserDefaults.UI.DarkMode,
"singleClick": settings.Config.UserDefaults.Listing.SingleClick,
"lightBackground": settings.Config.Frontend.Styling.LightBackground,
"darkBackground": settings.Config.Frontend.Styling.DarkBackground,
@@ -306,10 +299,16 @@ func handleWithStaticData(w http.ResponseWriter, r *http.Request, d *requestCont
"passwordMinLength": settings.PasswordMinLength(),
"ldapAvailable": settings.Config.Auth.Methods.LdapAuth.Enabled,
"ffmpegAvailable": settings.FFmpegEnabled(),
"hardwareAccelerationAvailable": settings.HardwareAccelerationSupported(),
"transcodeEnabled": settings.TranscodeEnabled(),
"transcodeProfiles": settings.EnabledTranscodeProfiles(),
"transcodeMaxPerUser": settings.TranscodeMaxConcurrentPerUser(),
"docPreviewExtensions": iteminfo.DocPreviewExtensionsForSPA(),
"updateAvailable": utils.GetUpdateAvailableUrl(),
"disableNavButtons": disableNavButtons,
"userSelectableThemes": settings.Config.Frontend.Styling.CustomThemeOptions,
"enableHeicConversion": settings.CanConvertImage("heic"),
"enableJxlConversion": settings.CanConvertImage("jxl"),
"eventBasedThemes": !settings.Config.Frontend.Styling.DisableEventBasedThemes,
"loginIcon": loginIcon,
"disableSidebar": disableSidebar,
@@ -33,7 +33,7 @@ func TestTranscodeManagerIsWiredWithoutFFmpeg(t *testing.T) {
// Startup with ffmpeg missing and transcoding disabled.
settings.Env.FFmpegAvailable = false
disabled := originalMedia
disabled.Transcode = settings.FullAdminTranscode{UserTranscode: settings.UserTranscode{Enabled: false}}
disabled.Transcode = settings.MediaTranscode{Enabled: false}
settings.ApplyMediaSettings(disabled)
setupTestEnv(t)
+9 -11
View File
@@ -428,7 +428,7 @@ const (
// clampTranscodeReadRate enforces throttled producers: unset or sub-realtime
// read rates are raised, so a producer is never left unthrottled. Burst and
// catch-up pacing are left to ffmpeg's defaults.
func clampTranscodeReadRate(t *FullAdminTranscode) {
func clampTranscodeReadRate(t *MediaTranscode) {
if t.ReadRate <= 0 {
t.ReadRate = defaultTranscodeReadRate
} else if t.ReadRate < minTranscodeReadRate {
@@ -1073,16 +1073,14 @@ func SetDefaults(generate bool) Settings {
for _, t := range AllVideoPreviewTypes {
s.Integrations.Media.Convert.VideoPreview[t] = boolPtr(true)
}
s.Integrations.Media.Transcode = FullAdminTranscode{
UserTranscode: UserTranscode{
Enabled: false,
MaxConcurrentPerUser: 1,
},
MaxConcurrent: 2,
CacheMaxSizeMB: 10240,
CacheRetentionH: 24,
ReadRate: defaultTranscodeReadRate,
Profiles: DefaultTranscodeProfiles(),
s.Integrations.Media.Transcode = MediaTranscode{
Enabled: false,
MaxConcurrent: 2,
MaxConcurrentPerUser: 1,
CacheMaxSizeMB: 10240,
CacheRetentionH: 24,
ReadRate: defaultTranscodeReadRate,
Profiles: DefaultTranscodeProfiles(),
}
// Hardware acceleration is opt-out: "auto" lets go-ffmpeg follow its device
// hierarchy (integrated GPU, discrete GPU, then software).
+1 -1
View File
@@ -331,7 +331,7 @@ func TestGenerateConfigYaml_IntegrationTest(t *testing.T) {
showComments: false,
showFull: true,
filterDeprecated: false,
expectSecret: true, // secrets should be hidden
expectSecret: true, // secrets should be hidden
expectDeprecated: false,
expectFull: true, // all fields shown
expectComments: false, // no comments
+2 -2
View File
@@ -68,14 +68,14 @@ func MediaPatchJSONForPaths(source any, paths []string) ([]byte, error) {
// ApplyConfigSpecifiedPathsToMedia overlays config media values onto stored settings for the
// paths the config file pins, so a config value always wins over the stored one.
func ApplyConfigSpecifiedPathsToMedia(stored FullAdminMedia, config Media) (FullAdminMedia, error) {
func ApplyConfigSpecifiedPathsToMedia(stored MediaSettings, config Media) (MediaSettings, error) {
paths := ConfigSpecifiedMediaPaths()
if len(paths) == 0 {
return stored, nil
}
patchJSON, err := MediaPatchJSONForPaths(config, paths)
if err != nil {
return FullAdminMedia{}, err
return MediaSettings{}, err
}
if len(patchJSON) == 0 || string(patchJSON) == "{}" || string(patchJSON) == "null" {
return stored, nil
@@ -60,11 +60,11 @@ func TestValidateMediaPatchNotConfigLockedWithoutLocks(t *testing.T) {
func TestApplyConfigSpecifiedPathsToMedia(t *testing.T) {
withConfigMediaPaths(t, "hardwareAcceleration", "transcode.profiles.datasaver.avgBitrateKbps")
stored := FullAdminMedia{
stored := MediaSettings{
Debug: true,
HardwareAcceleration: true,
Transcode: FullAdminTranscode{
UserTranscode: UserTranscode{Enabled: true},
Transcode: MediaTranscode{
Enabled: true,
Profiles: TranscodeProfiles{
DataSaver: TranscodeProfile{AvgBitrateKbps: 1500},
},
@@ -72,7 +72,7 @@ func TestApplyConfigSpecifiedPathsToMedia(t *testing.T) {
}
config := Media{
HardwareAcceleration: false,
Transcode: FullAdminTranscode{
Transcode: MediaTranscode{
Profiles: TranscodeProfiles{
DataSaver: TranscodeProfile{AvgBitrateKbps: 800},
},
@@ -97,7 +97,7 @@ func TestApplyConfigSpecifiedPathsToMedia(t *testing.T) {
func TestApplyConfigSpecifiedPathsToMediaNoLocks(t *testing.T) {
withConfigMediaPaths(t)
stored := FullAdminMedia{HardwareAcceleration: true}
stored := MediaSettings{HardwareAcceleration: true}
overlaid, err := ApplyConfigSpecifiedPathsToMedia(stored, Media{HardwareAcceleration: false})
if err != nil {
t.Fatalf("ApplyConfigSpecifiedPathsToMedia: %v", err)
+9 -9
View File
@@ -7,18 +7,18 @@ import (
)
// MergeMediaSettingsPatchJSON merges a partial JSON patch into base media settings.
func MergeMediaSettingsPatchJSON(base FullAdminMedia, patchJSON []byte) (FullAdminMedia, error) {
func MergeMediaSettingsPatchJSON(base MediaSettings, patchJSON []byte) (MediaSettings, error) {
baseBytes, err := json.Marshal(base)
if err != nil {
return FullAdminMedia{}, err
return MediaSettings{}, err
}
mergedBytes, err := mergeUserDefaultsJSON(baseBytes, patchJSON)
if err != nil {
return FullAdminMedia{}, err
return MediaSettings{}, err
}
var merged FullAdminMedia
var merged MediaSettings
if err := json.Unmarshal(mergedBytes, &merged); err != nil {
return FullAdminMedia{}, fmt.Errorf("unmarshal merged media settings: %w", err)
return MediaSettings{}, fmt.Errorf("unmarshal merged media settings: %w", err)
}
// An explicit accelDevice wins over the legacy hardwareAcceleration bool in
// the base settings, which would otherwise force the device back to software.
@@ -35,7 +35,7 @@ func MergeMediaSettingsPatchJSON(base FullAdminMedia, patchJSON []byte) (FullAdm
}
// MediaSettingsEqual reports whether two runtime media settings are equivalent.
func MediaSettingsEqual(a, b FullAdminMedia) bool {
func MediaSettingsEqual(a, b MediaSettings) bool {
ab, errA := json.Marshal(a)
bb, errB := json.Marshal(b)
if errA != nil || errB != nil {
@@ -46,7 +46,7 @@ func MediaSettingsEqual(a, b FullAdminMedia) bool {
// ApplyMediaSettingsIfChanged applies runtime media settings
// only when they actually differ. It never re-runs ffmpeg detection.
func ApplyMediaSettingsIfChanged(s FullAdminMedia) {
func ApplyMediaSettingsIfChanged(s MediaSettings) {
if MediaSettingsEqual(CurrentMediaSettings(), s) {
return
}
@@ -55,7 +55,7 @@ func ApplyMediaSettingsIfChanged(s FullAdminMedia) {
// CloneMediaSettings returns a deep copy of m — the conversion maps hold *bool
// values, so a shallow copy would alias the live config's reference state.
func CloneMediaSettings(m FullAdminMedia) FullAdminMedia {
func CloneMediaSettings(m MediaSettings) MediaSettings {
out := m
out.Convert = FfmpegConvert{
ImagePreview: cloneBoolMap(m.Convert.ImagePreview),
@@ -84,7 +84,7 @@ func cloneBoolPtr(v *bool) *bool {
}
// SanitizeMediaSettings clamps runtime media settings into supported ranges.
func SanitizeMediaSettings(m FullAdminMedia) FullAdminMedia {
func SanitizeMediaSettings(m MediaSettings) MediaSettings {
t := &m.Transcode
if t.MaxConcurrent < 1 {
t.MaxConcurrent = 2
+16 -15
View File
@@ -2,16 +2,17 @@ package settings
import "testing"
func testMediaSettings() FullAdminMedia {
return FullAdminMedia{
func testMediaSettings() MediaSettings {
return MediaSettings{
Debug: true,
HardwareAcceleration: true,
Transcode: FullAdminTranscode{
UserTranscode: UserTranscode{Enabled: true, MaxConcurrentPerUser: 1},
MaxConcurrent: 2,
CacheMaxSizeMB: 10240,
CacheRetentionH: 24,
Profiles: DefaultTranscodeProfiles(),
Transcode: MediaTranscode{
Enabled: true,
MaxConcurrent: 2,
MaxConcurrentPerUser: 1,
CacheMaxSizeMB: 10240,
CacheRetentionH: 24,
Profiles: DefaultTranscodeProfiles(),
},
}
}
@@ -53,11 +54,11 @@ func TestMergeMediaSettingsPatchJSONProfile(t *testing.T) {
}
func TestSanitizeMediaSettings(t *testing.T) {
in := FullAdminMedia{
Transcode: FullAdminTranscode{
UserTranscode: UserTranscode{MaxConcurrentPerUser: 0},
MaxConcurrent: -1,
CacheRetentionH: 0,
in := MediaSettings{
Transcode: MediaTranscode{
MaxConcurrent: -1,
MaxConcurrentPerUser: 0,
CacheRetentionH: 0,
Profiles: TranscodeProfiles{
Quality: TranscodeProfile{MaxResolution: -5, AvgBitrateKbps: -1},
},
@@ -115,10 +116,10 @@ func TestSanitizeMediaSettingsAccelDevice(t *testing.T) {
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
out := SanitizeMediaSettings(FullAdminMedia{
out := SanitizeMediaSettings(MediaSettings{
AccelDevice: tc.device,
HardwareAcceleration: tc.hwAccel,
Transcode: FullAdminTranscode{UserTranscode: UserTranscode{MaxConcurrentPerUser: 1}, MaxConcurrent: 1, CacheRetentionH: 1},
Transcode: MediaTranscode{MaxConcurrent: 1, MaxConcurrentPerUser: 1, CacheRetentionH: 1},
})
if out.AccelDevice != tc.wantDevice || out.HardwareAcceleration != tc.wantHW {
t.Fatalf("accelDevice = %q/%v, want %q/%v", out.AccelDevice, out.HardwareAcceleration, tc.wantDevice, tc.wantHW)
+9 -55
View File
@@ -209,10 +209,8 @@ func TranscodeCacheRetention() time.Duration {
return time.Duration(h) * time.Hour
}
// CurrentMediaSettings returns the stored runtime media settings (excluding ffmpegPath).
// Derived fields (ImagePreview, EnabledProfiles) are not populated; use CurrentFullAdminMedia
// or CurrentUserMedia for response payloads.
func CurrentMediaSettings() FullAdminMedia {
// CurrentMediaSettings returns the runtime media settings (excluding ffmpegPath).
func CurrentMediaSettings() MediaSettings {
mediaMu.RLock()
defer mediaMu.RUnlock()
return currentMediaSettingsLocked()
@@ -220,68 +218,24 @@ func CurrentMediaSettings() FullAdminMedia {
// currentMediaSettingsLocked snapshots the live media settings. Callers must hold
// mediaMu. The returned value is deep-copied so it cannot alias the live config.
func currentMediaSettingsLocked() FullAdminMedia {
func currentMediaSettingsLocked() MediaSettings {
m := Config.Integrations.Media
return CloneMediaSettings(FullAdminMedia{
return CloneMediaSettings(MediaSettings{
Convert: m.Convert,
Debug: m.Debug,
HardwareAcceleration: m.HardwareAcceleration,
AccelDevice: m.AccelDevice,
AlwaysUseFfmpeg: m.AlwaysUseFfmpeg,
AlwaysUseOnlyOffice: m.AlwaysUseOnlyOffice,
Transcode: m.Transcode,
AccelDevice: m.AccelDevice,
AlwaysUseFfmpeg: m.AlwaysUseFfmpeg,
AlwaysUseOnlyOffice: m.AlwaysUseOnlyOffice,
Transcode: m.Transcode,
})
}
// ImagePreviewAvailability resolves each supported image preview type to whether
// conversion is active right now, using the same check the preview pipeline uses.
func ImagePreviewAvailability() map[ImagePreviewType]bool {
out := make(map[ImagePreviewType]bool, len(AllImagePreviewTypes))
for _, t := range AllImagePreviewTypes {
out[t] = CanConvertImage(string(t))
}
return out
}
// CurrentUserMedia builds the PUBLIC media payload for non-admin users. Values come
// from the same accessors as the admin payload, so the shared fields always agree.
// The getters take mediaMu themselves, so they are called here without holding it.
func CurrentUserMedia() UserMedia {
return UserMedia{
Transcode: UserTranscode{
Enabled: TranscodeEnabled(),
MaxConcurrentPerUser: TranscodeMaxConcurrentPerUser(),
EnabledProfiles: EnabledTranscodeProfiles(),
},
ImagePreview: ImagePreviewAvailability(),
}
}
// PrepMediaForFrontend returns a read-only copy of m with derived values filled in,
// following PrepForFrontend in internal/web/users.go. The caller's value is not modified.
// Stored config (transcode.enabled, maxConcurrentPerUser) is deliberately NOT replaced
// with effective values: the admin UI edits these fields and sends them back, so they
// must stay the stored values. Only derived fields are filled.
// NEVER pass the result to SaveSetting without ClearMediaDerived first.
func PrepMediaForFrontend(m FullAdminMedia) FullAdminMedia {
m.Transcode.EnabledProfiles = EnabledTranscodeProfiles()
m.ImagePreview = ImagePreviewAvailability()
return m
}
// ClearMediaDerived zeroes the fields that PrepMediaForFrontend derives at read time so
// they are never written to the database. Enabled and MaxConcurrentPerUser are stored
// config and are not cleared here.
func ClearMediaDerived(m *FullAdminMedia) {
m.Transcode.EnabledProfiles = nil
m.ImagePreview = nil
}
// ApplyMediaSettings applies runtime media settings to the in-memory config.
// It never re-runs ffmpeg detection: codec/hardware detection happens exactly
// once at startup (InitFFmpeg). hardwareAcceleration is read live per transcode;
// ffmpegPath, accelDevice, debug and concurrency apply on the next restart.
func ApplyMediaSettings(s FullAdminMedia) {
func ApplyMediaSettings(s MediaSettings) {
mediaMu.Lock()
defer mediaMu.Unlock()
Config.Integrations.Media.Convert = s.Convert
+12 -11
View File
@@ -25,15 +25,16 @@ func TestMediaAccessorsReflectRuntimeSettings(t *testing.T) {
originalTranscode := Config.Integrations.Media.Transcode
t.Cleanup(func() { Config.Integrations.Media.Transcode = originalTranscode })
ApplyMediaSettings(FullAdminMedia{
ApplyMediaSettings(MediaSettings{
Debug: true,
HardwareAcceleration: true,
Transcode: FullAdminTranscode{
UserTranscode: UserTranscode{Enabled: true, MaxConcurrentPerUser: 2},
MaxConcurrent: 4,
CacheMaxSizeMB: 512,
CacheRetentionH: 6,
Profiles: DefaultTranscodeProfiles(),
Transcode: MediaTranscode{
Enabled: true,
MaxConcurrent: 4,
MaxConcurrentPerUser: 2,
CacheMaxSizeMB: 512,
CacheRetentionH: 6,
Profiles: DefaultTranscodeProfiles(),
},
})
@@ -66,7 +67,7 @@ func TestMediaAccessorsReflectRuntimeSettings(t *testing.T) {
func TestTranscodeAccessorsUseDefaultsWhenUnset(t *testing.T) {
withMediaConfig(t)
ApplyMediaSettings(FullAdminMedia{})
ApplyMediaSettings(MediaSettings{})
if got := TranscodeMaxConcurrent(); got != 2 {
t.Fatalf("TranscodeMaxConcurrent = %d, want the 2 default", got)
@@ -224,11 +225,11 @@ func TestMediaAccessorsAreRaceFree(t *testing.T) {
default:
}
enabled = !enabled
ApplyMediaSettings(FullAdminMedia{
ApplyMediaSettings(MediaSettings{
Debug: enabled,
HardwareAcceleration: enabled,
Transcode: FullAdminTranscode{
UserTranscode: UserTranscode{Enabled: enabled},
Transcode: MediaTranscode{
Enabled: enabled,
MaxConcurrent: 2,
Profiles: DefaultTranscodeProfiles(),
},
@@ -34,7 +34,7 @@ func TestSyncEnforcedSourcePermissionsOntoUser_skipsAdmin(t *testing.T) {
enforced := SourceFilePermissionsEnforcement{Create: true}
u := &users.User{
FrontendUser: users.FrontendUser{
Username: "admin",
Username: "admin",
Permissions: users.Permissions{Admin: true},
},
BackendScopes: []users.BackendScope{{
@@ -90,3 +90,4 @@ func TestValidateSelfUserUpdateScopesNotEnforced_caseInsensitive(t *testing.T) {
t.Fatal("expected mixed-case scope field to be blocked")
}
}
+29 -49
View File
@@ -175,63 +175,43 @@ type Media struct {
// The fields below are deprecated and migrated to runtime (DB-backed) media settings on
// first run. They are kept only to seed the database from an existing config.yaml.
Convert FfmpegConvert `json:"convert"` // deprecated: config for ffmpeg conversion settings. deprecated: manage via the admin media settings API
Debug bool `json:"debug"` // deprecated: output ffmpeg stdout for media integration. deprecated: manage via the admin media settings API
ExtractEmbeddedSubtitles bool `json:"extractEmbeddedSubtitles"` // deprecated: no longer configurable; embedded subtitles are always extracted
HardwareAcceleration bool `json:"hardwareAcceleration"` // deprecated: enable hardware acceleration for ffmpeg if available. deprecated: manage via the admin media settings API
Transcode FullAdminTranscode `json:"transcode"` // deprecated: HLS transcoding for media playback. deprecated: manage via the admin media settings API
Convert FfmpegConvert `json:"convert"` // deprecated: config for ffmpeg conversion settings. deprecated: manage via the admin media settings API
Debug bool `json:"debug"` // deprecated: output ffmpeg stdout for media integration. deprecated: manage via the admin media settings API
ExtractEmbeddedSubtitles bool `json:"extractEmbeddedSubtitles"` // deprecated: no longer configurable; embedded subtitles are always extracted
HardwareAcceleration bool `json:"hardwareAcceleration"` // deprecated: enable hardware acceleration for ffmpeg if available. deprecated: manage via the admin media settings API
Transcode MediaTranscode `json:"transcode"` // deprecated: HLS transcoding for media playback. deprecated: manage via the admin media settings API
// AccelDevice selects the acceleration device: "auto" (default), "software"/"cpu",
// "igpu", "dgpu", a Linux DRM render node (e.g. /dev/dri/renderD128), or a GPU
// name substring. Managed via the admin media settings API.
AccelDevice string `json:"accelDevice"` // deprecated: manage via the admin media settings API
AlwaysUseFfmpeg bool `json:"alwaysUseFfmpeg"` // deprecated: manage via the admin media settings API
AlwaysUseOnlyOffice bool `json:"alwaysUseOnlyOffice"` // deprecated: skip folio previews for office converter; manage via the admin media settings API
AccelDevice string `json:"accelDevice"` // deprecated: manage via the admin media settings API
AlwaysUseFfmpeg bool `json:"alwaysUseFfmpeg"` // deprecated: manage via the admin media settings API
AlwaysUseOnlyOffice bool `json:"alwaysUseOnlyOffice"` // deprecated: skip folio previews for office converter; manage via the admin media settings API
}
// FullAdminMedia holds every runtime (DB-backed) media integration setting.
// ADMIN ONLY: non-admins receive UserMedia instead. FfmpegPath is config-only and intentionally excluded.
// ImagePreview is derived at read time (see PrepMediaForFrontend) and is cleared before save.
type FullAdminMedia struct {
ImagePreview map[ImagePreviewType]bool `json:"imagePreview,omitempty"` // image formats that can be converted
Convert FfmpegConvert `json:"convert"` // config for ffmpeg conversion settings
Debug bool `json:"debug"` // output ffmpeg stdout for media integration -- careful can produces lots of output!
HardwareAcceleration bool `json:"hardwareAcceleration"` // enable hardware acceleration for ffmpeg if available
AccelDevice string `json:"accelDevice"` // acceleration device: "auto", "software"/"cpu", "igpu", "dgpu", a DRM render node, or a GPU name substring
AlwaysUseFfmpeg bool `json:"alwaysUseFfmpeg"` // skip the go-media fast path and use ffmpeg for all probe, metadata, subtitle, and thumbnail work (default: false)
AlwaysUseOnlyOffice bool `json:"alwaysUseOnlyOffice"` // skip folio document previews and use the office converter when configured (default: false)
Transcode FullAdminTranscode `json:"transcode"` // HLS transcoding for media playback
// MediaSettings holds the runtime (DB-backed) media integration settings.
// FfmpegPath is config-only and intentionally excluded.
type MediaSettings struct {
Convert FfmpegConvert `json:"convert"` // config for ffmpeg conversion settings
Debug bool `json:"debug"` // output ffmpeg stdout for media integration -- careful can produces lots of output!
HardwareAcceleration bool `json:"hardwareAcceleration"` // enable hardware acceleration for ffmpeg if available
AccelDevice string `json:"accelDevice"` // acceleration device: "auto", "software"/"cpu", "igpu", "dgpu", a DRM render node, or a GPU name substring
AlwaysUseFfmpeg bool `json:"alwaysUseFfmpeg"` // skip the go-media fast path and use ffmpeg for all probe, metadata, subtitle, and thumbnail work (default: false)
AlwaysUseOnlyOffice bool `json:"alwaysUseOnlyOffice"` // skip folio document previews and use the office converter when configured (default: false)
Transcode MediaTranscode `json:"transcode"` // HLS transcoding for media playback
}
// UserTranscode is PUBLIC: transcode fields every authenticated user receives in
// the UserMedia payload. FullAdminTranscode embeds it, so the same JSON keys appear
// in both admin and user responses. Add a field here only if the UI reads it.
type UserTranscode struct {
Enabled bool `json:"enabled"` // enable HLS transcoding for authenticated playback (default: false)
MaxConcurrentPerUser int `json:"maxConcurrentPerUser"` // hard per-user concurrent transcode ceiling (default: 1)
EnabledProfiles []string `json:"enabledProfiles,omitempty"` // derived at read time (player-menu profile ids); never stored
}
// UserMedia is PUBLIC: the only media payload non-admin users receive.
// Add a top-level key here only if the player or general UI reads it.
type UserMedia struct {
Transcode UserTranscode `json:"transcode"`
ImagePreview map[ImagePreviewType]bool `json:"imagePreview"` // availability, derived at read time
}
// FullAdminTranscode configures authenticated HLS transcoding (disabled by default).
// ADMIN ONLY beyond the embedded UserTranscode fields.
type FullAdminTranscode struct {
// inline: flattens the public fields in YAML (config.yaml) the same way the embed
// flattens them in JSON, so config keys stay transcode.enabled, not transcode.UserTranscode.enabled.
UserTranscode `yaml:",inline"`
MaxConcurrent int `json:"maxConcurrent"` // global concurrent transcode sessions (default: 2)
CacheMaxSizeMB int `json:"cacheMaxSizeMB"` // disk cache size limit in MB; 0 = unlimited (default: 10240)
CacheRetentionH int `json:"cacheRetentionH"` // completed cache retention in hours (default: 24)
Profiles TranscodeProfiles `json:"profiles"` // per-profile transcode settings shown in the player menu
MaxResolution int `json:"maxResolution"` // superseded by profiles.<name>.maxResolution. deprecated: kept for config compatibility
EncoderBackend string `json:"encoderBackend"` // default video encoder backend for transcodes: "" (auto), "cpu", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)
ReadRate float64 `json:"readRate"` // VOD producer input pacing in Nx realtime (-readrate); unset or <1 clamps to >=1 (default: 2)
// MediaTranscode configures authenticated HLS transcoding (disabled by default).
type MediaTranscode struct {
Enabled bool `json:"enabled"` // enable HLS transcoding for authenticated playback (default: false)
MaxConcurrent int `json:"maxConcurrent"` // global concurrent transcode sessions (default: 2)
MaxConcurrentPerUser int `json:"maxConcurrentPerUser"` // hard per-user concurrent transcode ceiling (default: 1)
CacheMaxSizeMB int `json:"cacheMaxSizeMB"` // disk cache size limit in MB; 0 = unlimited (default: 10240)
CacheRetentionH int `json:"cacheRetentionH"` // completed cache retention in hours (default: 24)
Profiles TranscodeProfiles `json:"profiles"` // per-profile transcode settings shown in the player menu
MaxResolution int `json:"maxResolution"` // superseded by profiles.<name>.maxResolution. deprecated: kept for config compatibility
EncoderBackend string `json:"encoderBackend"` // default video encoder backend for transcodes: "" (auto), "cpu", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)
ReadRate float64 `json:"readRate"` // VOD producer input pacing in Nx realtime (-readrate); unset or <1 clamps to >=1 (default: 2)
}
// TranscodeProfiles configures the player's transcode quality presets.
+48 -62
View File
@@ -6299,58 +6299,6 @@ const docTemplate = `{
}
}
},
"settings.FullAdminTranscode": {
"type": "object",
"properties": {
"cacheMaxSizeMB": {
"description": "disk cache size limit in MB; 0 = unlimited (default: 10240)",
"type": "integer"
},
"cacheRetentionH": {
"description": "completed cache retention in hours (default: 24)",
"type": "integer"
},
"enabled": {
"description": "enable HLS transcoding for authenticated playback (default: false)",
"type": "boolean"
},
"enabledProfiles": {
"description": "derived at read time (player-menu profile ids); never stored",
"type": "array",
"items": {
"type": "string"
}
},
"encoderBackend": {
"description": "default video encoder backend for transcodes: \"\" (auto), \"cpu\", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)",
"type": "string"
},
"maxConcurrent": {
"description": "global concurrent transcode sessions (default: 2)",
"type": "integer"
},
"maxConcurrentPerUser": {
"description": "hard per-user concurrent transcode ceiling (default: 1)",
"type": "integer"
},
"maxResolution": {
"description": "superseded by profiles.\u003cname\u003e.maxResolution. deprecated: kept for config compatibility",
"type": "integer"
},
"profiles": {
"description": "per-profile transcode settings shown in the player menu",
"allOf": [
{
"$ref": "#/definitions/settings.TranscodeProfiles"
}
]
},
"readRate": {
"description": "VOD producer input pacing in Nx realtime (-readrate); unset or \u003c1 clamps to \u003e=1 (default: 2)",
"type": "number"
}
}
},
"settings.Http": {
"type": "object",
"properties": {
@@ -6692,12 +6640,57 @@ const docTemplate = `{
"description": "deprecated: HLS transcoding for media playback. deprecated: manage via the admin media settings API",
"allOf": [
{
"$ref": "#/definitions/settings.FullAdminTranscode"
"$ref": "#/definitions/settings.MediaTranscode"
}
]
}
}
},
"settings.MediaTranscode": {
"type": "object",
"properties": {
"cacheMaxSizeMB": {
"description": "disk cache size limit in MB; 0 = unlimited (default: 10240)",
"type": "integer"
},
"cacheRetentionH": {
"description": "completed cache retention in hours (default: 24)",
"type": "integer"
},
"enabled": {
"description": "enable HLS transcoding for authenticated playback (default: false)",
"type": "boolean"
},
"encoderBackend": {
"description": "default video encoder backend for transcodes: \"\" (auto), \"cpu\", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)",
"type": "string"
},
"maxConcurrent": {
"description": "global concurrent transcode sessions (default: 2)",
"type": "integer"
},
"maxConcurrentPerUser": {
"description": "hard per-user concurrent transcode ceiling (default: 1)",
"type": "integer"
},
"maxResolution": {
"description": "superseded by profiles.\u003cname\u003e.maxResolution. deprecated: kept for config compatibility",
"type": "integer"
},
"profiles": {
"description": "per-profile transcode settings shown in the player menu",
"allOf": [
{
"$ref": "#/definitions/settings.TranscodeProfiles"
}
]
},
"readRate": {
"description": "VOD producer input pacing in Nx realtime (-readrate); unset or \u003c1 clamps to \u003e=1 (default: 2)",
"type": "number"
}
}
},
"settings.OidcConfig": {
"type": "object",
"properties": {
@@ -8949,7 +8942,7 @@ const docTemplate = `{
}
},
"web.mediaSettingsResponse": {
"description": "Returns the media settings the caller is allowed to see. Admins get the full settings, including ffmpeg and hardware options, so they can edit them. Everyone else gets a small read-only view: whether transcoding is on, how many transcodes they can run at once, which quality presets are enabled, and which image previews the server can generate. Keys in the view are the same for admins and users.",
"description": "Admins receive the DB-backed media integration settings; every authenticated user receives the player-relevant subset (transcode enabled, profiles, per-user limit).",
"type": "object",
"properties": {
"accelDevice": {
@@ -8992,13 +8985,6 @@ const docTemplate = `{
"description": "enable hardware acceleration for ffmpeg if available",
"type": "boolean"
},
"imagePreview": {
"description": "image formats that can be converted",
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"lockMessage": {
"type": "string"
},
@@ -9012,7 +8998,7 @@ const docTemplate = `{
"description": "HLS transcoding for media playback",
"allOf": [
{
"$ref": "#/definitions/settings.FullAdminTranscode"
"$ref": "#/definitions/settings.MediaTranscode"
}
]
}
+48 -62
View File
@@ -6288,58 +6288,6 @@
}
}
},
"settings.FullAdminTranscode": {
"type": "object",
"properties": {
"cacheMaxSizeMB": {
"description": "disk cache size limit in MB; 0 = unlimited (default: 10240)",
"type": "integer"
},
"cacheRetentionH": {
"description": "completed cache retention in hours (default: 24)",
"type": "integer"
},
"enabled": {
"description": "enable HLS transcoding for authenticated playback (default: false)",
"type": "boolean"
},
"enabledProfiles": {
"description": "derived at read time (player-menu profile ids); never stored",
"type": "array",
"items": {
"type": "string"
}
},
"encoderBackend": {
"description": "default video encoder backend for transcodes: \"\" (auto), \"cpu\", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)",
"type": "string"
},
"maxConcurrent": {
"description": "global concurrent transcode sessions (default: 2)",
"type": "integer"
},
"maxConcurrentPerUser": {
"description": "hard per-user concurrent transcode ceiling (default: 1)",
"type": "integer"
},
"maxResolution": {
"description": "superseded by profiles.\u003cname\u003e.maxResolution. deprecated: kept for config compatibility",
"type": "integer"
},
"profiles": {
"description": "per-profile transcode settings shown in the player menu",
"allOf": [
{
"$ref": "#/definitions/settings.TranscodeProfiles"
}
]
},
"readRate": {
"description": "VOD producer input pacing in Nx realtime (-readrate); unset or \u003c1 clamps to \u003e=1 (default: 2)",
"type": "number"
}
}
},
"settings.Http": {
"type": "object",
"properties": {
@@ -6681,12 +6629,57 @@
"description": "deprecated: HLS transcoding for media playback. deprecated: manage via the admin media settings API",
"allOf": [
{
"$ref": "#/definitions/settings.FullAdminTranscode"
"$ref": "#/definitions/settings.MediaTranscode"
}
]
}
}
},
"settings.MediaTranscode": {
"type": "object",
"properties": {
"cacheMaxSizeMB": {
"description": "disk cache size limit in MB; 0 = unlimited (default: 10240)",
"type": "integer"
},
"cacheRetentionH": {
"description": "completed cache retention in hours (default: 24)",
"type": "integer"
},
"enabled": {
"description": "enable HLS transcoding for authenticated playback (default: false)",
"type": "boolean"
},
"encoderBackend": {
"description": "default video encoder backend for transcodes: \"\" (auto), \"cpu\", or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)",
"type": "string"
},
"maxConcurrent": {
"description": "global concurrent transcode sessions (default: 2)",
"type": "integer"
},
"maxConcurrentPerUser": {
"description": "hard per-user concurrent transcode ceiling (default: 1)",
"type": "integer"
},
"maxResolution": {
"description": "superseded by profiles.\u003cname\u003e.maxResolution. deprecated: kept for config compatibility",
"type": "integer"
},
"profiles": {
"description": "per-profile transcode settings shown in the player menu",
"allOf": [
{
"$ref": "#/definitions/settings.TranscodeProfiles"
}
]
},
"readRate": {
"description": "VOD producer input pacing in Nx realtime (-readrate); unset or \u003c1 clamps to \u003e=1 (default: 2)",
"type": "number"
}
}
},
"settings.OidcConfig": {
"type": "object",
"properties": {
@@ -8938,7 +8931,7 @@
}
},
"web.mediaSettingsResponse": {
"description": "Returns the media settings the caller is allowed to see. Admins get the full settings, including ffmpeg and hardware options, so they can edit them. Everyone else gets a small read-only view: whether transcoding is on, how many transcodes they can run at once, which quality presets are enabled, and which image previews the server can generate. Keys in the view are the same for admins and users.",
"description": "Admins receive the DB-backed media integration settings; every authenticated user receives the player-relevant subset (transcode enabled, profiles, per-user limit).",
"type": "object",
"properties": {
"accelDevice": {
@@ -8981,13 +8974,6 @@
"description": "enable hardware acceleration for ffmpeg if available",
"type": "boolean"
},
"imagePreview": {
"description": "image formats that can be converted",
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"lockMessage": {
"type": "string"
},
@@ -9001,7 +8987,7 @@
"description": "HLS transcoding for media playback",
"allOf": [
{
"$ref": "#/definitions/settings.FullAdminTranscode"
"$ref": "#/definitions/settings.MediaTranscode"
}
]
}
+40 -53
View File
@@ -480,46 +480,6 @@ definitions:
styling:
$ref: '#/definitions/settings.StylingConfig'
type: object
settings.FullAdminTranscode:
properties:
cacheMaxSizeMB:
description: 'disk cache size limit in MB; 0 = unlimited (default: 10240)'
type: integer
cacheRetentionH:
description: 'completed cache retention in hours (default: 24)'
type: integer
enabled:
description: 'enable HLS transcoding for authenticated playback (default:
false)'
type: boolean
enabledProfiles:
description: derived at read time (player-menu profile ids); never stored
items:
type: string
type: array
encoderBackend:
description: 'default video encoder backend for transcodes: "" (auto), "cpu",
or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)'
type: string
maxConcurrent:
description: 'global concurrent transcode sessions (default: 2)'
type: integer
maxConcurrentPerUser:
description: 'hard per-user concurrent transcode ceiling (default: 1)'
type: integer
maxResolution:
description: 'superseded by profiles.<name>.maxResolution. deprecated: kept
for config compatibility'
type: integer
profiles:
allOf:
- $ref: '#/definitions/settings.TranscodeProfiles'
description: per-profile transcode settings shown in the player menu
readRate:
description: 'VOD producer input pacing in Nx realtime (-readrate); unset
or <1 clamps to >=1 (default: 2)'
type: number
type: object
settings.Http:
properties:
baseURL:
@@ -804,10 +764,45 @@ definitions:
type: boolean
transcode:
allOf:
- $ref: '#/definitions/settings.FullAdminTranscode'
- $ref: '#/definitions/settings.MediaTranscode'
description: 'deprecated: HLS transcoding for media playback. deprecated:
manage via the admin media settings API'
type: object
settings.MediaTranscode:
properties:
cacheMaxSizeMB:
description: 'disk cache size limit in MB; 0 = unlimited (default: 10240)'
type: integer
cacheRetentionH:
description: 'completed cache retention in hours (default: 24)'
type: integer
enabled:
description: 'enable HLS transcoding for authenticated playback (default:
false)'
type: boolean
encoderBackend:
description: 'default video encoder backend for transcodes: "" (auto), "cpu",
or an accel backend (nvenc, amf, qsv, vaapi, d3d12, videotoolbox)'
type: string
maxConcurrent:
description: 'global concurrent transcode sessions (default: 2)'
type: integer
maxConcurrentPerUser:
description: 'hard per-user concurrent transcode ceiling (default: 1)'
type: integer
maxResolution:
description: 'superseded by profiles.<name>.maxResolution. deprecated: kept
for config compatibility'
type: integer
profiles:
allOf:
- $ref: '#/definitions/settings.TranscodeProfiles'
description: per-profile transcode settings shown in the player menu
readRate:
description: 'VOD producer input pacing in Nx realtime (-readrate); unset
or <1 clamps to >=1 (default: 2)'
type: number
type: object
settings.OidcConfig:
properties:
adminGroup:
@@ -2416,12 +2411,9 @@ definitions:
description: File metadata for non-text files
type: object
web.mediaSettingsResponse:
description: 'Returns the media settings the caller is allowed to see. Admins
get the full settings, including ffmpeg and hardware options, so they can edit
them. Everyone else gets a small read-only view: whether transcoding is on,
how many transcodes they can run at once, which quality presets are enabled,
and which image previews the server can generate. Keys in the view are the same
for admins and users.'
description: Admins receive the DB-backed media integration settings; every authenticated
user receives the player-relevant subset (transcode enabled, profiles, per-user
limit).
properties:
accelDevice:
description: 'acceleration device: "auto", "software"/"cpu", "igpu", "dgpu",
@@ -2454,11 +2446,6 @@ definitions:
hardwareAcceleration:
description: enable hardware acceleration for ffmpeg if available
type: boolean
imagePreview:
additionalProperties:
type: boolean
description: image formats that can be converted
type: object
lockMessage:
type: string
lockedFromConfigPaths:
@@ -2467,7 +2454,7 @@ definitions:
type: array
transcode:
allOf:
- $ref: '#/definitions/settings.FullAdminTranscode'
- $ref: '#/definitions/settings.MediaTranscode'
description: HLS transcoding for media playback
type: object
web.pinnedItemPatchRequest:
+6 -7
View File
@@ -1,6 +1,6 @@
import { notify } from "@/notify/index.ts";
import { getApiPath, getPublicApiPath } from "@/utils/url.js";
import { normalizeSharedMediaSettings } from "@/utils/mediaSettings.js";
import { normalizeMediaPlayerSettings } from "@/utils/mediaSettings.js";
import { fetchJSON, fetchURL, requestTimeoutSignal } from "./utils.ts";
const analyticsRequestTimeoutMs = 5000;
@@ -124,14 +124,13 @@ export function getMediaSettings() {
}
/**
* Shared runtime media state (player + general UI), normalized to a flat shape.
* Non-admins receive the PUBLIC UserMedia payload; admins get the full payload on the
* same endpoint, which carries the same transcode and imagePreview keys.
* @returns {Promise<{ enabled: boolean, profiles: string[], maxConcurrentPerUser: number, imagePreview: object }>}
* Effective media settings for playback. Every authenticated user may read this;
* admins receive the full settings object and everyone else the player subset.
* @returns {Promise<{ enabled: boolean, profiles: string[], maxConcurrentPerUser: number, hardwareAcceleration: boolean }>}
*/
export async function getSharedMediaSettings() {
export async function getMediaPlayerSettings() {
const data = await fetchJSON(getApiPath("settings/media"));
return normalizeSharedMediaSettings(data);
return normalizeMediaPlayerSettings(data);
}
export async function patchMediaSettings(partial) {
@@ -132,7 +132,7 @@ export default {
}
// Don't use thumbnail when we show original embedded preview (HEIC/HEIF or raw)
const isHeicOrHeif = state.req?.type === "image/heic" || state.req?.type === "image/heif";
const useOriginalForHeic = isHeicOrHeif && (state.isSafari || state.mediaSettings?.imagePreview?.heic === true);
const useOriginalForHeic = isHeicOrHeif && (state.isSafari || (globalVars.ffmpegAvailable && globalVars.enableHeicConversion));
const useOriginalForRaw = isRawImageMimeType(state.req?.type);
if (useOriginalForHeic || useOriginalForRaw) {
return null;
@@ -138,7 +138,7 @@ export default {
if (!skipped) {
this.media = media;
}
void mutations.syncMediaSettings();
void mutations.syncMediaPlayerSettings();
notify.showSuccess(this.$t("general.saved"));
eventBus.emit(MEDIA_SETTINGS_CHANGED_EVENT);
this.close();
@@ -238,7 +238,7 @@ export default {
if (!skipped) {
this.media = media;
}
void mutations.syncMediaSettings();
void mutations.syncMediaPlayerSettings();
notify.showSuccess(this.$t("general.saved"));
eventBus.emit(MEDIA_SETTINGS_CHANGED_EVENT);
this.close();
+1 -1
View File
@@ -16,7 +16,7 @@ const { store, router, notify } = vi.hoisted(() => {
setCurrentUser: vi.fn((user) => { state.user = user; }),
setSession: vi.fn(),
syncEnforcedUserDefaults: vi.fn(),
syncMediaSettings: vi.fn(),
syncMediaPlayerSettings: vi.fn(),
syncSidebarLinkDefaultsPolicy: vi.fn(),
syncToolAccessDefaultsPolicy: vi.fn(),
syncShareDefaultsPolicy: vi.fn(),
@@ -194,7 +194,7 @@ export default {
computed: {
maxConcurrentTranscodesLimit() {
// Prefer the live media settings; globalVars are static page constants.
const live = state.mediaSettings?.maxConcurrentPerUser;
const live = state.mediaPlayerSettings?.maxConcurrentPerUser;
if (Number.isFinite(live) && live > 0) {
return live;
}
@@ -1,8 +1,8 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
vi.mock('@/store', () => ({ state: { mediaSettings: null } }));
vi.mock('@/store', () => ({ state: { mediaPlayerSettings: null } }));
vi.mock('@/utils/constants', () => ({
globalVars: { ffmpegAvailable: true },
globalVars: { ffmpegAvailable: true, transcodeEnabled: true },
}));
import { state } from '@/store/index.ts';
@@ -11,31 +11,35 @@ import { isTranscodeAvailable } from '@/plyr/transcodeMode.js';
describe('isTranscodeAvailable', () => {
beforeEach(() => {
state.mediaSettings = null;
state.mediaPlayerSettings = null;
globalVars.ffmpegAvailable = true;
globalVars.transcodeEnabled = true;
});
it('stays off until live media settings load', () => {
it('falls back to the page constant before settings load', () => {
expect(isTranscodeAvailable()).toBe(true);
globalVars.transcodeEnabled = false;
expect(isTranscodeAvailable()).toBe(false);
});
it('follows the live media settings', () => {
state.mediaSettings = { enabled: false };
it('prefers the live media settings over the page constant', () => {
state.mediaPlayerSettings = { enabled: false };
expect(isTranscodeAvailable()).toBe(false);
state.mediaSettings = { enabled: true };
state.mediaPlayerSettings = { enabled: true };
expect(isTranscodeAvailable()).toBe(true);
});
it('stays off when the server has no ffmpeg', () => {
globalVars.ffmpegAvailable = false;
state.mediaSettings = { enabled: true };
globalVars.transcodeEnabled = false;
expect(isTranscodeAvailable()).toBe(false);
});
it('stays off when ffmpeg is missing even if settings claim enabled', () => {
globalVars.ffmpegAvailable = false;
state.mediaSettings = { enabled: true };
state.mediaPlayerSettings = { enabled: true };
expect(isTranscodeAvailable()).toBe(false);
});
});
+9 -6
View File
@@ -4,17 +4,20 @@ import { state } from '@/store/index.ts';
import { globalVars } from '@/utils/constants.js';
/**
* `ffmpegAvailable` is a static page constant that mirrors ffmpeg availability, which
* cannot change without a restart. Transcoding is ffmpeg-only, so it gates the feature
* outright. The transcode toggle is read only from the live media settings, so an admin
* change applies without a page reload. Before those settings load (or for anonymous
* users and shares, which never load them) transcoding reports unavailable.
* `globalVars` are static page constants, and `ffmpegAvailable` mirrors ffmpeg
* availability, which cannot change without a restart. Transcoding is ffmpeg-only,
* so it gates the feature outright. The transcode toggle itself is read from the
* live media settings so an admin change applies without a page reload.
*/
export function isTranscodeAvailable() {
if (globalVars?.ffmpegAvailable !== true) {
return false;
}
return state?.mediaSettings?.enabled === true;
const live = state?.mediaPlayerSettings;
if (live) {
return live.enabled === true;
}
return globalVars.transcodeEnabled === true;
}
/** Supported transcode playback modes in the player UI. */
+9 -9
View File
@@ -3,7 +3,7 @@ import { markRaw } from "vue";
import { resourcesApi, usersApi } from "@/api/index.js";
import {
getEnforcedUserDefaults,
getSharedMediaSettings,
getMediaPlayerSettings,
getShareDefaultsPolicy,
getSidebarLinkDefaultsPolicy,
getToolAccessDefaultsPolicy,
@@ -622,25 +622,25 @@ export const mutations = {
}
},
/**
* Load the runtime media settings. Runtime admin changes are read from the API
* rather than static page constants. Called at app start so the state is present
* in every view, not only the player.
* Load the effective media settings for playback. `globalVars` are static
* page constants, so runtime changes to media settings are read from the API
* (available to every authenticated user) instead.
*/
syncMediaSettings: async () => {
syncMediaPlayerSettings: async () => {
if (!getters.isLoggedIn() || getters.isShare() || state.user?.username === "anonymous") {
state.mediaSettings = null;
state.mediaPlayerSettings = null;
return;
}
try {
const settings = await getSharedMediaSettings();
const settings = await getMediaPlayerSettings();
// The request can resolve after logout/share transition — don't write
// media settings into a logged-out state.
if (!getters.isLoggedIn() || getters.isShare() || state.user?.username === "anonymous") {
return;
}
state.mediaSettings = settings;
state.mediaPlayerSettings = settings;
} catch {
state.mediaSettings = null;
state.mediaPlayerSettings = null;
}
},
syncSidebarLinkDefaultsPolicy: async () => {
+2 -2
View File
@@ -33,8 +33,8 @@ export const state: StoreState = reactive({
showSidebar: false,
displayPreferences: {},
enforcedUserDefaults: {},
/** Runtime media state shared by the player and general UI; null until loaded (logged-in users only). */
mediaSettings: null,
/** Effective media settings for playback; null until the API reports them. */
mediaPlayerSettings: null,
sidebarLinkDefaultsPolicy: { items: [] },
toolAccessDefaultsPolicy: { items: [] },
shareDefaultsPolicy: { values: {}, enforced: {} },
+3 -4
View File
@@ -330,13 +330,12 @@ export interface StoreState {
newFileTemplate?: boolean;
};
};
/** Runtime media state for all UI (player, listings, previews); null until loaded. */
mediaSettings: {
/** Effective media settings for playback, or null before the API reports them. */
mediaPlayerSettings: {
enabled: boolean;
profiles: string[];
maxConcurrentPerUser: number;
/** Per image preview type (e.g. heic, jxl): conversion active on this server. */
imagePreview: Partial<Record<'heic' | 'jxl' | 'jpeg', boolean>>;
hardwareAcceleration: boolean;
} | null;
sidebarLinkDefaultsPolicy: {
items?: Array<{
+1 -1
View File
@@ -88,7 +88,7 @@ export async function validateLogin(isPublicRoute = false) {
const userInfo = await res.json();
await mutations.setCurrentUser(userInfo);
await mutations.syncEnforcedUserDefaults();
await mutations.syncMediaSettings();
await mutations.syncMediaPlayerSettings();
await mutations.syncSidebarLinkDefaultsPolicy();
await mutations.syncToolAccessDefaultsPolicy();
await mutations.syncShareDefaultsPolicy();
+1 -1
View File
@@ -8,7 +8,7 @@ const { storeMock } = vi.hoisted(() => ({
isLoggedIn: vi.fn(() => true),
isShare: vi.fn(() => false),
},
mutations: { setCurrentUser: vi.fn(), setSession: vi.fn(), syncEnforcedUserDefaults: vi.fn(), syncMediaSettings: vi.fn(), syncSidebarLinkDefaultsPolicy: vi.fn(), syncToolAccessDefaultsPolicy: vi.fn(), syncShareDefaultsPolicy: vi.fn() },
mutations: { setCurrentUser: vi.fn(), setSession: vi.fn(), syncEnforcedUserDefaults: vi.fn(), syncMediaPlayerSettings: vi.fn(), syncSidebarLinkDefaultsPolicy: vi.fn(), syncToolAccessDefaultsPolicy: vi.fn(), syncShareDefaultsPolicy: vi.fn() },
},
}));
+5 -8
View File
@@ -88,16 +88,13 @@ export function enabledTranscodeProfileIds(media) {
* the full object to admins and a player-only subset to everyone else, so both
* shapes collapse to the same fields here.
*/
export function normalizeSharedMediaSettings(data) {
// Both payloads share the transcode keys: enabled, maxConcurrentPerUser, and the
// derived enabledProfiles. Admin payloads also carry the full profiles object, so
// fall back to deriving the ids from it when enabledProfiles is absent.
export function normalizeMediaPlayerSettings(data) {
const transcode = data?.transcode || {};
return {
enabled: Boolean(transcode.enabled),
profiles: Array.isArray(transcode.enabledProfiles) ? transcode.enabledProfiles : enabledTranscodeProfileIds(data),
maxConcurrentPerUser: Number(transcode.maxConcurrentPerUser) || 1,
imagePreview: { ...(data?.imagePreview || {}) },
enabled: Boolean(data?.enabled ?? transcode.enabled),
profiles: Array.isArray(data?.profiles) ? data.profiles : enabledTranscodeProfileIds(data),
maxConcurrentPerUser: Number(data?.maxConcurrentPerUser ?? transcode.maxConcurrentPerUser) || 1,
hardwareAcceleration: Boolean(data?.hardwareAcceleration),
};
}
+13 -10
View File
@@ -8,7 +8,7 @@ import { patchMediaSettings } from '@/api/settings.js';
import {
enabledTranscodeProfileIds,
mergeMediaSettings,
normalizeSharedMediaSettings,
normalizeMediaPlayerSettings,
saveMediaSettingsPatch,
stripLockedMediaPaths,
} from '@/utils/mediaSettings.js';
@@ -104,7 +104,7 @@ describe('mediaSettings', () => {
});
});
describe('normalizeSharedMediaSettings', () => {
describe('normalizeMediaPlayerSettings', () => {
it('derives enabled profiles in menu order from the admin settings shape', () => {
const media = {
transcode: {
@@ -116,34 +116,37 @@ describe('mediaSettings', () => {
datasaver: { enabled: true },
},
},
hardwareAcceleration: true,
};
expect(enabledTranscodeProfileIds(media)).toEqual(['quality', 'datasaver']);
expect(normalizeSharedMediaSettings(media)).toEqual({
expect(normalizeMediaPlayerSettings(media)).toEqual({
enabled: true,
profiles: ['quality', 'datasaver'],
maxConcurrentPerUser: 2,
imagePreview: {},
hardwareAcceleration: true,
});
});
it('accepts the player-only shape returned to non-admin users', () => {
expect(normalizeSharedMediaSettings({
transcode: { enabled: false, maxConcurrentPerUser: 3, enabledProfiles: ['quality'] },
imagePreview: { heic: true },
expect(normalizeMediaPlayerSettings({
enabled: false,
profiles: ['quality'],
maxConcurrentPerUser: 3,
hardwareAcceleration: false,
})).toEqual({
enabled: false,
profiles: ['quality'],
maxConcurrentPerUser: 3,
imagePreview: { heic: true },
hardwareAcceleration: false,
});
});
it('falls back to a per-user limit of one and disabled when values are absent', () => {
expect(normalizeSharedMediaSettings(undefined)).toEqual({
expect(normalizeMediaPlayerSettings(undefined)).toEqual({
enabled: false,
profiles: [],
maxConcurrentPerUser: 1,
imagePreview: {},
hardwareAcceleration: false,
});
});
});
+2 -2
View File
@@ -211,7 +211,7 @@ export default {
// Viewable when we can get embedded/original preview: (media + heic conversion) or Safari native
isHeicAndViewable() {
if (state.isSafari) return true;
if (state.mediaSettings?.imagePreview?.heic === true) return true;
if (globalVars.ffmpegAvailable && globalVars.enableHeicConversion) return true;
return false;
},
pdfConvertable() {
@@ -262,7 +262,7 @@ export default {
}
const getRawPreview = isRawImageMimeType(state.req.type);
const getHeicPreview = isHeicOrHeif && state.mediaSettings?.imagePreview?.heic === true;
const getHeicPreview = isHeicOrHeif && globalVars.ffmpegAvailable && globalVars.enableHeicConversion;
if (this.pdfConvertable || getRawPreview || getHeicPreview) {
if (getters.isShare()) {
const previewPath = removeTrailingSlash(state.req.path);
+10 -3
View File
@@ -850,8 +850,15 @@ export default {
return needsTranscodeFirst(this.transcodeProbeParams());
},
transcodeProfileOptions() {
const live = state.mediaSettings?.profiles;
const configured = Array.isArray(live) ? live : PLYR_TRANSCODE_HLS_MODES;
const live = state.mediaPlayerSettings?.profiles;
let configured;
if (Array.isArray(live)) {
configured = live;
} else {
configured = Array.isArray(globalVars.transcodeProfiles)
? globalVars.transcodeProfiles
: PLYR_TRANSCODE_HLS_MODES;
}
const ids = configured.filter((id) => PLYR_TRANSCODE_HLS_MODES.includes(id));
return ids.length ? ids : PLYR_TRANSCODE_HLS_MODES;
},
@@ -868,7 +875,7 @@ export default {
const base = ['captions', 'captionSize', 'quality', 'speed', 'playback', 'loop'];
// Register the slot whenever authenticated video can show it later.
// Plyr only builds settings panels at mount; applyCustomSettings toggles
// visibility when media/live settings settle (e.g. after syncMediaSettings).
// visibility when media/live settings settle (e.g. after syncMediaPlayerSettings).
if (this.previewType === 'video' && getters.isLoggedIn() && !getters.isShare()) {
return [...base, 'transcodeMode'];
}
+3 -3
View File
@@ -121,8 +121,8 @@ export default {
mounted() {
this.mediaSettingsHandler = () => {
void this.load({ silent: true });
// Keep the shared live view of media settings in sync after a save.
void mutations.syncMediaSettings();
// Keep the player's live view of media settings in sync after a save.
void mutations.syncMediaPlayerSettings();
};
eventBus.on(MEDIA_SETTINGS_CHANGED_EVENT, this.mediaSettingsHandler);
void this.load();
@@ -200,7 +200,7 @@ export default {
return;
}
this.media = media;
void mutations.syncMediaSettings();
void mutations.syncMediaPlayerSettings();
notify.showSuccessToast(this.$t("settings.settingsUpdated"));
} catch (e) {
notify.showError(e?.message || this.$t("media.updateFailed"));
@@ -11,9 +11,8 @@ seg/00000.m4s
`;
/**
* Force ffmpeg availability in the static app-config and advertise transcoding via
* the live media settings API, so the plyr mode menu appears even when the CI image
* lacks ffmpeg. Transcode state is read only from the live API.
* Force the static app-config (and live media settings API) to advertise
* transcoding so the plyr mode menu appears even when the CI image lacks ffmpeg.
*
* Hook getElementById so the patch runs when constants.js reads `#app-config`.
* Only rewrite the JSON text — do not replace `window.globalVars` with a new
@@ -28,6 +27,10 @@ export async function enableTranscodeUi(page: Page) {
try {
const cfg = JSON.parse(el.textContent);
cfg.ffmpegAvailable = true;
cfg.transcodeEnabled = true;
if (!Array.isArray(cfg.transcodeProfiles) || cfg.transcodeProfiles.length === 0) {
cfg.transcodeProfiles = ["quality", "balanced", "datasaver"];
}
el.textContent = JSON.stringify(cfg);
el.dataset.transcodeUiPatched = "1";
} catch (_) {
@@ -45,14 +48,11 @@ export async function enableTranscodeUi(page: Page) {
await route.fulfill({
status: 200,
contentType: "application/json",
// Matches the PUBLIC UserMedia payload from GET /api/settings/media.
body: JSON.stringify({
transcode: {
enabled: true,
maxConcurrentPerUser: 1,
enabledProfiles: ["quality", "balanced", "datasaver"],
},
imagePreview: {},
enabled: true,
profiles: ["quality", "balanced", "datasaver"],
maxConcurrentPerUser: 1,
hardwareAcceleration: false,
}),
});
});