Getting Started {#gettingstarted}
===============


How to compile
--------------


### libopenmpt and openmpt123

 -  Autotools

    Grab a `libopenmpt-VERSION-autotools.tar.gz` tarball.

        ./configure
        make
        make check
        sudo make install

    Cross-compilation is generally supported (although only tested for
    targetting MinGW-w64).

    Note that some MinGW-w64 distributions come with the `win32` threading model
    enabled by default instead of the `posix` threading model. The `win32`
    threading model lacks proper support for C++11 `<thread>` and `<mutex>` as
    well as thread-safe magic statics. It is recommended to use the `posix`
    threading model for libopenmpt for this reason. On Debian, the appropriate
    configure command is
    `./configure --host=x86_64-w64-mingw32 CC=x86_64-w64-mingw32-gcc-posix CXX=x86_64-w64-mingw32-g++-posix`
    for 64bit, or
    `./configure --host=i686-w64-mingw32 CC=i686-w64-mingw32-gcc-posix CXX=i686-w64-mingw32-g++-posix`
    for 32bit. Other MinGW-w64 distributions may differ.

 -  Visual Studio:

     -  You will find solutions for Visual Studio in the matching
        `build/vsVERSIONwinWINDOWSVERSION/` folder.
        Minimal projects that target Windows 10 UWP are available in
        `build/vsVERSIONuwp/`.
        Most projects are supported with any of the mentioned Visual Studio
        verions, with the following exceptions:

         -  in_openmpt: Requires Visual Studio with MFC.

         -  xmp-openmpt: Requires Visual Studio with MFC.

     -  libopenmpt requires the compile host system to be amd64 or ARM64 when
        building with Visual Studio.

     -  In order to build libopenmpt for Windows XP, the Visual Studio 2017 XP 
        targeting toolset as well as the Windows 8.1 SDK need to be installed.
        The SDK is optionally included with Visual Studio 2017, but must be
        separately installed with later Visual Studio versions.

        The Windows 8.1 SDK is available from
        <https://developer.microsoft.com/en-us/windows/downloads/sdk-archive/>
        or directly from
        <https://download.microsoft.com/download/B/0/C/B0C80BA3-8AD6-4958-810B-6882485230B5/standalonesdk/sdksetup.exe>
        .

     -  You will need the Winamp 5 SDK and the XMPlay SDK if you want to
        compile the plugins for these 2 players. They can be downloaded
        automatically on Windows 7 or later by just running the
        `build/download_externals.cmd` script.

        If you do not want to or cannot use this script, you may follow these
        manual steps instead:

         -  Winamp 5 SDK:

            To build libopenmpt as a winamp input plugin, copy the contents of
            `WA5.55_SDK.exe` to include/winamp/.

            Please visit
            [winamp.com](http://wiki.winamp.com/wiki/Plug-in_Developer) to
            download the SDK.
            You can disable in_openmpt in the solution configuration.

         -  XMPlay SDK:

            To build libopenmpt with XMPlay input plugin support, copy the
            contents of xmp-sdk.zip into include/xmplay/.

            Please visit [un4seen.com](https://www.un4seen.com/xmplay.html) to
            download the SDK.
            You can disable xmp-openmpt in the solution configuration.

 -  Makefile

    The makefile supports different build environments and targets via the
    `CONFIG=` parameter directly to the make invocation.
    Use `make CONFIG=$newconfig clean` when switching between different configs
    because the makefile cleans only intermediates and target that are active
    for the current config and no configuration state is kept around across
    invocations.

     -  native build:

        Simply run

            make

        which will try to guess the compiler based on your operating system.

     -  gcc or clang (on Unix-like systems, including Mac OS X with MacPorts,
        and Haiku (32-bit Hybrid and 64-bit)):

        The Makefile requires pkg-config for native builds.
        For sound output in openmpt123, PortAudio or SDL is required.
        openmpt123 can optionally use libflac and libsndfile to render PCM
        files to disk.

        When you want to use gcc, run:

            make CONFIG=gcc

        When you want to use clang, it is recommended to do:

            make CONFIG=clang

     -  MinGW-w64:

            make CONFIG=mingw-w64 \
                 MINGW_FLAVOUR=[|-posix|-win32] \
                 WINDOWS_ARCH=[x86|amd64] \
                 WINDOWS_FAMILY=[|desktop-app|app|phone-app|pc-app] \
                 WINDOWS_VERSION=[win95|win98|winme|winnt4|win2000|winxp|winxp64|winvista|win7|win8|win8.1|win10]

     -  emscripten (on Unix-like systems):

        Run:

            # generates WebAssembly with JavaScript fallback
            make CONFIG=emscripten EMSCRIPTEN_TARGET=all

        or

            # generates WebAssembly
            make CONFIG=emscripten EMSCRIPTEN_TARGET=wasm

        or

            # generates JavaScript with compatibility for older VMs
            make CONFIG=emscripten EMSCRIPTEN_TARGET=js

        Running the test suite on the command line is also supported by using
        node.js. Depending on how your distribution calls the `node.js` binary,
        you might have to edit `build/make/config-emscripten.mk`.

     -  DJGPP / DOS

        Cross-compilation from Linux systems is supported with DJGPP GCC via

            make CONFIG=djgpp

        `openmpt123` can use liballegro 4.2 for sound output on DJGPP/DOS.
        liballegro needs to be downloaded into the `libopenmpt` source tree.

            ./build/download_externals.sh    # download liballegro source
            make CONFIG=djgpp USE_ALLEGRO42=1

     -  afl++:

        To compile libopenmpt with fuzzing instrumentation using afl++, run:
        
            make CONFIG=afl
        
        For more detailed instructions, read `contrib/fuzzing/readme.md`.

     -  other compilers:

        To compile libopenmpt with other compliant compilers, run:
        
            make CONFIG=generic
        
    
    The `Makefile` supports some customizations. You might want to read the top
    which should get you some possible make settings, like e.g.
    `make DYNLINK=0` or similar. Cross compiling or different compiler would
    best be implemented via new `config-*.mk` files.

    The `Makefile` also supports building doxygen documentation by using

        make doc

    Binaries and documentation can be installed systen-wide with

        make PREFIX=/yourprefix install
        make PREFIX=/yourprefix install-doc

    Some systems (i.e. Linux) require running

        sudo ldconfig

    in order for the system linker to be able to pick up newly installed
    libraries.

    `PREFIX` defaults to `/usr/local`. A `DESTDIR=` parameter is also
    supported.

 -  Android NDK

    See `build/android_ndk/README.AndroidNDK.txt`.



### Building libopenmpt with any other build system

libopenmpt is very simple to build with any build system of your choice. The
only required information is listed below. We currently only support building
libopenmpt itself this way, but the test suite and openmpt123 may follow later.

 -  language:
     -  C++17 / C++20 / C++23

 -  defines:
     -  LIBOPENMPT_BUILD

 -  private include directories:
     -  .
     -  common
     -  src

 -  files:
     -  common/*.cpp
     -  sounddsp/*.cpp
     -  soundlib/*.cpp
     -  soundlib/plugins/*.cpp
     -  soundlib/plugins/dmo/*.cpp
     -  libopenmpt/*.cpp

 -  public include directories:
     -  .

 -  public header files:
     -  libopenmpt/libopenmpt.h
     -  libopenmpt/libopenmpt.hpp
     -  libopenmpt/libopenmpt_config.h
     -  libopenmpt/libopenmpt_ext.h
     -  libopenmpt/libopenmpt_ext.hpp
     -  libopenmpt/libopenmpt_version.h
     -  libopenmpt/libopenmpt_stream_callbacks_buffer.h
     -  libopenmpt/libopenmpt_stream_callbacks_fd.h
     -  libopenmpt/libopenmpt_stream_callbacks_file_mingw.h
     -  libopenmpt/libopenmpt_stream_callbacks_file_msvcrt.h
     -  libopenmpt/libopenmpt_stream_callbacks_file_posix.h
     -  libopenmpt/libopenmpt_stream_callbacks_file_posix_lfs64.h

 -  dependencies:
     -  zlib:
         -  pkg-config
             -  zlib
         -  defines
             -  MPT_WITH_ZLIB
     -  libmpg123:
         -  pkg-config
             -  mpg123
         -  defines
             -  MPT_WITH_MPG123
     -  libogg:
         -  pkg-config
             -  ogg
         -  defines
             -  MPT_WITH_OGG
     -  libvorbis:
         -  pkg-config
             -  vorbis
         -  defines
             -  MPT_WITH_VORBIS
     -  libvorbisfile:
         -  pkg-config
             -  vorbisfile
         -  defines
             -  MPT_WITH_VORBISFILE

 -  dll:
     -  build:
         -  defines
             -  LIBOPENMPT_BUILD_DLL
     -  use:
         -  defines
             -  LIBOPENMPT_USE_DLL