wscript

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