18 from functools import lru_cache
19 from pathlib import PurePath, Path
21 from distutils.sysconfig import get_python_lib
22 from distutils.util import strtobool
24 from scripts.common import get_meson
25 from scripts.common import git
26 from scripts.common import win32_get_short_path_name
27 from scripts.common import get_wine_shortpath
29 SCRIPTDIR = os.path.dirname(os.path.realpath(__file__))
30 PREFIX_DIR = os.path.join(SCRIPTDIR, 'prefix')
31 # Look for the following build dirs: `build` `_build` `builddir`
32 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, 'build')
33 if not os.path.exists(DEFAULT_BUILDDIR):
34 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, '_build')
35 if not os.path.exists(DEFAULT_BUILDDIR):
36 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, 'builddir')
38 TYPELIB_REG = re.compile(r'.*\.typelib$')
39 SHAREDLIB_REG = re.compile(r'\.so|\.dylib|\.dll')
41 # libdir is expanded from option of the same name listed in the `meson
42 # introspect --buildoptions` output.
43 GSTPLUGIN_FILEPATH_REG_TEMPLATE = r'.*/{libdir}/gstreamer-1.0/[^/]+$'
44 GSTPLUGIN_FILEPATH_REG = None
47 BASH_COMPLETION_SCRIPTS="{bash_completions}"
48 BASH_COMPLETION_PATHS="{bash_completions_paths}"
49 for p in $BASH_COMPLETION_PATHS; do
50 for f in $BASH_COMPLETION_SCRIPTS; do
51 [ -f "$p/$f" ] && . "$p/$f"
55 BASH_COMPLETION_PATHS = [SCRIPTDIR + '/subprojects/gstreamer/data/bash-completion/completions']
56 BASH_COMPLETION_PATHS += [SCRIPTDIR + '/subprojects/gst-devtools/validate/data/bash-completion/completions']
59 if isinstance(o, str):
61 if isinstance(o, list):
63 raise AssertionError('Object {!r} must be a string or a list'.format(o))
66 if isinstance(o, str):
68 if isinstance(o, list):
71 raise AssertionError('Did not expect object {!r} to have more than one element'.format(o))
72 raise AssertionError('Object {!r} must be a string or a list'.format(o))
74 def prepend_env_var(env, var, value, sysroot):
75 if value.startswith(sysroot):
76 value = value[len(sysroot):]
77 # Try not to exceed maximum length limits for env vars on Windows
79 value = win32_get_short_path_name(value)
80 env_val = env.get(var, '')
81 val = os.pathsep + value + os.pathsep
82 # Don't add the same value twice
83 if val in env_val or env_val.startswith(value + os.pathsep):
85 env[var] = val + env_val
86 env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
88 def get_target_install_filename(target, filename):
90 Checks whether this file is one of the files installed by the target
92 basename = os.path.basename(filename)
93 for install_filename in listify(target['install_filename']):
94 if install_filename.endswith(basename):
95 return install_filename
98 def get_pkgconfig_variable_from_pcfile(pcfile, varname):
100 substre = re.compile('\$\{[^${}]+\}')
101 with pcfile.open('r', encoding='utf-8') as f:
105 key, value = line[:-1].split('=', 1)
107 for each in substre.findall(value):
108 substkey = each[2:-1]
109 subst[each] = variables.get(substkey, '')
110 for k, v in subst.items():
111 value = value.replace(k, v)
112 variables[key] = value
113 return variables.get(varname, '')
116 def get_pkgconfig_variable(builddir, pcname, varname):
118 Parsing isn't perfect, but it's good enough.
120 pcfile = Path(builddir) / 'meson-private' / (pcname + '.pc')
122 return get_pkgconfig_variable_from_pcfile(pcfile, varname)
123 return subprocess.check_output(['pkg-config', pcname, '--variable=' + varname],
124 universal_newlines=True, encoding='utf-8')
127 def is_gio_module(target, filename, builddir):
128 if target['type'] != 'shared module':
130 install_filename = get_target_install_filename(target, filename)
131 if not install_filename:
133 giomoduledir = PurePath(get_pkgconfig_variable(builddir, 'gio-2.0', 'giomoduledir'))
134 fpath = PurePath(install_filename)
135 if fpath.parent != giomoduledir:
139 def is_library_target_and_not_plugin(target, filename):
141 Don't add plugins to PATH/LD_LIBRARY_PATH because:
143 2. It causes us to exceed the PATH length limit on Windows and Wine
145 if target['type'] != 'shared library':
147 # Check if this output of that target is a shared library
148 if not SHAREDLIB_REG.search(filename):
150 # Check if it's installed to the gstreamer plugin location
151 install_filename = get_target_install_filename(target, filename)
152 if not install_filename:
154 global GSTPLUGIN_FILEPATH_REG
155 if GSTPLUGIN_FILEPATH_REG is None:
156 GSTPLUGIN_FILEPATH_REG = re.compile(GSTPLUGIN_FILEPATH_REG_TEMPLATE)
157 if GSTPLUGIN_FILEPATH_REG.search(install_filename.replace('\\', '/')):
161 def is_binary_target_and_in_path(target, filename, bindir):
162 if target['type'] != 'executable':
164 # Check if this file installed by this target is installed to bindir
165 install_filename = get_target_install_filename(target, filename)
166 if not install_filename:
168 fpath = PurePath(install_filename)
169 if fpath.parent != bindir:
174 def get_wine_subprocess_env(options, env):
175 with open(os.path.join(options.builddir, 'meson-info', 'intro-buildoptions.json')) as f:
176 buildoptions = json.load(f)
178 prefix, = [o for o in buildoptions if o['name'] == 'prefix']
179 path = os.path.normpath(os.path.join(prefix['value'], 'bin'))
180 prepend_env_var(env, "PATH", path, options.sysroot)
181 wine_path = get_wine_shortpath(
182 options.wine.split(' '),
183 [path] + env.get('WINEPATH', '').split(';')
186 wine_path += ';' + options.winepath
187 env['WINEPATH'] = wine_path
188 env['WINEDEBUG'] = 'fixme-all'
192 def setup_gdb(options):
195 if not shutil.which('gdb'):
198 bdir = pathlib.Path(options.builddir).resolve()
199 for libpath, gdb_path in [
200 (os.path.join("subprojects", "gstreamer", "gst"),
201 os.path.join("subprojects", "gstreamer", "libs", "gst", "helpers")),
202 (os.path.join("subprojects", "glib", "gobject"), None),
203 (os.path.join("subprojects", "glib", "glib"), None)]:
208 autoload_path = (pathlib.Path(bdir) / 'gdb-auto-load').joinpath(*bdir.parts[1:]) / libpath
209 autoload_path.mkdir(parents=True, exist_ok=True)
210 for gdb_helper in glob.glob(str(bdir / gdb_path / "*-gdb.py")):
211 python_paths.add(str(bdir / gdb_path))
212 python_paths.add(os.path.join(options.srcdir, gdb_path))
215 shutil.copy(gdb_helper, str(autoload_path / os.path.basename(gdb_helper)))
217 os.symlink(gdb_helper, str(autoload_path / os.path.basename(gdb_helper)))
218 except (FileExistsError, shutil.SameFileError):
221 gdbinit_line = 'add-auto-load-scripts-directory {}\n'.format(bdir / 'gdb-auto-load')
223 with open(os.path.join(options.srcdir, '.gdbinit'), 'r') as f:
224 if gdbinit_line in f.readlines():
226 except FileNotFoundError:
229 with open(os.path.join(options.srcdir, '.gdbinit'), 'a') as f:
230 f.write(gdbinit_line)
234 def is_bash_completion_available (options):
235 return os.path.exists(os.path.join(options.builddir, 'subprojects/gstreamer/data/bash-completion/helpers/gst'))
237 def get_subprocess_env(options, gst_version):
238 env = os.environ.copy()
240 env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
241 env["GST_VERSION"] = gst_version
242 prepend_env_var (env, "GST_VALIDATE_SCENARIOS_PATH", os.path.normpath(
243 "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR),
245 env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
246 "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
247 prepend_env_var (env, "GST_VALIDATE_APPS_DIR", os.path.normpath(
248 "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR),
250 env["GST_ENV"] = 'gst-' + gst_version
251 env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
252 prepend_env_var(env, "PATH", os.path.normpath(
253 "%s/subprojects/gst-devtools/validate/tools" % options.builddir),
256 prepend_env_var (env, "GST_VALIDATE_SCENARIOS_PATH", os.path.normpath(
257 "%s/subprojects/gst-examples/webrtc/check/validate/scenarios" %
258 SCRIPTDIR), options.sysroot)
259 prepend_env_var (env, "GST_VALIDATE_APPS_DIR", os.path.normpath(
260 "%s/subprojects/gst-examples/webrtc/check/validate/apps" %
261 SCRIPTDIR), options.sysroot)
264 return get_wine_subprocess_env(options, env)
266 prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'),
269 env["GST_PLUGIN_SYSTEM_PATH"] = ""
270 env["GST_PLUGIN_SCANNER"] = os.path.normpath(
271 "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
272 env["GST_PTP_HELPER"] = os.path.normpath(
273 "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
276 lib_path_envvar = 'PATH'
277 elif platform.system() == 'Darwin':
278 lib_path_envvar = 'DYLD_LIBRARY_PATH'
280 lib_path_envvar = 'LD_LIBRARY_PATH'
282 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
283 'gst-python', 'plugin'),
285 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(PREFIX_DIR, 'lib',
288 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(options.builddir, 'subprojects',
291 prepend_env_var(env, "GST_VALIDATE_SCENARIOS_PATH",
292 os.path.join(PREFIX_DIR, 'share', 'gstreamer-1.0',
293 'validate', 'scenarios'),
295 prepend_env_var(env, "GI_TYPELIB_PATH", os.path.join(PREFIX_DIR, 'lib',
296 'lib', 'girepository-1.0'),
298 prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(PREFIX_DIR, 'lib', 'pkgconfig'),
302 prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'gstreamer', 'tools'),
305 # tools: gst-launch-1.0, gst-inspect-1.0
306 prepend_env_var(env, "PATH", os.path.join(options.builddir, 'subprojects',
307 'gstreamer', 'tools'),
309 prepend_env_var(env, "PATH", os.path.join(options.builddir, 'subprojects',
310 'gst-plugins-base', 'tools'),
313 # Library and binary search paths
314 prepend_env_var(env, "PATH", os.path.join(PREFIX_DIR, 'bin'),
316 if lib_path_envvar != 'PATH':
317 prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib'),
319 prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib64'),
321 elif 'QMAKE' in os.environ:
322 # There's no RPATH on Windows, so we need to set PATH for the qt5 DLLs
323 prepend_env_var(env, 'PATH', os.path.dirname(os.environ['QMAKE']),
327 targets_s = subprocess.check_output(meson + ['introspect', options.builddir, '--targets'])
328 targets = json.loads(targets_s.decode())
331 srcdir_path = pathlib.Path(options.srcdir)
333 build_options_s = subprocess.check_output(meson + ['introspect', options.builddir, '--buildoptions'])
334 build_options = json.loads(build_options_s.decode())
335 libdir, = [o['value'] for o in build_options if o['name'] == 'libdir']
336 libdir = PurePath(libdir)
337 prefix, = [o['value'] for o in build_options if o['name'] == 'prefix']
338 bindir, = [o['value'] for o in build_options if o['name'] == 'bindir']
339 prefix = PurePath(prefix)
340 bindir = prefix / bindir
342 global GSTPLUGIN_FILEPATH_REG_TEMPLATE
343 GSTPLUGIN_FILEPATH_REG_TEMPLATE = GSTPLUGIN_FILEPATH_REG_TEMPLATE.format(libdir=libdir.as_posix())
345 for target in targets:
346 filenames = listify(target['filename'])
347 if not target['installed']:
349 for filename in filenames:
350 root = os.path.dirname(filename)
351 if srcdir_path / "subprojects/gst-devtools/validate/plugins" in (srcdir_path / root).parents:
353 if filename.endswith('.dll'):
354 mono_paths.add(os.path.join(options.builddir, root))
355 if TYPELIB_REG.search(filename):
356 prepend_env_var(env, "GI_TYPELIB_PATH",
357 os.path.join(options.builddir, root),
359 elif is_library_target_and_not_plugin(target, filename):
360 prepend_env_var(env, lib_path_envvar,
361 os.path.join(options.builddir, root),
363 elif is_binary_target_and_in_path(target, filename, bindir):
364 paths.add(os.path.join(options.builddir, root))
365 elif is_gio_module(target, filename, options.builddir):
366 prepend_env_var(env, 'GIO_EXTRA_MODULES',
367 os.path.join(options.builddir, root),
370 with open(os.path.join(options.builddir, 'GstPluginsPath.json')) as f:
371 for plugin_path in json.load(f):
372 prepend_env_var(env, 'GST_PLUGIN_PATH', plugin_path,
375 # Sort to iterate in a consistent order (`set`s and `hash`es are randomized)
376 for p in sorted(paths):
377 prepend_env_var(env, 'PATH', p, options.sysroot)
380 for p in sorted(mono_paths):
381 prepend_env_var(env, "MONO_PATH", p, options.sysroot)
384 encoding_targets = set()
385 python_dirs = setup_gdb(options)
386 if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
387 installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
388 for path, installpath in json.loads(installed_s.decode()).items():
389 installpath_parts = pathlib.Path(installpath).parts
390 path_parts = pathlib.Path(path).parts
392 # We want to add all python modules to the PYTHONPATH
393 # in a manner consistent with the way they would be imported:
394 # For example if the source path /home/meh/foo/bar.py
395 # is to be installed in /usr/lib/python/site-packages/foo/bar.py,
396 # we want to add /home/meh to the PYTHONPATH.
397 # This will only work for projects where the paths to be installed
398 # mirror the installed directory layout, for example if the path
399 # is /home/meh/baz/bar.py and the install path is
400 # /usr/lib/site-packages/foo/bar.py , we will not add anything
401 # to PYTHONPATH, but the current approach works with pygobject
402 # and gst-python at least.
403 if 'site-packages' in installpath_parts:
404 install_subpath = os.path.join(*installpath_parts[installpath_parts.index('site-packages') + 1:])
405 if path.endswith(install_subpath):
406 python_dirs.add(path[:len (install_subpath) * -1])
408 if path.endswith('.prs'):
409 presets.add(os.path.dirname(path))
410 elif path.endswith('.gep'):
411 encoding_targets.add(
412 os.path.abspath(os.path.join(os.path.dirname(path), '..')))
414 if path.endswith('gstomx.conf'):
415 prepend_env_var(env, 'GST_OMX_CONFIG_DIR', os.path.dirname(path),
418 for p in sorted(presets):
419 prepend_env_var(env, 'GST_PRESET_PATH', p, options.sysroot)
421 for t in sorted(encoding_targets):
422 prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t, options.sysroot)
424 # Check if meson has generated -uninstalled pkgconfig files
425 meson_uninstalled = pathlib.Path(options.builddir) / 'meson-uninstalled'
426 if meson_uninstalled.is_dir():
427 prepend_env_var(env, 'PKG_CONFIG_PATH', str(meson_uninstalled), options.sysroot)
429 for python_dir in sorted(python_dirs):
430 prepend_env_var(env, 'PYTHONPATH', python_dir, options.sysroot)
432 mesonpath = os.path.join(SCRIPTDIR, "meson")
433 if os.path.join(mesonpath):
434 # Add meson/ into PYTHONPATH if we are using a local meson
435 prepend_env_var(env, 'PYTHONPATH', mesonpath, options.sysroot)
438 if 'XDG_DATA_DIRS' not in env or not env['XDG_DATA_DIRS']:
439 # Preserve default paths when empty
440 prepend_env_var(env, 'XDG_DATA_DIRS', '/usr/local/share/:/usr/share/', '')
442 prepend_env_var (env, 'XDG_DATA_DIRS', os.path.join(options.builddir,
448 if 'XDG_CONFIG_DIRS' not in env or not env['XDG_CONFIG_DIRS']:
449 # Preserve default paths when empty
450 prepend_env_var(env, 'XDG_CONFIG_DIRS', '/etc/local/xdg:/etc/xdg', '')
452 prepend_env_var(env, "XDG_CONFIG_DIRS", os.path.join(PREFIX_DIR, 'etc', 'xdg'),
457 def get_windows_shell():
458 command = ['powershell.exe' ,'-noprofile', '-executionpolicy', 'bypass', '-file', 'cmd_or_ps.ps1']
459 result = subprocess.check_output(command, cwd=SCRIPTDIR)
460 return result.decode().strip()
462 if __name__ == "__main__":
463 parser = argparse.ArgumentParser(prog="gst-env")
465 parser.add_argument("--builddir",
466 default=DEFAULT_BUILDDIR,
467 help="The meson build directory")
468 parser.add_argument("--srcdir",
470 help="The top level source directory")
471 parser.add_argument("--sysroot",
473 help="The sysroot path used during cross-compilation")
474 parser.add_argument("--wine",
476 help="Build a wine env based on specified wine command")
477 parser.add_argument("--winepath",
479 help="Extra path to set to WINEPATH.")
480 parser.add_argument("--only-environment",
483 help="Do not start a shell, only print required environment.")
484 options, args = parser.parse_known_args()
486 if not os.path.exists(options.builddir):
487 print("GStreamer not built in %s\n\nBuild it and try again" %
490 options.builddir = os.path.abspath(options.builddir)
492 if not os.path.exists(options.srcdir):
493 print("The specified source dir does not exist" %
497 # The following incantation will retrieve the current branch name.
499 gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD",
500 repository_path=options.srcdir).strip('\n')
501 except subprocess.CalledProcessError:
502 gst_version = "unknown"
505 gst_version += '-' + os.path.basename(options.wine)
507 env = get_subprocess_env(options, gst_version)
510 shell = get_windows_shell()
511 if shell == 'powershell.exe':
512 args = ['powershell.exe']
513 args += ['-NoLogo', '-NoExit']
514 prompt = 'function global:prompt { "[gst-' + gst_version + '"+"] PS " + $PWD + "> "}'
515 args += ['-Command', prompt]
517 args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
518 args += ['/k', 'prompt [gst-{}] $P$G'.format(gst_version)]
520 args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
521 if args[0].endswith('bash') and not strtobool(os.environ.get("GST_BUILD_DISABLE_PS1_OVERRIDE", r"FALSE")):
522 # Let the GC remove the tmp file
523 tmprc = tempfile.NamedTemporaryFile(mode='w')
524 bashrc = os.path.expanduser('~/.bashrc')
525 if os.path.exists(bashrc):
526 with open(bashrc, 'r') as src:
527 shutil.copyfileobj(src, tmprc)
528 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
530 if is_bash_completion_available(options):
531 bash_completions_files = []
532 for p in BASH_COMPLETION_PATHS:
533 if os.path.exists(p):
534 bash_completions_files += os.listdir(path=p)
535 bc_rc = BC_RC.format(bash_completions=' '.join(bash_completions_files), bash_completions_paths=' '.join(BASH_COMPLETION_PATHS))
538 args.append("--rcfile")
539 args.append(tmprc.name)
540 elif args[0].endswith('fish'):
541 # Ignore SIGINT while using fish as the shell to make it behave
542 # like other shells such as bash and zsh.
543 # See: https://gitlab.freedesktop.org/gstreamer/gst-build/issues/18
544 signal.signal(signal.SIGINT, lambda x, y: True)
546 args.append('--init-command')
547 prompt_cmd = '''functions --copy fish_prompt original_fish_prompt
549 echo -n '[gst-{}] '(original_fish_prompt)
550 end'''.format(gst_version)
551 args.append(prompt_cmd)
552 elif args[0].endswith('zsh'):
553 tmpdir = tempfile.TemporaryDirectory()
554 # Let the GC remove the tmp file
555 tmprc = open(os.path.join(tmpdir.name, '.zshrc'), 'w')
556 zshrc = os.path.expanduser('~/.zshrc')
557 if os.path.exists(zshrc):
558 with open(zshrc, 'r') as src:
559 shutil.copyfileobj(src, tmprc)
560 tmprc.write('\nexport PROMPT="[gst-{}] $PROMPT"'.format(gst_version))
562 env['ZDOTDIR'] = tmpdir.name
564 if options.only_environment:
565 for name, value in env.items():
566 print('{}={}'.format(name, shlex.quote(value)))
567 print('export {}'.format(name))
569 exit(subprocess.call(args, close_fds=False, env=env))
571 except subprocess.CalledProcessError as e: