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