more info for NLS packaging
[ardour.git] / tools / linux_packaging / build
1 #!/bin/bash
2
3 # script for pulling together a Linux app bundle.
4 #
5 # This will create a bundle for a single architecture.
6 # Execute this scirpt on both x86 and x86_64 and then use
7 # package to merge the 2 bundles into a final package with the
8 # installer. See "noderun" for a complete build script.
9
10 # where the GTK stack is installed
11 GTKSTACK_ROOT=$HOME/gtk/inst
12 # where the Ardour dependencies are installed
13 ARDOURSTACK_ROOT=$HOME/a3/inst
14 # the waf build tree to use when copying built/generated files
15 BUILD_ROOT=../../build
16
17 MIXBUS=
18 WITH_LADSPA=0
19 STRIP=all
20 PRINT_SYSDEPS=
21 WITH_NLS=
22 EXTERNAL_JACK=
23 VENDOR=Ardour ;
24 BUILDTYPE=""
25
26 if [ $# -eq 0 ] ; then
27         echo ""  
28         echo "ERROR - Please specify build type"
29         echo "    --public"
30         echo "    --mixbus"
31         echo ""  
32         exit 1
33 fi
34
35 while [ $# -gt 0 ] ; do
36         echo "arg = $1"
37         case $1 in
38
39         #
40         # top level build targets
41         #
42
43         --mixbus)
44                 MIXBUS=1; 
45                 WITH_NLS=1 ; 
46                 WITH_LADSPA=; 
47                 STRIP=all
48                 APPNAME=Mixbus ;
49                 VENDOR=Harrison ;
50                 shift ;;
51         --public)
52                 WITH_NLS=1 ; 
53                 WITH_LADSPA=; 
54                 STRIP=all ; 
55                 APPNAME=Ardour ;
56                 shift ;;
57         --allinone)
58                 WITH_NLS= ; 
59                 WITH_LADSPA=1; 
60                 STRIP=all; 
61                 shift ;;
62         --test) WITH_LADSPA=; STRIP= ; shift ;;
63
64         #
65         # specific build flags
66         #
67
68         --nojack) INTERNAL_JACK= ; shift ;;
69         --noladspa) WITH_LADSPA= ; shift ;;
70         --strip) STRIP=$2 ; shift ; shift ;;
71         --sysdeps) PRINT_SYSDEPS=1; shift ;;
72         --nls) WITH_NLS=1 ; shift ;;
73
74         *)
75                 #catch all for unknown arguments
76                 echo ""
77                 echo "!!! ERROR !!! - Unknown argument $1"
78                 echo ""
79                 exit 1
80                 ;;
81         esac
82 done
83
84 if test x$STRIP != xall -a x$STRIP != xnone -a x$STRIP != xsome ; then
85     echo "Unknown strip option \"$STRIP\""
86     echo "Legal values are: all, none, some"
87     exit 1
88 fi
89
90 release_version=`grep -m 1 '^VERSION' ../../wscript | awk '{print $3}' | sed "s/'//g"`
91 svn_version=`grep -m 1 'svn_revision =' ../../libs/ardour/svn_revision.cc | cut -d'"' -f 2`
92 echo "Version is $release_version / $svn_version"
93 info_string="$release_version/$svn_version built on `hostname` by `whoami` on `date`"
94 echo "Info string is $info_string"
95
96 # Figure out our CPU type
97 case `uname -m` in
98         i[3456789]86|x86|i86pc)
99                 echo "Architecture is x86"
100                 ARCH='x86'
101                 ARCH_BITS='32-bit'
102                 ;;
103         x86_64|amd64|AMD64)
104                 echo "Architecture is x86_64"
105                 ARCH='x86_64'
106                 ARCH_BITS='64-bit'
107                 ;;
108         *)
109                 echo ""
110                 echo "ERROR - Unknown architecture `uname -m`"
111                 echo ""
112                 exit 1
113                 ;;
114 esac
115
116 # Figure out the Build Type
117 if grep -q "DEBUG = True" ../../build/c4che/default.cache.py; then
118         DEBUG="T"
119 else
120         DEBUG="F"
121 fi
122
123 if [ x$DEBUG = xT ]; then
124     BUILDTYPE="dbg"
125     if [ x$STRIP = xall ] ; then
126         echo "A debug build with --strip all makes no sense - STRIP reset to \"some\""
127         STRIP=some
128     fi
129 fi
130
131 # setup directory structure
132
133 if [ -z "${BUILDTYPE}" ]; then
134         APPDIR=${APPNAME}_${ARCH}-${release_version}_${svn_version}
135         APP_VER_NAME=${APPNAME}-${release_version}_${svn_version}
136 else
137         APPDIR=${APPNAME}_${ARCH}-${release_version}_${svn_version}-${BUILDTYPE}
138         APP_VER_NAME=${APPNAME}-${release_version}_${svn_version}-${BUILDTYPE}
139 fi
140
141 APPBIN=$APPDIR/bin
142 APPLIB=$APPDIR/lib
143 Libraries=$APPLIB
144 Etc=$APPDIR/etc
145 Shared=$APPDIR/share
146
147 Plugins=$APPLIB/plugins
148 Surfaces=$APPLIB/surfaces
149 Panners=$APPLIB/panners
150
151 Modules=$Libraries/modules
152 Loaders=$Libraries/loaders
153
154 Templates=$Shared/templates
155 ExportFormats=$Shared/export
156 Locale=$Shared/locale
157 MidiMaps=$Shared/midi_maps
158 PatchFiles=$Shared/patchfiles
159 MackieControl=$Shared/mcp
160
161 if [ x$PRINT_SYSDEPS != x ] ; then
162 #
163 # print system dependencies
164 #
165
166         for file in $APPBIN/* $Libraries/* $Modules/* $Plugins/*.so ; do 
167                 if ! file $file | grep -qs Mach-O ; then
168                         continue
169                 fi
170                 otool -L $file | awk '{print $1}' | egrep -v "(^@executable_path|^Ardour[0-9][.0-9]*.app)" 
171         done | sort | uniq
172         exit 0
173 fi
174
175 echo "Removing old $APPDIR tree ..."
176 rm -rf $APPDIR/
177
178 echo "Building new app directory structure ..."
179
180 # only bother to make the longest paths
181
182 mkdir -p $APPDIR
183 mkdir -p $APPBIN
184 mkdir -p $APPLIB
185 mkdir -p $Etc
186 mkdir -p $Plugins
187 mkdir -p $Modules
188 mkdir -p $Loaders
189 mkdir -p $Shared
190 mkdir -p $Locale
191 mkdir -p $Surfaces
192 mkdir -p $MidiMaps
193 mkdir -p $PatchFiles
194 mkdir -p $MackieControl
195 mkdir -p $ExportFormats
196 mkdir -p $Panners
197 mkdir -p $Templates
198 mkdir -p $Shared/templates
199 mkdir -p $Shared/doc
200
201 # maybe set variables
202 ENVIRONMENT=environment
203 rm -f $ENVIRONMENT
204 touch $ENVIRONMENT
205
206 if test x$MIXBUS != x ; then
207         echo export ARDOUR_MIXBUS=true >> $ENVIRONMENT
208         #
209         # current default for MIXBUS version is US keyboard layout without a keypad
210         #
211         echo export ARDOUR_KEYBOARD_LAYOUT=us-nokeypad >> $ENVIRONMENT
212         echo export ARDOUR_UI_CONF=ardour3_ui.conf >> $ENVIRONMENT
213         echo export ARDOUR3_UI_RC=ardour3_ui_dark.rc >> $ENVIRONMENT
214 fi
215
216 #
217 # if we're not going to bundle JACK, make sure we can find
218 # jack in the places where it might be
219 #
220
221 echo export 'PATH=/usr/local/bin:/opt/bin:$PATH' >> $ENVIRONMENT
222
223 # create startup helper script
224
225 sed -e "/^%ENV%/r $ENVIRONMENT" -e '/^%ENV%/d' -e 's/%VER%/'"${release_version}"'/' < ardour.sh.in > $APPBIN/ardour3
226 rm $ENVIRONMENT && chmod 775 $APPBIN/ardour3
227 # the 3.0 here is not the same as "release-version" because the latter may include "-betaN" etc.
228 MAIN_EXECUTABLE=ardour-3.0
229
230 echo "Copying ardour executable ...."
231 cp $BUILD_ROOT/gtk2_ardour/$MAIN_EXECUTABLE $APPBIN
232 if test x$STRIP = xall ; then
233         strip $APPBIN/$MAIN_EXECUTABLE
234 fi
235
236 # copy locale files
237 # note that at present(feb 2011), the .mo files end up in the source tree which is
238 # not really as it should be.
239 if test x$WITH_NLS != x ; then
240         echo "NLS support ..."
241         echo "I hope you remembered to run scons msgupdate!"
242         LINGUAS=
243
244         for dl in gtk2_ardour libs/ardour libs/gtkmm2ext ; do 
245             files=`find ../../$dl -name "*.mo"`
246
247             if [ -z "$files" ]; then
248                 echo ""
249                 echo "!!!! WARNING !!!! - Did not find any .mo files in ../../$dl"
250                 echo ""
251             fi
252  
253             for file in $files 
254             do
255                 echo $file
256                 lang=`basename $file | sed 's/\.mo//'`
257                 mkdir -p $Locale/$lang/LC_MESSAGES
258                 cp $file $Locale/$lang/LC_MESSAGES/`basename $dl`
259                 echo Copying message catalog for $lang into $Locale/$lang/LC_MESSAGES/`basename $dl`
260                 if echo $LINGUAS | grep $lang >/dev/null 2>&1 ; then
261                     :
262                 else 
263                     LINGUAS="$LINGUAS $lang"
264                 fi
265             done
266         done
267
268         GTK_MESSAGES="atk10.mo gdk-pixbuf.mo gtk20-properties.mo gtk20.mo atk10.mo glib20.mo"
269         LOCALEROOT=/usr/share/locale
270
271         for l in $LINGUAS ; do
272                 echo "Copying GTK i18n files for $l..."
273                 for MO in $GTK_MESSAGES ; do 
274                         if [ -f $LOCALEROOT/$l/LC_MESSAGES/$MO ] ; then
275                                 cp $LOCALEROOT/$l/LC_MESSAGES/$MO $Locale/$l/LC_MESSAGES
276                         else
277                                 # try with just the language spec
278                                 just_lang=`echo $l | sed 's/_[A-Z][A-Z]$//'`
279                                 if [ -f $LOCALEROOT/$just_lang/LC_MESSAGES/$MO ] ; then
280                                         cp $LOCALEROOT/$just_lang/LC_MESSAGES/$MO $Locale/$just_lang/LC_MESSAGES
281                                 fi
282                         fi
283                 done
284         done
285 else
286         echo "Skipping NLS support"
287 fi
288
289 #
290 # Copy stuff that may be dynamically loaded
291
292
293 cp -R $GTKSTACK_ROOT/etc/* $Etc
294 echo "Copying all Pango modules ..."
295 cp -R $GTKSTACK_ROOT/lib/pango/1.6.0/modules/*.so $Modules
296 echo "Copying all GDK Pixbuf loaders ..."
297 cp -R $GTKSTACK_ROOT/lib/gdk-pixbuf-2.0/2.10.0/loaders/*.so $Loaders
298
299 # Generate a pango module file using the actual Pango that we're going to bundle
300
301 cat > pangorc <<EOF 
302 [Pango]
303 ModulesPath=$GTKSTACK_ROOT/lib/pango/1.6.0/modules
304 EOF
305 env PANGO_RC_FILE=pangorc $GTKSTACK_ROOT/bin/pango-querymodules | sed "s?$GTKSTACK_ROOT/lib/pango/1.6.0/?@ROOTDIR@/?" > $Etc/pango.modules.in
306 rm pangorc
307
308 # Ditto for gdk-pixbuf loaders
309 gdk-pixbuf-query-loaders | sed "s?$GTKSTACK_ROOT/lib/gdk-pixbuf-2.0/2.10.0/?@ROOTDIR@/?" > $Etc/gdk-pixbuf.loaders.in
310
311 # We rely on clearlooks, so include a version from our own build tree
312 # this one is special - we will set GTK_PATH to $Libraries/clearlooks
313
314 echo "Copying clearlooks ..."
315 cp $BUILD_ROOT/libs/clearlooks-newer/libclearlooks.so $Libraries
316 mkdir -p $Libraries/clearlooks/engines
317 (cd $Libraries/clearlooks/engines && ln -s ../../libclearlooks.so . )
318
319 # LADSPA
320 if test x$WITH_LADSPA != x ; then
321         if test x$MIXBUS != x ; then
322                 plugdir=mixbus_ladspa
323         else
324                 plugdir=ladspa
325         fi
326         echo "Copying `ls $plugdir | wc -l` plugins ..."
327         if [ -d $plugdir ] ; then
328                 cp -r $plugdir/* $Plugins
329         fi
330 fi
331
332 # Control Surfaces
333 cp $BUILD_ROOT/libs/surfaces/*/libardour_*.so* $Surfaces
334 cp $BUILD_ROOT/libs/surfaces/control_protocol/libardourcp.so* $Libraries
335
336 # MidiMaps
337 # got to be careful with names here
338 for x in $BUILD_ROOT/../midi_maps/*.map ; do
339     cp "$x" $MidiMaps
340 done
341
342 # MIDNAM Patch Files
343 # got to be careful with names here
344 for x in $BUILD_ROOT/../patchfiles/*.midnam ; do
345     cp "$x" $PatchFiles
346 done
347
348 # MackieControl data
349 # got to be careful with names here
350 for x in $BUILD_ROOT/../mcp/*.device $BUILD_ROOT/../mcp/*.profile ; do
351     cp "$x" $MackieControl
352 done
353
354 # Templates
355 for f in $BUILD_ROOT/../templates/* ; do 
356     if [ -d "$f" ] ; then
357         echo Template: $f ; cp -r "$f" $Templates ; 
358     fi
359 done
360
361 # ExportFormats
362 # got to be careful with names here
363 for x in $BUILD_ROOT/../export/*.preset $BUILD_ROOT/../export/*.format ; do
364     cp "$x" $ExportFormats
365 done
366
367 # Panners
368 cp $BUILD_ROOT/libs/panners/*/lib*.so* $Panners
369
370 # VAMP plugins that we use
371 cp $BUILD_ROOT/libs/vamp-plugins/libardourvampplugins.so* $Libraries
372
373 # Suil modules
374 cp $ARDOURSTACK_ROOT/lib/suil-0/lib* $Libraries
375
376 OURLIBDIR=$BUILD_ROOT/libs
377 OURLIBS=$OURLIBDIR/vamp-sdk:$OURLIBDIR/surfaces/control_protocol:$OURLIBDIR/ardour:$OURLIBDIR/midi++2:$OURLIBDIR/pbd:$OURLIBDIR/rubberband:$OURLIBDIR/soundtouch:$OURLIBDIR/gtkmm2ext:$OURLIBDIR/sigc++2:$OURLIBDIR/glibmm2:$OURLIBDIR/gtkmm2/atk:$OURLIBDIR/gtkmm2/pango:$OURLIBDIR/gtkmm2/gdk:$OURLIBDIR/gtkmm2/gtk:$OURLIBDIR/libgnomecanvasmm:$OURLIBDIR/libsndfile:$OURLIBDIR/evoral:$OURLIBDIR/evoral/src/libsmf:$OURLIBDIR/audiographer:$OURLIBDIR/timecode:$OURLIBDIR/taglib:$OURLIBDIR/libltc:$OURLIBDIR/qm-dsp
378
379 echo $OURLIBS${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
380
381 checkedIdx=0
382 deplibs=
383
384 while [ true ] ; do 
385         missing=false
386         filelist=`find $APPLIB/ -type f`
387         filelist="$APPBIN/$MAIN_EXECUTABLE $filelist"
388
389         for file in $filelist  ; do 
390                 if ! file $file | grep -qs ELF ; then
391                         continue
392                 fi
393
394                 # speed this up a bit by not checking things multiple times.
395                 for i in "${depCheckedList[@]}"; do
396                         if [ $i == $file ]; then
397                                 continue 2
398                         fi
399                 done
400                 depCheckedList[$checkIdx]=$file
401                 checkIdx=$(($checkIdx + 1))
402                 
403                 # do not include libjack
404                 deps=`LD_LIBRARY_PATH=$OURLIBS${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH} ldd $file | awk '{print $3}'`
405
406                 echo -n "."
407                 for dep in $deps ; do
408                         if test "not" = ${dep}; then 
409                                 echo ""
410                                 echo "!!! ERROR !!! - Missing dependant library for $file."
411                                 echo "Searched: " $OURLIBS${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
412                                 echo ""
413                                 (LD_LIBRARY_PATH=$OURLIBS${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH} ldd $file)
414                                 echo ""
415                                 echo "!!! ERROR !!! - See Above"
416                                 exit 1
417                         fi
418
419                         # don't use anything mapped at a specific address
420                         if echo $dep | grep -qs '0x' ; then continue; fi
421                         # don't include /lib
422                         if echo $dep | grep -qs "^/lib/" ; then continue; fi
423                         # don't include jack
424                         if echo $dep | grep -qs libjack ; then continue; fi
425                         # don't include ALSA
426                         if echo $dep | grep -qs libasound ; then continue; fi
427                         # don't include any X Window libraries
428                         if echo $dep | grep -qs libX\. ; then continue; fi  
429                         if echo $dep | grep -qs libxcb ; then continue; fi  
430                         if echo $dep | grep -qs libICE\. ; then continue; fi  
431                         if echo $dep | grep -qs libSM\. ; then continue; fi  
432                         # don't include libc
433                         if echo $dep | grep -qs 'libc\.' ; then continue; fi
434                         # don't include libstdc++
435                         if echo $dep | grep -qs libstdc++ ; then continue; fi
436
437                         base=`basename $dep`
438                         if ! test -f $Libraries/$base; then
439                                 parent=$(basename ${file})
440                                 if echo $dep | grep -sq '^libs' ; then
441                                         echo "Copying dependant lib $BUILD_ROOT/$dep    (required by ${parent})"
442                                         cp $BUILD_ROOT/$dep $Libraries
443                                 else
444                                         echo "Copying dependant lib $dep    (required by ${parent})"
445                                         cp $dep $Libraries
446                                 fi
447                                 #
448                                 # reset RPATH so that the runtime linker never looks
449                                 # in places we don't want it to
450                                 #
451                                 chrpath -r foo $Libraries/`basename $dep`
452                                 if echo $dep | grep -sq '^/' ; then
453                                     # absolute path, candidate for stripping
454                                     deplibs="$deplibs $base"
455                                 fi
456                                 missing=true
457                         fi
458                 done
459         done
460         if test x$missing = xfalse ; then
461                 # everything has been found
462                 break
463         fi
464 done
465 echo
466
467 # strip libraries
468 if test x$STRIP = xall ; then
469     echo Stripping all libraries
470     # Must be writable so that we can strip
471     find $APPLIB/ -name "*.so*" | xargs chmod u+w
472     # and strip ...
473     find $APPLIB/ -name "*.so*" | xargs strip
474 elif test x$STRIP = xsome ; then
475     echo Stripping dependent libraries
476     for l in $deplibs ; do
477         chmod u+w $APPLIB/$l
478         strip $APPLIB/$l
479     done
480 fi
481 find $APPLIB/ -name "*.so*" | xargs chmod a+rx
482
483 echo "Copying other stuff to $APPDIR  ..."
484
485 # these are all generated by waf
486 #cp $BUILD_ROOT/gtk2_ardour/ergonomic-us.bindings       $Etc
487 cp $BUILD_ROOT/gtk2_ardour/mnemonic-us.bindings  $Etc
488 cp $BUILD_ROOT/gtk2_ardour/ardour.menus $Etc
489 cp ../../ardour_system.rc $Etc/ardour_system.rc
490 cp $BUILD_ROOT/gtk2_ardour/ardour3_ui_*.rc $Etc
491
492 # these are copied straight from the source tree
493
494 cp ../../gtk2_ardour/ardour3_ui_default.conf $Etc/ardour3_ui_default.conf
495 cp ../../gtk2_ardour/ardour3_ui_default.conf $Etc/ardour3_ui.conf
496 cp ../../instant.xml $Etc/instant.xml
497 cp ../../gtk2_ardour/step_editing.bindings $Etc
498 cp ../../gtk2_ardour/mixer.bindings $Etc
499 cp -r ../../gtk2_ardour/icons $Shared
500 cp -r ../../gtk2_ardour/pixmaps $Shared
501
502
503 #
504 # put sooper sekrit ingredients here and they will be copied
505 #
506
507 if [ -d specialSauce ] ; then
508         cp -r specialSauce $Etc
509 fi
510
511 # share stuff
512
513 cp -R ../../gtk2_ardour/splash.png $Shared
514
515 # go through and recursively remove any .svn dirs in the bundle
516 for svndir in `find $APPDIR -name .svn -type d`; do
517         rm -rf $svndir
518 done
519
520 #
521 # Add the uninstaller
522 #
523 sed -e "s/%REPLACE_PGM%/${APPNAME}/" -e "s/%REPLACE_VENDOR%/${VENDOR}/" -e "s/%REPLACE_VERSION%/${release_version}/" -e "s/%REPLACE_BUILD%/${svn_version}/" -e "s/%REPLACE_TYPE%/${BUILDTYPE}/" < uninstall.sh.in > $APPBIN/${APP_VER_NAME}.uninstall.sh
524 chmod a+x $APPBIN/${APP_VER_NAME}.uninstall.sh
525
526 #Sanity Check file
527 if [ -e $BUILD_ROOT/tools/sanity_check/sanityCheck ]; then
528         cp $BUILD_ROOT/tools/sanity_check/sanityCheck $APPBIN
529 else
530         echo "!!!ERROR !!! sanityCheck program is missing. packager will exit without being complete"
531         exit 1
532 fi
533
534 echo "Building tarball ..."
535
536 rm -f $APPDIR.tar.bz2
537 tar -cjf $APPDIR.tar.bz2 $APPDIR
538
539 echo "Calculating bundle size"
540 du -sb $APPDIR/  | awk '{print $1}' > $APPDIR.size
541
542 rm -rf $APPDIR/
543
544 echo "Done."
545