wscript

   1 #
   2 #    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
   3 #
   4 #    This file is part of libdcp.
   5 #
   6 #    libdcp is free software; you can redistribute it and/or modify
   7 #    it under the terms of the GNU General Public License as published by
   8 #    the Free Software Foundation; either version 2 of the License, or
   9 #    (at your option) any later version.
  10 #
  11 #    libdcp is distributed in the hope that it will be useful,
  12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #    GNU General Public License for more details.
  15 #
  16 #    You should have received a copy of the GNU General Public License
  17 #    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 #    In addition, as a special exception, the copyright holders give
  20 #    permission to link the code of portions of this program with the
  21 #    OpenSSL library under certain conditions as described in each
  22 #    individual source file, and distribute linked combinations
  23 #    including the two.
  24 #
  25 #    You must obey the GNU General Public License in all respects
  26 #    for all of the code used other than OpenSSL.  If you modify
  27 #    file(s) with this exception, you may extend this exception to your
  28 #    version of the file(s), but you are not obligated to do so.  If you
  29 #    do not wish to do so, delete this exception statement from your
  30 #    version.  If you delete this exception statement from all source
  31 #    files in the program, then also delete it here.
  32 #
  33
  34 import subprocess
  35 import os
  36 import sys
  37 import shlex
  38 import distutils.spawn
  39 from waflib import Logs, Context
  40
  41 APPNAME = 'libdcp'
  42
  43 this_version = subprocess.Popen(shlex.split('git tag -l --points-at HEAD'), stdout=subprocess.PIPE).communicate()[0]
  44 last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0]
  45
  46 if this_version == '':
  47     VERSION = '%sdevel' % last_version[1:].strip()
  48 else:
  49     VERSION = this_version[1:].strip()
  50
  51 API_VERSION = '-1.0'
  52
  53 def options(opt):
  54     opt.load('compiler_cxx')
  55     opt.add_option('--target-windows-64', action='store_true', default=False, help='set up to do a cross-compile to Windows 64-bit')
  56     opt.add_option('--target-windows-32', action='store_true', default=False, help='set up to do a cross-compile to Windows 32-bit')
  57     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
  58     opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-carl')
  59     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
  60     opt.add_option('--disable-benchmarks', action='store_true', default=False, help='disable building of benchmarks')
  61     opt.add_option('--disable-gcov', action='store_true', default=False, help='don''t use gcov in tests')
  62     opt.add_option('--disable-examples', action='store_true', default=False, help='disable building of examples')
  63     opt.add_option('--enable-openmp', action='store_true', default=False, help='enable use of OpenMP')
  64     opt.add_option('--openmp', default='gomp', help='specify OpenMP Library to use: omp, gomp (default), iomp')
  65     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')
  66
  67 def configure(conf):
  68     conf.load('compiler_cxx')
  69     conf.load('clang_compilation_database', tooldir=['waf-tools'])
  70     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS', '-std=c++11'])
  71     gcc = conf.env['CC_VERSION']
  72     if int(gcc[0]) >= 4 and int(gcc[1]) > 1:
  73         conf.env.append_value('CXXFLAGS', ['-Wno-maybe-uninitialized'])
  74     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_VERSION="%s"' % VERSION])
  75
  76     conf.env.TARGET_WINDOWS_64 = conf.options.target_windows_64
  77     conf.env.TARGET_WINDOWS_32 = conf.options.target_windows_32
  78     conf.env.TARGET_OSX = sys.platform == 'darwin'
  79     conf.env.TARGET_LINUX = not conf.env.TARGET_WINDOWS and not conf.env.TARGET_OSX
  80     conf.env.ENABLE_DEBUG = conf.options.enable_debug
  81     conf.env.DISABLE_TESTS = conf.options.disable_tests
  82     conf.env.DISABLE_BENCHMARKS = conf.options.disable_benchmarks
  83     conf.env.DISABLE_EXAMPLES = conf.options.disable_examples
  84     conf.env.STATIC = conf.options.static
  85     conf.env.API_VERSION = API_VERSION
  86
  87     if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
  88         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
  89     if conf.env.TARGET_OSX:
  90         conf.env.append_value('CXXFLAGS', '-DLIBDCP_OSX')
  91     if conf.env.TARGET_LINUX:
  92         conf.env.append_value('CXXFLAGS', '-DLIBDCP_LINUX')
  93
  94     if conf.env.TARGET_OSX:
  95         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
  96         conf.env.append_value('LINKFLAGS', '-headerpad_max_install_names')
  97     elif int(gcc[0]) > 4:
  98         conf.env.append_value('CXXFLAGS', ['-Wsuggest-override'])
  99
 100     # Disable libxml++ deprecation warnings for now
 101     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
 102
 103     if conf.options.enable_openmp:
 104         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
 105         conf.env.LIB_OPENMP = [conf.options.openmp]
 106         conf.env.append_value('LDFLAGS', ['-l%s' % conf.options.openmp])
 107         conf.check_cxx(cxxflags='-fopenmp', msg='Checking that compiler supports -fopenmp')
 108
 109     if not conf.env.TARGET_WINDOWS_64 and not conf.env.TARGET_WINDOWS_32:
 110         conf.env.append_value('LINKFLAGS', '-pthread')
 111
 112     if conf.env.TARGET_LINUX:
 113         conf.check(lib='dl', uselib_store='DL', msg='Checking for library dl')
 114
 115     if conf.options.jpeg == 'oj1':
 116         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG1'])
 117     elif conf.options.jpeg == 'oj2':
 118         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG2'])
 119     else:
 120         Logs.error('Invalid --jpeg value %s' % conf.options.jpeg)
 121
 122     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
 123     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
 124     conf.check_cfg(package='xmlsec1', args='--cflags --libs', uselib_store='XMLSEC1', mandatory=True)
 125     # Remove erroneous escaping of quotes from xmlsec1 defines
 126     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 127
 128     # ImageMagick / GraphicsMagick
 129     if not conf.options.disable_examples:
 130         if distutils.spawn.find_executable('Magick++-config'):
 131             conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True, msg='Checking for ImageMagick/GraphicsMagick')
 132         else:
 133             image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 134             graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 135             if image is None and graphics is None:
 136                 Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required')
 137
 138     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 139
 140     if conf.options.static:
 141         if conf.options.jpeg == 'oj2':
 142             conf.check_cfg(package='libopenjp2', args='--cflags', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 143             conf.env.STLIB_OPENJPEG = ['openjp2']
 144         elif conf.options.jpeg == 'oj1':
 145             conf.check_cfg(package='libopenjpeg1', args='--cflags', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 146             conf.env.STLIB_OPENJPEG = ['openjpeg']
 147         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
 148         conf.env.HAVE_ASDCPLIB_CTH = 1
 149         conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-carl', 'kumu-carl']
 150         conf.env.HAVE_CXML = 1
 151         conf.env.LIB_CXML = ['xml++-2.6', 'glibmm-2.4']
 152         conf.env.STLIB_CXML = ['cxml']
 153         conf.check_cfg(package='xerces-c', args='--cflags', uselib_store='XERCES', mandatory=True)
 154         conf.env.LIB_XERCES = ['xerces-c', 'icuuc', 'curl']
 155     else:
 156         if conf.options.jpeg == 'oj2':
 157             conf.check_cfg(package='libopenjp2', args='--cflags --libs', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 158         elif conf.options.jpeg == 'oj1':
 159             conf.check_cfg(package='libopenjpeg1', args='--cflags --libs', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 160         conf.check_cfg(package='libasdcp-carl', atleast_version='0.1.3', args='--cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
 161         conf.check_cfg(package='libcxml', atleast_version='0.17.0', args='--cflags --libs', uselib_store='CXML', mandatory=True)
 162         conf.check_cfg(package='xerces-c', args='--cflags --libs', uselib_store='XERCES', mandatory=True)
 163
 164     if conf.env.TARGET_WINDOWS_64 or conf.env.TARGET_WINDOWS_32:
 165         # XXX: it feels like there should be a more elegant way to get these included
 166         conf.env.LIB_XERCES.append('curl')
 167         conf.env.LIB_XERCES.append('ws2_32')
 168
 169     if conf.options.target_windows_64:
 170         boost_lib_suffix = '-mt-x64'
 171     elif conf.options.target_windows_32:
 172         boost_lib_suffix = '-mt-x32'
 173     else:
 174         boost_lib_suffix = ''
 175
 176     if conf.options.enable_debug:
 177         conf.env.append_value('CXXFLAGS', '-g')
 178     else:
 179         # Somewhat experimental use of -O2 rather than -O3 to see if
 180         # Windows builds are any more reliable
 181         conf.env.append_value('CXXFLAGS', '-O2')
 182
 183     # We support older boosts on Linux so we can use the distribution-provided package
 184     # on Centos 7, but it's good if we can use 1.61 for boost::dll::program_location()
 185     boost_version = ('1.45', '104500') if conf.env.TARGET_LINUX else ('1.61', '106800')
 186
 187     conf.check_cxx(fragment="""
 188                             #include <boost/version.hpp>\n
 189                             #if BOOST_VERSION < %s\n
 190                             #error boost too old\n
 191                             #endif\n
 192                             int main(void) { return 0; }\n
 193                             """ % boost_version[1],
 194                    mandatory=True,
 195                    msg='Checking for boost library >= %s' % boost_version[0],
 196                    okmsg='yes',
 197                    errmsg='too old\nPlease install boost version %s or higher.' % boost_version[0])
 198
 199     conf.check_cxx(fragment="""
 200                             #include <boost/filesystem.hpp>\n
 201                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
 202                             """,
 203                    msg='Checking for boost filesystem library',
 204                    libpath='/usr/local/lib',
 205                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 206                    uselib_store='BOOST_FILESYSTEM')
 207
 208     conf.check_cxx(fragment="""
 209                             #include <boost/signals2.hpp>\n
 210                             int main() { boost::signals2::signal<void (int)> x; }\n
 211                             """,
 212                    msg='Checking for boost signals2 library',
 213                    uselib_store='BOOST_SIGNALS2')
 214
 215     conf.check_cxx(fragment="""
 216                             #include <boost/date_time.hpp>\n
 217                             int main() { boost::gregorian::day_clock::local_day(); }\n
 218                             """,
 219                    msg='Checking for boost datetime library',
 220                    libpath='/usr/local/lib',
 221                    lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 222                    uselib_store='BOOST_DATETIME')
 223
 224     if not conf.env.DISABLE_TESTS:
 225         conf.recurse('test')
 226         if not conf.options.disable_gcov:
 227             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
 228             conf.env.append_value('LINKFLAGS', '-fprofile-arcs')
 229
 230 def build(bld):
 231     create_version_cc(bld, VERSION)
 232
 233     if bld.env.TARGET_WINDOWS_64:
 234         boost_lib_suffix = '-mt-x64'
 235     elif bld.env.TARGET_WINDOWS_32:
 236         boost_lib_suffix = '-mt-x32'
 237     else:
 238         boost_lib_suffix = ''
 239
 240     libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix)
 241     if bld.env.TARGET_LINUX:
 242         libs += " -ldl"
 243
 244     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
 245         version=VERSION,
 246         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
 247         libs=libs,
 248         install_path='${LIBDIR}/pkgconfig')
 249
 250     bld.recurse('src')
 251     bld.recurse('tools')
 252     if not bld.env.DISABLE_TESTS:
 253         bld.recurse('test')
 254     if not bld.env.DISABLE_EXAMPLES:
 255         bld.recurse('examples')
 256     if not bld.env.DISABLE_BENCHMARKS:
 257         bld.recurse('benchmark')
 258
 259     for i in os.listdir('xsd'):
 260         bld.install_files('${PREFIX}/share/libdcp/xsd', os.path.join('xsd', i))
 261
 262     for i in ['language', 'region', 'script', 'variant', 'extlang', 'dcnc']:
 263         bld.install_files('${PREFIX}/share/libdcp/tags', os.path.join('tags', i))
 264
 265     bld.install_files('${PREFIX}/share/libdcp', 'ratings')
 266
 267     bld.add_post_fun(post)
 268
 269 def dist(ctx):
 270     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
 271
 272 def create_version_cc(bld, version):
 273     if os.path.exists('.git'):
 274         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
 275         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
 276         o = output[0].decode('utf-8')
 277         commit = o.replace ("commit ", "")[0:10]
 278     else:
 279         commit = "release"
 280
 281     try:
 282         text =  '#include "version.h"\n'
 283         text += 'char const * dcp::git_commit = \"%s\";\n' % commit
 284         text += 'char const * dcp::version = \"%s\";\n' % version
 285         if bld.env.ENABLE_DEBUG:
 286             debug_string = 'true'
 287         else:
 288             debug_string = 'false'
 289         text += 'bool const dcp::built_with_debug = %s;\n' % debug_string
 290         print('Writing version information to src/version.cc')
 291         o = open('src/version.cc', 'w')
 292         o.write(text)
 293         o.close()
 294     except IOError:
 295         print('Could not open src/version.cc for writing\n')
 296         sys.exit(-1)
 297
 298 def post(ctx):
 299     if ctx.cmd == 'install':
 300         ctx.exec_command('/sbin/ldconfig')
 301
 302 def tags(bld):
 303     os.system('etags src/*.cc src/*.h')