Add note.
[dcpomatic.git] / wscript
1 import subprocess
2 import os
3 import sys
4
5 APPNAME = 'dcpomatic'
6 VERSION = '1.00pre'
7
8 def options(opt):
9     opt.load('compiler_cxx')
10     opt.load('winres')
11
12     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
13     opt.add_option('--disable-gui', action='store_true', default=False, help='disable building of GUI tools')
14     opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to Windows')
15     opt.add_option('--static', action='store_true', default=False, help='build statically, and link statically to libdcp and FFmpeg')
16     opt.add_option('--magickpp-config', action='store', default='Magick++-config', help='path to Magick++-config')
17     opt.add_option('--wx-config', action='store', default='wx-config', help='path to wx-config')
18
19 def pkg_config_args(conf):
20     if conf.env.STATIC:
21         return '--cflags'
22     else:
23         return '--cflags --libs'
24
25 def configure(conf):
26     conf.load('compiler_cxx')
27     if conf.options.target_windows:
28         conf.load('winres')
29
30     conf.env.TARGET_WINDOWS = conf.options.target_windows
31     conf.env.DISABLE_GUI = conf.options.disable_gui
32     conf.env.STATIC = conf.options.static
33     conf.env.VERSION = VERSION
34     conf.env.TARGET_OSX = sys.platform == 'darwin'
35     conf.env.TARGET_LINUX = not conf.env.TARGET_WINDOWS and not conf.env.TARGET_OSX
36
37     # Common CXXFLAGS
38     conf.env.append_value('CXXFLAGS', ['-D__STDC_CONSTANT_MACROS', '-D__STDC_LIMIT_MACROS', '-msse', '-mfpmath=sse', '-ffast-math', '-fno-strict-aliasing',
39                                        '-Wall', '-Wno-attributes', '-Wextra', '-D_FILE_OFFSET_BITS=64'])
40
41     if conf.options.enable_debug:
42         conf.env.append_value('CXXFLAGS', ['-g', '-DDCPOMATIC_DEBUG'])
43     else:
44         conf.env.append_value('CXXFLAGS', '-O2')
45
46     # Windows-specific
47     if conf.env.TARGET_WINDOWS:
48         conf.env.append_value('CXXFLAGS', ['-DDCPOMATIC_WINDOWS', '-DWIN32_LEAN_AND_MEAN', '-DBOOST_USE_WINDOWS_H', '-DUNICODE', '-DBOOST_THREAD_PROVIDES_GENERIC_SHARED_MUTEX_ON_WIN'])
49         wxrc = os.popen('wx-config --rescomp').read().split()[1:]
50         conf.env.append_value('WINRCFLAGS', wxrc)
51         if conf.options.enable_debug:
52             conf.env.append_value('CXXFLAGS', ['-mconsole'])
53             conf.env.append_value('LINKFLAGS', ['-mconsole'])
54         conf.check(lib = 'ws2_32', uselib_store = 'WINSOCK2', msg = "Checking for library winsock2")
55         conf.check(lib = 'bfd', uselib_store = 'BFD', msg = "Checking for library bfd")
56         conf.check(lib = 'dbghelp', uselib_store = 'DBGHELP', msg = "Checking for library dbghelp")
57         conf.check(lib = 'iberty', uselib_store = 'IBERTY', msg = "Checking for library iberty")
58         conf.check(lib = 'shlwapi', uselib_store = 'SHLWAPI', msg = "Checking for library shlwapi")
59         boost_lib_suffix = '-mt'
60         boost_thread = 'boost_thread_win32-mt'
61
62     # POSIX-specific
63     if conf.env.TARGET_LINUX or conf.env.TARGET_OSX:
64         conf.env.append_value('CXXFLAGS', '-DDCPOMATIC_POSIX')
65         conf.env.append_value('CXXFLAGS', '-DPOSIX_LOCALE_PREFIX="%s/share/locale"' % conf.env['PREFIX'])
66         conf.env.append_value('CXXFLAGS', '-DPOSIX_ICON_PREFIX="%s/share/dcpomatic"' % conf.env['PREFIX'])
67         boost_lib_suffix = ''
68         boost_thread = 'boost_thread'
69         conf.env.append_value('LINKFLAGS', '-pthread')
70
71     # Linux-specific
72     if conf.env.TARGET_LINUX:
73         conf.env.append_value('CXXFLAGS', '-DDCPOMATIC_LINUX')
74         # libxml2 seems to be linked against this on Ubuntu but it doesn't mention it in its .pc file
75         conf.check_cfg(package='liblzma', args='--cflags --libs', uselib_store='LZMA', mandatory=True)
76         if conf.env.STATIC:
77             conf.check_cfg(package='gtk+-2.0', args='--cflags --libs', uselib_store='GTK', mandatory=True)
78         else:
79             # On Linux we need to be able to include <gtk/gtk.h> to check GTK's version
80             conf.check_cfg(package='gtk+-2.0', args='--cflags', uselib_store='GTK', mandatory=True)
81
82     # OSX-specific
83     if conf.env.TARGET_OSX:
84         conf.env.append_value('CXXFLAGS', '-DDCPOMATIC_OSX')
85         conf.env.append_value('LINKFLAGS', '-headerpad_max_install_names')
86
87     # Dependencies which are dynamically linked everywhere except --static
88     # Get libs only when we are dynamically linking
89     conf.check_cfg(package='libdcp',        atleast_version='0.69', args=pkg_config_args(conf), uselib_store='DCP',  mandatory=True)
90     # Remove erroneous escaping of quotes from xmlsec1 defines
91     conf.env.DEFINES_DCP = [f.replace('\\', '') for f in conf.env.DEFINES_DCP]
92     conf.check_cfg(package='libcxml',       atleast_version='0.01', args=pkg_config_args(conf), uselib_store='CXML', mandatory=True)
93     conf.check_cfg(package='libavformat',   args=pkg_config_args(conf), uselib_store='AVFORMAT',   mandatory=True)
94     conf.check_cfg(package='libavfilter',   args=pkg_config_args(conf), uselib_store='AVFILTER',   mandatory=True)
95     conf.check_cfg(package='libavcodec',    args=pkg_config_args(conf), uselib_store='AVCODEC',    mandatory=True)
96     conf.check_cfg(package='libavutil',     args=pkg_config_args(conf), uselib_store='AVUTIL',     mandatory=True)
97     conf.check_cfg(package='libswscale',    args=pkg_config_args(conf), uselib_store='SWSCALE',    mandatory=True)
98     conf.check_cfg(package='libswresample', args=pkg_config_args(conf), uselib_store='SWRESAMPLE', mandatory=True)
99     conf.check_cfg(package='libpostproc',   args=pkg_config_args(conf), uselib_store='POSTPROC',   mandatory=True)
100     conf.check_cfg(package='libopenjpeg',   args=pkg_config_args(conf), atleast_version='1.5.0', uselib_store='OPENJPEG', mandatory=True)
101     conf.check_cfg(package='libopenjpeg',   args=pkg_config_args(conf), max_version='1.5.1', mandatory=True)
102
103     if conf.env.STATIC:
104         # This is hackio grotesquio for static builds (ie for .deb packages).  We need to link some things
105         # statically and some dynamically, or things get horribly confused and the dynamic linker (I think)
106         # crashes.  These calls do what the check_cfg calls would have done, but specify the
107         # different bits as static or dynamic as required.  It'll break if you look at it funny, but
108         # I think anyone else who builds would do so dynamically.
109         conf.env.STLIB_CXML       = ['cxml']
110         conf.env.STLIB_DCP        = ['dcp', 'asdcp-libdcp', 'kumu-libdcp']
111         conf.env.LIB_DCP          = ['glibmm-2.4', 'xml++-2.6', 'ssl', 'crypto', 'bz2', 'xmlsec1', 'xmlsec1-openssl', 'xslt']
112         conf.env.STLIB_CXML       = ['cxml']
113         conf.env.STLIB_AVFORMAT   = ['avformat']
114         conf.env.STLIB_AVFILTER   = ['avfilter', 'swresample']
115         conf.env.STLIB_AVCODEC    = ['avcodec']
116         conf.env.LIB_AVCODEC      = ['z']
117         conf.env.STLIB_AVUTIL     = ['avutil']
118         conf.env.STLIB_SWSCALE    = ['swscale']
119         conf.env.STLIB_POSTPROC   = ['postproc']
120         conf.env.STLIB_SWRESAMPLE = ['swresample']
121         conf.env.STLIB_OPENJPEG   = ['openjpeg']
122
123     # Dependencies which are always dynamically linked
124     conf.check_cfg(package='sndfile', args='--cflags --libs', uselib_store='SNDFILE', mandatory=True)
125     conf.check_cfg(package='glib-2.0', args='--cflags --libs', uselib_store='GLIB', mandatory=True)
126     conf.check_cfg(package= '', path=conf.options.magickpp_config, args='--cppflags --cxxflags --libs', uselib_store='MAGICK', mandatory=True)
127     conf.check_cfg(package='libxml++-2.6', args='--cflags --libs', uselib_store='XML++', mandatory=True)
128
129     conf.check_cxx(fragment="""
130                             #include <boost/version.hpp>\n
131                             #if BOOST_VERSION < 104500\n
132                             #error boost too old\n
133                             #endif\n
134                             int main(void) { return 0; }\n
135                             """,
136                    mandatory=True,
137                    msg='Checking for boost library >= 1.45',
138                    okmsg='yes',
139                    errmsg='too old\nPlease install boost version 1.45 or higher.')
140
141     conf.check_cc(fragment="""
142                            #include <libssh/libssh.h>\n
143                            int main () {\n
144                            ssh_session s = ssh_new ();\n
145                            return 0;\n
146                            }
147                            """, msg='Checking for library libssh', mandatory=True, lib='ssh', uselib_store='SSH')
148
149     conf.check_cxx(fragment="""
150                             #include <boost/thread.hpp>\n
151                             int main() { boost::thread t (); }\n
152                             """, msg='Checking for boost threading library',
153                             libpath='/usr/local/lib',
154                             lib=[boost_thread, 'boost_system%s' % boost_lib_suffix],
155                             uselib_store='BOOST_THREAD')
156
157     conf.check_cxx(fragment="""
158                             #include <boost/filesystem.hpp>\n
159                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
160                             """, msg='Checking for boost filesystem library',
161                             libpath='/usr/local/lib',
162                             lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
163                             uselib_store='BOOST_FILESYSTEM')
164
165     conf.check_cxx(fragment="""
166                             #include <boost/date_time.hpp>\n
167                             int main() { boost::gregorian::day_clock::local_day(); }\n
168                             """, msg='Checking for boost datetime library',
169                             libpath='/usr/local/lib',
170                             lib=['boost_date_time%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
171                             uselib_store='BOOST_DATETIME')
172
173     conf.check_cxx(fragment="""
174                             #include <boost/signals2.hpp>\n
175                             int main() { boost::signals2::signal<void (int)> x; }\n
176                             """,
177                             msg='Checking for boost signals2 library',
178                             uselib_store='BOOST_SIGNALS2')
179
180     conf.check_cc(fragment="""
181                            #include <glib.h>
182                            int main() { g_format_size (1); }
183                            """, msg='Checking for g_format_size ()',
184                            uselib='GLIB',
185                            define_name='HAVE_G_FORMAT_SIZE',
186                            mandatory=False)
187
188     conf.find_program('msgfmt', var='MSGFMT')
189     
190     datadir = conf.env.DATADIR
191     if not datadir:
192         datadir = os.path.join(conf.env.PREFIX, 'share')
193     
194     conf.define('LOCALEDIR', os.path.join(datadir, 'locale'))
195     conf.define('DATADIR', datadir)
196
197     conf.recurse('src')
198     conf.recurse('test')
199
200 def build(bld):
201     create_version_cc(VERSION, bld.env.CXXFLAGS)
202
203     bld.recurse('src')
204     bld.recurse('test')
205     if bld.env.TARGET_WINDOWS:
206         bld.recurse('platform/windows')
207     if bld.env.TARGET_LINUX:
208         bld.recurse('platform/linux')
209     if bld.env.TARGET_OSX:
210         bld.recurse('platform/osx')
211
212     for r in ['22x22', '32x32', '48x48', '64x64', '128x128']:
213         bld.install_files('${PREFIX}/share/icons/hicolor/%s/apps' % r, 'icons/%s/dcpomatic.png' % r)
214
215     if not bld.env.TARGET_WINDOWS:
216         bld.install_files('${PREFIX}/share/dcpomatic', 'icons/taskbar_icon.png')
217
218     bld.add_post_fun(post)
219
220 def git_revision():
221     if not os.path.exists('.git'):
222         return None
223
224     cmd = "LANG= git log --abbrev HEAD^..HEAD ."
225     output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
226     o = output[0].decode('utf-8')
227     return o.replace("commit ", "")[0:10]
228
229 def dist(ctx):
230     r = git_revision()
231     if r is not None:
232         f = open('.git_revision', 'w')
233         print >>f,r
234     f.close()
235
236     ctx.excl = """
237                TODO core *~ src/wx/*~ src/lib/*~ builds/*~ doc/manual/*~ src/tools/*~ *.pyc .waf* build .git
238                deps alignment hacks sync *.tar.bz2 *.exe .lock* *build-windows doc/manual/pdf doc/manual/html
239                GRSYMS GRTAGS GSYMS GTAGS
240                """
241
242
243 def create_version_cc(version, cxx_flags):
244     commit = git_revision()
245     if commit is None and os.path.exists('.git_revision'):
246         f = open('.git_revision', 'r')
247         commit = f.readline().strip()
248     
249     if commit is None:
250         commit = 'release'
251
252     try:
253         text =  '#include "version.h"\n'
254         text += 'char const * dcpomatic_git_commit = \"%s\";\n' % commit
255         text += 'char const * dcpomatic_version = \"%s\";\n' % version
256
257         t = ''
258         for f in cxx_flags:
259             f = f.replace('"', '\\"')
260             t += f + ' '
261         text += 'char const * dcpomatic_cxx_flags = \"%s\";\n' % t[:-1]
262
263         print('Writing version information to src/lib/version.cc')
264         o = open('src/lib/version.cc', 'w')
265         o.write(text)
266         o.close()
267     except IOError:
268         print('Could not open src/lib/version.cc for writing\n')
269         sys.exit(-1)
270     
271 def post(ctx):
272     if ctx.cmd == 'install':
273         ctx.exec_command('/sbin/ldconfig')
274
275 def pot(bld):
276     bld.recurse('src')
277
278 def pot_merge(bld):
279     bld.recurse('src')