rtpa-qclient.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### QClient - A graphical client for the RTP Audio Server            ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### This program is distributed in the hope that it will be useful,  ####
// #### but WITHOUT ANY WARRANTY; without even the implied warranty of   ####
// #### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    ####
// #### GNU General Public License for more details.                     ####
// ####                                                                  ####
// #### You should have received a copy of the GNU General Public        ####
// #### License along with this program.  If not, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: rtpa-qclient.h 1286 2011-12-18 13:43:16Z dreibh $


#ifndef RTPA_QCLIENT_H
#define RTPA_QCLIENT_H


#include "audiowriterinterface.h"
#include "spectrumanalyzer.h"
#include "audiomixer.h"
#include "tools.h"
#include "strings.h"
#include "audioclient.h"
#include "strings.h"


#include <qapplication.h>
#include <qlayout.h>
#include <qpushbutton.h>
#include <qscrollbar.h>
#include <qlineedit.h>
#include <qbuttongroup.h>
#include <qcheckbox.h>
#include <qcombobox.h>
#include <qradiobutton.h>
#include <qframe.h>
#include <qgroupbox.h>
#include <qlabel.h>
#include <qlcdnumber.h>
#include <qwhatsthis.h>
#include <qmainwindow.h>
#include <qlist.h>


#include "qspectrumanalyzer.h"
#include "qaudiomixer.h"
#include "qinfotabwidget.h"


const InfoEntry InfoEntries1[] = {
   {"SA",    "Server Address",   "This are the IPv4 or IPv6 address and port number of the audio server."},
   {"TF",    "TOS/Flow Label",   "This are the TOS/traffic class values for each layer and the flow label "
                                 "(IPv6 only) of the received packets."},
   {"SSSRC", "Server SSRC",      "This is the audio server's RTP SSRC. It is a 32-bit random number."},
   {"CA",    "Client Address",   "This is the IPv4 or IPv6 address and port number of the audio client."},
   {"CSSRC", "Client SSRC",      "This is the audio clients's RTP SSRC. It is a 32-bit random number."},
   {"BR",    "Bytes Received",   "This is a counter for the number of bytes received from server "
                                 "(IP/UDP/RTP/RTP Audio headers + payload)."},
   {"PR",    "Packets Received", "This is a counter for the number of packets received from server. "
                                 "The bytes per second value is the value for the quality received "
                                 "from server (IP/UDP/RTP/RTP Audio headers + payload)."},
   {"PL",    "Packets Lost",     "This is a counter for the number of packets lost during transmission."
                                 "The loss fraction shows the fraction of packets lost during the last "
                                 "RTCP report interval in each layer."},
   {"IJ", "Interarrival Jitter", "This is the interarrival jitter: An estimate of the statistical variance of "
                                 "the RTP data packet interarrival time, measured in milliseconds.\n\n"
                                 "Definition:\n"
                                 "Let Si, Sj be the RTP timestamps of packets i, j.\n"
                                 "Let Ri, Rj be the arrival timestamps.\n"
                                 "Dij := (Rj - Sj) - (Ri - Si).\n"
                                 "Jitter := Jitter + (1.0/16.0) * abs(Dij).\n\n"
                                 "See RFC 1889, Page 25-26 for more details."},
   {"Q", "Quality",  "This is the audio quality received from server: Sampling rate, bits and channels."},
   {"E", "Encoding", "This is the name of the audio encoding format received from server."},
};


const InfoTable InfoTable1 =
{
   sizeof(InfoEntries1) / sizeof(InfoEntry),
   (const InfoEntry*)&InfoEntries1
};



const InfoEntry InfoEntries2[] = {
   {"LSA", "Source",           "This is the current layer's source address and port number."},
   {"LTF", "TOS/Flow Label",   "This are the current layer's traffic class and flow label (IPv6 only)."},
   {"CA",  "Destination",      "This is the current layer's destination address and port number."},
   {"LPR", "Packets Received", "This is the number of packets received in this layer."},
   {"LPL", "Packets Lost",     "This is the number of packets lost in this layer."},
   {"LFL", "Fraction Lost",    "This is the fraction of packets lost in this layer."},
   {"LBR", "Bytes Received",   "This is the sum of bytes received in this layer."},
   {"LIJ", "Interarrival Jitter", "This is the interarrival jitter of this layer."},
   {"Q", "Quality",  "This is the audio quality received from server: Sampling rate, bits and channels."},
   {"E", "Encoding", "This is the name of the audio encoding format received from server."},
};


const InfoTable InfoTable2 =
{
   sizeof(InfoEntries2) / sizeof(InfoEntry),
   (const InfoEntry*)&InfoEntries2
};



class QClient : public QMainWindow
{
   Q_OBJECT

   // ====== Constructor/Destructor =========================================
   public:
   QClient(AudioWriterInterface* audioOutput,
           const char*           receiverName = NULL,
           const char*           defaultURL   = NULL,
           SpectrumAnalyzer*     analyzer     = NULL,
           AudioMixer*           mixer        = NULL,
           QWidget*              parent       = NULL);

   ~QClient();


   // ====== Slots for Qt ===================================================
   public slots:
   void play();

   void stop();

   void information();

   void whatsThis();

   void pause(bool on);

   void togglePause();

   void toggleAddressResolution(bool selected);

   void spectrumAnalyzer();

   void audioMixer();

   void closeSpectrumAnalyzer();

   void closeAudioMixer();

   void quit();

   void position(int value);

   void setSamplingRate(int index);

   void setChannels(bool stereo);

   void setBits(int index);

   void setEncoding(int index);

   void locationSelected(QAction* action);

   void loadBookmarks();

   void clearBookmarks();

   void saveBookmarks();

   void timerEvent();


   // ====== Status update ==================================================
   private:
   void updateCounter(card64 position);
   void insertURL(const String& urlToInsert, const int where = 0);


   // ====== Private data ===================================================
   private:
   void showError(const cardinal error);
   QString bytesToQString(const card64 bytes) const;
   QString card64ToQString(const card64 value,
                           const char*  formatString = "%Ld") const;
   QString doubleToQString(const double value,
                           const char*  formatString = "%f") const;
   QString flowInfoToQString(const card8  trafficClass,
                             const card32 flowLabel) const;

   static const cardinal LocationCount           = 15;
   static const cardinal DisplayUpdateInterval   = 250;
   static const cardinal EOFRepeatInterval       = 20000 / DisplayUpdateInterval;
   static const cardinal MaxScrollBarUpdateDelay = 4;
   static const cardinal MaxLayerInfo            = 3;

   QAction*              ResolverAction;
   QAction*              MixerAction;
   QAction*              SpectrumAnalyzerAction;
   QAction*              AutoRepeatAction;
   QAction*              AutoSaveBookmarksAction;
   QAction*              LocationAction[LocationCount];

   QSpectrumAnalyzer*    SpectrumAnalyzerWindow;
   QAudioMixer*          MixerWindow;
   SpectrumAnalyzer*     SpectrumAnalyzerDevice;
   AudioMixer*           MixerDevice;

   QMenu*                ToolsMenu;
   QMenu*                URLMenu;
   QMenu*                SettingsMenu;
   QLineEdit*            Location;
   QLCDNumber*           Counter;
   QLabel*               TitleLabel;
   QLabel*               ArtistLabel;
   QLabel*               CommentLabel;
   QLabel*               StatusBar;
   QInfoTabWidget*       InfoWidget;
   QInfoWidget*          LayerInfo[MaxLayerInfo];
   QScrollBar*           ScrollBar;
   bool                  ScrollBarUpdated;
   cardinal              ScrollBarUpdateDelay;
   cardinal              EOFRepeatDelay;
   QPushButton*          Pause;
   QWhatsThis*           WhatsThis;

   AudioClient*          Client;
   QList<String*>        URLList;
   String                PlayingURL;
   bool                  InsertionRequired;
};


#endif