meson: Add an option to build examples

Required renaming threadshare/benchmark to threadshare/ts-benchmark
because 'benchmark' as a target name is reserved for meson's
`benchmark` target.

Disabled by default because cargo decides that it has to rebuild
everything, and is really slow because of that.

Also required adding --features for setting features required by the
examples.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1028>

cargo_wrapper.py

@@ -20,7 +20,9 @@ PARSER.add_argument('prefix', type=P)
 PARSER.add_argument('libdir', type=P)
 PARSER.add_argument('--version', default=None)
 PARSER.add_argument('--bin', default=None, type=P)
+PARSER.add_argument('--features', nargs="+", default=[])
 PARSER.add_argument('--packages', nargs="+", default=[])
+PARSER.add_argument('--examples', nargs="+", default=[])
 PARSER.add_argument('--lib-suffixes', nargs="+", default=[])
 PARSER.add_argument('--exe-suffix')
 PARSER.add_argument('--depfile')
@@ -80,14 +82,15 @@ if __name__ == "__main__":
     pkg_config_path.append(str(opts.root_dir / 'meson-uninstalled'))
     env['PKG_CONFIG_PATH'] = os.pathsep.join(pkg_config_path)
 
+    features = opts.features
     if opts.command == 'build':
         cargo_cmd = ['cargo']
-        if opts.bin:
+        if opts.bin or opts.examples:
             cargo_cmd += ['build']
         else:
             cargo_cmd += ['cbuild']
             if not opts.disable_doc:
-                cargo_cmd += ['--features', "doc"]
+                features += ['doc']
         if opts.target == 'release':
             cargo_cmd.append('--release')
     elif opts.command == 'test':
@@ -97,25 +100,29 @@ if __name__ == "__main__":
         print("Unknown command:", opts.command, file=logfile)
         sys.exit(1)
 
-    cwd = None
+    if features:
+        cargo_cmd += ['--features', ','.join(features)]
     cargo_cmd += ['--target-dir', cargo_target_dir]
-    if not opts.bin:
+    cargo_cmd += ['--manifest-path', opts.src_dir / 'Cargo.toml']
-        cargo_cmd.extend(['--manifest-path', opts.src_dir / 'Cargo.toml'])
+    if opts.bin:
-        cargo_cmd.extend(['--prefix', opts.prefix, '--libdir',
+        cargo_cmd.extend(['--bin', opts.bin.name])
-                        opts.prefix / opts.libdir])
+    else:
+        if not opts.examples:
+            cargo_cmd.extend(['--prefix', opts.prefix, '--libdir',
+                              opts.prefix / opts.libdir])
         for p in opts.packages:
             cargo_cmd.extend(['-p', p])
-    else:
+        for e in opts.examples:
-        cargo_cmd.extend(['--bin', opts.bin.name])
+            cargo_cmd.extend(['--example', e])
-        cwd = opts.src_dir
 
-    def run(cargo_cmd, env, cwd=cwd):
+    def run(cargo_cmd, env):
+        print(cargo_cmd, env, file=logfile)
         try:
-            subprocess.run(cargo_cmd, env=env, check=True, cwd=cwd)
+            subprocess.run(cargo_cmd, env=env, cwd=opts.src_dir, check=True)
         except subprocess.SubprocessError:
             sys.exit(1)
 
-    run(cargo_cmd, env, cwd)
+    run(cargo_cmd, env)
 
     if opts.command == 'build':
         target_dir = cargo_target_dir / '**' / opts.target
@@ -142,6 +149,12 @@ if __name__ == "__main__":
 
                     print(f"Copying {copied_file}", file=logfile)
                     shutil.copy2(f, opts.build_dir)
+            # Copy examples to builddir
+            for example in opts.examples:
+                example_glob = str(target_dir / 'examples' / example) + opts.exe_suffix
+                exe = glob.glob(example_glob, recursive=True)[0]
+                shutil.copy2(exe, opts.build_dir)
+                depfile_content += generate_depfile_for(P(exe))
 
         with open(opts.depfile, 'w') as depfile:
             depfile.write(depfile_content)

generic/threadshare/Cargo.toml

@@ -43,7 +43,7 @@ crate-type = ["cdylib", "rlib"]
 path = "src/lib.rs"
 
 [[example]]
-name = "benchmark"
+name = "ts-benchmark"
 path = "examples/benchmark.rs"
 
 [[example]]

meson.build

@@ -45,6 +45,7 @@ endif
 plugins = {
   'audiofx': {
     'library': 'libgstrsaudiofx',
+    'examples': ['hrtfrender'],
   },
   'claxon': {'library': 'libgstclaxon'},
   # csound has a non-trivial external dependency, see below
@@ -55,11 +56,22 @@ plugins = {
   # sodium can have an external dependency, see below
   'threadshare': {
     'library': 'libgstthreadshare',
+    'examples': [
+      'ts-benchmark',
+      'udpsrc-benchmark-sender',
+      'tcpclientsrc-benchmark-sender',
+      'ts-standalone',
+    ],
   },
 
   'mp4': {'library': 'libgstmp4'},
   'fmp4': {
     'library': 'libgstfmp4',
+    'examples': [
+      'dash_vod',
+      'hls_live',
+      'hls_vod',
+    ],
   },
 
   'aws': {
@@ -78,6 +90,7 @@ plugins = {
   'webrtchttp': {'library': 'libgstwebrtchttp'},
   'webrtc': {
     'library': 'libgstrswebrtc',
+    'examples': ['webrtcsink-stats-server'],
   },
 
   'textahead': {'library': 'libgsttextahead'},
@@ -87,16 +100,24 @@ plugins = {
 
   'fallbackswitch': {
     'library': 'libgstfallbackswitch',
+    'examples': ['gtk-fallbackswitch'],
+    'features': ['gtk', 'gio', 'gst-plugin-gtk4'],
   },
   'livesync': {
     'library': 'libgstlivesync',
+    'examples': ['gtk-livesync'],
+    'features': ['gtk', 'gio', 'gst-plugin-gtk4'],
   },
   'togglerecord': {
     'library': 'libgsttogglerecord',
+    'examples': ['gtk-recording'],
+    'features': ['gtk', 'gio', 'gst-plugin-gtk4'],
   },
   'tracers': {'library': 'libgstrstracers'},
   'uriplaylistbin': {
     'library': 'libgsturiplaylistbin',
+    'examples': ['playlist'],
+    'features': ['clap'],
   },
 
   'cdg': {'library': 'libgstcdg'},
@@ -116,14 +137,17 @@ plugins = {
   'flavors': {'library': 'libgstrsflv'},
   'gif': {
     'library': 'libgstgif',
+    'examples': ['testvideosrc2gif'],
   },
   'gtk4': {
     'library': 'libgstgtk4',
+    'examples': ['gtksink'],
     'extra-deps': {'gtk4': '>=4.6'},
   },
   'hsv': {'library': 'libgsthsv'},
   'png': {
     'library': 'libgstrspng',
+    'examples': ['pngenc'],
   },
   'rav1e': {'library': 'libgstrav1e'},
   'videofx': {
@@ -151,6 +175,8 @@ sodium_opt = get_option('sodium')
 if sodium_opt.allowed()
   sodium_plugin = {'sodium': {
     'library': 'libgstsodium',
+    'examples': ['generate-keys', 'encrypt-example', 'decrypt-example'],
+    'features': ['serde', 'serde_json', 'clap'],
   }}
   if get_option('sodium-source') == 'system'
     sodium_dep = dependency('libsodium', required: sodium_opt.enabled())
@@ -175,6 +201,7 @@ if csound_option.allowed()
     if csound_dep.found()
       plugins += {'csound': {
         'library': 'libgstcsound',
+        'examples': ['csound-effect'],
       }}
       extra_env += {'CSOUND_LIB_DIR': csound_libdir}
     elif csound_option.enabled()
@@ -183,6 +210,45 @@ if csound_option.allowed()
   endif
 endif
 
+# Used to not lookup the same dependency multiple times which clutters logs
+deps_cache = {}
+
+# Need to depends on all gstreamer-rs deps to ensure they are built
+# before gstreamer-rs when building with gst-build.
+# Custom targets can't depend on dependency() objects so we have to depend
+# on the library variable from the subproject instead.
+glib_req = '>=2.62'
+gst_req = '>=1.20.0'
+depends = []
+
+deps = [
+  # name, subproject name, subproject dep, library object
+  ['gstreamer-1.0', 'gstreamer', 'gst_dep', 'libgst'],
+  ['gstreamer-app-1.0', 'gst-plugins-base', 'app_dep', 'gstapp'],
+  ['gstreamer-audio-1.0', 'gst-plugins-base', 'audio_dep', 'gstaudio'],
+  ['gstreamer-base-1.0', 'gstreamer', 'gst_base_dep', 'gst_base'],
+  ['gstreamer-check-1.0', 'gstreamer', 'gst_check_dep', 'gst_check'],
+  ['gstreamer-net-1.0', 'gstreamer', 'gst_net_dep', 'gst_net'],
+  ['gstreamer-rtp-1.0', 'gst-plugins-base', 'rtp_dep', 'gst_rtp'],
+  ['gstreamer-video-1.0', 'gst-plugins-base', 'video_dep', 'gstvideo'],
+  ['gstreamer-sdp-1.0', 'gst-plugins-base', 'sdp_dep', 'gstsdp'],
+  ['gstreamer-webrtc-1.0', 'gst-plugins-bad', 'gstwebrtc_dep', 'gstwebrtc'],
+]
+
+glib_dep = dependency('glib-2.0', version: glib_req)
+deps_cache += {'glib-2.0': glib_dep}
+
+foreach d: deps
+  dep = dependency(d[0], version: gst_req,
+    fallback : [d[1], d[2]])
+  set_variable(d[2], dep)
+  deps_cache += {d[0]: dep}
+  if dep.type_name() == 'internal'
+    lib = subproject(d[1]).get_variable(d[3])
+    depends += lib
+  endif
+endforeach
+
 # Process plugins list
 
 default_library = get_option('default_library')
@@ -197,10 +263,47 @@ endif
 
 # cargo packages (plugins) to build
 packages = []
+# cargo features
+features = []
+# examples to build
+examples = []
 # Add the plugin library files as output
 output = []
-# Used to not lookup the same dependency multiple times which clutters logs
+
-deps_cache = {}
+if glib_dep.version().version_compare('>=2.74')
+  features += ['glib/v2_74', 'gio/v2_74']
+elif glib_dep.version().version_compare('>=2.72')
+  features += ['glib/v2_72', 'gio/v2_72']
+elif glib_dep.version().version_compare('>=2.70')
+  features += ['glib/v2_70', 'gio/v2_70']
+elif glib_dep.version().version_compare('>=2.68')
+  features += ['glib/v2_68', 'gio/v2_68']
+elif glib_dep.version().version_compare('>=2.66')
+  features += ['glib/v2_66', 'gio/v2_66']
+elif glib_dep.version().version_compare('>=2.64')
+  features += ['glib/v2_64', 'gio/v2_64']
+elif glib_dep.version().version_compare('>=2.62')
+  features += ['glib/v2_62', 'gio/v2_62']
+elif glib_dep.version().version_compare('>=2.60')
+  features += ['glib/v2_60', 'gio/v2_60']
+elif glib_dep.version().version_compare('>=2.58')
+  features += ['glib/v2_58', 'gio/v2_58']
+endif
+
+if gst_dep.version().version_compare('>=1.21')
+  components = [
+    '', '-app', '-audio', '-base', '-check', '-net', '-pbutils',
+    '-plugin-tracers', '-rtp', '-sdp', '-utils', '-video', '-webrtc',
+  ]
+  foreach c: components
+    features += f'gst@c@/v1_22'
+  endforeach
+  features += ['gst-plugin-webrtc/gst1_22']
+endif
+
+if find_program('nasm', required: false).found()
+  features += 'gst-plugin-rav1e/asm'
+endif
 
 foreach plugin_name, details: plugins
   plugin_opt = get_option(plugin_name)
@@ -219,6 +322,8 @@ foreach plugin_name, details: plugins
     endforeach
     if plugin_deps_found
       packages += f'gst-plugin-@plugin_name@'
+      features += details.get('features', [])
+      examples += details.get('examples', [])
       lib = details.get('library')
       if default_library in ['shared', 'both']
         output += [lib + '.' + ext_dynamic]
@@ -231,48 +336,12 @@ foreach plugin_name, details: plugins
 endforeach
 
 
-
-# Need to depends on all gstreamer-rs deps to ensure they are built
-# before gstreamer-rs when building with gst-build.
-# Custom targets can't depend on dependency() objects so we have to depend
-# on the library variable from the subproject instead.
-gst_req = '>= 1.20.0'
-depends = []
-
-deps = [
-  # name, subproject name, subproject dep, library object
-  ['gstreamer-1.0', 'gstreamer', 'gst_dep', 'libgst'],
-  ['gstreamer-app-1.0', 'gst-plugins-base', 'app_dep', 'gstapp'],
-  ['gstreamer-audio-1.0', 'gst-plugins-base', 'audio_dep', 'gstaudio'],
-  ['gstreamer-base-1.0', 'gstreamer', 'gst_base_dep', 'gst_base'],
-  ['gstreamer-check-1.0', 'gstreamer', 'gst_check_dep', 'gst_check'],
-  ['gstreamer-net-1.0', 'gstreamer', 'gst_net_dep', 'gst_net'],
-  ['gstreamer-rtp-1.0', 'gst-plugins-base', 'rtp_dep', 'gst_rtp'],
-  ['gstreamer-video-1.0', 'gst-plugins-base', 'video_dep', 'gstvideo'],
-  ['gstreamer-sdp-1.0', 'gst-plugins-base', 'sdp_dep', 'gstsdp'],
-  ['gstreamer-webrtc-1.0', 'gst-plugins-bad', 'gstwebrtc_dep', 'gstwebrtc'],
-]
-
-foreach d: deps
-  dep = dependency(d[0], version : gst_req,
-    fallback : [d[1], d[2]])
-  set_variable(d[2], dep)
-  deps_cache += {d[0]: dep}
-  if dep.type_name() == 'internal'
-    lib = subproject(d[1]).get_variable(d[3])
-    depends += lib
-  endif
-endforeach
-
-include = ','.join(plugins.keys())
-
 plugins_install_dir = get_option('libdir') / 'gstreamer-1.0'
 pkgconfig_install_dir = get_option('libdir') / 'pkgconfig'
 
+extra_args = []
 if get_option('doc').disabled()
-  disable_doc = ['--disable-doc']
+  extra_args = ['--disable-doc']
-else
-  disable_doc = []
 endif
 
 # 'pkgconfig' is the entry in the machine file, if specified
@@ -308,9 +377,10 @@ rs_plugins = custom_target('gst-plugins-rs',
     get_option('prefix'),
     get_option('libdir'),
     '--packages', packages,
+    '--features', features,
     '--depfile', '@DEPFILE@',
     '--lib-suffixes', library_suffixes,
-  ] + disable_doc)
+  ] + extra_args)
 
 plugins = rs_plugins.to_list()
 
@@ -413,6 +483,30 @@ if get_option('webrtc').allowed()
     ])
 endif
 
+if get_option('examples').allowed() and examples.length() > 0
+  custom_target('gst-plugins-rs-examples',
+    build_by_default: true,
+    output: examples,
+    console: true,
+    install: false,
+    depfile: 'gst-plugins-rs-examples.dep',
+    env: extra_env,
+    command: [cargo_wrapper,
+      'build',
+      meson.current_build_dir(),
+      meson.current_source_dir(),
+      meson.global_build_root(),
+      target,
+      get_option('prefix'),
+      get_option('libdir'),
+      '--depfile', '@DEPFILE@',
+      '--packages', packages,
+      '--features', features,
+      '--examples', examples,
+      '--exe-suffix', exe_suffix,
+    ])
+endif
+
 test('tests',
   cargo_wrapper,
   env: extra_env,

meson_options.txt

@@ -60,3 +60,5 @@ option('webp', type: 'feature', value: 'auto', description: 'Build webp plugin')
 # Common options
 option('doc', type: 'feature', value: 'auto', yield: true,
        description: 'Enable documentation')
+option('examples', type: 'feature', value: 'disabled', yield: true,
+       description: 'Build examples')