gst-uninstalled: Add qt5 DLLs to PATH on Windows
[platform/upstream/gstreamer.git] / gst-uninstalled.py
1 #!/usr/bin/env python3
2
3 import argparse
4 import contextlib
5 import json
6 import os
7 import platform
8 import re
9 import site
10 import shutil
11 import subprocess
12 import sys
13 import tempfile
14 import pathlib
15
16 from distutils.sysconfig import get_python_lib
17 from distutils.util import strtobool
18
19 from common import get_meson
20 from common import git
21
22 SCRIPTDIR = os.path.dirname(os.path.realpath(__file__))
23 PREFIX_DIR = os.path.join(SCRIPTDIR, 'prefix')
24 # Use '_build' as the builddir instead of 'build'
25 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, 'build')
26 if not os.path.exists(DEFAULT_BUILDDIR):
27     DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, '_build')
28
29
30 def listify(o):
31     if isinstance(o, str):
32         return [o]
33     if isinstance(o, list):
34         return o
35     raise AssertionError('Object {!r} must be a string or a list'.format(o))
36
37 def stringify(o):
38     if isinstance(o, str):
39         return o
40     if isinstance(o, list):
41         if len(o) == 1:
42             return o[0]
43         raise AssertionError('Did not expect object {!r} to have more than one element'.format(o))
44     raise AssertionError('Object {!r} must be a string or a list'.format(o))
45
46 def prepend_env_var(env, var, value):
47     env[var] = os.pathsep + value + os.pathsep + env.get(var, "")
48     env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
49
50
51 def get_subprocess_env(options, gst_version):
52     env = os.environ.copy()
53
54     env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
55     env["GST_VALIDATE_SCENARIOS_PATH"] = os.path.normpath(
56         "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR)
57     env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
58         "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
59     env["GST_VALIDATE_APPS_DIR"] = os.path.normpath(
60         "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR)
61     prepend_env_var(env, "PATH", os.path.normpath(
62         "%s/subprojects/gst-devtools/validate/tools" % options.builddir))
63     prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'))
64     env["GST_VERSION"] = gst_version
65     env["GST_ENV"] = 'gst-' + gst_version
66     env["GST_PLUGIN_SYSTEM_PATH"] = ""
67     env["GST_PLUGIN_SCANNER"] = os.path.normpath(
68         "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
69     env["GST_PTP_HELPER"] = os.path.normpath(
70         "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
71     env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
72
73     sharedlib_reg = re.compile(r'\.so|\.dylib|\.dll')
74     typelib_reg = re.compile(r'.*\.typelib$')
75     pluginpath_reg = re.compile(r'lib.*' + re.escape(os.path.normpath('/gstreamer-1.0/')))
76
77     if os.name is 'nt':
78         lib_path_envvar = 'PATH'
79     elif platform.system() == 'Darwin':
80         lib_path_envvar = 'DYLD_LIBRARY_PATH'
81     else:
82         lib_path_envvar = 'LD_LIBRARY_PATH'
83
84     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
85                                                         'gst-python', 'plugin'))
86     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(PREFIX_DIR, 'lib',
87                                                         'gstreamer-1.0'))
88     prepend_env_var(env, "GST_VALIDATE_SCENARIOS_PATH", os.path.join(
89         PREFIX_DIR, 'share', 'gstreamer-1.0', 'validate', 'scenarios'))
90     prepend_env_var(env, "GI_TYPELIB_PATH", os.path.join(PREFIX_DIR, 'lib',
91                                                          'lib', 'girepository-1.0'))
92     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(PREFIX_DIR, 'lib', 'pkgconfig'))
93
94     # Library and binary search paths
95     prepend_env_var(env, "PATH", os.path.join(PREFIX_DIR, 'bin'))
96     if lib_path_envvar != 'PATH':
97         prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib'))
98     elif 'QMAKE' in os.environ:
99         # There's no RPATH on Windows, so we need to set PATH for the qt5 DLLs
100         prepend_env_var(env, 'PATH', os.path.dirname(os.environ['QMAKE']))
101
102     meson = get_meson()
103     targets_s = subprocess.check_output(meson + ['introspect', options.builddir, '--targets'])
104     targets = json.loads(targets_s.decode())
105     paths = set()
106     mono_paths = set()
107     srcdir_path = pathlib.Path(options.srcdir)
108     for target in targets:
109         filenames = listify(target['filename'])
110         for filename in filenames:
111             root = os.path.dirname(filename)
112             if srcdir_path / "subprojects/gst-devtools/validate/plugins" in (srcdir_path / root).parents:
113                 continue
114             if filename.endswith('.dll'):
115                 mono_paths.add(os.path.join(options.builddir, root))
116             if typelib_reg.search(filename):
117                 prepend_env_var(env, "GI_TYPELIB_PATH",
118                                 os.path.join(options.builddir, root))
119             elif sharedlib_reg.search(filename):
120                 if not target['type'].startswith('shared'):
121                     continue
122                 if target['installed']:
123                     if pluginpath_reg.search(os.path.normpath(stringify(target['install_filename']))):
124                         prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(options.builddir, root))
125                         continue
126
127                 prepend_env_var(env, lib_path_envvar,
128                                 os.path.join(options.builddir, root))
129             elif target['type'] == 'executable' and target['installed']:
130                 paths.add(os.path.join(options.builddir, root))
131
132     for p in paths:
133         prepend_env_var(env, 'PATH', p)
134
135     if os.name != 'nt':
136         for p in mono_paths:
137             prepend_env_var(env, "MONO_PATH", p)
138
139     presets = set()
140     encoding_targets = set()
141     pkg_dirs = set()
142     python_dirs = set(["%s/subprojects/gstreamer/libs/gst/helpers/" % options.srcdir])
143     if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
144         installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
145         for path, installpath in json.loads(installed_s.decode()).items():
146             installpath_parts = pathlib.Path(installpath).parts
147             path_parts = pathlib.Path(path).parts
148
149             # We want to add all python modules to the PYTHONPATH
150             # in a manner consistent with the way they would be imported:
151             # For example if the source path /home/meh/foo/bar.py
152             # is to be installed in /usr/lib/python/site-packages/foo/bar.py,
153             # we want to add /home/meh to the PYTHONPATH.
154             # This will only work for projects where the paths to be installed
155             # mirror the installed directory layout, for example if the path
156             # is /home/meh/baz/bar.py and the install path is
157             # /usr/lib/site-packages/foo/bar.py , we will not add anything
158             # to PYTHONPATH, but the current approach works with pygobject
159             # and gst-python at least.
160             if 'site-packages' in installpath_parts:
161                 install_subpath = os.path.join(*installpath_parts[installpath_parts.index('site-packages') + 1:])
162                 if path.endswith(install_subpath):
163                     python_dirs.add(path[:len (install_subpath) * -1])
164
165             if path.endswith('.prs'):
166                 presets.add(os.path.dirname(path))
167             elif path.endswith('.gep'):
168                 encoding_targets.add(
169                     os.path.abspath(os.path.join(os.path.dirname(path), '..')))
170             elif path.endswith('.pc'):
171                 # Is there a -uninstalled pc file for this file?
172                 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
173                 if os.path.exists(uninstalled):
174                     pkg_dirs.add(os.path.dirname(path))
175
176             if path.endswith('gstomx.conf'):
177                 prepend_env_var(env, 'GST_OMX_CONFIG_DIR', os.path.dirname(path))
178
179         for p in presets:
180             prepend_env_var(env, 'GST_PRESET_PATH', p)
181
182         for t in encoding_targets:
183             prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t)
184
185         for pkg_dir in pkg_dirs:
186             prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir)
187     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(options.builddir,
188                                                          'subprojects',
189                                                          'gst-plugins-good',
190                                                          'pkgconfig'))
191
192     for python_dir in python_dirs:
193         prepend_env_var(env, 'PYTHONPATH', python_dir)
194
195     mesonpath = os.path.join(SCRIPTDIR, "meson")
196     if os.path.join(mesonpath):
197         # Add meson/ into PYTHONPATH if we are using a local meson
198         prepend_env_var(env, 'PYTHONPATH', mesonpath)
199
200     return env
201
202 def get_windows_shell():
203     command = ['powershell.exe' ,'-noprofile', '-executionpolicy', 'bypass', '-file', 'cmd_or_ps.ps1']
204     result = subprocess.check_output(command)
205     return result.decode().strip()
206
207 # https://stackoverflow.com/questions/1871549/determine-if-python-is-running-inside-virtualenv
208 def in_venv():
209     return (hasattr(sys, 'real_prefix') or
210             (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix))
211
212 if __name__ == "__main__":
213     parser = argparse.ArgumentParser(prog="gstreamer-uninstalled")
214
215     parser.add_argument("--builddir",
216                         default=DEFAULT_BUILDDIR,
217                         help="The meson build directory")
218     parser.add_argument("--srcdir",
219                         default=SCRIPTDIR,
220                         help="The top level source directory")
221     options, args = parser.parse_known_args()
222
223     if not os.path.exists(options.builddir):
224         print("GStreamer not built in %s\n\nBuild it and try again" %
225               options.builddir)
226         exit(1)
227     options.builddir = os.path.abspath(options.builddir)
228
229     if not os.path.exists(options.srcdir):
230         print("The specified source dir does not exist" %
231               options.srcdir)
232         exit(1)
233
234     # The following incantation will retrieve the current branch name.
235     gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD",
236                       repository_path=options.srcdir).strip('\n')
237
238     if not args:
239         if os.name is 'nt':
240             shell = get_windows_shell()
241             if shell == 'powershell.exe':
242                 args = ['powershell.exe']
243                 args += ['-NoLogo', '-NoExit']
244                 prompt = 'function global:prompt {  "[gst-' + gst_version + '"+"] PS " + $PWD + "> "}'
245                 args += ['-Command', prompt]
246             else:
247                 args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
248                 args += ['/k', 'prompt [gst-{}] $P$G'.format(gst_version)]
249         else:
250             args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
251         if "bash" in args[0] and not strtobool(os.environ.get("GST_BUILD_DISABLE_PS1_OVERRIDE", r"FALSE")):
252             bashrc = os.path.expanduser('~/.bashrc')
253             if os.path.exists(bashrc):
254                 tmprc = tempfile.NamedTemporaryFile(mode='w')
255                 with open(bashrc, 'r') as src:
256                     shutil.copyfileobj(src, tmprc)
257                 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
258                 tmprc.flush()
259                 # Let the GC remove the tmp file
260                 args.append("--rcfile")
261                 args.append(tmprc.name)
262     try:
263         exit(subprocess.call(args, close_fds=False,
264                              env=get_subprocess_env(options, gst_version)))
265     except subprocess.CalledProcessError as e:
266         exit(e.returncode)