lib: Introduce Clapper playback library

An easy to use media playback library (libclapper) as a GstPlayer replacement. Previously we tried to use upstream `gstplayer` library to control playback and pass all events from multiple threads GStreamer uses into an app main thread. Since this caused some thread racy problems and we needed additional ABI breaking changes to better suit our needs, we ended up with a modified fork of said library renamed to `gstclapper` as a temporary solution. This new library simply named `clapper` replaces our previous `gstclapper` solution and is written completely from scratch by myself. The aim here is to have an easy to use playback library better suited to work with (but not limited to) GTK and GObject properties bindings by relying on "notify" signals. Major differences include: * Operates on a playback queue (inherits `GListModel` interface) instead of a single URI * Uses "notify" signals for property changes always dispatched to app thread * Time is passed/read as decimal number in seconds instead of int64 in nanoseconds * Integrates `GstDiscoverer` to figure out media info (such as title) before playback * Easy to use MPRIS support as part of library * Optional playback remote controls with WebSocket messages The new library will be distributed with Clapper player. This includes public headers and GObject Introspection support. Licensed under LGPL-2.1-or-later. Enjoy
2025-08-30 07:42:23 +02:00 · 2024-03-13 20:45:03 +01:00
parent edaba00658
commit d7f069d6c3
196 changed files with 17622 additions and 21004 deletions
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -0,0 +1,10 @@
+gi_docgen = find_program('gi-docgen', required: get_option('doc'))
+dot = find_program('dot', required: get_option('doc')) # Class hierarchy generation
+build_doc = (gi_docgen.found() and dot.found() and get_option('doc'))
+
+if build_doc
+  if not build_gir
+    error('Building documentation requires introspection to be compiled')
+  endif
+  subdir('reference')
+endif
--- a/doc/reference/clapper/clapper.toml.in
+++ b/doc/reference/clapper/clapper.toml.in
@@ -0,0 +1,73 @@
+[library]
+version = "@CLAPPER_VERSION@"
+browse_url = "https://github.com/Rafostar/clapper/"
+repository_url = "https://github.com/Rafostar/clapper.git"
+website_url = "https://rafostar.github.io/clapper/"
+docs_url = "https://rafostar.github.io/clapper/doc/clapper/"
+authors = "Rafał Dzięgiel"
+logo_url = "clapper-logo.svg"
+license = "LGPL-2.1-or-later"
+description = "Clapper playback library"
+devhelp = true
+search_index = true
+
+dependencies = ["GLib-2.0", "GObject-2.0", "Gio-2.0", "Gst-1.0", "GstBase-1.0", "GstAudio-1.0", "GstTag-1.0", "GstPbutils-1.0"]
+
+  [dependencies."GLib-2.0"]
+  name = "GLib"
+  description = "A general-purpose, portable utility library"
+  docs_url = "https://docs.gtk.org/glib/"
+
+  [dependencies."GObject-2.0"]
+  name = "GObject"
+  description = "The base type system library"
+  docs_url = "https://docs.gtk.org/gobject/"
+
+  [dependencies."Gio-2.0"]
+  name = "Gio"
+  description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
+  docs_url = "https://docs.gtk.org/gio/"
+
+  [dependencies."Gst-1.0"]
+  name = "Gst"
+  description = "GStreamer core library"
+  docs_url = "https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html"
+
+  [dependencies."GstBase-1.0"]
+  name = "GstBase"
+  description = "GStreamer base and utility classes"
+  docs_url = "https://gstreamer.freedesktop.org/documentation/base/"
+
+  [dependencies."GstAudio-1.0"]
+  name = "GstAudio"
+  description = "GStreamer audio library"
+  docs_url = "https://gstreamer.freedesktop.org/documentation/audio/"
+
+  [dependencies."GstTag-1.0"]
+  name = "GstTag"
+  description = "GStreamer tag support library"
+  docs_url = "https://gstreamer.freedesktop.org/documentation/tag/"
+
+  [dependencies."GstPbutils-1.0"]
+  name = "GstPbutils"
+  description = "GStreamer base utils library"
+  docs_url = "https://gstreamer.freedesktop.org/documentation/pbutils/"
+
+related = []
+
+[theme]
+name = "basic"
+show_index_summary = true
+show_class_hierarchy = true
+
+[source-location]
+base_url = "https://github.com/Rafostar/clapper/tree/master/"
+
+[extra]
+# The same order will be used when generating the index
+content_files = [
+]
+content_images = [
+  "images/clapper-logo.svg",
+]
+urlmap_file = "urlmap.js"
--- a/doc/reference/clapper/images/clapper-logo.svg
+++ b/doc/reference/clapper/images/clapper-logo.svg
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 256 256" width="256" height="256">
+  <defs>
+    <path id="b1nGq5BrLC" d="M27.2 243.52C27.2 236.16 27.2 199.83 27.2 134.22C47.64 134.22 211.12 134.22 231.56 134.22C231.56 199.83 231.56 236.16 231.56 243.52C231.56 250.4 225.96 256 218.92 256C183.07 256 57.77 256 39.84 256C32.8 256 27.2 250.4 27.2 243.52Z"></path>
+    <path id="a3jkaoNn4k" d="M24.32 103.65C24.32 106.22 24.32 127.02 24.32 129.58C24.32 132.78 26.72 135.18 29.92 135.18C50.41 135.18 215.08 135.18 235.72 135.18C238.76 135.18 241.32 132.78 241.32 129.58C241.32 127.02 241.32 106.22 241.32 103.65C241.32 100.45 238.76 98.05 235.72 98.05C194.59 98.05 50.41 98.05 29.92 98.05C26.72 98.05 24.32 100.45 24.32 103.65Z"></path>
+    <path id="atpVQ8mnd" d="M174.59 135.18L211.87 98.05L171.07 98.05L133.78 135.18L174.59 135.18Z"></path>
+    <path id="bMtYoNHu0" d="M76.81 135.18L114.1 98.05L73.13 98.05L35.84 135.18L76.81 135.18Z"></path>
+    <path id="b5oP0Glp4" d="M19.04 69.41C19.84 71.97 25.92 91.97 26.72 94.37C27.68 97.41 30.72 99.01 33.76 98.05C54.09 91.81 216.68 42.04 237 35.8C240.04 35 241.64 31.8 240.84 28.92C240.04 26.36 233.96 6.36 233.16 3.96C232.2 0.92 229.16 -0.68 226.12 0.28C185.47 12.6 43.21 56.29 22.88 62.53C19.84 63.33 18.24 66.53 19.04 69.41Z"></path>
+    <path id="lwBgev6DR" d="M176.51 54.37L129.94 29.4L169.15 17.56L215.72 42.52L176.51 54.37Z"></path>
+    <path id="cUsjEMRUu" d="M81.61 83.49L35.04 58.69L74.25 46.69L120.82 71.49L81.61 83.49Z"></path>
+    <path id="c1bcHZGXe" d="M14.72 66.69C14.72 72.93 14.72 123.02 14.72 129.26C14.72 132.62 17.44 135.18 20.64 135.18C26.56 135.18 74.09 135.18 80.01 135.18C84.33 135.18 87.21 130.86 85.61 127.02C82.89 120.78 61.45 70.53 58.73 64.29C57.77 62.05 55.69 60.77 53.29 60.77C46.73 60.77 24 60.77 20.64 60.77C17.44 60.77 14.72 63.33 14.72 66.69Z"></path>
+    <path id="f2PtH0V1vC" d="M32.64 60.61C31.52 60.61 21.92 60.61 20.64 60.61C17.44 60.61 14.72 63.33 14.72 66.53C14.72 72.77 14.72 123.02 14.72 129.26C14.72 132.46 17.44 135.18 20.64 135.18C21.92 135.18 31.52 135.18 32.64 135.18C29.44 135.18 26.72 132.46 26.72 129.26C26.72 116.62 26.72 72.77 26.72 66.53C26.72 63.33 29.44 60.61 32.64 60.61Z"></path>
+    <path id="a1SvrrkqVm" d="M231.56 135.18C231.56 143.82 231.56 148.46 231.56 149.42C231.56 149.42 231.56 149.42 231.56 149.42C108.98 149.42 40.8 149.42 27.2 149.42C27.2 149.42 27.2 149.42 27.2 149.42C27.2 140.94 27.2 136.14 27.2 135.18C27.2 135.18 27.2 135.18 27.2 135.18C149.78 135.18 217.96 135.18 231.56 135.18C231.56 135.18 231.56 135.18 231.56 135.18Z"></path>
+    <path id="agXcvKqh8" d="M104.22 162.46L104.22 234.46L163.22 198.54L104.22 162.46Z"></path>
+  </defs>
+  <g>
+    <g><use xlink:href="#b1nGq5BrLC" fill="#4747d1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#a3jkaoNn4k" fill="#4747d1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#atpVQ8mnd" fill="#f1f1f1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#bMtYoNHu0" fill="#f1f1f1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#b5oP0Glp4" fill="#4747d1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#lwBgev6DR" fill="#f1f1f1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#cUsjEMRUu" fill="#f1f1f1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#c1bcHZGXe" fill="#a9a9a9" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#f2PtH0V1vC" opacity="0.2" fill="#000000" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#a1SvrrkqVm" opacity="0.2" fill="#000000" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+    <g><use xlink:href="#agXcvKqh8" fill="#f1f1f1" transform="matrix(1, 0, 0, 0.97, 0, 0)"></use></g>
+  </g>
+</svg>
--- a/doc/reference/clapper/meson.build
+++ b/doc/reference/clapper/meson.build
@@ -0,0 +1,29 @@
+clapper_toml = configure_file(
+  input: 'clapper.toml.in',
+  output: 'clapper.toml',
+  configuration: doc_version_conf,
+  install: true,
+  install_dir: join_paths(datadir, 'doc', 'clapper'),
+)
+
+custom_target('clapper-doc',
+  input: [
+    clapper_toml,
+    clapper_gir[0],
+  ],
+  output: 'clapper',
+  command: [
+    gi_docgen,
+    'generate',
+    gi_docgen_common_args,
+    '--add-include-path=@0@'.format(join_paths(meson.project_build_root(), 'src', 'lib', 'clapper')),
+    '--config=@INPUT0@',
+    '--output-dir=@OUTPUT@',
+    '--content-dir=@0@'.format(meson.current_build_dir()),
+    '--content-dir=@0@'.format(meson.current_source_dir()),
+    '@INPUT1@',
+  ],
+  build_by_default: true,
+  install: true,
+  install_dir: join_paths(datadir, 'doc'),
+)
--- a/doc/reference/clapper/urlmap.js
+++ b/doc/reference/clapper/urlmap.js
@@ -0,0 +1,10 @@
+baseURLs = [
+  ['GLib', 'https://docs.gtk.org/glib/'],
+  ['GObject', 'https://docs.gtk.org/gobject/'],
+  ['Gio', 'https://docs.gtk.org/gio/'],
+  ['Gst', 'https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html?'],
+  ['GstBase', 'https://gstreamer.freedesktop.org/documentation/base/?'],
+  ['GstAudio', 'https://gstreamer.freedesktop.org/documentation/audio/?'],
+  ['GstTag', 'https://gstreamer.freedesktop.org/documentation/tag/?'],
+  ['GstPbutils', 'https://gstreamer.freedesktop.org/documentation/pbutils/?'],
+]
--- a/doc/reference/meson.build
+++ b/doc/reference/meson.build
@@ -0,0 +1,15 @@
+doc_version_conf = configuration_data()
+doc_version_conf.set('CLAPPER_VERSION', meson.project_version())
+doc_version_conf.set('CLAPPER_VERSION_SUFFIX', clapper_version_suffix)
+
+gi_docgen_common_args = [
+  '--quiet',
+  '--no-namespace-dir',
+]
+if get_option('werror')
+  gi_docgen_common_args += ['--fatal-warnings']
+endif
+
+if build_clapper
+  subdir('clapper')
+endif