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 if isinstance(o, str):
49 if isinstance(o, list):
51 raise AssertionError('Object {!r} must be a string or a list'.format(o))
54 if isinstance(o, str):
56 if isinstance(o, list):
59 raise AssertionError('Did not expect object {!r} to have more than one element'.format(o))
60 raise AssertionError('Object {!r} must be a string or a list'.format(o))
62 def prepend_env_var(env, var, value, sysroot):
63 if value.startswith(sysroot):
64 value = value[len(sysroot):]
65 # Try not to exceed maximum length limits for env vars on Windows
67 value = win32_get_short_path_name(value)
68 env_val = env.get(var, '')
69 val = os.pathsep + value + os.pathsep
70 # Don't add the same value twice
71 if val in env_val or env_val.startswith(value + os.pathsep):
73 env[var] = val + env_val
74 env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
76 def get_target_install_filename(target, filename):
78 Checks whether this file is one of the files installed by the target
80 basename = os.path.basename(filename)
81 for install_filename in listify(target['install_filename']):
82 if install_filename.endswith(basename):
83 return install_filename
86 def get_pkgconfig_variable_from_pcfile(pcfile, varname):
88 substre = re.compile('\$\{[^${}]+\}')
89 with pcfile.open('r', encoding='utf-8') as f:
93 key, value = line[:-1].split('=', 1)
95 for each in substre.findall(value):
97 subst[each] = variables.get(substkey, '')
98 for k, v in subst.items():
99 value = value.replace(k, v)
100 variables[key] = value
101 return variables.get(varname, '')
104 def get_pkgconfig_variable(builddir, pcname, varname):
106 Parsing isn't perfect, but it's good enough.
108 pcfile = Path(builddir) / 'meson-private' / (pcname + '.pc')
110 return get_pkgconfig_variable_from_pcfile(pcfile, varname)
111 return subprocess.check_output(['pkg-config', pcname, '--variable=' + varname],
112 universal_newlines=True, encoding='utf-8')
115 def is_gio_module(target, filename, builddir):
116 if target['type'] != 'shared module':
118 install_filename = get_target_install_filename(target, filename)
119 if not install_filename:
121 giomoduledir = PurePath(get_pkgconfig_variable(builddir, 'gio-2.0', 'giomoduledir'))
122 fpath = PurePath(install_filename)
123 if fpath.parent != giomoduledir:
127 def is_library_target_and_not_plugin(target, filename):
129 Don't add plugins to PATH/LD_LIBRARY_PATH because:
131 2. It causes us to exceed the PATH length limit on Windows and Wine
133 if target['type'] != 'shared library':
135 # Check if this output of that target is a shared library
136 if not SHAREDLIB_REG.search(filename):
138 # Check if it's installed to the gstreamer plugin location
139 install_filename = get_target_install_filename(target, filename)
140 if not install_filename:
142 global GSTPLUGIN_FILEPATH_REG
143 if GSTPLUGIN_FILEPATH_REG is None:
144 GSTPLUGIN_FILEPATH_REG = re.compile(GSTPLUGIN_FILEPATH_REG_TEMPLATE)
145 if GSTPLUGIN_FILEPATH_REG.search(install_filename.replace('\\', '/')):
149 def is_binary_target_and_in_path(target, filename, bindir):
150 if target['type'] != 'executable':
152 # Check if this file installed by this target is installed to bindir
153 install_filename = get_target_install_filename(target, filename)
154 if not install_filename:
156 fpath = PurePath(install_filename)
157 if fpath.parent != bindir:
162 def get_wine_subprocess_env(options, env):
163 with open(os.path.join(options.builddir, 'meson-info', 'intro-buildoptions.json')) as f:
164 buildoptions = json.load(f)
166 prefix, = [o for o in buildoptions if o['name'] == 'prefix']
167 path = os.path.normpath(os.path.join(prefix['value'], 'bin'))
168 prepend_env_var(env, "PATH", path, options.sysroot)
169 wine_path = get_wine_shortpath(
170 options.wine.split(' '),
171 [path] + env.get('WINEPATH', '').split(';')
174 wine_path += ';' + options.winepath
175 env['WINEPATH'] = wine_path
176 env['WINEDEBUG'] = 'fixme-all'
180 def setup_gdb(options):
183 if not shutil.which('gdb'):
186 bdir = pathlib.Path(options.builddir).resolve()
187 for libpath, gdb_path in [
188 (os.path.join("subprojects", "gstreamer", "gst"),
189 os.path.join("subprojects", "gstreamer", "libs", "gst", "helpers")),
190 (os.path.join("subprojects", "glib", "gobject"), None),
191 (os.path.join("subprojects", "glib", "glib"), None)]:
196 autoload_path = (pathlib.Path(bdir) / 'gdb-auto-load').joinpath(*bdir.parts[1:]) / libpath
197 autoload_path.mkdir(parents=True, exist_ok=True)
198 for gdb_helper in glob.glob(str(bdir / gdb_path / "*-gdb.py")):
199 python_paths.add(str(bdir / gdb_path))
200 python_paths.add(os.path.join(options.srcdir, gdb_path))
203 shutil.copy(gdb_helper, str(autoload_path / os.path.basename(gdb_helper)))
205 os.symlink(gdb_helper, str(autoload_path / os.path.basename(gdb_helper)))
206 except (FileExistsError, shutil.SameFileError):
209 gdbinit_line = 'add-auto-load-scripts-directory {}\n'.format(bdir / 'gdb-auto-load')
211 with open(os.path.join(options.srcdir, '.gdbinit'), 'r') as f:
212 if gdbinit_line in f.readlines():
214 except FileNotFoundError:
217 with open(os.path.join(options.srcdir, '.gdbinit'), 'a') as f:
218 f.write(gdbinit_line)
223 def get_subprocess_env(options, gst_version):
224 env = os.environ.copy()
226 env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
227 env["GST_VERSION"] = gst_version
228 env["GST_VALIDATE_SCENARIOS_PATH"] = os.path.normpath(
229 "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR)
230 env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
231 "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
232 env["GST_VALIDATE_APPS_DIR"] = os.path.normpath(
233 "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR)
234 env["GST_ENV"] = 'gst-' + gst_version
235 env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
236 prepend_env_var(env, "PATH", os.path.normpath(
237 "%s/subprojects/gst-devtools/validate/tools" % options.builddir),
241 return get_wine_subprocess_env(options, env)
243 prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'),
246 env["GST_PLUGIN_SYSTEM_PATH"] = ""
247 env["GST_PLUGIN_SCANNER"] = os.path.normpath(
248 "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
249 env["GST_PTP_HELPER"] = os.path.normpath(
250 "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
253 lib_path_envvar = 'PATH'
254 elif platform.system() == 'Darwin':
255 lib_path_envvar = 'DYLD_LIBRARY_PATH'
257 lib_path_envvar = 'LD_LIBRARY_PATH'
259 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
260 'gst-python', 'plugin'),
262 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(PREFIX_DIR, 'lib',
265 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(options.builddir, 'subprojects',
268 prepend_env_var(env, "GST_VALIDATE_SCENARIOS_PATH",
269 os.path.join(PREFIX_DIR, 'share', 'gstreamer-1.0',
270 'validate', 'scenarios'),
272 prepend_env_var(env, "GI_TYPELIB_PATH", os.path.join(PREFIX_DIR, 'lib',
273 'lib', 'girepository-1.0'),
275 prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(PREFIX_DIR, 'lib', 'pkgconfig'),
279 prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'gstreamer', 'tools'),
282 # tools: gst-launch-1.0, gst-inspect-1.0
283 prepend_env_var(env, "PATH", os.path.join(options.builddir, 'subprojects',
284 'gstreamer', 'tools'),
286 prepend_env_var(env, "PATH", os.path.join(options.builddir, 'subprojects',
287 'gst-plugins-base', 'tools'),
290 # Library and binary search paths
291 prepend_env_var(env, "PATH", os.path.join(PREFIX_DIR, 'bin'),
293 if lib_path_envvar != 'PATH':
294 prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib'),
296 prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib64'),
298 elif 'QMAKE' in os.environ:
299 # There's no RPATH on Windows, so we need to set PATH for the qt5 DLLs
300 prepend_env_var(env, 'PATH', os.path.dirname(os.environ['QMAKE']),
304 targets_s = subprocess.check_output(meson + ['introspect', options.builddir, '--targets'])
305 targets = json.loads(targets_s.decode())
308 srcdir_path = pathlib.Path(options.srcdir)
310 build_options_s = subprocess.check_output(meson + ['introspect', options.builddir, '--buildoptions'])
311 build_options = json.loads(build_options_s.decode())
312 libdir, = [o['value'] for o in build_options if o['name'] == 'libdir']
313 libdir = PurePath(libdir)
314 prefix, = [o['value'] for o in build_options if o['name'] == 'prefix']
315 bindir, = [o['value'] for o in build_options if o['name'] == 'bindir']
316 prefix = PurePath(prefix)
317 bindir = prefix / bindir
319 global GSTPLUGIN_FILEPATH_REG_TEMPLATE
320 GSTPLUGIN_FILEPATH_REG_TEMPLATE = GSTPLUGIN_FILEPATH_REG_TEMPLATE.format(libdir=libdir.as_posix())
322 for target in targets:
323 filenames = listify(target['filename'])
324 if not target['installed']:
326 for filename in filenames:
327 root = os.path.dirname(filename)
328 if srcdir_path / "subprojects/gst-devtools/validate/plugins" in (srcdir_path / root).parents:
330 if filename.endswith('.dll'):
331 mono_paths.add(os.path.join(options.builddir, root))
332 if TYPELIB_REG.search(filename):
333 prepend_env_var(env, "GI_TYPELIB_PATH",
334 os.path.join(options.builddir, root),
336 elif is_library_target_and_not_plugin(target, filename):
337 prepend_env_var(env, lib_path_envvar,
338 os.path.join(options.builddir, root),
340 elif is_binary_target_and_in_path(target, filename, bindir):
341 paths.add(os.path.join(options.builddir, root))
342 elif is_gio_module(target, filename, options.builddir):
343 prepend_env_var(env, 'GIO_EXTRA_MODULES',
344 os.path.join(options.builddir, root),
347 with open(os.path.join(options.builddir, 'GstPluginsPath.json')) as f:
348 for plugin_path in json.load(f):
349 prepend_env_var(env, 'GST_PLUGIN_PATH', plugin_path,
352 # Sort to iterate in a consistent order (`set`s and `hash`es are randomized)
353 for p in sorted(paths):
354 prepend_env_var(env, 'PATH', p, options.sysroot)
357 for p in sorted(mono_paths):
358 prepend_env_var(env, "MONO_PATH", p, options.sysroot)
361 encoding_targets = set()
363 python_dirs = setup_gdb(options)
364 if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
365 installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
366 for path, installpath in json.loads(installed_s.decode()).items():
367 installpath_parts = pathlib.Path(installpath).parts
368 path_parts = pathlib.Path(path).parts
370 # We want to add all python modules to the PYTHONPATH
371 # in a manner consistent with the way they would be imported:
372 # For example if the source path /home/meh/foo/bar.py
373 # is to be installed in /usr/lib/python/site-packages/foo/bar.py,
374 # we want to add /home/meh to the PYTHONPATH.
375 # This will only work for projects where the paths to be installed
376 # mirror the installed directory layout, for example if the path
377 # is /home/meh/baz/bar.py and the install path is
378 # /usr/lib/site-packages/foo/bar.py , we will not add anything
379 # to PYTHONPATH, but the current approach works with pygobject
380 # and gst-python at least.
381 if 'site-packages' in installpath_parts:
382 install_subpath = os.path.join(*installpath_parts[installpath_parts.index('site-packages') + 1:])
383 if path.endswith(install_subpath):
384 python_dirs.add(path[:len (install_subpath) * -1])
386 if path.endswith('.prs'):
387 presets.add(os.path.dirname(path))
388 elif path.endswith('.gep'):
389 encoding_targets.add(
390 os.path.abspath(os.path.join(os.path.dirname(path), '..')))
391 elif path.endswith('.pc'):
392 # Is there a -uninstalled pc file for this file?
393 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
394 if os.path.exists(uninstalled):
395 pkg_dirs.add(os.path.dirname(path))
397 if path.endswith('gstomx.conf'):
398 prepend_env_var(env, 'GST_OMX_CONFIG_DIR', os.path.dirname(path),
401 for p in sorted(presets):
402 prepend_env_var(env, 'GST_PRESET_PATH', p, options.sysroot)
404 for t in sorted(encoding_targets):
405 prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t, options.sysroot)
407 for pkg_dir in sorted(pkg_dirs):
408 prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir, options.sysroot)
410 # Check if meson has generated -uninstalled pkgconfig files
411 meson_uninstalled = pathlib.Path(options.builddir) / 'meson-uninstalled'
412 if meson_uninstalled.is_dir():
413 prepend_env_var(env, 'PKG_CONFIG_PATH', str(meson_uninstalled), options.sysroot)
415 for python_dir in sorted(python_dirs):
416 prepend_env_var(env, 'PYTHONPATH', python_dir, options.sysroot)
418 mesonpath = os.path.join(SCRIPTDIR, "meson")
419 if os.path.join(mesonpath):
420 # Add meson/ into PYTHONPATH if we are using a local meson
421 prepend_env_var(env, 'PYTHONPATH', mesonpath, options.sysroot)
424 if 'XDG_DATA_DIRS' not in env or not env['XDG_DATA_DIRS']:
425 # Preserve default paths when empty
426 prepend_env_var(env, 'XDG_DATA_DIRS', '/usr/local/share/:/usr/share/', '')
428 prepend_env_var (env, 'XDG_DATA_DIRS', os.path.join(options.builddir,
434 if 'XDG_CONFIG_DIRS' not in env or not env['XDG_CONFIG_DIRS']:
435 # Preserve default paths when empty
436 prepend_env_var(env, 'XDG_CONFIG_DIRS', '/etc/local/xdg:/etc/xdg', '')
438 prepend_env_var(env, "XDG_CONFIG_DIRS", os.path.join(PREFIX_DIR, 'etc', 'xdg'),
443 def get_windows_shell():
444 command = ['powershell.exe' ,'-noprofile', '-executionpolicy', 'bypass', '-file', 'cmd_or_ps.ps1']
445 result = subprocess.check_output(command)
446 return result.decode().strip()
448 if __name__ == "__main__":
449 parser = argparse.ArgumentParser(prog="gst-env")
451 parser.add_argument("--builddir",
452 default=DEFAULT_BUILDDIR,
453 help="The meson build directory")
454 parser.add_argument("--srcdir",
456 help="The top level source directory")
457 parser.add_argument("--sysroot",
459 help="The sysroot path used during cross-compilation")
460 parser.add_argument("--wine",
462 help="Build a wine env based on specified wine command")
463 parser.add_argument("--winepath",
465 help="Extra path to set to WINEPATH.")
466 parser.add_argument("--only-environment",
469 help="Do not start a shell, only print required environment.")
470 options, args = parser.parse_known_args()
472 if not os.path.exists(options.builddir):
473 print("GStreamer not built in %s\n\nBuild it and try again" %
476 options.builddir = os.path.abspath(options.builddir)
478 if not os.path.exists(options.srcdir):
479 print("The specified source dir does not exist" %
483 # The following incantation will retrieve the current branch name.
485 gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD",
486 repository_path=options.srcdir).strip('\n')
487 except subprocess.CalledProcessError:
488 gst_version = "unknown"
491 gst_version += '-' + os.path.basename(options.wine)
493 env = get_subprocess_env(options, gst_version)
496 shell = get_windows_shell()
497 if shell == 'powershell.exe':
498 args = ['powershell.exe']
499 args += ['-NoLogo', '-NoExit']
500 prompt = 'function global:prompt { "[gst-' + gst_version + '"+"] PS " + $PWD + "> "}'
501 args += ['-Command', prompt]
503 args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
504 args += ['/k', 'prompt [gst-{}] $P$G'.format(gst_version)]
506 args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
507 if args[0].endswith('bash') and not strtobool(os.environ.get("GST_BUILD_DISABLE_PS1_OVERRIDE", r"FALSE")):
508 # Let the GC remove the tmp file
509 tmprc = tempfile.NamedTemporaryFile(mode='w')
510 bashrc = os.path.expanduser('~/.bashrc')
511 if os.path.exists(bashrc):
512 with open(bashrc, 'r') as src:
513 shutil.copyfileobj(src, tmprc)
514 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
516 args.append("--rcfile")
517 args.append(tmprc.name)
518 elif args[0].endswith('fish'):
519 # Ignore SIGINT while using fish as the shell to make it behave
520 # like other shells such as bash and zsh.
521 # See: https://gitlab.freedesktop.org/gstreamer/gst-build/issues/18
522 signal.signal(signal.SIGINT, lambda x, y: True)
524 args.append('--init-command')
525 prompt_cmd = '''functions --copy fish_prompt original_fish_prompt
527 echo -n '[gst-{}] '(original_fish_prompt)
528 end'''.format(gst_version)
529 args.append(prompt_cmd)
530 elif args[0].endswith('zsh'):
531 tmpdir = tempfile.TemporaryDirectory()
532 # Let the GC remove the tmp file
533 tmprc = open(os.path.join(tmpdir.name, '.zshrc'), 'w')
534 zshrc = os.path.expanduser('~/.zshrc')
535 if os.path.exists(zshrc):
536 with open(zshrc, 'r') as src:
537 shutil.copyfileobj(src, tmprc)
538 tmprc.write('\nexport PROMPT="[gst-{}] $PROMPT"'.format(gst_version))
540 env['ZDOTDIR'] = tmpdir.name
542 if options.only_environment:
543 for name, value in env.items():
544 print('{}={}'.format(name, shlex.quote(value)))
545 print('export {}'.format(name))
547 exit(subprocess.call(args, close_fds=False, env=env))
549 except subprocess.CalledProcessError as e: