From bd254654bcd6765f926dfca25a85989f543a662f Mon Sep 17 00:00:00 2001 From: Urs Fleisch Date: Sun, 14 Feb 2021 11:22:30 +0100 Subject: [PATCH] Update documentation for version 1.12.0 --- AUTHORS | 2 ++ INSTALL.md | 80 ++++++++++++++++++++++++++++++++++++++++++------------ NEWS | 1 + README.md | 12 ++++---- 4 files changed, 71 insertions(+), 24 deletions(-) diff --git a/AUTHORS b/AUTHORS index 279ee221..3e801538 100644 --- a/AUTHORS +++ b/AUTHORS @@ -16,6 +16,8 @@ Mathias Panzenböck Mod, S3M, IT and XM metadata implementations Damien Plisson DSDIFF metadata implementation +Urs Fleisch + Bug fixes, maintainer. Please send all patches and questions to taglib-devel@kde.org rather than to individual developers! diff --git a/INSTALL.md b/INSTALL.md index ee9a81ae..a398654e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -38,7 +38,7 @@ For a 10.6 Snow Leopard static library with both 32-bit and 64-bit code, use: -DCMAKE_OSX_DEPLOYMENT_TARGET=10.6 \ -DCMAKE_OSX_ARCHITECTURES="i386;x86_64" \ -DBUILD_SHARED_LIBS=OFF \ - -DCMAKE_INSTALL_PREFIX="" + -DCMAKE_INSTALL_PREFIX="" After `make`, and `make install`, add `libtag.` to your XCode project, and add the include folder to the project's User Header Search Paths. @@ -52,7 +52,7 @@ This means you need to adjust things to suit your system, especially paths. Tested with: * Microsoft Visual Studio 2010, 2015, 2017 * Microsoft C++ Build Tools 2015, 2017 (standalone packages not requiring Visual Studio) -* Gcc by mingw-w64.sf.net v4.6.3 (Strawberry Perl 32b) +* GCC by mingw-w64.sf.net v4.6.3 (Strawberry Perl 32b) * MinGW32-4.8.0 Requirements: @@ -69,15 +69,15 @@ Optional: Useful configuration options used with CMake (GUI and/or command line): Any of the `ZLIB_` variables may be used at the command line, `ZLIB_ROOT` is only available on the command line. - - | option | description | - ---------------------| ------------| - `ZLIB_ROOT=` | Where to find ZLib's root directory. Assumes parent of: `\include` and `\lib.`| - `ZLIB_INCLUDE_DIR=` | Where to find ZLib's Include directory.| - `ZLIB_LIBRARY=` | Where to find ZLib's Library. - `ZLIB_SOURCE=` | Where to find ZLib's Source Code. Alternative to `ZLIB_INCLUDE_DIR` and `ZLIB_LIBRARY`. - `CMAKE_INSTALL_PREFIX=` | Where to install Taglib. | - `CMAKE_BUILD_TYPE=` | Release, Debug, etc ... (Not available in MSVC) | + + | option | description | + | ----------------------- | ----------- | + | `ZLIB_ROOT=` | Where to find ZLib's root directory. Assumes parent of: `\include` and `\lib.`| + | `ZLIB_INCLUDE_DIR=` | Where to find ZLib's Include directory.| + | `ZLIB_LIBRARY=` | Where to find ZLib's Library. + | `ZLIB_SOURCE=` | Where to find ZLib's Source Code. Alternative to `ZLIB_INCLUDE_DIR` and `ZLIB_LIBRARY`. + | `CMAKE_INSTALL_PREFIX=` | Where to install Taglib. | + | `CMAKE_BUILD_TYPE=` | Release, Debug, etc ... (Not available in MSVC) | The easiest way is at the command prompt (Visual C++ command prompt for MSVS users – batch file and/or shortcuts are your friends). @@ -85,11 +85,11 @@ The easiest way is at the command prompt (Visual C++ command prompt for MSVS use Replace "GENERATOR" with your needs. * For MSVS: `Visual Studio XX YYYY`, e.g. `Visual Studio 14 2015`. - + **Note**: As Visual Studio 2017 supports CMake, you can skip this step and open the taglib folder in VS instead. * For MinGW: `MinGW Makefiles` - + C:\GitRoot\taglib> cmake -G "GENERATOR" -DCMAKE_INSTALL_PREFIX=C:\Libraries\taglib Or use the CMake GUI: @@ -126,13 +126,13 @@ The easiest way is at the command prompt (Visual C++ command prompt for MSVS use C:\GitRoot\taglib> gmake OR (Depending on MinGW install) - + C:\GitRoot\taglib> mingw32-make 3. **Install the project** - + (Change `install` to `uninstall` to uninstall the project) * MSVS: @@ -140,7 +140,7 @@ The easiest way is at the command prompt (Visual C++ command prompt for MSVS use OR (Depending on MSVC version or personal choice) C:\GitRoot\taglib> devenv install.vcxproj - + Or in the MSVS GUI: 1. Open project. 2. Open Solution Explorer. @@ -151,7 +151,7 @@ The easiest way is at the command prompt (Visual C++ command prompt for MSVS use C:\GitRoot\taglib> gmake install OR (Depending on MinGW install) - + C:\GitRoot\taglib> mingw32-make install @@ -167,9 +167,53 @@ Unit Tests If you want to run the test suite to make sure TagLib works properly on your system, you need to have cppunit installed. To build the tests, include -the option `-DBUILD_TESTS=on` when running cmake. +the option `-DBUILD_TESTS=ON -DBUILD_SHARED_LIBS=OFF` when running cmake. The test suite has a custom target in the build system, so you can run the tests using make: make check + +Windows MinGW: + +* Get cppunit from https://www.freedesktop.org/wiki/Software/cppunit/ +* Build it for MinGW: + - `./autogen.sh` + - `./configure --disable-shared` + - `mingw32-make; mingw32-make install DESTDIR=/path/to/install/dir` +* Build TagLib with testing enabled: + - ``` + cmake -G "MinGW Makefiles" -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON -DBUILD_SHARED_LIBS=OFF \ + -DCPPUNIT_INCLUDE_DIR=/path/to/cppunit/include \ + -DCPPUNIT_LIBRARIES=/path/to/cppunit/lib/libcppunit.a \ + -DCPPUNIT_INSTALLED_VERSION=1.15.1 + ``` + - `mingw32-make` + - `mingw32-make check` + +Windows MSVS: + +* Get cppunit from https://www.freedesktop.org/wiki/Software/cppunit/ +* Build it in Visual Studio: + - Open examples/examples2008.sln, convert all, do not overwrite. + - Set architecture to x64, build configuration, e.g. Debug DLL. + - It may fail, but the needed libraries should be available in src\cppunit\DebugDll. +* Build TagLib with testing enabled: + - ``` + cmake -G "Visual Studio 16 2019" -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON + -DBUILD_SHARED_LIBS=OFF -DENABLE_STATIC_RUNTIME=ON + -DCPPUNIT_INCLUDE_DIR=\path\to\cppunit\include + -DCPPUNIT_LIBRARIES=\path\to\cppunit\DebugDll\cppunitd_dll.lib + -DCPPUNIT_INSTALLED_VERSION=1.15.1 + ``` + - `msbuild all_build.vcxproj /p:Configuration=Debug` + - `path %path%;\path\to\cppunit\DebugDll` + - `tests\Debug\test_runner.exe` + +macOS: + +* Install cppunit using a package manager, e.g. `brew install cppunit` +* Build TagLib with testing enabled: + - `cmake -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON -DBUILD_SHARED_LIBS=OFF` + - `make` + - `make check` diff --git a/NEWS b/NEWS index 4b1cab50..3839e065 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,4 @@ +TagLib 1.12.0 (Feb 16, 2021) ============================ * Added support for WinRT. diff --git a/README.md b/README.md index 1c9b1f38..6e443dc0 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ ### TagLib Audio Metadata Library -http://taglib.org/ +https://taglib.org/ TagLib is a library for reading and editing the metadata of several popular audio formats. Currently it supports both ID3v1 and [ID3v2][] -for MP3 files, [Ogg Vorbis][] comments and ID3 tags +for MP3 files, [Ogg Vorbis][] comments and ID3 tags in [FLAC][], MPC, Speex, WavPack, TrueAudio, WAV, AIFF, MP4, APE, and ASF files. @@ -18,9 +18,9 @@ it may be used in proprietary applications, but if changes are made to TagLib they must be contributed back to the project. Please review the licenses if you are considering using TagLib in your project. - [ID3v2]: http://www.id3.org - [Ogg Vorbis]: http://vorbis.com/ + [ID3v2]: https://id3.org/ + [Ogg Vorbis]: https://xiph.org/vorbis/ [FLAC]: https://xiph.org/flac/ - [GNU Lesser General Public License]: http://www.gnu.org/licenses/lgpl.html - [Mozilla Public License]: http://www.mozilla.org/MPL/MPL-1.1.html + [GNU Lesser General Public License]: https://www.gnu.org/licenses/lgpl.html + [Mozilla Public License]: https://www.mozilla.org/MPL/MPL-1.1.html