Difference between revisions of "Building On Mac"

From Audacity Wiki
Jump to: navigation, search
(Guide for setting up a build environment on OS X Snow Leopard, Lion, or Mountain Lion)
 
m (+deprecated)
 
(111 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
{{deprecated|https://github.com/audacity/audacity/blob/master/BUILDING.md}}
 +
{{ednote|1=[[ToDo-2]] Add<br>
 +
* Instructions for building modules
 +
}}{{Intro|1='''These are instructions for building on Mac'''
  
This guide will help you establish a working development environment for Audacity on OS X Snow Leopard, Lion, or Mountain Lion.  You may use the environment for general development as well, but the intent is to get you started building Audacity as quickly and easily as possible.  To that end, the steps detailed below will concentrate on Audacity and general development will be left up to you.
+
The build family of pages:
 +
* [[Building On Windows]]
 +
* [[Building On Mac]]
 +
* [[Building On Linux]]}}
  
== Download Xcode 3.2.6 ==
+
== Instructions in mac/build.txt ==
  
To download Xcode, you will need to register at the Apple Developer site:
+
{{note|1=These instructions for building on mac are in [https://github.com/audacity/audacity/blob/master/mac/cmake_build.txt mac/cmake_build.txt in the Git repo].}}
  
:http://developer.apple.com
+
<pre>
 +
Instructions for building on macOS using CMake.
  
Once registered, the available downloads are located here:
+
Building on macOS has been made much simpler with the Audacity 2.4.0
 +
release. Still, read this document throughly before starting.
  
:http://developer.apple.com/downloads
+
1) Get and install the latest Xcode version available your macOS version:
  
Xcode 3.2.6 is the last version that (officially) supports the PPC architecture and the macosx10.4u SDK. Unless you're building release versions, the PPC support isn't absolutely necessary, but the SDK is required.
+
      MacOS                  Xcode Version (as of Mar 2020)
 +
      Catalina - 10.15        11.3
 +
      Mojave - 10.14          10.3
 +
      High Sierra - 10.13    9.4.1
 +
      Sierra - 10.12          9.2
 +
      El Capitan - 10.11      8.2.1
 +
      Yosemite - 10.10        7.2.1
  
Enter “Xcode 3.2.6” in the search box on the left, press enter, and download the “Xcode 3.2.6 and iOS SDK 4.3” dmg:
+
2) Clone the Audacity repository:
  
:[[File:Example.jpg]]
+
      git clone https://github.com/audacity/audacity
  
== Download Xcode 4.5.2 ==
+
3) Clone wxWidgets 3.1.3:
  
Snow Leopard users may skip this step.
+
      git clone --recurse-submodules https://github.com/audacity/wxWidgets.git
  
NOTE:  You may choose to install other versions of Xcode, but at the time this guide was written, 4.5.2 was the latest and other versions may not work as outlined here.
+
  Ensure that you clone with the "--recurse-submodules" option, and do not
 +
  just download the Zip package, otherwise there will be required components
 +
  missing.
  
Enter “Xcode 4.5.2” in the search box on the left, press enter, and download the “Xcode 4.5.2” dmg:
+
  Don't be tempted to use wxWidgets already installed by a package manager
 +
  such as Homebrew because this will cause problems.
  
:[[File:Example.jpg]]
+
  We have applied some Audacity specific patches to wxWidgets to better
 +
  support VoiceOver, so please use the audacity-fixes-3.1.3 branch. It's
 +
  the default branch on our GitHub copy:
  
Enter “Command Line Tools” in the search box on the left, press enter and download the “Command Line Tools” dmg that corresponds to your version of OS X:
+
      https://github.com/audacity/wxWidgets/tree/audacity-fixes-3.1.3
  
:[[File:Example.jpg]]
+
  You can be certain the correct branch is active with:
  
== Download MacPorts ==
+
      git checkout audacity-fixes-3.1.3
  
Two build utilities, cmake and pkgconfig, will need to be installed and MacPorts or Fink are the easiest way to get them.  This guide will use MacPorts so you will need to make adjustments if you choose to use Fink.
+
4) Change directory to the folder where wxWidgets was cloned and build it using:
Download the version of MacPorts which matches your OS X version from:
 
  
:http://www.macports.org/install.php
+
      sudo <path to Audacity source>/mac/scripts/build_wxwidgets
  
== Download wxWidgets ==
+
5) The config command should return "3.1.3" if the install was successful:
  
You must download the wxMac version 2.8.12 of wxWidgets from:
+
      /usr/local/x86_64/bin/wx-config --version
  
:http://www.wxwidgets.org/downloads/
+
6) Now that you have wxWidgets installed, edit your ~/.bash_profile or
 +
  ~/.zprofile and add:
  
Download the [[File:build_wxwidgets]] script that will be used to build wxWidgets for use with Audacity.
+
      export WX_CONFIG=/usr/local/x86_64/bin/wx-config
  
== Install Xcode 3.2.6 ==
+
  Log out and back in again (or reboot) for this to take effect.
  
Locate the Xcode 3.2.6 dmg, xcode_3.2.6_and_ios_sdk_4.3.dmg, on your system and double click it to have Finder verify and mount it:
+
7) Download the CMake 3.16.4 DMG from:
  
[[File:Example.jpg]]
+
      https://cmake.org/download
  
The “Xcode and iOS SDK” installer checks the version of OS X that is currently running and it will not work on any version above Snow Leopard.  However, this version check can be bypassed by starting the installation from the command line.
+
8) Double click the DMG, follow the prompts and drag the CMake app to the
 +
  Applications folder.
  
NOTE:  It is advisable to have all OS X updates applied to your system before installing Xcode 3.2.6.  This is especially important for Lion users as the installation will fail.
+
  If you will be building from the command line, open the CMake application
 +
  and click the "Tools -> How to Install For Command Line Use" menu. It will
 +
  give you additional instructions on making CMake available to the command
 +
  line.
  
Open a Terminal window and start the installation by entering the following commands:
+
  You are now ready to start building Audacity.
  
export COMMAND_LINE_INSTALL=1
+
BUILDING USING THE CMAKE GUI
open "/Volumes/Xcode and iOS SDK/Xcode and iOS SDK.mpkg"
 
  
[[File:Example.jpg]]
+
  NOTE: Building with the GUI interface will result in the downloading of
 +
        another copy of wxWidgets from Audacity.
  
This will start the installation while bypassing the version check:
+
1) Open the app.
  
[[File:Example.jpg]]
+
2) Click the "Browse Source..." button and locate the top of your Audacity
 +
  source tree, then click the "Open" button.
  
Proceed through the various installation pages until you get to the “Custom Install” page:
+
3) Click the "Browse Build..." button and find the location where you want to
 +
  put the build (use the "New Folder" button at the bottom left to create a
 +
  new folder).
  
[[File:Example.jpg]]
+
  This folder does not have to be in or even near the source tree, but it
 +
  must not be the same as the source tree. However, it is common to make it
 +
  a subdirectory of the Audacity source tree.
  
Open the Essentials item by clicking the arrow:
+
4) Click the "Configure" button and when the dialog pops up, select "Xcode" for
 +
  the generator, then click the "Done" button.
  
[[File:Example.jpg]]
+
5) Click the "Generate" button to create the Xcode project.
  
The minimum required options are “Unix Development” and “Mac OS X 10.4 SDK”, but if you're running Snow Leopard, you may elect to install everything.  On Lion or above, you will not be able to use “System Tools” and may choose to use the “iOS SDK” and “Documentation” from Xcode 4.5.2:
+
6) Now you can either click the "Open Project" button or go to your "Build" folder in
 +
  Finder and open the Xcode project as normal.
  
[[File:Example.jpg]]
+
BUILDING FROM THE COMMAND LINE
  
Continue through the installation dialogs to start the installation and close the installer when complete:
+
1) Change directory to your Audacity source tree.
  
[[File:Example.jpg]]
+
      cd audacity
  
This completes the Xcode 3.2.6 installation.
+
2) Create the "build" folder (name it anything you like):
  
== Install Xcode 4.5.2 ==
+
      mkdir bld
  
Snow Leopard users should skip this step.
+
3) Change to the "build" folder:
  
Locate the Xcode 4.5.2 dmg, xcode4520418508a.dmg, on your system and double click it to have Finder verify and mount it:
+
      cd bld
  
[[File:Example.jpg]]
+
4) Configure and generate the Xcode project:
  
The Xcode folder will open when it's mounted:
+
      cmake -G Xcode ..
  
[[File:Example.jpg]]
+
5) Build Audacity using the CMake command or xcodebuild:
  
You may choose to drag the Xcode app to wherever you like, but this guide expects it to be located in the Applications folder:
+
      cmake --build . --config Release
  
[[File:Example.jpg]]
+
      xcodebuild --configuration Release
  
Locate the Command Line Tools dmg, xcode452cltools10_76938212a.dmg, on your system and double click it to have Finder verify and mount it:
+
  The "Audacity.app" bundle will be in the "bin/Release" subdirectory of your
 +
  "build" folder, so you can start it via Finder or:
  
[[File:Example.jpg]]
+
      open bin/Release/Audacity.app
  
The Command Line Tools folder will open:
+
Notes:
  
[[File:Example.jpg]]
+
  - If you'd like to get a completely clean build, just delete "build" folder
 +
    and return to step 2 above.
  
Start the installation by double clicking the installer, “Command Line Tools (Lion).mpkg” in this case:
+
  - Once the Xcode project is generated, you shouldn't have to "configure" or
 +
    "generate" again as it will be done for you automatically after pulling
 +
    updates and building.
  
[[File:Example.jpg]]
+
    For example:
  
Once the installation completes, close the installer:
+
        cd <audacity> directory
 +
        git pull
 +
        cd bld
 +
        cmake --build . --config Release
  
[[File:Example.jpg]]
+
  - Instructions on optional signing of DMGs, showing languages other than English,
 +
    and other useful information can be found on our wiki at:  
 +
    http://wiki.audacityteam.org/wiki/Building_On_Mac
  
Open a Terminal window and enter:
+
</pre>
  
:sudo xcode-select -switch "/Applications/Xcode.app/Contents/Developer"
+
== CMake Build ==
  
[[File:Example.jpg]]
+
<pre>
 +
1) Change directory to your Audacity source tree.
  
This completes the Xcode 4.5.2 installation.
+
      cd audacity
  
== Install MacPorts ==
+
2) Create the "build" folder (name it anything you like):
  
Locate the MacPorts installer and double click to start the installation:
+
      mkdir bld
  
[[File:Example.jpg]]
+
3) Change to the "build" folder:
  
Click through the installation pages and close the installer when installation completes:
+
      cd bld
  
[[File:Example.jpg]]
+
4) Configure and generate the Xcode project:
  
Open a Terminal window and install the cmake and pkgconfig packages:
+
      cmake -G Xcode ..
  
[[File:Example.jpg]]
+
5) Build Audacity using the CMake command or xcodebuild:
  
This completes the MacPorts installation.
+
      cmake --build . --config Release
  
== Install wxWidgets ==
+
      xcodebuild --configuration Release
  
Open a Terminal window and extract the wxWidgets source:
+
  The "Audacity.app" bundle will be in the "bin/Release" subdirectory of your
 +
  "build" folder, so you can start it via Finder or:
  
:tar xf ~/Downloads/wxMac-2.8.12.tar
+
      open bin/Release/Audacity.app
 +
</pre>
  
[[File:Example.jpg]]
+
== For a Release CMake build ==
  
Change to the newly created directory:
+
Additionally:
  
:cd wxMac-2.8.12
+
<pre>
 +
6) Add the help files
  
[[File:Example.jpg]]
+
  Open contents of bin/Release/Audacity.app
 +
  Add in files with directory help/manual/ and then the 5 top level items
  
Start the build.  This assumes you downloaded the build_wxwidgets script to your Downloads directory:
+
7) Notarize Audacity
  
:~/Downloads/build_wxwidgets
+
  ../mac/scripts/build_dist.sh ../mac ../bld/bin/Release
 +
</pre>
  
[[File:Example.jpg]]
+
For Notarization to work, you'll need to have already jumped through the Apple hoops, and have set up your signing file.  There are two stages to notarization, one for the bundle, one for the dmg.
  
After all configurations are built, you will be prompted for your password:
+
To test the Notarization, upload the dmg to dropbox and then download it again.  Then double-click to
 +
install and drag across to /Applications. When you launch Audacity, you now get a warning about having downloaded from the internet, rather than being prevented from running...
  
[[File:Example.jpg]]
 
  
wxWidgets installation is now complete.
+
== Optional Extras ==
 +
 
 +
{{tip|'''FFmpeg and LAME'''
 +
For these, see [[Building Extras on Mac]]}}
 +
 
 +
== Variations ==
 +
 
 +
{{note|1=These instructions for variations on building aren't in mac/build.txt in the Git repo.  They're actually mostly obsolete instructions.  The CMake building now takes care of the GitIdent and mod-script-pipe.  Languages should not be an issue if you are already set up with gettext.  The signing has been replaced by Notarization.  We no longer declutter the dmg, and no one has complained or commented about it on the forums.}}
 +
 
 +
===Fetching The Manual===
 +
 
 +
We have [[Building The Manual|instructions for fetching the manual]] on another page.
 +
 
 +
 
 +
===Defaulting to Portable Settings===
 +
 
 +
<pre>
 +
1. Within audacity.app/Contents add the directories:
 +
    Portable Settings
 +
    Portable Settings/AutoSave
 +
 
 +
2. Set permissions on these two directories to 777
 +
    chmod 777 "Portable Settings"
 +
    chmod 777 "Portable Settings/AutoSave"
 +
</pre>
 +
 
 +
These steps should of course be done before signing.
 +
 
 +
== Official Full Releases==
 +
 
 +
Official Audacity full releases:
 +
 
 +
* Have a GitIdent, visible in the about box build information, that says what branch was used in building.
 +
* Include a copy of the manual.
 +
* Include other languages.
 +
* Have a de-cluttered .dmg (the folders in it are dragged outside the visible area)
 +
* Are signed with a signing key.
 +
 
 +
<s>
 +
===Updating GitIdent===
 +
 
 +
<pre>
 +
The Audacity "About" box can contain a link to the git commit at which
 +
Audacity was built. To create this, run this batch script in /mac/scripts/
 +
 +
  get_gitident.sh
 +
 +
If you do this, you are responsible for making sure the ident is correct
 +
in future builds.  The script overwrites RevisionIdent.h in the src directory.
 +
If you make further changes to your local copy after this step, or merge a
 +
more recent version from git, this file, and hence the ident in the build,
 +
stays the same, and so would be misleading.
 +
 +
To reset RevisionIdent.h you could do:
 +
 +
  git reset --hard origin/master
 +
</pre>
 +
 
 +
===Include mod-script-pipe===
 +
 
 +
Build this within the Xcode project ON THE SAME DAY as you built audacity.  You can click on the .so in the IDE to find out where Xcode put it (it will have some weird long temporary path).
 +
 
 +
Just before code signing, add it in to the Audacity bundle, into a subdirectory called 'modules'.
 +
</s>
 +
 
 +
===Include Languages===
 +
 
 +
 
 +
{{alert|1=Beware!  Audacity needs a clean and then a recompile if it is to include languages.<br>
 +
For some reason yet to be investigated, incremental compiles will not include the language files in audacity.app.<br>
 +
''(Check by looking inside the app and looking in 'Resources')''}}
 +
 
 +
<pre>
 +
If you need Audacity to show languages other than English, install the gettext
 +
suite of tools (to get the msgfmt command).  The source can be downloaded from:
 +
 
 +
  ftp://ftp.gnu.org/gnu/gettext/gettext-latest.tar.gz
 +
 
 +
Untar it:
 +
 
 +
  tar xf gettext-latest.tar.gz
 +
 
 +
And install:
 +
 
 +
  cd gexttext-latest
 +
  ./configure
 +
  sudo make install
 +
 
 +
Then clean and recompile.
 +
Incremental compiles will NOT include the language files.
 +
 
 +
</pre>
 +
 
 +
<s>
 +
===Decluttering the dmg===
 +
 
 +
<pre>
 +
1. Open the dmg
 +
 
 +
2. Drag the right border wider.
 +
 
 +
3. Drag all folders that should not be visible into that area.
 +
 
 +
4. Drag right border narrower again.
 +
</pre>
 +
 
 +
 
 +
===Signing the DMG===
 +
 
 +
<pre>
 +
1) Comment out the last line of mac/scripts/build_dist.sh so that it reads
 +
 +
  #rm -rf ${DMG} TMP.dmg
 +
 +
  This will prevent deletion of TMP.dmg
 +
 
 +
2) Delete any previous /private/tmp/TMP.dmg and /private/tmp/Audacity.dst
 +
    (otherwise, the rebuilt plug-ins folder will contain an unnecessary duplicate
 +
    of itself).
 +
 
 +
    Then clean and build Audacity normally.
 +
 +
3) Navigate to /private/tmp/ and type
 +
 +
    hdiutil resize -size 200m TMP.dmg
 +
 +
    This step is needed as codesigning takes some temporary space, more than is
 +
    available in the dmg.
 +
 +
4) mount the dmg
 +
    hdiutil mount TMP.dmg
 +
 
 +
4a) Not part of the signing, but a good idea to de-clutter the dmg
 +
    per instructions in the section above.
 +
 +
5) Codesign the app (deep to make sure everything important is signed)
 +
   
 +
    codesign --deep -s <identity> -v "/Volumes/Audacity 2.2.0/Audacity.app"
 +
 
 +
    If you see errors like this, no matter what size you used in step (3):
 +
 
 +
        can't allocate code signature data for: /Volumes/Audacity 2.2.0/Audacity.app/Contents/MacOS/Audacity
 +
        (for architecture i386) because larger updated load commands do not fit (the program must be relinked
 +
        using a larger -headerpad value)
 +
 
 +
    Then in the XCode project, add -headerpad_max_install_names to Other Linker flags (OTHER_LDFLAGS)
 +
    for Release configuration of the Audacity target, and go back to step (2).
 +
 +
6) Check it is signed to gatekeeper's satisfaction:
 +
 +
    spctl -a -v "/Volumes/Audacity 2.2.0/Audacity.app"
 +
 +
7) unmount the dmg
 +
 
 +
    hdiutil eject "/Volumes/Audacity 2.2.0"
 +
 +
8) Make a compressed dmg
 +
 +
    hdiutil convert TMP.dmg -format UDZO -imagekey zlib-level=9 -o "Newname.dmg"
 +
 +
9) codesign that
 +
 +
    codesign -s <identity> -v Newname.dmg
 +
</pre>
 +
</s>
 +
 
 +
 
 +
 
 +
[[Category:Mac Platform]] [[Category:For Developers]]

Latest revision as of 11:54, 19 August 2021

Warning icon This page has been deprecated. Newer information can be found here: https://github.com/audacity/audacity/blob/master/BUILDING.md
The information on this page are likely out-of-date and will not be updated in the forseeable future. It may be removed at any time.
ToDo-2 Add
  • Instructions for building modules
These are instructions for building on Mac

The build family of pages:

Instructions in mac/build.txt

These instructions for building on mac are in mac/cmake_build.txt in the Git repo.
Instructions for building on macOS using CMake.

Building on macOS has been made much simpler with the Audacity 2.4.0
release. Still, read this document throughly before starting.

1) Get and install the latest Xcode version available your macOS version:

      MacOS                   Xcode Version (as of Mar 2020)
      Catalina - 10.15        11.3
      Mojave - 10.14          10.3
      High Sierra - 10.13     9.4.1
      Sierra - 10.12          9.2
      El Capitan - 10.11      8.2.1
      Yosemite - 10.10        7.2.1

2) Clone the Audacity repository:

      git clone https://github.com/audacity/audacity

3) Clone wxWidgets 3.1.3:

      git clone --recurse-submodules https://github.com/audacity/wxWidgets.git

   Ensure that you clone with the "--recurse-submodules" option, and do not
   just download the Zip package, otherwise there will be required components
   missing.

   Don't be tempted to use wxWidgets already installed by a package manager
   such as Homebrew because this will cause problems.

   We have applied some Audacity specific patches to wxWidgets to better 
   support VoiceOver, so please use the audacity-fixes-3.1.3 branch. It's
   the default branch on our GitHub copy:

      https://github.com/audacity/wxWidgets/tree/audacity-fixes-3.1.3

   You can be certain the correct branch is active with:

      git checkout audacity-fixes-3.1.3

4) Change directory to the folder where wxWidgets was cloned and build it using:

      sudo <path to Audacity source>/mac/scripts/build_wxwidgets

5) The config command should return "3.1.3" if the install was successful:

      /usr/local/x86_64/bin/wx-config --version

6) Now that you have wxWidgets installed, edit your ~/.bash_profile or
   ~/.zprofile and add:

      export WX_CONFIG=/usr/local/x86_64/bin/wx-config

   Log out and back in again (or reboot) for this to take effect.

7) Download the CMake 3.16.4 DMG from:

      https://cmake.org/download

8) Double click the DMG, follow the prompts and drag the CMake app to the
   Applications folder.

   If you will be building from the command line, open the CMake application
   and click the "Tools -> How to Install For Command Line Use" menu. It will
   give you additional instructions on making CMake available to the command
   line.

   You are now ready to start building Audacity.

BUILDING USING THE CMAKE GUI

   NOTE: Building with the GUI interface will result in the downloading of
         another copy of wxWidgets from Audacity.

1) Open the app.

2) Click the "Browse Source..." button and locate the top of your Audacity
   source tree, then click the "Open" button.

3) Click the "Browse Build..." button and find the location where you want to
   put the build (use the "New Folder" button at the bottom left to create a
   new folder).

   This folder does not have to be in or even near the source tree, but it
   must not be the same as the source tree. However, it is common to make it
   a subdirectory of the Audacity source tree.

4) Click the "Configure" button and when the dialog pops up, select "Xcode" for
   the generator, then click the "Done" button.

5) Click the "Generate" button to create the Xcode project.

6) Now you can either click the "Open Project" button or go to your "Build" folder in
   Finder and open the Xcode project as normal.

BUILDING FROM THE COMMAND LINE

1) Change directory to your Audacity source tree.

      cd audacity

2) Create the "build" folder (name it anything you like):

      mkdir bld

3) Change to the "build" folder:

      cd bld

4) Configure and generate the Xcode project:

      cmake -G Xcode ..

5) Build Audacity using the CMake command or xcodebuild:

      cmake --build . --config Release

      xcodebuild --configuration Release

   The "Audacity.app" bundle will be in the "bin/Release" subdirectory of your
   "build" folder, so you can start it via Finder or:

      open bin/Release/Audacity.app

Notes:

   - If you'd like to get a completely clean build, just delete "build" folder
     and return to step 2 above.

   - Once the Xcode project is generated, you shouldn't have to "configure" or
     "generate" again as it will be done for you automatically after pulling
     updates and building.

     For example:

        cd <audacity> directory
        git pull
        cd bld
        cmake --build . --config Release

   - Instructions on optional signing of DMGs, showing languages other than English,
     and other useful information can be found on our wiki at: 
     http://wiki.audacityteam.org/wiki/Building_On_Mac

CMake Build

1) Change directory to your Audacity source tree.

      cd audacity

2) Create the "build" folder (name it anything you like):

      mkdir bld

3) Change to the "build" folder:

      cd bld

4) Configure and generate the Xcode project:

      cmake -G Xcode ..

5) Build Audacity using the CMake command or xcodebuild:

      cmake --build . --config Release

      xcodebuild --configuration Release

   The "Audacity.app" bundle will be in the "bin/Release" subdirectory of your
   "build" folder, so you can start it via Finder or:

      open bin/Release/Audacity.app

For a Release CMake build

Additionally:

6) Add the help files

   Open contents of bin/Release/Audacity.app
   Add in files with directory help/manual/ and then the 5 top level items

7) Notarize Audacity

   ../mac/scripts/build_dist.sh ../mac ../bld/bin/Release

For Notarization to work, you'll need to have already jumped through the Apple hoops, and have set up your signing file. There are two stages to notarization, one for the bundle, one for the dmg.

To test the Notarization, upload the dmg to dropbox and then download it again. Then double-click to install and drag across to /Applications. When you launch Audacity, you now get a warning about having downloaded from the internet, rather than being prevented from running...


Optional Extras

Bulb icon FFmpeg and LAME

For these, see Building Extras on Mac

Variations

These instructions for variations on building aren't in mac/build.txt in the Git repo. They're actually mostly obsolete instructions. The CMake building now takes care of the GitIdent and mod-script-pipe. Languages should not be an issue if you are already set up with gettext. The signing has been replaced by Notarization. We no longer declutter the dmg, and no one has complained or commented about it on the forums.

Fetching The Manual

We have instructions for fetching the manual on another page.


Defaulting to Portable Settings

 1. Within audacity.app/Contents add the directories:
    Portable Settings
    Portable Settings/AutoSave

 2. Set permissions on these two directories to 777
    chmod 777 "Portable Settings"
    chmod 777 "Portable Settings/AutoSave"

These steps should of course be done before signing.

Official Full Releases

Official Audacity full releases:

  • Have a GitIdent, visible in the about box build information, that says what branch was used in building.
  • Include a copy of the manual.
  • Include other languages.
  • Have a de-cluttered .dmg (the folders in it are dragged outside the visible area)
  • Are signed with a signing key.

Updating GitIdent

 The Audacity "About" box can contain a link to the git commit at which 
 Audacity was built. To create this, run this batch script in /mac/scripts/
 
   get_gitident.sh
 
 If you do this, you are responsible for making sure the ident is correct
 in future builds.  The script overwrites RevisionIdent.h in the src directory.
 If you make further changes to your local copy after this step, or merge a
 more recent version from git, this file, and hence the ident in the build, 
 stays the same, and so would be misleading.
 
 To reset RevisionIdent.h you could do:
 
   git reset --hard origin/master

Include mod-script-pipe

Build this within the Xcode project ON THE SAME DAY as you built audacity. You can click on the .so in the IDE to find out where Xcode put it (it will have some weird long temporary path).

Just before code signing, add it in to the Audacity bundle, into a subdirectory called 'modules'.

Include Languages

Warning icon Beware! Audacity needs a clean and then a recompile if it is to include languages.

For some reason yet to be investigated, incremental compiles will not include the language files in audacity.app.
(Check by looking inside the app and looking in 'Resources')

If you need Audacity to show languages other than English, install the gettext
suite of tools (to get the msgfmt command).  The source can be downloaded from:

   ftp://ftp.gnu.org/gnu/gettext/gettext-latest.tar.gz

Untar it:

   tar xf gettext-latest.tar.gz

And install:

   cd gexttext-latest
   ./configure
   sudo make install

Then clean and recompile.
Incremental compiles will NOT include the language files.

Decluttering the dmg

 1. Open the dmg

 2. Drag the right border wider.

 3. Drag all folders that should not be visible into that area.

 4. Drag right border narrower again.


Signing the DMG

 1) Comment out the last line of mac/scripts/build_dist.sh so that it reads
 
   #rm -rf ${DMG} TMP.dmg
 
   This will prevent deletion of TMP.dmg

 2) Delete any previous /private/tmp/TMP.dmg and /private/tmp/Audacity.dst
    (otherwise, the rebuilt plug-ins folder will contain an unnecessary duplicate
    of itself).

    Then clean and build Audacity normally.
 
 3) Navigate to /private/tmp/ and type 
 
    hdiutil resize -size 200m TMP.dmg
 
    This step is needed as codesigning takes some temporary space, more than is 
    available in the dmg.
 
 4) mount the dmg
    hdiutil mount TMP.dmg

 4a) Not part of the signing, but a good idea to de-clutter the dmg
    per instructions in the section above.
 
 5) Codesign the app (deep to make sure everything important is signed)
     
    codesign --deep -s <identity> -v "/Volumes/Audacity 2.2.0/Audacity.app"

    If you see errors like this, no matter what size you used in step (3):

        can't allocate code signature data for: /Volumes/Audacity 2.2.0/Audacity.app/Contents/MacOS/Audacity
        (for architecture i386) because larger updated load commands do not fit (the program must be relinked
        using a larger -headerpad value)

    Then in the XCode project, add -headerpad_max_install_names to Other Linker flags (OTHER_LDFLAGS)
    for Release configuration of the Audacity target, and go back to step (2).
 
 6) Check it is signed to gatekeeper's satisfaction:
 
    spctl -a -v "/Volumes/Audacity 2.2.0/Audacity.app"
 
 7) unmount the dmg

    hdiutil eject "/Volumes/Audacity 2.2.0"
 
 8) Make a compressed dmg
 
    hdiutil convert TMP.dmg -format UDZO -imagekey zlib-level=9 -o "Newname.dmg"
 
 9) codesign that
 
    codesign -s <identity> -v Newname.dmg