SIP

.travis.yml

@@ -32,3 +32,17 @@ after_script:
   - cd build
   - chmod +x test/Tests
   - test/Tests
+
+before_deploy:
+  - ls ./
+  - mv build/OHMComm build/OHMComm-$TRAVIS_OS_NAME-$TRAVIS_TAG
+
+deploy:
+  provider: releases
+  api_key: "eCpBRcWXtxWlRBxGVQFwMq+zR5ga4/TwZZV1W5pgJd1mT6sECTFaYr5Z3T7MOoSWkBBYFQ56ulIi4rMrcoN1WH7kbqX6RwfwYRm3LakqsLD9iRwLXzLNNke2RAAC2Z7UA8GgFaVtVHJxHj4DVLMSva9PqS2K3F9xQmiTDKp4LuU="
+  file-glob: true
+  file: "build/OHMComm-*"
+  skip_cleanup: true
+  on:
+    tags: true
+    all_branches: true

CMakeLists.txt

@@ -9,28 +9,70 @@ project (OHMComm)
 SET(BUILD_SHARED_LIBS ON)
 # Option to enable/disable test-program
 option(BUILD_TESTING "Build testing program" ON)
+option(BUILD_DEBUG "Build with debugging symbols. Otherwise build for performance" OFF)
 
 # append usage of C++ to compiler flags, also optimize for speed and enable all warnings
 if(NOT MSVC)
 	# the following instruction causes warnings in visual studio, 
 	# therefore enable it only when MSVC-compiler is not used
-	LIST(APPEND CMAKE_CXX_FLAGS "-std=c++0x -O3 -Wall -pthread")
+	if(BUILD_DEBUG)
+		LIST(APPEND CMAKE_CXX_FLAGS "-std=c++0x -g3 -Wextra -Wno-missing-field-initializers -pthread")
+	else()
+		LIST(APPEND CMAKE_CXX_FLAGS "-std=c++0x -O3 -Wextra -Wno-missing-field-initializers -pthread")
+	endif()
 else()
 	# visual studio specific flags
-	set(CMAKE_CXX_FLAGS "/W3 /D_UNICODE /DUNICODE")
+	set(CMAKE_CXX_FLAGS "/W3 /D_UNICODE /DUNICODE /DNOMINMAX")
 	add_definitions(-DWIN32_LEAN_AND_MEAN)
 endif()
 
 ####
 # Dependencies
 ####
-# Set output copy path
-add_subdirectory(lib/rtaudio-4.1.1 build/rtaudio)
-add_subdirectory(lib/opus-1.1 build/opus)
+# Opus - http://opus-codec.org/
+#Try to find precompiled library
+find_library(OPUS_LIBRARY NAMES opus libopus)
+find_path(OPUS_HEADER_PATH "opus.h" HINTS lib/opus-1.1/include)
+if(OPUS_LIBRARY)
+	message(STATUS "Opus library found: " ${OPUS_LIBRARY})
+	#Set header to default include path
+	add_definitions(-DOPUS_HEADER="opus/opus.h")
+elseif(OPUS_HEADER_PATH)
+	message(STATUS "Compiling provided opus-library in version 1.1")
+	# Compile ourselves and set correct header-path
+	add_subdirectory(lib/opus-1.1 build/opus)
+	add_definitions(-DOPUS_HEADER="../lib/opus-1.1/include/opus.h")
+else()
+	message(WARNING "No opus library found")
+endif()
+
+# RTAudio - http://www.music.mcgill.ca/~gary/rtaudio/
+#Try to find precompiled library
+find_library(RTAUDIO_LIBRARY NAMES rtaudio librtaudio)
+find_path(RTAUDIO_HEADER_PATH "RtAudio.h" HINTS lib/rtaudio-4.1.1)
+if(RTAUDIO_LIBRARY)
+	message(STATUS "RTAudio library found: " ${RTAUDIO_LIBRARY})
+	#Set header to default include path
+	add_definitions(-DRTAUDIO_HEADER="RtAudio.h")
+elseif(RTAUDIO_HEADER_PATH)
+	message(STATUS "Compiling provided rtaudio-library in version 4.1.1")
+	# Compile ourselves and set correct header-path
+	add_subdirectory(lib/rtaudio-4.1.1 build/rtaudio)
+	add_definitions(-DRTAUDIO_HEADER="../lib/rtaudio-4.1.1/RtAudio.h")
+endif()
 
-#Include headers in the project settings (as search-path for header-files)
-include_directories ("${PROJECT_SOURCE_DIR}/lib/rtaudio-4.1.1")
-include_directories ("${PROJECT_SOURCE_DIR}/lib/opus-1.1/include")
+# PortAudio - http://www.portaudio.com/
+#Try to find precompiled library
+find_library(PORTAUDIO_LIBRARY NAMES portaudio libportaudio)
+if(PORTAUDIO_LIBRARY)
+	message(STATUS "PortAudio library found: " ${PORTAUDIO_LIBRARY})
+	#Set header to default include path
+	add_definitions(-DPORTAUDIO_HEADER="portaudio.h")
+endif()
+
+if(NOT RTAUDIO_LIBRARY AND NOT RTAUDIO_HEADER_PATH AND NOT PORTAUDIO_LIBRARY)
+	message(WARNING "No supported audio-library found!")
+endif()
 
 ####
 # Main files

README.md

@@ -1,13 +1,21 @@
 # OHMComm
-IT-Project at the [faculty for Computer Science of the technical university Georg Simon Ohm Nürnberg](http://www.th-nuernberg.de/seitenbaum/fakultaeten/informatik/page.html) in summer semester 2015 and winter semester 2015/2016 to create a platform-independent voice-over-IP peer-to-peer communication program in C++.
+This project started as an IT-Project at the [faculty for Computer Science of the technical university Georg Simon Ohm Nürnberg](http://www.th-nuernberg.de/seitenbaum/fakultaeten/informatik/page.html) in summer semester 2015 and winter semester 2015/2016 to create a platform-independent voice-over-IP peer-to-peer communication program in C++.
 
 [![Build Status](https://travis-ci.org/doe300/OHMComm.svg)](https://travis-ci.org/doe300/OHMComm)
+[![Build Status](https://ci.appveyor.com/api/projects/status/58fv0pln0jv270am?svg=true)](https://ci.appveyor.com/project/doe300/ohmcomm)
 [![GitHub license](https://img.shields.io/github/license/doe300/OHMComm.svg)](https://github.com/doe300/OHMComm/blob/master/LICENSE)
 [![Release](https://img.shields.io/github/tag/doe300/OHMComm.svg)](https://github.com/doe300/OHMComm/releases/latest)
 
 This program is currently developed under linux (Fedora 22) and Windows (7/8) and tested under Mac OS X.
 
-OHMComm is based upon [RtAudio](http://www.music.mcgill.ca/~gary/rtaudio/) and therefore supports all audio-libraries supported by RtAudio (see [RtAudio API-Notes](http://www.music.mcgill.ca/~gary/rtaudio/apinotes.html)). The audio-data are (optionally but highly recommended) encoded with the included [opus-codec](http://www.opus-codec.org/).
+OHMComm is based upon [RtAudio](http://www.music.mcgill.ca/~gary/rtaudio/) and therefore supports all audio-libraries supported by RtAudio (see [RtAudio API-Notes](http://www.music.mcgill.ca/~gary/rtaudio/apinotes.html)). 
+The audio-data are (optionally but highly recommended) encoded with the included [opus-codec](http://www.opus-codec.org/).
+As of version 0.8, RtAudio as well as Opus are optional and [PortAudio](http://www.portaudio.com/) is also supported as audio-library.
+By additionally supporting [SIP](https://tools.ietf.org/html/rfc3261) as well as the audio-codecs Opus, G.711 A-law and mu-law, 
+OHMComm can be used to call or get called by any other SIP-based VoIP application.
+
+The OHMComm framework is highly extensible. Any audio-library or codec can be added by writing a wrapper-class 
+and registering it with the correct factory-class.
 
 ## Build it
 
@@ -29,4 +37,18 @@ This will build the library/executable into `<project-directory>/build/` by defa
 	$ cd <executable-directory>	
 	$ ./OHMComm		# To run in interactive mode
 	$ ./OHMComm	-h	# Prints all command-line arguments
-	$ ./OHMComm path/to/config-file	# Runs in file-configuration mode
+	$ ./OHMComm path/to/config-file	# Runs in file-configuration mode
+
+## Supported libraries
+#### Audio libraries
+- [RtAudio](http://www.music.mcgill.ca/~gary/rtaudio/): A platform-independent API for accessing audio-drivers written in C++
+- [PortAudio](http://www.portaudio.com/): Another platform-independent audio API for accessing native libraries, written in C
+
+#### Codecs
+- [Opus](http://www.opus-codec.org/): An highly effective audio-codec, primarily used for real-time applications (e.g. VoIP)
+- [G.711](https://www.itu.int/rec/T-REC-G.711): The two audio-codecs (A-law and mu-law) used for digital telephony
+
+## Features
+- Fully standard-conform communication based on [RTP](https://tools.ietf.org/html/rfc3550) including full [RTCP](https://tools.ietf.org/html/rfc3550#section-6) support
+- Support for direct calls to and from any VoIP application featuring [SIP](https://tools.ietf.org/html/rfc3261)
+- Support for DTX to further decrease required bandwidth

appveyor.yml

@@ -0,0 +1,37 @@
+platform:
+  - x86
+  - x64
+
+configuration:
+  - Release
+
+os:
+  - Visual Studio 2015 RC
+
+build_script:
+  - md build
+  - cd build
+  - cmake -DBUILD_TESTING=ON -DTEST_OUTPUT_CONSOLE=ON -G"Visual Studio 14 2015" ..
+  - cmake --build .
+
+after_build:
+  - ps: Push-AppveyorArtifact build\Debug\OHMComm.exe -FileName "OHMComm-win-$env:platform.exe"
+
+#test_script:
+#  - .\build\test\Debug\Tests.exe
+
+#artifacts:
+#  - path: '**\OHMComm.exe'
+#    name: OHMComm-win-$(platform)
+
+deploy:
+- provider: GitHub
+  description: 'Windows builds'
+  draft: false
+  prerelease: false
+  artifact: OHMComm-win-$(platform).exe
+  auth_token:
+    secure: fIObA1SGSxF/oK69Deh0D7eTmdJirubBGCjbHDn7EA7M4mP2AdkHDEheW77PTPge
+  on:
+    #branch: master
+    appveyor_repo_tag: true

include/AudioHandler.h

@@ -18,6 +18,37 @@ class AudioHandler
 {
 public:
 
+    //Container for storing info about a single audio-device, library-independent
+    struct AudioDevice
+    {
+        //name of this audio-device
+        const std::string name;
+        //the maximum number of available output-channels
+        //a value of 0 signals a non-output device
+        const unsigned int outputChannels;
+        //the maximum number of available input-channels
+        //a value of 0 signals a non-input device
+        const unsigned int inputChannels;
+        //whether this device is the default output device
+        const bool defaultOutputDevice;
+        //whether this device is the default input device
+        const bool defaultInputDevice;
+        //a bit-mask of natively supported audio-formats
+        const unsigned int nativeFormats;
+        //a list of all supported sample-rates
+        const std::vector<unsigned int> sampleRates;
+
+        inline bool isOutputDevice() const
+        {
+            return outputChannels > 0;
+        }
+
+        inline bool isInputDevice() const
+        {
+            return inputChannels > 0;
+        }
+    };
+
     AudioHandler();
 
     virtual ~AudioHandler();
@@ -74,12 +105,12 @@ class AudioHandler
      *
      * This includes allocating memory, configuring the audio-processors or the audio-library, etc.
      */
-    virtual auto prepare(const std::shared_ptr<ConfigurationMode> configMode) -> bool = 0;
+    virtual bool prepare(const std::shared_ptr<ConfigurationMode> configMode) = 0;
 
 	/*!
 	* Returns the actual buffer size, which can be different than in the audio configuration (
 	*/
-    virtual auto getBufferSize() -> unsigned int = 0;
+    virtual unsigned int getBufferSize() = 0;
 
 	/*!
 	* Prints all included AudioProcessor in the processing order
@@ -131,7 +162,7 @@ class AudioHandler
 	*
 	* \return The result of the action
 	*/
-    auto hasAudioProcessor(AudioProcessor *audioProcessor) const -> bool;
+    bool hasAudioProcessor(AudioProcessor *audioProcessor) const;
 
 	/*!
 	* Gives a information wheater the an AudioProcessor is already added or not
@@ -140,28 +171,35 @@ class AudioHandler
 	*
 	* \return The result of the action
 	*/
-    auto hasAudioProcessor(std::string nameOfAudioProcessor) const -> bool;
+    bool hasAudioProcessor(std::string nameOfAudioProcessor) const;
 
 	/*!
 	* Returns the current AudioConfiguration
 	*
 	* \return Current AudioConfiguration
 	*/
-    auto getAudioConfiguration() -> AudioConfiguration;
+    AudioConfiguration getAudioConfiguration();
 
 	/*!
 	* Returns wheater the instance has an AudioConfiguration
 	*
 	* \return Status of the AudioConfiguration
 	*/
-    auto isAudioConfigSet() const -> bool;
+    bool isAudioConfigSet() const;
 
 	/*!
 	* Returns wheater instance is prepared (ready) for execution
 	*
 	* \return Prepared status of the instance
 	*/
-    auto isPrepared() const -> bool;
+    bool isPrepared() const;
+
+    /*!
+     * Returns a platform- and library-independent list of all available audio-devices
+     * 
+     * \return a reference to all local audio-devices
+     */
+    virtual const std::vector<AudioDevice>& getAudioDevices() = 0;
 
 protected:
     bool flagAudioConfigSet = false;
@@ -175,8 +213,36 @@ class AudioHandler
     /*!
      * Calls AudioProcessor#configure() for all registered processors
      */
-    auto configureAudioProcessors(const std::shared_ptr<ConfigurationMode> configMode) -> bool;
-    auto cleanUpAudioProcessors() -> bool;
+    bool configureAudioProcessors(const std::shared_ptr<ConfigurationMode> configMode);
+    bool cleanUpAudioProcessors();
+
+    /*!
+     * Automatically selects the best audio format out of the supported formats
+     */
+    unsigned int autoSelectAudioFormat(unsigned int supportedFormats);
+
+    /*!
+     * Returns the sample-rate as number of the best supported sample-rate flag
+     */
+    unsigned int autoSelectSampleRate(unsigned int supportedRatesFlag);
+
+    /*!
+     * "Asks" the AudioProcessors for supported audio-configuration and uses the sample-rate, frame-size and
+     * number of samples per package all processors can agree on
+     *
+     * \return whether all processors could agree on a value for every field
+     */
+    bool queryProcessorSupport();
+
+    /*!
+     * Maps the supported sample-rates from the device to the flags specified in AudioConfiguration
+     */
+    unsigned int mapDeviceSampleRates(std::vector<unsigned int> sampleRates);
+
+    /*!
+     * Returns the best match for the number of buffered frames according to all processors
+     */
+    unsigned int findOptimalBufferSize(unsigned int defaultBufferSize);
 };
 
 #endif

include/AudioHandlerFactory.h

@@ -15,6 +15,8 @@ class AudioHandlerFactory
 public:
     /*! Name for the RtAudioWrapper */
     static const std::string RTAUDIO_WRAPPER;
+    /*! name for the PortAudioWrapper */
+    static const std::string PORTAUDIO_WRAPPER;
 
     /*!
      * \param name The name of the audio-handler to create

include/AudioProcessor.h

@@ -8,12 +8,7 @@
 
 #include "configuration.h"
 #include "ConfigurationMode.h"
-#include "rtp/RTPPackageHandler.h"
-
-/*!
- * This AudioProcessor supports any buffer-length
- */
-const int BUFFER_SIZE_ANY = -1;
+#include "rtp/RTPHeader.h"
 
 /*!
  * Information about the stream to be passed to the process-methods of AudioProcessor.
@@ -35,6 +30,12 @@ struct StreamData
      * The maximum number of bytes to be stored in the input/output-buffer
      */
     unsigned int maxBufferSize;
+
+    /*!
+     * Whether the current package is a silent-package.
+     * A silence-package has all samples set to a volume of zero
+     */
+    bool isSilentPackage;
 };
 
 /*!
@@ -48,6 +49,11 @@ struct StreamData
 class AudioProcessor
 {
 public:
+    /*!
+     * This AudioProcessor supports any buffer-length
+     */
+    static constexpr int BUFFER_SIZE_ANY{1};
+
     AudioProcessor(const std::string name);
 
     virtual ~AudioProcessor()

include/AudioProcessorFactory.h

@@ -20,6 +20,9 @@ class AudioProcessorFactory
 public:
     static const std::string OPUS_CODEC;
     static const std::string WAV_WRITER;
+    static const std::string G711_PCMA;
+    static const std::string G711_PCMU;
+    static const std::string GAIN_CONTROL;
 
     /*!
      * Returns the AudioProcessor for the given name