1 project('gstreamer-full', 'c',
3 meson_version : '>= 0.60.0',
4 default_options : ['buildtype=debugoptimized',
5 # Needed due to https://github.com/mesonbuild/meson/issues/1889,
6 # but this can cause problems in the future. Remove it
7 # when it's no longer necessary.
11 gst_version = '>= @0@'.format(meson.project_version())
13 build_system = build_machine.system()
14 cc = meson.get_compiler('c')
17 gnome = import('gnome')
18 pkgconfig = import('pkgconfig')
19 python3 = import('python').find_installation()
20 # Ensure that we're not being run from inside the development environment
21 # because that will confuse meson, and it might find the already-built
22 # gstreamer. It's fine if people run `ninja` as long as it doesn't run
23 # reconfigure because ninja doesn't care about the env.
24 ensure_not_devenv = '''
26 assert('GST_ENV' not in os.environ)
28 cmdres = run_command(python3, '-c', ensure_not_devenv, check: false)
29 if cmdres.returncode() != 0
30 error('Do not run `ninja reconfigure` or `meson` for gst-build inside the development environment, you will run into problems')
33 # Install gst-indent pre-commit hook
34 run_command(python3, '-c', 'import shutil; shutil.copy("scripts/git-hooks/multi-pre-commit.hook", ".git/hooks/pre-commit")', check: false)
36 # Ensure that the user does not have Strawberry Perl in PATH, since it ships
37 # with a pkg-config.bat and broken pkgconfig files for libffi and zlib. Will
38 # cause a build error, such as in
39 # https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/41
40 ensure_no_strawberry_perl = '''
42 assert(r'Strawberry\perl\bin' not in os.environ['PATH'])
44 if build_system == 'windows' and meson.version().version_compare('<0.60.0')
45 cmdres = run_command(python3, '-c', ensure_no_strawberry_perl, check: false)
46 if cmdres.returncode() != 0
47 error('You have Strawberry Perl in PATH which is known to cause build issues with Meson < 0.60.0. Please remove it from PATH, uninstall it, or upgrade Meson.')
51 # On macOS, you have to run "Install Certificates.command" otherwise Python
52 # doesn't have access to the latest SSL CA Certificates, and Meson will fail to
53 # download wrap files from websites that use, for example, Let's Encrypt.
54 # We already recommend this in the README, but add a warning here as well.
55 # Can't make this an error because the user might be using XCode's Python
56 # 3 which doesn't have this script.
57 if build_system == 'darwin'
58 python3_cacert_file = python3.get_path('data') / 'etc/openssl/cert.pem'
59 install_cert_cmd = '/Applications/Python @0@/Install Certificates.command'.format(python3.language_version())
60 if not fs.is_symlink(python3_cacert_file) and fs.is_file(install_cert_cmd)
61 warning('Please run "@0@" so that Python has access to the latest SSL certificates. Meson might fail to download some wraps without it.'.format(install_cert_cmd))
65 documented_projects = ''
66 # Make it possible to use msys2 built zlib which fails
67 # when not using the mingw toolchain as it uses unistd.h
68 if not meson.is_subproject() and cc.get_id() == 'msvc'
69 uname = find_program('uname', required: false)
71 ret = run_command(uname, '-o', check: false)
72 if ret.returncode() == 0 and ret.stdout().to_lower() == 'msys'
73 ret = run_command(uname, '-r', check: false)
74 # The kernel version returned by uname is actually the msys version
75 if ret.returncode() == 0 and ret.stdout().startswith('2')
76 # If a system zlib is found, disable UNIX features in zlib.h and zconf.h
77 if cc.find_library('z').found()
78 add_global_arguments('-DZ_SOLO', language: 'c')
85 # Ensure that MSVC interprets all source code as UTF-8. Only do this when we're
86 # not a subproject, because subprojects are not allowed to call
87 # add_global_arguments().
88 if not meson.is_subproject() and cc.get_id() == 'msvc'
90 cc.get_supported_arguments(['/utf-8']), # set the input encoding to utf-8
91 language: ['c', 'cpp'])
94 building_full = get_option('default_library') == 'static'
95 tools_option = 'tools=auto'
96 if building_full and not get_option('tools').disabled()
97 # Do not build subprojects tools when we build them against gst-full
98 tools_option = 'tools=disabled'
101 # Ordered list of subprojects (dict has no ordering guarantees)
103 ['gstreamer', {'build-hotdoc': true, 'subproject_options': [tools_option]}],
104 ['gst-plugins-base', {'option': get_option('base'), 'build-hotdoc': true}],
105 ['gst-plugins-good', {'option': get_option('good'), 'build-hotdoc': true}],
106 ['libnice', { 'option': get_option('libnice'), 'match_gst_version': false}],
107 ['gst-plugins-bad', { 'option': get_option('bad'), 'build-hotdoc': true}],
108 ['gst-plugins-ugly', { 'option': get_option('ugly'), 'build-hotdoc': true}],
109 ['gst-libav', { 'option': get_option('libav'), 'build-hotdoc': true}],
110 ['gst-rtsp-server', { 'option': get_option('rtsp_server'), 'build-hotdoc': true}],
111 ['gst-devtools', { 'option': get_option('devtools'), 'build-hotdoc': true, 'subproject_options': [tools_option]}],
112 ['gst-integration-testsuites', { 'option': get_option('devtools') }],
113 ['gst-editing-services', { 'option': get_option('ges'), 'build-hotdoc': true, 'subproject_options': [tools_option]}],
114 ['gstreamer-vaapi', { 'option': get_option('vaapi'), 'build-hotdoc': true}],
115 ['gst-omx', { 'option': get_option('omx'), 'build-hotdoc': true}],
116 ['gstreamer-sharp', { 'option': get_option('sharp') }],
117 ['pygobject', { 'option': get_option('python'), 'match_gst_version': false, 'sysdep': 'pygobject-3.0', 'sysdep_version': '>= 3.8' }],
118 ['gst-python', { 'option': get_option('python')}],
119 ['gst-examples', { 'option': get_option('gst-examples'), 'match_gst_versions': false}],
120 ['gst-plugins-rs', { 'option': get_option('rs'), 'match_gst_version': false}],
126 os.symlink(os.path.join('@1@', 'subprojects', '@0@'),
127 os.path.join('@1@', '@0@'))
130 if build_system == 'windows'
131 subproject('win-flex-bison-binaries')
132 subproject('win-nasm')
133 elif build_system == 'darwin'
134 subproject('macos-bison-binary')
137 orc_subproject = subproject('orc', required: get_option('orc'))
139 foreach custom_subproj: get_option('custom_subprojects').split(',')
140 if custom_subproj != ''
141 message ('Adding custom subproject ' + custom_subproj)
142 subprojects += [[custom_subproj, {'match_gst_version': false}]]
147 subprojects_names = []
148 plugins_doc_caches = []
149 orc_update_targets = []
152 # Using a list and not a dict to keep the ordering to build the chain of `gir`
155 foreach sp : subprojects
158 is_required = build_infos.get('option', true)
159 sysdep = build_infos.get('sysdep', '')
160 sysdep_version = build_infos.get('sysdep_version', '')
161 match_gst_version = build_infos.get('match_gst_version', true)
162 default_options = build_infos.get('subproject_options', [])
165 subproj = subproject(project_name, version: gst_version, required: is_required, default_options: default_options)
167 sysdep_dep = dependency(sysdep, version: sysdep_version, required: false, default_options: default_options)
168 if not sysdep_dep.found()
169 subproj = subproject(project_name, required: is_required, default_options: default_options)
172 subproj = subproject(project_name, required: is_required, default_options: default_options)
176 plugins = subproj.get_variable('gst_plugins', [])
177 legacy_plugins = subproj.get_variable('plugins', [])
178 all_plugins += plugins
179 if plugins.length() == 0 and legacy_plugins.length() > 0
180 warning(f'DEPRECATED use of the `plugins` variable in @project_name@.')
181 warning('The variable should now be called `gst_plugins` and use:')
182 warning('`declare_dependency( link_with: <plugin_target>, variable: {\'full_path\': <plugin_target>.full_path()})` instead')
183 foreach plugin: legacy_plugins
184 all_plugins += [declare_dependency(link_with: plugin, variables: {'full_path': plugin.full_path()})]
188 all_libraries += subproj.get_variable('gst_libraries', [])
189 if not get_option('tools').disabled()
190 all_tools += subproj.get_variable('gst_tools', {})
193 orc_update_targets += subproj.get_variable('orc_update_targets', [])
195 subprojects_names += [project_name]
197 if not meson.is_cross_build() and build_infos.get('build-hotdoc', false)
198 plugins_doc_caches += [subproj.get_variable('gst_plugins_doc_dep', [])]
199 if documented_projects != ''
200 documented_projects += ','
202 documented_projects += project_name
207 # Check if we need to also build glib-networking for TLS modules
209 glib_dep = dependency('glib-2.0')
210 if glib_dep.type_name() == 'internal'
211 subp = subproject('glib-networking', required : get_option('tls'),
212 default_options: ['gnutls=auto', 'openssl=auto'])
214 giomodules += subp.get_variable('giomodules', [])
218 gst_plugins_doc_dep = custom_target('plugins-doc-cache',
219 command: [python3, '-c', 'print("Built all doc caches")'],
220 input: plugins_doc_caches,
221 output: 'plugins_doc_caches',
225 if meson.is_cross_build() or build_machine.system() == 'windows'
226 if get_option('doc').enabled()
227 error('Documentation enabled but building the doc while cross building or building on windows is not supported yet.')
230 documented_projects = ''
231 message('Documentation not built as building the documentation while cross building or building on windows is not supported yet.')
233 hotdoc_p = find_program('hotdoc', required : get_option('doc'))
234 if not hotdoc_p.found()
235 documented_projects = ''
236 message('Not building documentation as hotdoc was not found')
240 write_file_contents = '''
244 assert len(sys.argv) >= 3
246 contents = sys.argv[2]
248 with open(fname, 'w') as f:
253 output : 'GstDocumentedSubprojects',
255 '-c', write_file_contents,
260 if documented_projects != ''
261 subproject('gst-docs', required: get_option('doc').enabled())
262 message('Gst docs subprojects: ' + documented_projects)
265 all_plugins_paths = []
266 all_plugins_dirs = []
268 foreach plugin: all_plugins
269 plugin_path = plugin.get_variable('full_path')
270 all_plugins_paths += plugin_path
271 all_plugins_dirs += fs.parent(plugin_path)
272 plugins_names += plugin_path
275 # Work around meson bug: https://github.com/mesonbuild/meson/pull/6770
276 pathsep = host_machine.system() == 'windows' ? ';' : ':'
277 all_plugins_paths = pathsep.join(all_plugins_paths)
279 devenv = environment()
281 devenv.prepend('GST_PLUGIN_PATH', all_plugins_dirs)
283 # Make sure the current build directory is first in PATH so we prefer tools
284 # built here that links on gst-full instead instead of those built in
286 devenv.prepend('PATH', meson.current_build_dir())
288 devenv.set('CURRENT_GST', meson.current_source_dir())
289 devenv.set('GST_VERSION', meson.project_version())
290 devenv.set('GST_ENV', 'gst-' + meson.project_version())
291 devenv.set('GST_REGISTRY', meson.current_build_dir() / 'registry.dat')
292 devenv.set('GST_PLUGIN_SYSTEM_PATH', '')
293 meson.add_devenv(devenv)
295 generate_plugins_paths = find_program('scripts/generate_plugins_path.py')
297 output : 'GstPluginsPath.json',
298 command : [generate_plugins_paths,
304 cdata = configuration_data()
305 cdata.set_quoted('GST_API_VERSION', apiversion)
306 cdata.set_quoted('GETTEXT_PACKAGE', 'gstreamer-full-1.0')
307 cdata.set_quoted('PACKAGE_VERSION', gst_version)
308 cdata.set_quoted('GST_PACKAGE_ORIGIN', get_option('package-origin'))
309 configure_file(output : 'config.h', configuration : cdata)
310 configinc = include_directories('.')
311 gst_c_args = ['-DHAVE_CONFIG_H']
313 # Generate a .c file which declare and register all built plugins
314 all_plugin_names = ';'.join(plugins_names)
316 static_plugins = get_option('gst-full-plugins')
317 if static_plugins == '*'
318 static_plugins = all_plugin_names
320 generate_init_static_plugins = find_program('scripts/generate_init_static_plugins.py')
321 init_static_plugins_c = configure_file(
322 output: 'gstinitstaticplugins.c',
323 command : [generate_init_static_plugins,
325 '-p ' + static_plugins,
326 '-e ' + get_option('gst-full-elements'),
327 '-t ' + get_option('gst-full-typefind-functions'),
328 '-d ' + get_option('gst-full-device-providers'),
329 '-T ' + get_option('gst-full-dynamic-types'),
330 '--giomodules', ';'.join(giomodules),
334 gstfull_link_args = cc.get_supported_link_arguments(['-Wl,-Bsymbolic-functions'])
336 # Get a list of libraries that needs to be exposed in the ABI.
341 wanted_libs = ['gstreamer-1.0'] + get_option('gst-full-libraries')
342 all_libs = '*' in wanted_libs
344 foreach pkgname_library : all_libraries
345 pkg_name = pkgname_library[0]
346 lib_def = pkgname_library[1]
348 if pkg_name in wanted_libs or all_libs
349 if lib_def.has_key('lib')
350 exposed_deps += dependency(pkg_name)
351 incdir_deps += dependency(pkg_name).partial_dependency(includes: true, sources: true)
352 exposed_libs += [lib_def['lib']]
355 if lib_def.has_key('gir')
356 exposed_girs += lib_def['gir']
361 # glib and gobject are part of our public API. If we are using glib from the
362 # system then our pkg-config file must require it. If we built it as
363 # subproject then we need to link_whole it.
365 glib_dep = dependency('glib-2.0')
366 gobject_dep = dependency('gobject-2.0')
367 if gobject_dep.type_name() == 'internal'
368 glib_subproject = subproject('glib')
369 exposed_libs += glib_subproject.get_variable('libglib')
370 exposed_libs += glib_subproject.get_variable('libgobject')
372 glib_dep.partial_dependency(includes: true),
373 gobject_dep.partial_dependency(includes: true),
376 glib_deps = [glib_dep, gobject_dep]
380 if get_option('gst-full-version-script') != ''
381 symbol_map = meson.current_source_dir() / get_option('gst-full-version-script')
382 link_arg = '-Wl,--version-script=' + symbol_map
383 if cc.has_link_argument(link_arg)
384 gstfull_link_args += link_arg
385 link_deps += symbol_map
386 elif cc.get_id() == 'msvc'
387 warning('FIXME: Provide a def file to publish the public symbols')
389 warning('FIXME: Linker does not support the supplied version script (' + symbol_map + '), please disable the "gst-full-version-script" option')
394 foreach module : giomodules
395 giomodules_deps += dependency(module)
398 # Build both shared and static library
399 gstfull = both_libraries('gstreamer-full-1.0',
400 init_static_plugins_c,
401 link_args: gstfull_link_args,
402 link_whole : exposed_libs,
403 dependencies : [incdir_deps, glib_deps, all_plugins, giomodules_deps],
404 link_depends : link_deps,
408 gst_full_dep = declare_dependency(link_with: gstfull.get_shared_lib(),
409 dependencies : incdir_deps + glib_deps,
410 include_directories: include_directories('.')
413 gst_full_libs_private = cc.get_supported_link_arguments(['-Wl,--undefined=gst_init_static_plugins'])
414 if gst_full_libs_private == []
415 warning('The compiler does not support `-Wl,--undefined` linker flag. The method `gst_init_static_plugins` might be dropped during the link stage of an application using libgstreamer-full-1.0.a, preventing plugins registration.')
418 if not get_option('introspection').disabled()
420 foreach gir: exposed_girs
422 foreach include: gir.get('includes', [])
423 includes += [built_girs.get(include, include)]
427 'includes': includes,
428 'extra_args': gir.get('extra_args', []) + ['--add-include-path=' + meson.current_build_dir()],
431 built_girs += {gir.get('namespace') + '-' + gir.get('nsversion'): gnome.generate_gir(gstfull, kwargs: gir)[0]}
435 pkgconfig.generate(gstfull,
437 libraries_private: gst_full_libs_private,
438 subdirs : 'gstreamer-1.0')
439 meson.override_dependency('gstreamer-full-1.0', gst_full_dep)
441 if not get_option('tools').disabled()
442 foreach tool, data: all_tools
443 exe_name = '@0@-@1@'.format(tool, apiversion)
444 extra_args = data.get('extra_c_args', [])
445 sources = data.get('files')
447 foreach d : data.get('deps', [])
448 if d not in exposed_deps
456 include_directories : [configinc],
457 dependencies : [gst_full_dep] + deps,
458 c_args: extra_args + gst_c_args + ['-DG_LOG_DOMAIN="@0@"'.format(exe_name)],
461 if data.has_key('man_page')
462 install_man(data.get('man_page'))
469 message('Building subprojects: ' + ', '.join(subprojects_names))
471 setenv = find_program('gst-env.py')
473 devenv_cmd = [setenv, '--builddir=@0@'.format(meson.global_build_root()),
474 '--srcdir=@0@'.format(meson.global_source_root())]
479 if meson.can_run_host_binaries() and build_machine.system() == 'linux' and host_machine.system() == 'windows'
480 # FIXME: Ideally we could get the wrapper directly from meson
481 devenv_cmd += ['--wine', host_machine.cpu_family() == 'x86_64' ? 'wine64' : 'wine32']
482 sysroot = meson.get_cross_property('sys_root')
485 devenv_cmd += ['--winepath', 'Z:' + join_paths(sysroot, 'bin')]
489 run_target('devenv', command : devenv_cmd)
491 if orc_subproject.found() and orc_update_targets.length() > 0
492 alias_target('update-orc-dist', orc_update_targets)
495 dotnet_format = find_program('dotnet-format', required: false)
496 if dotnet_format.found()
497 run_target('csharp_format_check',
498 command: [join_paths(meson.current_source_dir(), 'scripts', 'format-csharp'),
502 run_target('csharp_format_apply',
503 command: [join_paths(meson.current_source_dir(), 'scripts', 'format-csharp'),
509 'gstreamer-full library': building_full,
510 }, section: 'Build options', bool_yn: true, list_sep: ' ')
513 foreach tool, data: all_tools
519 }, section: 'Build options', list_sep: ', ')