Optional network clock reference

src/preferences/dialog/dlgprefsound.cpp

@@ -74,6 +74,13 @@ DlgPrefSound::DlgPrefSound(QWidget* pParent, SoundManager* pSoundManager,
     connect(deviceSyncComboBox, SIGNAL(currentIndexChanged(int)),
             this, SLOT(syncBuffersChanged(int)));
 
+    engineClockComboBox->clear();
+    engineClockComboBox->addItem(tr("Soundcard Clock"));
+    engineClockComboBox->addItem(tr("Network Clock"));
+    engineClockComboBox->setCurrentIndex(0);
+    connect(engineClockComboBox, SIGNAL(currentIndexChanged(int)),
+            this, SLOT(engineClockChanged(int)));
+
     keylockComboBox->clear();
     for (int i = 0; i < EngineBuffer::KEYLOCK_ENGINE_COUNT; ++i) {
         keylockComboBox->addItem(
@@ -126,6 +133,8 @@ DlgPrefSound::DlgPrefSound(QWidget* pParent, SoundManager* pSoundManager,
             this, SLOT(settingChanged()));
     connect(deviceSyncComboBox, SIGNAL(currentIndexChanged(int)),
             this, SLOT(settingChanged()));
+    connect(engineClockComboBox, SIGNAL(currentIndexChanged(int)),
+            this, SLOT(settingChanged()));
     connect(keylockComboBox, SIGNAL(currentIndexChanged(int)),
             this, SLOT(settingChanged()));
 
@@ -398,6 +407,12 @@ void DlgPrefSound::loadSettings(const SoundManagerConfig &config) {
         deviceSyncComboBox->setCurrentIndex(0);
     }
 
+    if (m_config.getForceNetworkClock()) {
+        engineClockComboBox->setCurrentIndex(1);
+    } else {
+        engineClockComboBox->setCurrentIndex(0);
+    }
+
     // Default keylock is Rubberband.
     int keylock_engine = m_pConfig->getValue(
             ConfigKey("[Master]", "keylock_engine"), 1);
@@ -486,6 +501,16 @@ void DlgPrefSound::syncBuffersChanged(int index) {
     }
 }
 
+void DlgPrefSound::engineClockChanged(int index) {
+    if (index == 0) {
+        // "Soundcard Clock"
+        m_config.setForceNetworkClock(false);
+    } else {
+        // "Network Clock"
+        m_config.setForceNetworkClock(true);
+    }
+}
+
 // Slot called whenever the selected sample rate is changed. Populates the
 // audio buffer input box with SMConfig::kMaxLatency values, starting at 1ms,
 // representing a number of frames per buffer, which will always be a power

src/preferences/dialog/dlgprefsound.h

@@ -80,6 +80,7 @@ class DlgPrefSound : public DlgPreferencePage, public Ui::DlgPrefSoundDlg  {
     void audioBufferChanged(int index);
     void updateAudioBufferSizes(int sampleRateIndex);
     void syncBuffersChanged(int index);
+    void engineClockChanged(int index);
     void refreshDevices();
     void settingChanged();
     void deviceSettingChanged();

src/preferences/dialog/dlgprefsounddlg.ui

@@ -66,6 +66,20 @@
       <widget class="QComboBox" name="deviceSyncComboBox"/>
      </item>
      <item row="4" column="0">
+      <widget class="QLabel" name="engineClockLabel">
+       <property name="text">
+        <string>Engine Clock</string>
+       </property>
+      </widget>
+     </item>
+     <item row="4" column="1">
+      <widget class="QComboBox" name="engineClockComboBox">
+       <property name="toolTip">
+        <string>Use soundcard clock for live audience setups and lowest latency.&lt;br&gt;Use network clock for broadcasting without a live audience.</string>
+       </property>
+      </widget>
+     </item>
+     <item row="5" column="0">
       <widget class="QLabel" name="keylockLabel">
        <property name="text">
         <string>Keylock/Pitch-Bending Engine</string>
@@ -76,46 +90,46 @@
       </widget>
      </item>
      <item row="5" column="1">
-      <widget class="QComboBox" name="masterMixComboBox"/>
-     </item>
-     <item row="4" column="1">
       <widget class="QComboBox" name="keylockComboBox"/>
      </item>
-     <item row="5" column="0">
+     <item row="6" column="0">
       <widget class="QLabel" name="masteMixLabel">
        <property name="text">
         <string>Master Mix</string>
        </property>
       </widget>
      </item>
      <item row="6" column="1">
+      <widget class="QComboBox" name="masterMixComboBox"/>
+     </item>
+     <item row="7" column="1">
       <widget class="QComboBox" name="masterOutputModeComboBox"/>
      </item>
-     <item row="6" column="0">
+     <item row="7" column="0">
       <widget class="QLabel" name="masterMonoLabel">
        <property name="text">
         <string>Master Output Mode</string>
        </property>
       </widget>
      </item>
-     <item row="7" column="1">
+     <item row="8" column="1">
       <widget class="QComboBox" name="micMonitorModeComboBox"/>
      </item>
-     <item row="7" column="0">
+     <item row="8" column="0">
       <widget class="QLabel" name="micMonitorModeLabel">
        <property name="text">
         <string>Microphone Monitor Mode</string>
        </property>
       </widget>
      </item>
-     <item row="8" column="0">
+     <item row="9" column="0">
       <widget class="QLabel" name="latencyCompensationLabel">
        <property name="text">
         <string>Microphone Latency Compensation</string>
        </property>
       </widget>
      </item>
-     <item row="8" column="1">
+     <item row="9" column="1">
       <widget class="QDoubleSpinBox" name="latencyCompensationSpinBox">
        <property name="suffix">
         <string> ms</string>
@@ -131,14 +145,14 @@
        </property>
       </widget>
      </item>
-     <item row="10" column="0">
+     <item row="11" column="0">
       <widget class="QLabel" name="masterDelayLabel">
        <property name="text">
         <string>Master Delay</string>
        </property>
       </widget>
      </item>
-     <item row="10" column="1">
+     <item row="11" column="1">
       <widget class="QDoubleSpinBox" name="masterDelaySpinBox">
        <property name="suffix">
         <string extracomment="milliseconds"> ms</string>
@@ -154,14 +168,14 @@
        </property>
       </widget>
      </item>
-     <item row="11" column="0">
+     <item row="12" column="0">
       <widget class="QLabel" name="headDelayLabel">
        <property name="text">
         <string>Headphone Delay</string>
        </property>
       </widget>
      </item>
-     <item row="11" column="1">
+     <item row="12" column="1">
       <widget class="QDoubleSpinBox" name="headDelaySpinBox">
        <property name="suffix">
         <string extracomment="milliseconds"> ms</string>
@@ -177,14 +191,14 @@
        </property>
       </widget>
      </item>
-     <item row="12" column="0">
+     <item row="13" column="0">
       <widget class="QLabel" name="boothDelayLabel">
        <property name="text">
         <string>Booth Delay</string>
        </property>
       </widget>
      </item>
-     <item row="12" column="1">
+     <item row="13" column="1">
       <widget class="QDoubleSpinBox" name="boothDelaySpinBox">
        <property name="suffix">
         <string extracomment="milliseconds"> ms</string>
@@ -200,7 +214,7 @@
        </property>
       </widget>
      </item>
-     <item row="9" column="0" colspan="2">
+     <item row="14" column="0" colspan="2">
       <widget class="QLabel" name="latencyCompensationWarningLabel">
        <property name="text">
         <string notr="true">warning goes here</string>

src/soundio/sounddevice.cpp

@@ -112,9 +112,9 @@ bool SoundDevice::operator==(const QString &other) const {
 }
 
 void SoundDevice::composeOutputBuffer(CSAMPLE* outputBuffer,
-                                      const unsigned int framesToCompose,
-                                      const unsigned int framesReadOffset,
-                                      const unsigned int iFrameSize) {
+                                      const SINT framesToCompose,
+                                      const SINT framesReadOffset,
+                                      const int iFrameSize) {
     //qDebug() << "SoundDevice::composeOutputBuffer()"
     //         << device->getInternalName()
     //         << framesToCompose << iFrameSize;
@@ -149,20 +149,20 @@ void SoundDevice::composeOutputBuffer(CSAMPLE* outputBuffer,
             if (iChannelCount == 1) {
                 // All AudioOutputs are stereo as of Mixxx 1.12.0. If we have a mono
                 // output then we need to downsample.
-                for (unsigned int iFrameNo = 0; iFrameNo < framesToCompose; ++iFrameNo) {
+                for (SINT iFrameNo = 0; iFrameNo < framesToCompose; ++iFrameNo) {
                     // iFrameBase is the "base sample" in a frame (ie. the first
                     // sample in a frame)
-                    const unsigned int iFrameBase = iFrameNo * iFrameSize;
+                    const SINT iFrameBase = iFrameNo * iFrameSize;
                     outputBuffer[iFrameBase + iChannelBase] = SampleUtil::clampSample(
                             (pAudioOutputBuffer[iFrameNo * 2] +
                                     pAudioOutputBuffer[iFrameNo * 2 + 1]) / 2.0f);
                 }
             } else {
-                for (unsigned int iFrameNo = 0; iFrameNo < framesToCompose; ++iFrameNo) {
+                for (SINT iFrameNo = 0; iFrameNo < framesToCompose; ++iFrameNo) {
                     // iFrameBase is the "base sample" in a frame (ie. the first
                     // sample in a frame)
-                    const unsigned int iFrameBase = iFrameNo * iFrameSize;
-                    const unsigned int iLocalFrameBase = iFrameNo * iChannelCount;
+                    const SINT iFrameBase = iFrameNo * iFrameSize;
+                    const SINT iLocalFrameBase = iFrameNo * iChannelCount;
 
                     // this will make sure a sample from each channel is copied
                     for (int iChannel = 0; iChannel < iChannelCount; ++iChannel) {
@@ -182,9 +182,9 @@ void SoundDevice::composeOutputBuffer(CSAMPLE* outputBuffer,
 }
 
 void SoundDevice::composeInputBuffer(const CSAMPLE* inputBuffer,
-                                     const unsigned int framesToPush,
-                                     const unsigned int framesWriteOffset,
-                                     const unsigned int iFrameSize) {
+                                     const SINT framesToPush,
+                                     const SINT framesWriteOffset,
+                                     const int iFrameSize) {
     //qDebug() << "SoundManager::pushBuffer"
     //         << framesToPush << framesWriteOffset << iFrameSize;
     // This function is called a *lot* and is a big source of CPU usage.
@@ -199,7 +199,7 @@ void SoundDevice::composeInputBuffer(const CSAMPLE* inputBuffer,
         const AudioInputBuffer& in = m_audioInputs.at(0);
         CSAMPLE* pInputBuffer = in.getBuffer(); // Always Stereo
         pInputBuffer = &pInputBuffer[framesWriteOffset * 2];
-        for (unsigned int iFrameNo = 0; iFrameNo < framesToPush; ++iFrameNo) {
+        for (SINT iFrameNo = 0; iFrameNo < framesToPush; ++iFrameNo) {
             pInputBuffer[iFrameNo * 2] =
                     inputBuffer[iFrameNo];
             pInputBuffer[iFrameNo * 2 + 1] =
@@ -225,11 +225,11 @@ void SoundDevice::composeInputBuffer(const CSAMPLE* inputBuffer,
             CSAMPLE* pInputBuffer = in.getBuffer();
             pInputBuffer = &pInputBuffer[framesWriteOffset * 2];
 
-            for (unsigned int iFrameNo = 0; iFrameNo < framesToPush; ++iFrameNo) {
+            for (SINT iFrameNo = 0; iFrameNo < framesToPush; ++iFrameNo) {
                 // iFrameBase is the "base sample" in a frame (ie. the first
                 // sample in a frame)
-                unsigned int iFrameBase = iFrameNo * iFrameSize;
-                unsigned int iLocalFrameBase = iFrameNo * 2;
+                SINT iFrameBase = iFrameNo * iFrameSize;
+                SINT iLocalFrameBase = iFrameNo * 2;
 
                 if (iChannelCount == 1) {
                     pInputBuffer[iLocalFrameBase] =
@@ -247,9 +247,8 @@ void SoundDevice::composeInputBuffer(const CSAMPLE* inputBuffer,
     }
 }
 
-void SoundDevice::clearInputBuffer(const unsigned int framesToPush,
-                                   const unsigned int framesWriteOffset) {
-
+void SoundDevice::clearInputBuffer(const SINT framesToPush,
+                                   const SINT framesWriteOffset) {
     for (QList<AudioInputBuffer>::const_iterator i = m_audioInputs.begin(),
                  e = m_audioInputs.end(); i != e; ++i) {
         const AudioInputBuffer& in = *i;

src/soundio/sounddevice.h

@@ -73,17 +73,17 @@ class SoundDevice {
 
   protected:
     void composeOutputBuffer(CSAMPLE* outputBuffer,
-                             const unsigned int iFramesPerBuffer,
-                             const unsigned int readOffset,
-                             const unsigned int iFrameSize);
+                             const SINT iFramesPerBuffer,
+                             const SINT readOffset,
+                             const int iFrameSize);
 
     void composeInputBuffer(const CSAMPLE* inputBuffer,
-                            const unsigned int framesToPush,
-                            const unsigned int framesWriteOffset,
-                            const unsigned int iFrameSize);
+                            const SINT framesToPush,
+                            const SINT framesWriteOffset,
+                            const int iFrameSize);
 
-    void clearInputBuffer(const unsigned int framesToPush,
-                          const unsigned int framesWriteOffset);
+    void clearInputBuffer(const SINT framesToPush,
+                          const SINT framesWriteOffset);
 
     UserSettingsPointer m_pConfig;
     // Pointer to the SoundManager object which we'll request audio from.
@@ -100,7 +100,7 @@ class SoundDevice {
     double m_dSampleRate;
     // The name of the audio API used by this device.
     QString m_hostAPI;
-    unsigned int m_framesPerBuffer;
+    SINT m_framesPerBuffer;
     QList<AudioOutputBuffer> m_audioOutputs;
     QList<AudioInputBuffer> m_audioInputs;
 };