docs: document gstreamer-bad-audio

And unprefix subproject paths, making a special case for
webrtc, to not conflict with the webrtc plugin

diff --git a/docs/libs/audio/index.md b/docs/libs/audio/index.md
new file mode 100644 (file)
index 0000000..75152f8
--- /dev/null
+++ b/docs/libs/audio/index.md
@@ -0,0 +1,6 @@
+# Bad Audio library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-bad-audio{{ gst_api_version.md }}.pc
+
+> NOTE: This library API is considered *unstable*

diff --git a/docs/libs/audio/sitemap.txt b/docs/libs/audio/sitemap.txt
new file mode 100644 (file)
index 0000000..4f91fcd
--- /dev/null
+++ b/docs/libs/audio/sitemap.txt
@@ -0,0 +1 @@
+gi-index

diff --git a/docs/meson.build b/docs/meson.build
index 955ad23..4ecf45d 100644 (file)
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -99,7 +99,8 @@ if build_gir
         {'name': 'insertbin', 'gir': insertbin_gir, 'lib': gstinsertbin_dep},
         {'name': 'codecparsers', 'lib': gstcodecparsers_dep},
         {'name': 'adaptivedemux', 'lib': gstadaptivedemux_dep},
-        {'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep},
+        {'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep, 'suffix': 'lib'},
+        {'name': 'audio', 'gir': audio_gir, 'lib': gstbadaudio_dep, 'prefix': 'bad-'},
    ]
 endif
 
@@ -112,7 +113,9 @@ foreach lib_def: libs
     if lib_def.has_key('gir')
         if has_gi_extension
             gir = lib_def['gir']
-            libs_doc += [hotdoc.generate_doc('gst-plugins-bad-' + name,
+            prefix = lib_def.get('prefix', '')
+            suffix = lib_def.get('suffix', '')
+            libs_doc += [hotdoc.generate_doc(prefix + name + suffix,
                 project_version: api_version,
                 gi_c_sources: [join_paths(root_rel, 'gst-libs/gst', name, '*.[hc]')],
                 gi_sources: gir[0].full_path(),

diff --git a/gst-libs/gst/audio/gstnonstreamaudiodecoder.c b/gst-libs/gst/audio/gstnonstreamaudiodecoder.c
index ef1361c..3ace713 100644 (file)
--- a/gst-libs/gst/audio/gstnonstreamaudiodecoder.c
+++ b/gst-libs/gst/audio/gstnonstreamaudiodecoder.c
@@ -42,8 +42,8 @@
  * Subsongs are a set of songs-within-a-song. An analogy would be a multitrack
  * recording, where each track is its own song. The first subsong is typically
  * the "main" one. Subsongs were popular for video games to enable context-
- * aware music; for example, subsong #0 would be the "main" song, #1 would be
- * an alternate song playing when a fight started, #2 would be heard during
+ * aware music; for example, subsong `#0` would be the "main" song, `#1` would be
+ * an alternate song playing when a fight started, `#2` would be heard during
  * conversations etc. The base class is designed to always have at least one
  * subsong. If the subclass doesn't provide any, the base class creates a
  * "pseudo" subsong, which is actually the whole song.
@@ -89,7 +89,7 @@
  *   - If upstream cannot respond to the size query (in bytes) of @load_from_buffer
  *     fails, an error is reported, and the pipeline stops.
  *   - If there are no errors, @load_from_buffer is called to load the media. The
- *     subclass must at least call gst_nonstream_audio_decoder_set_output_audioinfo()
+ *     subclass must at least call gst_nonstream_audio_decoder_set_output_format()
  *     there, and is free to make use of the initial subsong, output mode, and
  *     position. If the actual output mode or position differs from the initial
  *     value,it must set the initial value to the actual one (for example, if