wscript: build sphinx in doc/_build, add a note on install trick
[aubio.git] / Makefile
1 #!/usr/bin/make -f
2 # -*- makefile -*-
3 #
4 # This makefile contains simple rules to prepare, compile, test, and install
5 # aubio. Try one of the following rules:
6 #
7 # $ make configure
8 # $ make build
9 # $ make install
10 # $ make test_python
11
12 WAFCMD=python waf
13 WAFURL=https://waf.io/waf-1.8.22
14
15 #WAFOPTS:=
16 # turn on verbose mode
17 WAFOPTS += --verbose
18 # build wafopts
19 WAFOPTS += --destdir $(DESTDIR)
20 # multiple jobs
21 WAFOPTS += --jobs 4
22 # if HAVE_AUBIO_DOUBLE is defined, pass --enable-double to waf
23 # python/lib/moresetuptools.py also checks for HAVE_AUBIO_DOUBLE
24 WAFOPTS += $(shell [ -z $(HAVE_AUBIO_DOUBLE) ] || echo --enable-double )
25
26 PIPOPTS += --verbose
27
28 DESTDIR:=$(PWD)/build/dist
29 PYDESTDIR:=$(PWD)/build/pydist
30
31 # default install locations
32 PREFIX?=/usr/local
33 EXEC_PREFIX?=$(PREFIX)
34 LIBDIR?=$(PREFIX)/lib
35 INCLUDEDIR?=$(PREFIX)/include
36 DATAROOTDIR?=$(PREFIX)/share
37 MANDIR?=$(DATAROOTDIR)/man
38
39 SOX=sox
40
41 TESTSOUNDS := python/tests/sounds
42
43 all: build
44
45 checkwaf:
46         @[ -f waf ] || make getwaf
47
48 getwaf:
49         ./scripts/get_waf.sh
50
51 expandwaf: getwaf
52         [ -d wafilb ] || rm -fr waflib
53         $(WAFCMD) --help > /dev/null
54         mv .waf*/waflib . && rm -fr .waf*
55         sed '/^#==>$$/,$$d' waf > waf2 && mv waf2 waf
56         chmod +x waf
57
58 cleanwaf:
59         rm -rf waf waflib .waf*
60
61 configure: checkwaf
62         $(WAFCMD) configure $(WAFOPTS)
63
64 build: configure
65         $(WAFCMD) build $(WAFOPTS)
66
67 install:
68         # install
69         $(WAFCMD) install $(WAFOPTS)
70
71 list_installed:
72         find $(DESTDIR) -ls | sed 's|$(DESTDIR)|/«destdir»|'
73
74 list_installed_python:
75         pip show -f aubio
76
77 list_all_installed: list_installed list_installed_python
78
79 uninstall:
80         # uninstall
81         $(WAFCMD) uninstall $(WAFOPTS)
82
83 delete_install:
84         rm -rf $(PWD)/dist/test
85
86 build_python:
87         # build python-aubio, using locally built libaubio if found
88         python ./setup.py build
89
90 build_python_extlib:
91         # build python-aubio using (locally) installed libaubio
92         [ -f $(DESTDIR)/$(INCLUDEDIR)/aubio/aubio.h ]
93         [ -d $(DESTDIR)/$(LIBDIR) ]
94         [ -f $(DESTDIR)/$(LIBDIR)/pkgconfig/aubio.pc ]
95         PKG_CONFIG_PATH=$(DESTDIR)/$(LIBDIR)/pkgconfig \
96         CFLAGS="-I$(DESTDIR)/$(INCLUDEDIR)" \
97         LDFLAGS="-L$(DESTDIR)/$(LIBDIR)" \
98                 make build_python
99
100 deps_python:
101         # install or upgrade python requirements
102         pip install $(PIPOPTS) --requirement requirements.txt
103
104 # use pip or distutils?
105 install_python: install_python_with_pip
106 uninstall_python: uninstall_python_with_pip
107 #install_python: install_python_with_distutils
108 #uninstall_python: uninstall_python_with_distutils
109
110 install_python_with_pip:
111         # install package
112         pip install $(PIPOPTS) .
113
114 uninstall_python_with_pip:
115         # uninstall package
116         ( pip show aubio | grep -l aubio > /dev/null ) && \
117         pip uninstall -y -v aubio || echo "info: aubio package is not installed"
118
119 install_python_with_distutils:
120         ./setup.py install $(PIPOPTS) $(DISTUTILSOPTS)
121
122 uninstall_python_with_distutils:
123         #./setup.py uninstall
124         [ -d $(PYDESTDIR)/$(LIBDIR) ] && echo Warning: did not clean $(PYDESTDIR)/$(LIBDIR) || true
125
126 force_uninstall_python:
127         # ignore failure if not installed
128         -make uninstall_python
129
130 local_dylib:
131         # DYLD_LIBRARY_PATH is no more on mac os
132         # create links from ~/lib/lib* to build/src/lib*
133         [ -f $(PWD)/build/src/libaubio.[0-9].dylib ] && ( mkdir -p ~/lib && cp -prv build/src/libaubio.[0-9].dylib ~/lib ) || true
134
135 test_python: export LD_LIBRARY_PATH=$(DESTDIR)/$(LIBDIR)
136 test_python: export PYTHONPATH=$(PYDESTDIR)/$(LIBDIR)
137 test_python: local_dylib
138         # run test with installed package
139         ./python/tests/run_all_tests --verbose
140         # also run with nose, multiple processes
141         nose2 -N 4
142
143 clean_python:
144         ./setup.py clean
145
146 check_clean_python:
147         # check cleaning a second time works
148         make clean_python
149         make clean_python
150
151 clean: checkwaf
152         # optionnaly clean before build
153         -$(WAFCMD) clean
154         # remove possible left overs
155         -rm -rf doc/_build
156
157 check_clean:
158         # check cleaning after build works
159         $(WAFCMD) clean
160         # check cleaning a second time works
161         $(WAFCMD) clean
162
163 distclean:
164         $(WAFCMD) distclean
165
166 check_distclean:
167         make distclean
168
169 distcheck: checkwaf
170         $(WAFCMD) distcheck $(WAFOPTS)
171
172 help:
173         $(WAFCMD) --help
174
175 create_test_sounds:
176         -[ -z `which $(SOX)` ] && ( echo $(SOX) could not be found) || true
177         -mkdir -p $(TESTSOUNDS)
178         -$(SOX) -r 44100 -b 16 -n "$(TESTSOUNDS)/44100Hz_1f_silence.wav"      trim 0 1s
179         -$(SOX) -r 22050 -b 16 -n "$(TESTSOUNDS)/22050Hz_5s_brownnoise.wav"   synth 5    brownnoise      vol 0.9
180         -$(SOX) -r 32000 -b 16 -n "$(TESTSOUNDS)/32000Hz_127f_sine440.wav"    synth 127s sine 440        vol 0.9
181         -$(SOX) -r  8000 -b 16 -n "$(TESTSOUNDS)/8000Hz_30s_silence.wav"      trim 0 30
182         -$(SOX) -r 48000 -b 32 -n "$(TESTSOUNDS)/48000Hz_60s_sweep.wav"       synth 60   sine 100-20000  vol 0.9
183         -$(SOX) -r 44100 -b 16 -n "$(TESTSOUNDS)/44100Hz_44100f_sine441.wav"  synth 44100s   sine 441   vol 0.9
184         -$(SOX) -r 44100 -b 16 -n "$(TESTSOUNDS)/44100Hz_100f_sine441.wav"    synth 100s sine 441       vol 0.9
185
186 # build only libaubio, no python-aubio
187 test_lib_only: clean distclean configure build install list_installed
188 # additionally, clean after a fresh build
189 test_lib_only_clean: test_lib_only uninstall check_clean check_distclean
190
191 # build libaubio, build and test python-aubio against it
192 test_lib_python: force_uninstall_python deps_python \
193         clean_python clean distclean \
194         configure build build_python \
195         install install_python \
196         test_python \
197         list_all_installed
198
199 test_lib_python_clean: test_lib_python \
200         uninstall_python uninstall \
201         check_clean_python \
202         check_clean \
203         check_distclean
204
205 # build libaubio, install it, build python-aubio against it
206 test_lib_install_python: force_uninstall_python deps_python \
207         clean_python distclean \
208         configure build \
209         install \
210         build_python_extlib \
211         install_python \
212         test_python \
213         list_all_installed
214
215 test_lib_install_python_clean: test_lib_install_python \
216         uninstall_python \
217         delete_install \
218         check_clean_python \
219         check_distclean
220
221 # build a python-aubio that includes libaubio
222 test_python_only: force_uninstall_python deps_python \
223         clean_python clean distclean \
224         build_python \
225         install_python \
226         test_python \
227         list_installed_python
228
229 test_python_only_clean: test_python_only \
230         uninstall_python \
231         check_clean_python
232
233 sphinx: configure
234         $(WAFCMD) sphinx $(WAFOPTS)
235
236 doxygen: configure
237         $(WAFCMD) doxygen $(WAFOPTS)
238
239 manpages: configure
240         $(WAFCMD) manpages $(WAFOPTS)
241
242 html: doxygen sphinx
243
244 docs: html manpages
245
246 dist: distclean expandwaf
247         $(WAFCMD) dist