wscript

   1 #
   2 #    Copyright (C) 2012-2017 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 isinstance(this_version, bytes):
  47     this_version = this_version.decode('UTF-8')
  48 if isinstance(last_version, bytes):
  49     last_version = last_version.decode('UTF-8')
  50
  51 if this_version == '':
  52     VERSION = '%sdevel' % last_version[1:].strip()
  53 else:
  54     VERSION = this_version[1:].strip()
  55
  56 API_VERSION = '-1.0'
  57
  58 def options(opt):
  59     opt.load('compiler_cxx')
  60     opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to Windows')
  61     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
  62     opt.add_option('--static', action='store_true', default=False, help='build libdcp statically, and link statically to openjpeg, cxml, asdcplib-cth')
  63     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
  64     opt.add_option('--disable-gcov', action='store_true', default=False, help='don''t use gcov in tests')
  65     opt.add_option('--disable-examples', action='store_true', default=False, help='disable building of examples')
  66     opt.add_option('--enable-openmp', action='store_true', default=False, help='enable use of OpenMP')
  67     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')
  68     opt.add_option('--force-cpp11', action='store_true', default=False, help='force use of C++11')
  69
  70 def configure(conf):
  71     conf.load('compiler_cxx')
  72     conf.load('clang_compilation_database', tooldir=['waf-tools'])
  73     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS'])
  74     if conf.options.force_cpp11:
  75         conf.env.append_value('CXXFLAGS', ['-std=c++11', '-DBOOST_NO_CXX11_SCOPED_ENUMS'])
  76     gcc = conf.env['CC_VERSION']
  77     if int(gcc[0]) >= 4 and int(gcc[1]) > 1:
  78         conf.env.append_value('CXXFLAGS', ['-Wno-maybe-uninitialized'])
  79     conf.env.append_value('CXXFLAGS', ['-DLIBDCP_VERSION="%s"' % VERSION])
  80
  81     conf.env.TARGET_WINDOWS = conf.options.target_windows
  82     conf.env.TARGET_OSX = sys.platform == 'darwin'
  83     conf.env.ENABLE_DEBUG = conf.options.enable_debug
  84     conf.env.DISABLE_TESTS = conf.options.disable_tests
  85     conf.env.DISABLE_EXAMPLES = conf.options.disable_examples
  86     conf.env.STATIC = conf.options.static
  87     conf.env.API_VERSION = API_VERSION
  88
  89     if conf.options.target_windows:
  90         conf.env.append_value('CXXFLAGS', '-DLIBDCP_WINDOWS')
  91     else:
  92         conf.env.append_value('CXXFLAGS', '-DLIBDCP_POSIX')
  93
  94     if conf.env.TARGET_OSX:
  95         conf.env.append_value('CXXFLAGS', ['-Wno-unused-result', '-Wno-unused-parameter', '-Wno-unused-local-typedef'])
  96
  97     # Disable libxml++ deprecation warnings for now
  98     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
  99
 100     if conf.options.enable_openmp:
 101         conf.env.append_value('CXXFLAGS', ['-fopenmp', '-DLIBDCP_OPENMP'])
 102         conf.env.LIB_OPENMP = ['gomp']
 103
 104     if not conf.env.TARGET_WINDOWS:
 105         conf.env.append_value('LINKFLAGS', '-pthread')
 106
 107     if conf.options.jpeg == 'oj1':
 108         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG1'])
 109     elif conf.options.jpeg == 'oj2':
 110         conf.env.append_value('CXXFLAGS', ['-DLIBDCP_OPENJPEG2'])
 111     else:
 112         Logs.error('Invalid --jpeg value %s' % conf.options.jpeg)
 113
 114     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
 115     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='LIBXML++', mandatory=True)
 116     conf.check_cfg(package='xmlsec1', args='--cflags --libs', uselib_store='XMLSEC1', mandatory=True)
 117     # Remove erroneous escaping of quotes from xmlsec1 defines
 118     conf.env.DEFINES_XMLSEC1 = [f.replace('\\', '') for f in conf.env.DEFINES_XMLSEC1]
 119
 120     # ImageMagick / GraphicsMagick
 121     if distutils.spawn.find_executable('Magick++-config'):
 122         conf.check_cfg(package='', path='Magick++-config', args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True)
 123     else:
 124         image = conf.check_cfg(package='ImageMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 125         graphics = conf.check_cfg(package='GraphicsMagick++', args='--cflags --libs', uselib_store='MAGICK', mandatory=False)
 126         if image is None and graphics is None:
 127             Logs.error('Neither ImageMagick++ nor GraphicsMagick++ found: one or the other is required')
 128
 129     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=False)
 130
 131     if conf.options.static:
 132         if conf.options.jpeg == 'oj2':
 133             conf.check_cfg(package='libopenjp2', args='--cflags', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 134             conf.env.STLIB_OPENJPEG = ['openjp2']
 135         elif conf.options.jpeg == 'oj1':
 136             conf.check_cfg(package='libopenjpeg1', args='--cflags', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 137             conf.env.STLIB_OPENJPEG = ['openjpeg']
 138         conf.check_cfg(package='libasdcp-cth', atleast_version='0.1.3', args='--cflags', uselib_store='ASDCPLIB_CTH', mandatory=True)
 139         conf.env.HAVE_ASDCPLIB_CTH = 1
 140         conf.env.STLIB_ASDCPLIB_CTH = ['asdcp-cth', 'kumu-cth']
 141         conf.env.HAVE_CXML = 1
 142         conf.env.LIB_CXML = ['xml++-2.6', 'glibmm-2.4']
 143         conf.env.STLIB_CXML = ['cxml']
 144     else:
 145         if conf.options.jpeg == 'oj2':
 146             conf.check_cfg(package='libopenjp2', args='--cflags --libs', atleast_version='2.1.0', uselib_store='OPENJPEG', mandatory=True)
 147         elif conf.options.jpeg == 'oj1':
 148             conf.check_cfg(package='libopenjpeg1', args='--cflags --libs', atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
 149         conf.check_cfg(package='libasdcp-cth', atleast_version='0.1.3', args='--cflags --libs', uselib_store='ASDCPLIB_CTH', mandatory=True)
 150         conf.check_cfg(package='libcxml', atleast_version='0.16.0', args='--cflags --libs', uselib_store='CXML', mandatory=True)
 151
 152     if conf.options.target_windows:
 153         boost_lib_suffix = '-mt'
 154     else:
 155         boost_lib_suffix = ''
 156
 157     if conf.options.enable_debug:
 158         conf.env.append_value('CXXFLAGS', '-g')
 159     else:
 160         # Somewhat experimental use of -O2 rather than -O3 to see if
 161         # Windows builds are any more reliable
 162         conf.env.append_value('CXXFLAGS', '-O2')
 163
 164     conf.check_cxx(fragment="""
 165                             #include <boost/version.hpp>\n
 166                             #if BOOST_VERSION < 104500\n
 167                             #error boost too old\n
 168                             #endif\n
 169                             int main(void) { return 0; }\n
 170                             """,
 171                    mandatory=True,
 172                    msg='Checking for boost library >= 1.45',
 173                    okmsg='yes',
 174                    errmsg='too old\nPlease install boost version 1.45 or higher.')
 175
 176     conf.check_cxx(fragment="""
 177                             #include <boost/filesystem.hpp>\n
 178                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
 179                             """,
 180                    msg='Checking for boost filesystem library',
 181                    libpath='/usr/local/lib',
 182                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 183                    uselib_store='BOOST_FILESYSTEM')
 184
 185     conf.check_cxx(fragment="""
 186                             #include <boost/signals2.hpp>\n
 187                             int main() { boost::signals2::signal<void (int)> x; }\n
 188                             """,
 189                    msg='Checking for boost signals2 library',
 190                    uselib_store='BOOST_SIGNALS2')
 191
 192     conf.check_cxx(fragment="""
 193                             #include <boost/date_time.hpp>\n
 194                             int main() { boost::gregorian::day_clock::local_day(); }\n
 195                             """,
 196                    msg='Checking for boost datetime library',
 197                    libpath='/usr/local/lib',
 198                    lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
 199                    uselib_store='BOOST_DATETIME')
 200
 201     if not conf.env.DISABLE_TESTS:
 202         conf.recurse('test')
 203         if not conf.options.disable_gcov:
 204             conf.check(lib='gcov', define_name='HAVE_GCOV', mandatory=False)
 205
 206 def build(bld):
 207     create_version_cc(bld, VERSION)
 208
 209     if bld.env.TARGET_WINDOWS:
 210         boost_lib_suffix = '-mt'
 211     else:
 212         boost_lib_suffix = ''
 213
 214     bld(source='libdcp%s.pc.in' % bld.env.API_VERSION,
 215         version=VERSION,
 216         includedir='%s/include/libdcp%s' % (bld.env.PREFIX, bld.env.API_VERSION),
 217         libs="-L${libdir} -ldcp%s -lcxml -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix),
 218         install_path='${LIBDIR}/pkgconfig')
 219
 220     bld.recurse('src')
 221     bld.recurse('tools')
 222     if not bld.env.DISABLE_TESTS:
 223         bld.recurse('test')
 224     if not bld.env.DISABLE_EXAMPLES:
 225         bld.recurse('examples')
 226
 227     bld.add_post_fun(post)
 228
 229 def dist(ctx):
 230     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
 231
 232 def create_version_cc(bld, version):
 233     if os.path.exists('.git'):
 234         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
 235         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
 236         o = output[0].decode('utf-8')
 237         commit = o.replace ("commit ", "")[0:10]
 238     else:
 239         commit = "release"
 240
 241     try:
 242         text =  '#include "version.h"\n'
 243         text += 'char const * dcp::git_commit = \"%s\";\n' % commit
 244         text += 'char const * dcp::version = \"%s\";\n' % version
 245         if bld.env.ENABLE_DEBUG:
 246             debug_string = 'true'
 247         else:
 248             debug_string = 'false'
 249         text += 'bool const dcp::built_with_debug = %s;\n' % debug_string
 250         print('Writing version information to src/version.cc')
 251         o = open('src/version.cc', 'w')
 252         o.write(text)
 253         o.close()
 254     except IOError:
 255         print('Could not open src/version.cc for writing\n')
 256         sys.exit(-1)
 257
 258 def post(ctx):
 259     if ctx.cmd == 'install':
 260         ctx.exec_command('/sbin/ldconfig')
 261
 262 def tags(bld):
 263     os.system('etags src/*.cc src/*.h')