Skip to main content

CLI-Tool zur Erstellung von Mediensets (statisches HTML mit OG-Tags, Vorschaubildern und ZIP-Download) aus Videodateien.

Project description

mediaset-creator

CLI-Tool und Python-Bibliothek zur Erstellung von Mediensets aus Videodateien. Ein Medienset ist ein ULID-basiertes Verzeichnis mit statischem HTML, Vorschaubildern, ZIP-Download und der Videodatei – bereit zum Hochladen auf einen Webserver.


Voraussetzungen


Installation

uv pip install kurmann-mediaset-creator

Im Entwicklungsmodus (editierbar):

uv sync

Verwendung (CLI)

Einzelnes Video

mediaset-creator create /pfad/zu/video.m4v \
  --title "Familienfilme 2024" \
  --video-title "Leah Treppen-Surfen" \
  --video-description "Leah demonstriert ihre hohe Kunst des Treppen-Surfens." \
  --video-category "Familie Kurmann-Glück" \
  --video-date "2024-07-01" \
  --video-quality "Dolby Vision"

Das Medienset wird im Verzeichnis der Quelldatei unter einem ULID-Unterverzeichnis erstellt. Ein anderes Ausgabeverzeichnis kann mit --output-dir angegeben werden:

mediaset-creator create /pfad/zu/video.m4v \
  --output-dir /tmp/mediasets \
  --video-title "Mein Film"

Mehrere Videos (JSON)

Für Mediensets mit mehreren Videos wird eine JSON-Datei mit Metadaten übergeben:

mediaset-creator create --from-json metadaten.json

Format der JSON-Datei:

{
  "title": "Familienfilme 2024",
  "videos": [
    {
      "path": "/pfad/zu/video1.m4v",
      "title": "Leah Treppen-Surfen",
      "description": "Beschreibung des Videos.",
      "category": "Familie Kurmann-Glück",
      "recording_date": "2024-07-01",
      "quality_label": "Dolby Vision"
    },
    {
      "path": "/pfad/zu/video2.m4v",
      "title": "Herbst-Spaziergang",
      "description": "Ein sonniger Herbsttag.",
      "recording_date": "2024-11-01",
      "quality_label": "4K HDR"
    }
  ]
}

Optionen

Option Beschreibung
--title TEXT Übergeordneter Mediaset-Titel (h1). Bei Einzelvideo auch als Video-Titel verwendet, wenn --video-title fehlt. Fallback: Dateiname.
--video-title TEXT Titel des Videos (nur bei Multi-Video nötig; bei Einzelvideo wird --title übernommen)
--video-description TEXT Beschreibung des Videos
--video-category TEXT Kategorie (z.B. «Familie Kurmann-Glück»)
--video-date TEXT Aufnahmedatum im ISO-Format (YYYY-MM-DD). Wird als Dateiname-Prefix und in der Anzeige als deutsches Long-Datum verwendet.
--video-quality TEXT Qualitätsangabe (z.B. «Dolby Vision», «4K HDR»)
--output-dir PATH Basisverzeichnis für die Ausgabe (Default: Verzeichnis der Quelldatei)
--from-json PATH JSON-Datei mit Metadaten für Multi-Video-Mediaset
--ulid TEXT Bestehende ULID verwenden (überschreibt ein vorhandenes Medienset)
--no-og-tags OpenGraph-Tags deaktivieren
--verbose, -v Zusätzliche Ablaufinformationen auf stderr ausgeben

Ausgabe

stdout enthält den Pfad zum erstellten ULID-Verzeichnis:

/pfad/zum/output/01JNXYZ.../

Statusmeldungen werden auf stderr ausgegeben (nur mit --verbose).

Erzeugte Verzeichnisstruktur

<ULID>/
├── index.html              # HTML-Seite mit Vorschaubild und Video-Link
├── video.mp4               # Komprimierte MP4 (bei >4K oder >50 Mbit/s) oder Original-Kopie
├── video-landscape.jpg     # Landscape-Vorschaubild (16:9, 1920×1080)
├── video-poster.jpg        # Portrait-Vorschaubild (2:3, 1080×1620)
├── video.nfo               # Infuse/Firecore-Metadaten (Titel, Datum, Genre)
└── video.zip               # ZIP mit Original-Video, Vorschaubildern und NFO

Konfiguration

Einstellungen werden in ~/.config/mediaset-creator/config.toml gespeichert.

Befehle

# Wert speichern
mediaset-creator config set <schlüssel> "<wert>"

# Einzelnen Wert lesen
mediaset-creator config get <schlüssel>

# Alle gespeicherten Werte anzeigen
mediaset-creator config list

Erlaubte Schlüssel

Schlüssel Beschreibung Standard
og.base_url Stamm-URL für OG-Tags (z.B. https://example.com/shares/) (leer)
og.enabled OG-Tags aktivieren (true/false) true
og.site_name OG site_name Metadatum (leer)
og.locale OG locale Metadatum de_CH
thumbnails.sidecar Sidecar-Bilder als Landscape-Quelle verwenden (true/false) true
title.filename_fallback Dateiname (ohne Erweiterung) als Titel-Fallback verwenden (true/false) true
filename.date_prefix Datum (YYYY-MM-DD) als Dateiname-Prefix verwenden (true/false) true
video.auto_compress Automatische Komprimierung bei >4K-UHD oder >50 Mbit/s (true/false) true
video.max_bitrate Maximale Bitrate in Mbit/s – darüber wird komprimiert/nachkomprimiert 50
video.quality VideoToolbox-Qualität für Komprimierung (0–100, tiefer = besser) 72
tools.ffmpeg Pfad zur ffmpeg-Binärdatei ffmpeg
tools.ffprobe Pfad zur ffprobe-Binärdatei ffprobe
tools.nice_level CPU-Priorität für ffmpeg via nice (0–19; leer = keine Drosselung) (leer)

Beispiel config.toml

[og]
base_url = "https://kurmannmedia.blob.core.windows.net/kurmann-glueck/"
enabled = "true"
site_name = "Patrick Kurmann Familienfilm-Freigabe"
locale = "de_CH"

[thumbnails]
sidecar = "true"

[title]
filename_fallback = "true"

[filename]
date_prefix = "true"

[video]
auto_compress = "true"
max_bitrate = "50"
quality = "72"

[tools]
ffmpeg = "ffmpeg"
ffprobe = "ffprobe"
nice_level = "10"

OG-Tags

Wenn og.base_url gesetzt ist und OG-Tags aktiviert sind, generiert das HTML OpenGraph-Metadaten für ansprechende Link-Vorschauen in Messengern und sozialen Netzwerken. Die vollständige URL wird aus base_url + ULID/ zusammengesetzt.

OG-Tags lassen sich deaktivieren via:

  • mediaset-creator config set og.enabled false (persistent)
  • mediaset-creator create --no-og-tags ... (pro Aufruf)

Automatische Videokompression

Wenn video.auto_compress aktiv ist (Standard), analysiert das Tool vor der Verarbeitung die technischen Eigenschaften des Videos. Bei Überschreiten eines der folgenden Schwellwerte wird automatisch eine komprimierte MP4-Version erstellt:

  • Auflösung > 4K UHD (Pixelzahl > 3840×2160, z.B. 5K, 6K)
  • Bitrate > 50 Mbit/s (z.B. ProRes, hochbitratige HEVC-Aufnahmen)

Was wird wohin geschrieben:

Datei Inhalt
video.mp4 im ULID-Verzeichnis Komprimierte MP4 zum direkten Streaming
video.zip Original-Videodatei + Vorschaubilder (für Medienserver)

Wenn keine Kompression nötig ist, wird das Original wie bisher kopiert.

Komprimierungsparameter (macOS, VideoToolbox):

  • Codec: HEVC (hevc_videotoolbox), Profil main10, 10-Bit
  • Auflösung: 2560×1440 (QHD), Skalierung mit Lanczos-Filter
  • Audio: AAC (aac_at), 192 kbit/s
  • Keyframe-Abstand: 30 Frames, faststart für sofortiges Streaming
  • Qualität: q:v 72 (konfigurierbar via video.quality)

Nachkomprimierung bei hoher Bitrate:

Wenn die Bitrate nach der initialen Komprimierung noch über 50 Mbit/s liegt (z.B. bei Videos mit viel Bewegung wie Schneefall), wird automatisch erneut vom Original komprimiert – mit schrittweise reduzierter Qualität (q -= 2 pro Iteration, z.B. 72 → 70 → 68) bis die Bitrate unter 50 Mbit/s liegt oder die Untergrenze von q=50 erreicht ist.

Hinweis: Die Komprimierung verwendet macOS-spezifische Hardware-Beschleunigung (hevc_videotoolbox, aac_at). Auf anderen Plattformen schlägt ffmpeg fehl und das Original wird stattdessen kopiert (Fallback).

Komprimierung deaktivieren:

mediaset-creator config set video.auto_compress false

CPU-Drosselung (verhindert Lüfterlärm bei lang laufenden Encodings):

mediaset-creator config set tools.nice_level 10

Der nice-Wert (0–19) steuert die Prozesspriorität von ffmpeg. Höhere Werte = geringere Priorität. Leer lassen (Standard) bedeutet keine Drosselung.


Verwendung (Python API)

Die öffentliche API kann von anderen Python-Anwendungen genutzt werden:

from pathlib import Path
from mediaset_creator.api import (
    CreateMediasetRequest,
    MediaItem,
    RuntimeOptions,
    create_mediaset,
)

# Fachlicher Request
request = CreateMediasetRequest(
    items=[
        MediaItem(
            source_path=Path("/pfad/zu/video.m4v"),
            title="Leah Treppen-Surfen",
            description="Beschreibung des Videos.",
            category="Familie Kurmann-Glück",
            recording_date="1. Juli 2024",
            quality_label="Dolby Vision",
        ),
    ],
    mediaset_title="Familienfilme 2024",
    output_dir=Path("/tmp/mediasets"),
    enable_og_tags=True,
)

# Technische Laufzeitoptionen (getrennt vom fachlichen Request)
runtime = RuntimeOptions(
    base_url="https://example.com/shares/",
    ffmpeg_path="ffmpeg",
    ffprobe_path="ffprobe",
)

# Mediaset erstellen
result = create_mediaset(request, runtime)

if result.success:
    print(f"Mediaset erstellt: {result.output_dir}")
    print(f"HTML: {result.html_path}")
else:
    print(f"Fehler: {result.error_message}")

Fortschritts-Events

Für lang laufende Operationen kann ein Event-Callback übergeben werden:

from mediaset_creator.api import MediasetCreatorEvent

def on_event(event: MediasetCreatorEvent) -> None:
    label = f" [{event.current}/{event.total}]" if event.current is not None else ""
    print(f"  {event.message}{label}")

result = create_mediaset(request, runtime, on_event=on_event)

Öffentliche API-Exporte

from mediaset_creator.api import (
    create_mediaset,          # Hauptfunktion
    CreateMediasetRequest,    # Fachlicher Request
    MediaItem,                # Ein Medienelement (aktuell: Video)
    RuntimeOptions,           # Technische Laufzeitoptionen
    MediasetResult,           # Ergebnis mit Pfaden
    MediasetCreatorEvent,     # Strukturiertes Fortschritts-Event
    MediasetCreatorStage,     # Stage-IDs (StrEnum)
)

Änderungsverlauf

Beinhaltet die letzten drei Minorversionen.

1.3.0 – 2026-03-28

  • Internet-freundliche Dateinamen: Umlaute transliteriert (ö→oe), Leerzeichen → Bindestriche, nur ASCII-Zeichen. Verhindert 404-Fehler durch Unicode-Normalisierungs-Unterschiede (macOS NFD vs. Server NFC).
  • ZIP-Inhalte behalten originale Dateinamen (Infuse-freundlich)
  • Neue Option --ulid zum Überschreiben bestehender Mediensets
  • Automatische Nachkomprimierung: Bei Bitrate >50 Mbit/s nach initialer Komprimierung wird erneut mit reduzierter Qualität komprimiert (q -= 2 pro Iteration, Untergrenze q=50)
  • Neue Config-Keys: video.quality (initiale VideoToolbox-Qualität, Default: 72), video.max_bitrate (maximale Bitrate in Mbit/s, Default: 50)

1.2.1 – 2026-03-28

  • Bugfix: Sidecar-Bilder im TIFF-Format (16-Bit) werden jetzt beim Landscape-Vorschaubild korrekt zu sRGB-JPG konvertiert (vorher wurde die Datei unverändert kopiert)

1.2.0 – 2026-03-28

  • Verbessertes HTML-Layout: Mediathek-Header, Datenschutzhinweis (privater Link, 30-Tage-Ablauf), Videodauer unterhalb des Titels
  • Download-Link zeigt ZIP-Grösse und weist auf volle Auflösung hin
  • Infuse-Kompatibilität: NFO-Datei im Firecore-Format (<media type="Other">) wird generiert und ins ZIP gepackt (Titel, Datum, Genre)
  • Grösseres Play-Icon mit Drop-Shadow für besseren Kontrast auf hellen Bildern
  • Erstellungsdatum (Timestamp) wird auf der HTML-Seite angezeigt
  • Videodauer wird via ffprobe extrahiert und im HTML dargestellt

1.1.0 – 2026-03-27

  • Automatische Videokompression: Bei >4K-UHD oder >50 Mbit/s wird eine komprimierte HEVC-MP4 (2560×1440, VideoToolbox) erstellt – das Original kommt ins ZIP für den Medienserver
  • CPU-Drosselung via tools.nice_level (0–19) verhindert Lüfterlärm bei lang laufenden Encodings
  • Graceful Fallback: Bei Analysefehler oder fehlgeschlagenem Encoding wird das Original kopiert
  • Neue Config-Keys: video.auto_compress, tools.nice_level
  • Neue Event-Stages: VIDEO_ANALYSIERT, VIDEO_KOMPRIMIERT

Vollständige Historie: CHANGELOG.md


Lizenz

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kurmann_mediaset_creator-1.3.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kurmann_mediaset_creator-1.3.0-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file kurmann_mediaset_creator-1.3.0.tar.gz.

File metadata

  • Download URL: kurmann_mediaset_creator-1.3.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kurmann_mediaset_creator-1.3.0.tar.gz
Algorithm Hash digest
SHA256 72c3efbff78ac415047a8b63c253db6b2c151c61dbbc921c1f009c273a156dcc
MD5 54c5c7182c6552e13650df0e6d99123b
BLAKE2b-256 71b2c89130f2c212bdf00d2160fc00f1492435da0f4352c284823174beaa96df

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurmann_mediaset_creator-1.3.0.tar.gz:

Publisher: publish.yml on kurmann/mediaset-creator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kurmann_mediaset_creator-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kurmann_mediaset_creator-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9713df290220d19f203a24cb84ec1c9d05ec64b19a51a76aa99b72ccac43a96c
MD5 721ee0296e43c7884af79851fee4266c
BLAKE2b-256 96c55ee7316366c861ea52cfbd40501f7bed4cae636a49a9c851f3bc1664aa28

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurmann_mediaset_creator-1.3.0-py3-none-any.whl:

Publisher: publish.yml on kurmann/mediaset-creator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page