audioclient.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Audio Client Implementation                                      ####
// ####                                                                  ####
// ####           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: audioclient.h 1286 2011-12-18 13:43:16Z dreibh $


#ifndef AUDIOCLIENT_H
#define AUDIOCLIENT_H


#include "audiowriterinterface.h"
#include "audiodecoderinterface.h"
#include "audiodecoderrepository.h"
#include "mediainfo.h"
#include "rtcpsender.h"
#include "rtpreceiver.h"
#include "internetaddress.h"
#include "tdsocket.h"
#include "strings.h"

#include "audioclientapppacket.h"

#include <map>


class AudioClient : virtual public AdjustableAudioQualityInterface
{
   // ====== Constructor/Destructor =========================================
   public:
   AudioClient(AudioWriterInterface* audioOutput);

   virtual ~AudioClient();


   // ====== Player functions ===============================================
   public:
   bool play(const char* url);

   bool change(const char* mediaName);

   void stop();


   // ====== Settings =======================================================
   card64 getPosition();

   inline card64 getMaxPosition() const;


   card16 getSamplingRate() const;

   card8 getBits() const;

   card8 getChannels() const;


   card16 getByteOrder() const;


   cardinal getBytesPerSecond() const;

   cardinal getBitsPerSample() const;


   cardinal getRawBytesPerSecond();


   MediaInfo getMediaInfo() const;


   inline card8 getErrorCode() const;

   inline const char* getEncoding() const;

   inline card32 getBandwidthLimit() const;

   card8 getIPVersion() const;

   inline bool playing() const;


   String getServerAddressString(const InternetAddress::PrintFormat format = InternetAddress::PF_Address) const;

   String getOurAddressString(const InternetAddress::PrintFormat format = InternetAddress::PF_Address) const;


   inline cardinal getLayers() const;

   inline card64 getBytesReceived(const cardinal layer = 0) const;

   inline card64 getPacketsReceived(const cardinal layer = 0) const;

   inline InternetFlow getInternetFlow(const cardinal layer = 0) const;

   inline card32 getFlowLabel(const cardinal layer = 0) const;

   inline card8 getTrafficClass(const cardinal layer = 0) const;

   card32 getServerSSRC(const cardinal layer = 0) const;

   inline card32 getOurSSRC() const;

   card64 getPacketsLost(const cardinal layer = 0) const;

   double getFractionLost(const cardinal layer = 0) const;

   double getJitter(const cardinal layer = 0) const;


   const char* getEncodingName(const cardinal index);


   inline void setPosition(const card64 position);

   void setPause(const bool on);

   card16 setSamplingRate(const card16 rate);

   card8 setChannels(const card8 channels);

   card8 setBits(const card8 bits);

   card16 setByteOrder(const card16 byteOrder);

   void setEncoding(const cardinal index);

   inline void setBandwidthLimit(const card32 bandwidthLimit);


   // ====== Private data ===================================================
   private:
   void sendCommand(const bool updateRestartPosition = true);


   // Update of RestartPosition has to be delayed after change() call to
   // ensure that there are no more packets of the old file on the network
   // which change the restart position back to the old value.
   static const card64 RestartPositionUpdateDelay = 5000000;


   AudioWriterInterface*                                AudioOutput;
   RTPReceiver*                                         Receiver;
   RTCPSender*                                          Sender;
   Socket                                               SenderSocket;
   Socket                                               ReceiverSocket;
   InternetFlow                                         Flow;
   InternetAddress                                      ServerAddress;
   InternetAddress                                      OurAddress;
   card32                                               OurSSRC;

   std::multimap<const cardinal,AudioDecoderInterface*> DecoderSet;
   AudioDecoderRepository                               Decoders;

   AudioClientAppPacket                                 Status;
   card64                                               OldPosition;
   card64                                               ChangeTimeStamp;
   bool                                                 IsPlaying;
};


#include "audioclient.icc"


#endif