In-line run of subs_in_out so that it gets the environment more easily.
[libdcp.git] / wscript
diff --git a/wscript b/wscript
index 57fed17310bc134d8ffe7fdbc530bcea3a52f123..ba74aa0f5a9d55242932c3fd1befb39a6f155ef6 100644 (file)
--- a/wscript
+++ b/wscript
@@ -1,5 +1,5 @@
 #
-#    Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
+#    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
 #
 #    This file is part of libdcp.
 #
@@ -40,73 +40,82 @@ from waflib import Logs, Context
 
 APPNAME = 'libdcp'
 
-this_version = subprocess.Popen(shlex.split('git tag -l --points-at HEAD'), stdout=subprocess.PIPE).communicate()[0]
-last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0]
+this_version = subprocess.Popen(shlex.split('git tag -l --points-at HEAD'), stdout=subprocess.PIPE).communicate()[0].decode('UTF-8')
+last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0].decode('UTF-8')
 
 if this_version == '':
     VERSION = '%sdevel' % last_version[1:].strip()
 else:
     VERSION = this_version[1:].strip()
 
+if sys.version_info.major == 2:
+    # Handle Python 2 (for Ubuntu 16.04)
+    VERSION = VERSION.encode('UTF-8')
+
 API_VERSION = '-1.0'
 
 def options(opt):
     opt.load('compiler_cxx')
-    opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to Windows')
+    opt.add_option('--target-windows-64', action='store_true', default=False, help='set up to do a cross-compile to Windows 64-bit')
+    opt.add_option('--target-windows-32', action='store_true', default=False, help='set up to do a cross-compile to Windows 32-bit')
     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
-    opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-cth')
+    opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-carl')
     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
-    opt.add_option('--disable-gcov', action='store_true', default=False, help='don''t use gcov in tests')
+    opt.add_option('--disable-benchmarks', action='store_true', default=False, help='disable building of benchmarks')
+    opt.add_option('--enable-gcov', action='store_true', default=False, help='use gcov in tests')
     opt.add_option('--disable-examples', action='store_true', default=False, help='disable building of examples')
+    opt.add_option('--disable-dumpimage', action='store_true', default=False, help='disable building of dcpdumpimage')
     opt.add_option('--enable-openmp', action='store_true', default=False, help='enable use of OpenMP')
-    opt.add_option('--jpeg', default='oj2', help='specify JPEG library to build with: oj1 or oj2 for OpenJPEG 1.5.x or OpenJPEG 2.1.x respectively')
-    opt.add_option('--force-cpp11', action='store_true', default=False, help='force use of C++11')
+    opt.add_option('--openmp', default='gomp', help='specify OpenMP Library to use: omp, gomp (default), iomp')
 
 def configure(conf):
     conf.load('compiler_cxx')
     conf.load('clang_compilation_database', tooldir=['waf-tools'])
-    conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS'])
-    if conf.options.force_cpp11:
-        conf.env.append_value('CXXFLAGS', ['-std=c++11', '-DBOOST_NO_CXX11_SCOPED_ENUMS'])
+    conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS', '-std=c++11'])
     gcc = conf.env['CC_VERSION']
     if int(gcc[0]) >= 4 and int(gcc[1]) > 1:
         conf.env.append_value('CXXFLAGS', ['-Wno-maybe-uninitialized'])
     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_VERSION="%s"' % VERSION])
 
-    conf.env.TARGET_WINDOWS = conf.options.target_windows
+    conf.env.TARGET_WINDOWS_64 = conf.options.target_windows_64
+    conf.env.TARGET_WINDOWS_32 = conf.options.target_windows_32
     conf.env.TARGET_OSX = sys.platform == 'darwin'
+    conf.env.TARGET_LINUX = not conf.env.TARGET_WINDOWS and not conf.env.TARGET_OSX
     conf.env.ENABLE_DEBUG = conf.options.enable_debug
     conf.env.DISABLE_TESTS = conf.options.disable_tests
+    conf.env.DISABLE_BENCHMARKS = conf.options.disable_benchmarks
     conf.env.DISABLE_EXAMPLES = conf.options.disable_examples
+    conf.env.DISABLE_DUMPIMAGE = conf.options.disable_dumpimage
     conf.env.STATIC = conf.options.static
     conf.env.API_VERSION = API_VERSION
 
-    if conf.options.target_windows:
+    if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
-    else:
-        conf.env.append_value('CXXFLAGS', '-DLIBDCP_POSIX')
+    if conf.env.TARGET_OSX:
+        conf.env.append_value('CXXFLAGS', '-DLIBDCP_OSX')
+    if conf.env.TARGET_LINUX:
+        conf.env.append_value('CXXFLAGS', '-DLIBDCP_LINUX')
 
     if conf.env.TARGET_OSX:
         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
+        conf.env.append_value('LINKFLAGS', '-headerpad_max_install_names')
+    elif int(gcc[0]) > 4:
+        conf.env.append_value('CXXFLAGS', ['-Wsuggest-override'])
 
     # Disable libxml++ deprecation warnings for now
     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
 
     if conf.options.enable_openmp:
         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
-        conf.env.LIB_OPENMP = ['gomp']
+        conf.env.LIB_OPENMP = [conf.options.openmp]
+        conf.env.append_value('LDFLAGS', ['-l%s' % conf.options.openmp])
+        conf.check_cxx(cxxflags='-fopenmp', msg='Checking that compiler supports -fopenmp')
 
-    if not conf.env.TARGET_WINDOWS:
+    if not conf.env.TARGET_WINDOWS_64 and not conf.env.TARGET_WINDOWS_32:
         conf.env.append_value('LINKFLAGS', '-pthread')
-    if not conf.options.disable_gcov:
-        conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 
-    if conf.options.jpeg == 'oj1':
-        conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG1'])
-    elif conf.options.jpeg == 'oj2':
-        conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG2'])
-    else:
-        Logs.error('Invalid --jpeg value %s' % conf.options.jpeg)
+    if conf.env.TARGET_LINUX:
+        conf.check(lib='dl', uselib_store='DL', msg='Checking for library dl')
 
     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
@@ -115,39 +124,61 @@ def configure(conf):
     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 
     # ImageMagick / GraphicsMagick
-    if distutils.spawn.find_executable('Magick++-config'):
-        conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True)
-    else:
-        image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
-        graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
-        if image is None and graphics is None:
-            Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required')
+    if (not conf.options.disable_examples) and (not conf.options.disable_dumpimage):
+        if distutils.spawn.find_executable('Magick++-config'):
+            conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True, msg='Checking for ImageMagick/GraphicsMagick')
+        else:
+            image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
+            graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
+            if image is None and graphics is None:
+                Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required unless you ./waf configure --disable-examples --disable-dumpimage')
+                sys.exit(1)
 
     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 
+    # Find openjpeg so that we can test to see if it's the right version
+    if conf.options.static:
+        conf.check_cfg(package='libopenjp2', args='--cflags', uselib_store='OPENJPEG', mandatory=True, msg='Checking for any version of libopenjp2')
+    else:
+        conf.check_cfg(package='libopenjp2', args='--cflags --libs', uselib_store='OPENJPEG', mandatory=True, msg='Checking for any version of libopenjp2')
+
+    patched_openjpeg = conf.check_cxx(fragment="""
+                   #include <openjpeg.h>
+                   int main() { opj_cparameters_t p; p.numgbits = 2; }\n
+                   """,
+                   msg='Checking for numgbits in opj_cparameters_t',
+                   use='OPENJPEG',
+                   mandatory=False,
+                   define_name='LIBDCP_HAVE_NUMGBITS')
+
+    if not patched_openjpeg:
+        # We don't have our patched version so we need 2.5.0 to get the GUARD_BITS option
+        conf.check_cfg(package='libopenjp2', args='libopenjp2 >= 2.5.0', uselib_store='OPENJPEG', mandatory=True, msg='Checking for libopenjp2 >= 2.5.0')
+
     if conf.options.static:
-        if conf.options.jpeg == 'oj2':
-            conf.check_cfg(package='libopenjp2', args='--cflags', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
-            conf.env.STLIB_OPENJPEG = ['openjp2']
-        elif conf.options.jpeg == 'oj1':
-            conf.check_cfg(package='libopenjpeg1', args='--cflags', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
-            conf.env.STLIB_OPENJPEG = ['openjpeg']
-        conf.check_cfg(package='libasdcp-cth', atleast_version='0.1.3', args='--cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
+        conf.env.STLIB_OPENJPEG = ['openjp2']
+        conf.check_cfg(package='libasdcp-carl', args='libasdcp-carl >= 0.1.3 --cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
         conf.env.HAVE_ASDCPLIB_CTH = 1
-        conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-cth', 'kumu-cth']
+        conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-carl', 'kumu-carl']
         conf.env.HAVE_CXML = 1
         conf.env.LIB_CXML = ['xml++-2.6', 'glibmm-2.4']
         conf.env.STLIB_CXML = ['cxml']
+        conf.check_cfg(package='xerces-c', args='--cflags', uselib_store='XERCES', mandatory=True)
+        conf.env.LIB_XERCES = ['xerces-c', 'icuuc', 'curl']
     else:
-        if conf.options.jpeg == 'oj2':
-            conf.check_cfg(package='libopenjp2', args='--cflags --libs', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
-        elif conf.options.jpeg == 'oj1':
-            conf.check_cfg(package='libopenjpeg1', args='--cflags --libs', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
-        conf.check_cfg(package='libasdcp-cth', atleast_version='0.1.3', args='--cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
-        conf.check_cfg(package='libcxml', atleast_version='0.16.0', args='--cflags --libs', uselib_store='CXML', mandatory=True)
-
-    if conf.options.target_windows:
-        boost_lib_suffix = '-mt'
+        conf.check_cfg(package='libasdcp-carl', args='libasdcp-carl >= 0.1.3 --cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
+        conf.check_cfg(package='libcxml', args='libcxml >= 0.17.0 --cflags --libs', uselib_store='CXML', mandatory=True)
+        conf.check_cfg(package='xerces-c', args='--cflags --libs', uselib_store='XERCES', mandatory=True)
+
+    if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
+        # XXX: it feels like there should be a more elegant way to get these included
+        conf.env.LIB_XERCES.append('curl')
+        conf.env.LIB_XERCES.append('ws2_32')
+
+    if conf.options.target_windows_64:
+        boost_lib_suffix = '-mt-x64'
+    elif conf.options.target_windows_32:
+        boost_lib_suffix = '-mt-x32'
     else:
         boost_lib_suffix = ''
 
@@ -158,17 +189,21 @@ def configure(conf):
         # Windows builds are any more reliable
         conf.env.append_value('CXXFLAGS', '-O2')
 
+    # We support older boosts on Linux so we can use the distribution-provided package
+    # on Centos 7, but it's good if we can use 1.61 for boost::dll::program_location()
+    boost_version = ('1.45', '104500') if conf.env.TARGET_LINUX else ('1.61', '106800')
+
     conf.check_cxx(fragment="""
                             #include <boost/version.hpp>\n
-                            #if BOOST_VERSION < 104500\n
+                            #if BOOST_VERSION < %s\n
                             #error boost too old\n
                             #endif\n
                             int main(void) { return 0; }\n
-                            """,
+                            """ % boost_version[1],
                    mandatory=True,
-                   msg='Checking for boost library >= 1.45',
+                   msg='Checking for boost library >= %s' % boost_version[0],
                    okmsg='yes',
-                   errmsg='too old\nPlease install boost version 1.45 or higher.')
+                   errmsg='too old\nPlease install boost version %s or higher.' % boost_version[0])
 
     conf.check_cxx(fragment="""
                            #include <boost/filesystem.hpp>\n
@@ -179,6 +214,15 @@ def configure(conf):
                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
                    uselib_store='BOOST_FILESYSTEM')
 
+    conf.check_cxx(fragment="""
+                   #include <boost/filesystem.hpp>\n
+                   int main() { boost::filesystem::weakly_canonical("a/b/c"); }\n
+                   """,
+                   mandatory=False,
+                   msg='Checking for boost::filesystem::weakly_canonical',
+                   uselib='BOOST_FILESYSTEM',
+                   define_name='LIBDCP_HAVE_WEAKLY_CANONICAL')
+
     conf.check_cxx(fragment="""
                            #include <boost/signals2.hpp>\n
                            int main() { boost::signals2::signal<void (int)> x; }\n
@@ -197,21 +241,28 @@ def configure(conf):
 
     if not conf.env.DISABLE_TESTS:
         conf.recurse('test')
-        if not conf.options.disable_gcov:
+        if conf.options.enable_gcov:
             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
+            conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 
 def build(bld):
     create_version_cc(bld, VERSION)
 
-    if bld.env.TARGET_WINDOWS:
-        boost_lib_suffix = '-mt'
+    if bld.env.TARGET_WINDOWS_64:
+        boost_lib_suffix = '-mt-x64'
+    elif bld.env.TARGET_WINDOWS_32:
+        boost_lib_suffix = '-mt-x32'
     else:
         boost_lib_suffix = ''
 
+    libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix)
+    if bld.env.TARGET_LINUX:
+        libs += " -ldl"
+
     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
         version=VERSION,
         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
-        libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix),
+        libs=libs,
         install_path='${LIBDIR}/pkgconfig')
 
     bld.recurse('src')
@@ -220,6 +271,16 @@ def build(bld):
         bld.recurse('test')
     if not bld.env.DISABLE_EXAMPLES:
         bld.recurse('examples')
+    if not bld.env.DISABLE_BENCHMARKS:
+        bld.recurse('benchmark')
+
+    for i in os.listdir('xsd'):
+        bld.install_files('${PREFIX}/share/libdcp/xsd', os.path.join('xsd', i))
+
+    for i in ['language', 'region', 'script', 'variant', 'extlang', 'dcnc']:
+        bld.install_files('${PREFIX}/share/libdcp/tags', os.path.join('tags', i))
+
+    bld.install_files('${PREFIX}/share/libdcp', 'ratings')
 
     bld.add_post_fun(post)