Update

subprojects/gst-plugins-base/docs/gst_api_version.in

@@ -0,0 +1 @@
+@GST_API_VERSION@

subprojects/gst-plugins-base/docs/index.md

@@ -0,0 +1,6 @@
+---
+short-description:  GStreamer Base Plugins API reference.
+...
+
+# GStreamer Base Plugins
+

subprojects/gst-plugins-base/docs/libs/allocators/index.md

@@ -0,0 +1,5 @@
+# Allocators Library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-plugins-base-{{ gst_api_version.md }}.pc and adding
+-lgstallocators-{{ gst_api_version.md }} to the library flags.

subprojects/gst-plugins-base/docs/libs/allocators/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/app/index.md

@@ -0,0 +1,8 @@
+# App Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}pc` and adding
+-lgstapp-{{ gst_api_version.md }} to the library flags.
+
+To use it the functionality, insert an `appsrc` or `appsink` element
+into a pipeline and call the appropriate functions on the element.

subprojects/gst-plugins-base/docs/libs/app/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/audio/index.md

@@ -0,0 +1,6 @@
+# Audio Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstaudio-{{ gst_api_version.md }}` to the library flags.
+

subprojects/gst-plugins-base/docs/libs/audio/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/ext/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/fft/index.md

@@ -0,0 +1,8 @@
+# FFT Library
+
+The gstfft library is based on
+[kissfft](http://sourceforge.net/projects/kissfft) by Mark Borgerding.
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstfft-{{ gst_api_version.md }}` to the library flags.

subprojects/gst-plugins-base/docs/libs/fft/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/gl-egl/index.md

@@ -0,0 +1,4 @@
+# GStreamer OpenGL Library - EGL
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-gl-egl-{{ gst_api_version.md }}.pc`.

subprojects/gst-plugins-base/docs/libs/gl-egl/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/gl-wayland/index.md

@@ -0,0 +1,4 @@
+# GStreamer OpenGL Library - Wayland
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-gl-wayland-{{ gst_api_version.md }}.pc`.

subprojects/gst-plugins-base/docs/libs/gl-wayland/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/gl-x11/index.md

@@ -0,0 +1,4 @@
+# GStreamer OpenGL Library - X11
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-gl-x11-{{ gst_api_version.md }}.pc`.

subprojects/gst-plugins-base/docs/libs/gl-x11/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/gl/index.md

@@ -0,0 +1,4 @@
+# GStreamer OpenGL Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-gl-{{ gst_api_version.md }}.pc`.

subprojects/gst-plugins-base/docs/libs/gl/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/pbutils/index.md

@@ -0,0 +1,7 @@
+# Base Utils Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstpbutils-{{ gst_api_version.md }}` to the library
+flags.
+

subprojects/gst-plugins-base/docs/libs/pbutils/sitemap.txt

@@ -0,0 +1,3 @@
+gi-index
+	pbutils.h
+	encoding-profile.h

subprojects/gst-plugins-base/docs/libs/riff/index.md

@@ -0,0 +1,5 @@
+# Riff Media Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstriff-{{ gst_api_version.md }}` to the library flags.

subprojects/gst-plugins-base/docs/libs/riff/sitemap.txt

@@ -0,0 +1 @@
+c-index

subprojects/gst-plugins-base/docs/libs/rtp/index.md

@@ -0,0 +1,5 @@
+# RTP Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstrtp-{{ gst_api_version.md }}` to the library flags.

subprojects/gst-plugins-base/docs/libs/rtp/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/rtsp/index.md

@@ -0,0 +1,5 @@
+# RTSP Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstrtsp-{{ gst_api_version.md }}` to the library flags.

subprojects/gst-plugins-base/docs/libs/rtsp/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/sdp/index.md

@@ -0,0 +1,6 @@
+# SDP Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstsdp-{{ gst_api_version.md }}` to the library flags.
+

subprojects/gst-plugins-base/docs/libs/sdp/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/tag/index.md

@@ -0,0 +1,6 @@
+# Tag Support Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgsttag-{{ gst_api_version.md }}` to the library flags.
+

subprojects/gst-plugins-base/docs/libs/tag/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/libs/video/index.md

@@ -0,0 +1,5 @@
+# Video Library
+
+This library should be linked to by getting cflags and libs from
+`gstreamer-plugins-base-{{ gst_api_version.md }}.pc` and adding
+`-lgstvideo-{{ gst_api_version.md }}` to the library flags.

subprojects/gst-plugins-base/docs/libs/video/sitemap.txt

@@ -0,0 +1 @@
+gi-index

subprojects/gst-plugins-base/docs/meson.build

@@ -0,0 +1,225 @@
+build_hotdoc = false
+
+if meson.is_cross_build()
+    if get_option('doc').enabled()
+        error('Documentation enabled but building the doc while cross building is not supported yet.')
+    endif
+
+    message('Documentation not built as building it while cross building is not supported yet.')
+    subdir_done()
+endif
+
+if static_build
+    if get_option('doc').enabled()
+        error('Documentation enabled but not supported when building statically.')
+    endif
+
+    message('Building statically, can\'t build the documentation')
+    subdir_done()
+endif
+
+if not build_gir
+    if get_option('doc').enabled()
+        error('Documentation enabled but introspection not built.')
+    endif
+
+    message('Introspection not built, won\'t build documentation requiring it')
+    subdir_done()
+endif
+
+
+required_hotdoc_extensions = ['gi-extension', 'gst-extension']
+if gst_dep.type_name() == 'internal'
+    gst_proj = subproject('gstreamer')
+    plugins_cache_generator = gst_proj.get_variable('plugins_cache_generator')
+else
+    plugins_cache_generator = find_program(join_paths(gst_dep.get_variable('libexecdir'), 'gstreamer-' + api_version, 'gst-plugins-doc-cache-generator'),
+        required: false)
+endif
+
+plugins_cache = join_paths(meson.current_source_dir(), 'plugins', 'gst_plugins_cache.json')
+if plugins.length() == 0
+    message('All base plugins have been disabled')
+elif plugins_cache_generator.found()
+    plugins_doc_dep = custom_target('base-plugins-doc-cache',
+        command: [plugins_cache_generator, plugins_cache, '@OUTPUT@', '@INPUT@'],
+        input: plugins,
+        output: 'gst_plugins_cache.json',
+        build_always_stale: true,
+    )
+else
+    warning('GStreamer plugin inspector for documentation not found, can\'t update the cache')
+endif
+
+hotdoc_p = find_program('hotdoc', required: get_option('doc'))
+if not hotdoc_p.found()
+    message('Hotdoc not found, not building the documentation')
+    subdir_done()
+endif
+
+hotdoc_req = '>= 0.11.0'
+hotdoc_version = run_command(hotdoc_p, '--version', check: false).stdout()
+if not hotdoc_version.version_compare(hotdoc_req)
+    if get_option('doc').enabled()
+        error('Hotdoc version @0@ not found, got @1@'.format(hotdoc_req, hotdoc_version))
+    else
+        message('Hotdoc version @0@ not found, got @1@'.format(hotdoc_req, hotdoc_version))
+        subdir_done()
+    endif
+endif
+
+hotdoc = import('hotdoc')
+foreach extension: required_hotdoc_extensions
+    if not hotdoc.has_extensions(extension)
+        if get_option('doc').enabled()
+            error('Documentation enabled but @0@ missing'.format(extension))
+        endif
+
+        message('@0@ extension not found, not building documentation'.format(extension))
+        subdir_done()
+    endif
+endforeach
+
+build_hotdoc = true
+docconf = configuration_data()
+docconf.set('GST_API_VERSION', api_version)
+
+version_entities = configure_file(input : 'version.in',
+    output : 'gst_api_version.md',
+    configuration : docconf)
+
+libs_excludes = []
+foreach h: ['pbutils-private.h', 'gsttageditingprivate.h', 'id3v2.h',
+  'kiss_fft_f32.h', 'kiss_fft_f64.h', 'kiss_fftr_f32.h', 'kiss_fftr_f64.h',
+  'kiss_fftr_s16.h', 'kiss_fftr_s32.h', 'kiss_fft_s16.h', 'kiss_fft_s32.h',
+  '_kiss_fft_guts_f32.h', '_kiss_fft_guts_f64.h', '_kiss_fft_guts_s16.h',
+  '_kiss_fft_guts_s16.h', '_kiss_fft_guts_s32.h', '_kiss_fft_guts_s32.h',
+  'pbutils-marshal.h', 'audio-resampler-private.h', '*orc-dist.*',
+  '*-neon.h', 'audio-resampler-macros.[ch]', '*-prelude.h', '*_private.h',
+  'gstglfuncs.[ch]', 'gstgl_fwd.h'
+  ]
+
+  libs_excludes += [join_paths(meson.current_source_dir(), '..', 'gst-libs/gst/*/', h)]
+endforeach
+
+libs = [
+  ['allocators', allocators_gir, allocators_dep],
+  ['app', app_gir, app_dep],
+  ['audio', audio_gir, audio_dep],
+  # FIXME! ['fft', fft_gir, fft_dep],
+  ['pbutils', pbutils_gir, pbutils_dep],
+  ['rtp', rtp_gir, rtp_dep],
+  ['rtsp', rtsp_gir, rtsp_dep],
+  ['sdp', sdp_gir, sdp_dep],
+  ['tag', tag_gir, tag_dep],
+  ['video', video_gir, video_dep],
+]
+
+if build_gstgl
+  libs += [['gl', gl_gir, gstgl_dep]]
+  if enabled_gl_platforms.contains('egl')
+    libs += [['gl-egl', gl_egl_gir, gstgl_dep, [
+      join_paths('../gst-libs/gst', 'gl', 'egl', 'gstegl.[ch]'),
+      join_paths('../gst-libs/gst', 'gl', 'egl', 'gsteglimage.[ch]'),
+      join_paths('../gst-libs/gst', 'gl', 'egl', 'gstgldisplay_egl.[ch]'),
+      join_paths('../gst-libs/gst', 'gl', 'egl', 'gstgldisplay_egl_device.[ch]'),
+      join_paths('../gst-libs/gst', 'gl', 'egl', 'gstglmemoryegl.[ch]'),
+    ]]]
+  endif
+  if enabled_gl_winsys.contains('x11')
+    libs += [['gl-x11', gl_x11_gir, gstgl_dep, [
+      join_paths('../gst-libs/gst', 'gl', 'x11', 'gstgldisplay_x11.[ch]'),
+    ]]]
+  endif
+  if enabled_gl_winsys.contains('wayland')
+    libs += [['gl-wayland', gl_wayland_gir, gstgl_dep, [
+      join_paths('../gst-libs/gst', 'gl', 'wayland', 'gstgldisplay_wayland.[ch]'),
+    ]]]
+  endif
+endif
+
+# Used to avoid conflicts with known plugin names
+project_names = {
+  'app': 'applib',
+  'rtp': 'rtplib',
+  'rtsp': 'rtsplib',
+}
+
+libs_doc = []
+foreach lib: libs
+  name = lib[0]
+  gir = lib[1]
+  deps = [lib[2], gir]
+  extra_sources = []
+  if lib.length() >= 4
+    extra_sources = lib[3]
+  endif
+  project_name = project_names.get(name, name)
+  libs_doc += [hotdoc.generate_doc(project_name,
+      project_version: api_version,
+      gi_c_sources: [join_paths('../gst-libs/gst', name, '*.[hc]')] + extra_sources,
+      gi_sources: gir[0].full_path(),
+      gi_c_source_filters: libs_excludes,
+      gi_c_source_roots: [join_paths(meson.current_source_dir(), '../gst-libs/gst/' + name), ],
+      sitemap: 'libs/' + name + '/sitemap.txt',
+      index: 'libs/' + name + '/index.md',
+      gi_index: 'libs/' + name + '/index.md',
+      gi_smart_index: true,
+      gi_order_generated_subpages: true,
+      dependencies: deps,
+      install: false,
+  )]
+endforeach
+
+if not hotdoc.has_extensions('c-extension')
+    if get_option('doc').enabled()
+        error('Documentation enabled but c-extension missing')
+    endif
+    message('c-extension not found, not building documentation')
+else
+    libs_doc += [hotdoc.generate_doc('riff',
+        project_version: api_version,
+        c_sources: ['../gst-libs/gst/riff/*.[hc]'],
+        c_source_filters: libs_excludes,
+        sitemap: 'libs/riff/sitemap.txt',
+        index: 'libs/riff/index.md',
+        c_index: 'libs/riff/index.md',
+        c_smart_index: true,
+        c_order_generated_subpages: true,
+        dependencies: [gst_base_dep, riff_dep],
+        install: false,
+        disable_incremental_build: true,
+    )]
+endif
+
+plugins_doc = []
+sitemap = 'all_index.md\n'
+
+list_plugin_res = run_command(python3, '-c',
+'''
+import sys
+import json
+
+with open("@0@") as f:
+    print(':'.join(json.load(f).keys()), end='')
+'''.format(plugins_cache),
+  check: true)
+foreach plugin_name: list_plugin_res.stdout().split(':')
+    plugins_doc += [hotdoc.generate_doc(plugin_name,
+        project_version: api_version,
+        sitemap: 'plugins/sitemap.txt',
+        index: 'plugins/index.md',
+        gst_index: 'plugins/index.md',
+        gst_smart_index: true,
+        gst_c_sources: [
+          '../sys/*/*.[ch]',
+          '../ext/*/*.[cmh]',
+          '../gst/*/*.[ch]',
+        ],
+        dependencies: [gst_dep, plugins],
+        gst_order_generated_subpages: true,
+        gst_cache_file: plugins_cache,
+        gst_plugin_name: plugin_name,
+    )]
+    sitemap += '        @0@-doc.json\n'.format(plugin_name)
+endforeach

subprojects/gst-plugins-base/docs/plugins/all_index.md

@@ -0,0 +1,5 @@
+---
+short-description: Plugins from gst-plugins-base
+...
+
+# Plugins

subprojects/gst-plugins-base/docs/plugins/sitemap.txt

@@ -0,0 +1 @@
+gst-index

subprojects/gst-plugins-base/docs/random/LICENSE

@@ -0,0 +1,18 @@
+/* GStreamer
+ * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */

subprojects/gst-plugins-base/docs/sitemap.txt

@@ -0,0 +1,3 @@
+index.md
+        gst-plugins-base-libs-doc.json
+        gst-plugins-base-plugins-doc.json

subprojects/gst-plugins-base/docs/version.in

@@ -0,0 +1 @@
+@GST_API_VERSION@