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