Basic telemetry for the Audacity

.github/workflows/cmake_build.yml

@@ -27,6 +27,8 @@ env:
   # it has a bug in the install_name_tool.  So explicitly use 12.3
   # instead.
   DEVELOPER_DIR: /Applications/Xcode_12.3.app/Contents/Developer
+  GOOGLE_UA_TRACKING_ID: ${{ secrets.GOOGLE_UA_TRACKING_ID }}
+  METRICA_TRACKING_ID: ${{ secrets.METRICA_TRACKING_ID }} 
 
 #
 # Define our job(s)
@@ -214,7 +216,7 @@ jobs:
                       --with-libjpeg=builtin \
                       --with-libpng=builtin \
                       --with-libtiff=builtin \
-                      --with-macosx-version-min="10.7" \
+                      --with-macosx-version-min="10.9" \
                       --with-regex=builtin \
                       --with-zlib=builtin \
                       --without-liblzma
@@ -234,6 +236,7 @@ jobs:
         cmake -S . \
               -B build \
               -G "${{matrix.config.generator}}" \
+              -T buildsystem=1 \
               -D audacity_use_pch=no
 
         # Build Audacity
@@ -261,7 +264,7 @@ jobs:
 
         # Install required packages
         sudo apt-get update -y
-        sudo apt-get install -y libgtk2.0-dev libasound2-dev gettext
+        sudo apt-get install -y libgtk2.0-dev libasound2-dev gettext uuid-dev
         sudo apt-get remove -y ccache
 
         # Build wxWidgets if needed
@@ -293,7 +296,7 @@ jobs:
               -D audacity_use_pch=no
 
         # Build Audacity
-        cmake --build build --config Release
+        cmake --build build --config Release -- -j$(nproc)
 
         # "Install" Audacity
         cmake --install build --config Release --prefix "${DEST}"

.gitignore

@@ -206,3 +206,5 @@ win/xaudacity.ico
 #other files that get in the way
 */not-for-git/*
 *.dll
+
+.idea/

CMakeLists.txt

@@ -51,7 +51,7 @@ if( APPLE )
 
    # Define the OSX compatibility parameters
    set( CMAKE_OSX_ARCHITECTURES x86_64 CACHE INTERNAL "" )
-   set( CMAKE_OSX_DEPLOYMENT_TARGET 10.7 CACHE INTERNAL "" )
+   set( CMAKE_OSX_DEPLOYMENT_TARGET 10.9 CACHE INTERNAL "" )
    set( CMAKE_OSX_SYSROOT macosx CACHE INTERNAL "" )
    set( CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "" CACHE INTERNAL "" )
 
@@ -427,6 +427,7 @@ add_subdirectory( "cmake-proxies" )
 add_subdirectory( "help" )
 add_subdirectory( "images" )
 add_subdirectory( "locale" )
+add_subdirectory( "libraries" )
 add_subdirectory( "modules" )
 add_subdirectory( "nyquist" )
 add_subdirectory( "plug-ins" )

README.txt

@@ -137,6 +137,9 @@ our web site at:
 
   https://www.audacityteam.org/download/source
 
+The Audacity source code is located in all the locations within the source tree 
+except for lib-src.
+
 Audacity is built upon other free libraries; some of these libraries may have
 come with Audacity in the lib-src directory.  Others you are expected to install
 first if you want Audacity to have certain capabilities.  Most of these libraries
@@ -210,6 +213,12 @@ GPL-compatible license.  Specifically:
   wxWidgets: wxWindows license (based on LGPL)
     Cross-platform GUI library - must be downloaded and
     compiled separately.
+
+  libcurl: MIT/X like license
+    Cross-platform library for transferring data with URLs.
+
+  ThreadPool: zlib License
+    C++11 thread pool.
 
 
 For more information, see the documentation inside each library's

audacity.dox.in

@@ -793,7 +793,8 @@ WARN_LOGFILE           =
 INPUT                  = src/ \
                          dox2-src/ \
                          include/ \
-                         lib-src/FileDialog/
+                         lib-src/FileDialog/ \
+                         libraries/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

cmake-proxies/CMakeLists.txt

@@ -134,6 +134,7 @@ addlib( libsndfile         sndfile     SNDFILE     YES   YES   "sndfile >= 1.0.2
 addlib( libsoxr            soxr        SOXR        YES   YES   "soxr >= 0.1.1" )
 addlib( portaudio-v19      portaudio   PORTAUDIO   YES   YES   "" )
 addlib( sqlite             sqlite      SQLITE      YES   YES   "sqlite3 >= 3.32.0" )
+addlib( libcurl            curl        CURL        YES   YES   "libcurl >= 7.76.0" )
 
 # Optional libraries
 #

cmake-proxies/cmake-modules/CopyLibs.cmake

@@ -34,6 +34,8 @@ function( execute )
    set( ${outlist} ${cmd_out} PARENT_SCOPE )
 endfunction()
 
+get_filename_component(SRC_DIR ${SRC} DIRECTORY)
+
 function( gather_libs src )
    if( CMAKE_HOST_SYSTEM_NAME MATCHES "Windows" )
       execute( output cmd /k dumpbin /dependents ${src} )
@@ -45,6 +47,14 @@ function( gather_libs src )
             list( APPEND libs ${lib} )
 
             gather_libs( ${lib} )
+         elseif (line MATCHES "^ *libcurl.*\\.dll")
+            set( lib ${CURL_PATH}/${line} )
+
+            list( APPEND libs ${lib} )
+
+            gather_libs( ${lib} )
+         elseif (line MATCHES "^ *lib-.*\\.dll")
+            gather_libs( "${SRC_DIR}/${line}" )
          endif()
       endforeach()
    elseif( CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin" )
@@ -59,7 +69,18 @@ function( gather_libs src )
       endif()
 
       foreach( line ${output} )
-         if( line MATCHES "^.*libwx.*\\.dylib " )
+         if( line MATCHES "@rpath/libcurl.*\\.dylib ")
+            message(STATUS "Matched ${line}")
+
+            string( REGEX REPLACE "dylib .*" "dylib" line "${line}" )
+
+            get_filename_component( refname "${line}" NAME )
+
+            set (lib "${CURL_PATH}/${refname}")
+            list( APPEND libs ${lib} )
+
+            list( APPEND postcmds "sh -c 'install_name_tool -change @rpath/${refname} @executable_path/../Frameworks/${refname} ${libname}'" )
+         elseif( line MATCHES "^.*(libwx|lib-).*\\.dylib " )
             string( REGEX REPLACE "dylib .*" "dylib" line "${line}" )
             if( NOT line STREQUAL "${src}" AND NOT line MATCHES "@executable" )
                set( lib ${line} )
@@ -74,12 +95,12 @@ function( gather_libs src )
          endif()
       endforeach()
    elseif( CMAKE_HOST_SYSTEM_NAME MATCHES "Linux" )
-      execute( output sh -c "LD_LIBRARY_PATH='${WXWIN}' ldd ${src}" )
+      execute( output sh -c "LD_LIBRARY_PATH='${WXWIN}:${CURL_PATH}' ldd ${src}" )
 
       get_filename_component( libname "${src}" NAME )
 
       foreach( line ${output} )
-         if( line MATCHES ".*libwx.*" )
+         if( line MATCHES ".*lib(wx|lib-).*" )
             string( REGEX REPLACE ".* => (.*) \\(.*$" "\\1" line "${line}" )
 
             set( lib ${line} )

cmake-proxies/libcurl/CMakeLists.txt

@@ -0,0 +1,82 @@
+include(ExternalProject)
+
+def_vars()
+
+set( CURL_DIR "${_INTDIR}/libcurl" )
+set( CURL_TAG "curl-7_76_0")
+
+set(CURL_CMAKE_ARGS 
+   -DCMAKE_INSTALL_PREFIX:STRING=${CURL_DIR} 
+   -DHTTP_ONLY:BOOL=On 
+   -DBUILD_CURL_EXE:BOOL=Off
+   -DCMAKE_USE_LIBSSH2:BOOL=Off
+)
+
+if( CMAKE_SYSTEM_NAME MATCHES "Windows" )
+   set(CURL_CMAKE_ARGS ${CURL_CMAKE_ARGS} 
+      -DCMAKE_USE_SCHANNEL:BOOL=On
+   )
+elseif( CMAKE_SYSTEM_NAME MATCHES "Darwin" )
+   set(CURL_CMAKE_ARGS ${CURL_CMAKE_ARGS} 
+      -DCMAKE_USE_SECTRANSP:BOOL=On
+      -DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=10.9 
+      -DCMAKE_OSX_ARCHITECTURES:STRING=x86_64
+   )
+elseif( CMAKE_SYSTEM_NAME MATCHES "Linux|FreeBSD" )
+
+endif()
+
+ExternalProject_Add(curl
+   PREFIX "${CURL_DIR}"
+   INSTALL_DIR "${CURL_DIR}"
+   GIT_REPOSITORY https://github.com/curl/curl
+   GIT_TAG ${CURL_TAG}
+   GIT_SHALLOW Yes
+   CMAKE_CACHE_ARGS ${CURL_CMAKE_ARGS}
+)
+
+add_library(AUDACITY::libcurl SHARED IMPORTED GLOBAL)
+
+file(MAKE_DIRECTORY "${CURL_DIR}/include")
+
+set_target_properties(AUDACITY::libcurl PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES "${CURL_DIR}/include"
+)
+
+if (WIN32)
+   set_target_properties(AUDACITY::libcurl PROPERTIES
+      INTERFACE_LINK_LIBRARIES "winmm;ws2_32;advapi32;crypt32"
+   )
+
+   set_property(TARGET AUDACITY::libcurl APPEND PROPERTY IMPORTED_CONFIGURATIONS "Debug;Release")
+
+   set_target_properties(AUDACITY::libcurl PROPERTIES
+      IMPORTED_IMPLIB_DEBUG "${CURL_DIR}/lib/libcurl-d_imp.lib"
+      IMPORTED_LOCATION_DEBUG "${CURL_DIR}/bin/libcurl-d.dll"
+
+      IMPORTED_IMPLIB_RELEASE "${CURL_DIR}/lib/libcurl_imp.lib"
+      IMPORTED_LOCATION_RELEASE "${CURL_DIR}/bin/libcurl.dll"
+   )
+elseif(APPLE)
+   if(XCODE)
+      set_property(TARGET AUDACITY::libcurl APPEND PROPERTY IMPORTED_CONFIGURATIONS "Debug;Release")
+
+      set_target_properties(AUDACITY::libcurl PROPERTIES
+         IMPORTED_LOCATION_RELEASE "${CURL_DIR}/lib/libcurl.dylib"
+         IMPORTED_LOCATION_DEBUG "${CURL_DIR}/lib/libcurl-d.dylib"
+      )
+   else()
+      set_property(TARGET AUDACITY::libcurl APPEND PROPERTY IMPORTED_CONFIGURATIONS NOCONFIG)
+
+      set_target_properties(AUDACITY::libcurl PROPERTIES
+         IMPORTED_LOCATION_NOCONFIG "${CURL_DIR}/lib/libcurl.dylib"
+      )
+   endif()
+elseif(UNIX)
+   set_property(TARGET AUDACITY::libcurl APPEND PROPERTY IMPORTED_CONFIGURATIONS NOCONFIG)
+
+   set_target_properties(AUDACITY::libcurl PROPERTIES
+     IMPORTED_LOCATION_NOCONFIG "${CURL_DIR}/lib/libcurl.so"
+     IMPORTED_SONAME_NOCONFIG "libcurl.so"
+  )
+endif()

lib-src/ThreadPool/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jakob Progsch, Václav Zeman
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

lib-src/ThreadPool/README.md

@@ -0,0 +1,17 @@
+ThreadPool
+==========
+
+A simple C++11 Thread Pool implementation.
+
+Basic usage:
+```c++
+// create thread pool with 4 worker threads
+ThreadPool pool(4);
+
+// enqueue and store future
+auto result = pool.enqueue([](int answer) { return answer; }, 42);
+
+// get result from future
+std::cout << result.get() << std::endl;
+
+```

lib-src/ThreadPool/ThreadPool.h

@@ -0,0 +1,98 @@
+#ifndef THREAD_POOL_H
+#define THREAD_POOL_H
+
+#include <vector>
+#include <queue>
+#include <memory>
+#include <thread>
+#include <mutex>
+#include <condition_variable>
+#include <future>
+#include <functional>
+#include <stdexcept>
+
+class ThreadPool {
+public:
+    ThreadPool(size_t);
+    template<class F, class... Args>
+    auto enqueue(F&& f, Args&&... args) 
+        -> std::future<typename std::result_of<F(Args...)>::type>;
+    ~ThreadPool();
+private:
+    // need to keep track of threads so we can join them
+    std::vector< std::thread > workers;
+    // the task queue
+    std::queue< std::function<void()> > tasks;
+
+    // synchronization
+    std::mutex queue_mutex;
+    std::condition_variable condition;
+    bool stop;
+};
+
+// the constructor just launches some amount of workers
+inline ThreadPool::ThreadPool(size_t threads)
+    :   stop(false)
+{
+    for(size_t i = 0;i<threads;++i)
+        workers.emplace_back(
+            [this]
+            {
+                for(;;)
+                {
+                    std::function<void()> task;
+
+                    {
+                        std::unique_lock<std::mutex> lock(this->queue_mutex);
+                        this->condition.wait(lock,
+                            [this]{ return this->stop || !this->tasks.empty(); });
+                        if(this->stop && this->tasks.empty())
+                            return;
+                        task = std::move(this->tasks.front());
+                        this->tasks.pop();
+                    }
+
+                    task();
+                }
+            }
+        );
+}
+
+// add new work item to the pool
+template<class F, class... Args>
+auto ThreadPool::enqueue(F&& f, Args&&... args) 
+    -> std::future<typename std::result_of<F(Args...)>::type>
+{
+    using return_type = typename std::result_of<F(Args...)>::type;
+
+    auto task = std::make_shared< std::packaged_task<return_type()> >(
+            std::bind(std::forward<F>(f), std::forward<Args>(args)...)
+        );
+
+    std::future<return_type> res = task->get_future();
+    {
+        std::unique_lock<std::mutex> lock(queue_mutex);
+
+        // don't allow enqueueing after stopping the pool
+        if(stop)
+            throw std::runtime_error("enqueue on stopped ThreadPool");
+
+        tasks.emplace([task](){ (*task)(); });
+    }
+    condition.notify_one();
+    return res;
+}
+
+// the destructor joins all threads
+inline ThreadPool::~ThreadPool()
+{
+    {
+        std::unique_lock<std::mutex> lock(queue_mutex);
+        stop = true;
+    }
+    condition.notify_all();
+    for(std::thread &worker: workers)
+        worker.join();
+}
+
+#endif