AudioMixer.h

//
//  AudioMixer.h
//  assignment-client/src/audio
//
//  Created by Stephen Birarda on 8/22/13.
//  Copyright 2013 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
 
#ifndef hifi_AudioMixer_h
#define hifi_AudioMixer_h
 
#include <QtCore/QSharedPointer>
 
#include <Transform.h>
#include <AudioHRTF.h>
#include <AudioRingBuffer.h>
#include <ThreadedAssignment.h>
#include <UUIDHasher.h>
 
#include <plugins/Forward.h>
 
#include "AudioMixerStats.h"
#include "AudioMixerWorkerPool.h"
 
#include "../entities/EntityTreeHeadlessViewer.h"
 
class PositionalAudioStream;
class AvatarAudioStream;
class AudioHRTF;
class AudioMixerClientData;
 
class AudioMixer : public ThreadedAssignment {
    Q_OBJECT
public:
    AudioMixer(ReceivedMessage& message);
 
    struct ZoneSettings {
        glm::mat4 inverseTransform;
        float volume { FLT_MAX };
 
        bool reverbEnabled { false };
        float reverbTime { 0.0f };
        float wetLevel { 0.0f };
 
        std::vector<QString> listeners;
        std::vector<float> coefficients;
    };
 
    static int getStaticJitterFrames() { return _numStaticJitterFrames; }
    static bool shouldMute(float quietestFrame) { return quietestFrame > _noiseMutingThreshold; }
    static float getAttenuationPerDoublingInDistance() { return _attenuationPerDoublingInDistance; }
    static const std::unordered_map<QString, ZoneSettings>& getAudioZones() { return _audioZones; }
    static const std::pair<QString, CodecPluginPointer> negotiateCodec(std::vector<QString> codecs);
 
    static bool shouldReplicateTo(const Node& from, const Node& to) {
        return to.getType() == NodeType::DownstreamAudioMixer &&
               to.getPublicSocket() != from.getPublicSocket() &&
               to.getLocalSocket() != from.getLocalSocket();
    }
 
    virtual void aboutToFinish() override;
    
public slots:
    void run() override;
    void sendStatsPacket() override;
 
    // Audio zone possibly changed
    void entityAdded(EntityItem* entity);
    void entityRemoved(EntityItem* entity);
 
private slots:
    // packet handlers
    void handleMuteEnvironmentPacket(QSharedPointer<ReceivedMessage> packet, SharedNodePointer sendingNode);
    void handleNodeMuteRequestPacket(QSharedPointer<ReceivedMessage> packet, SharedNodePointer sendingNode);
    void handleNodeKilled(SharedNodePointer killedNode);
    void handleKillAvatarPacket(QSharedPointer<ReceivedMessage> packet, SharedNodePointer sendingNode);
    void handleOctreePacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer senderNode);
 
    void queueAudioPacket(QSharedPointer<ReceivedMessage> packet, SharedNodePointer sendingNode);
    void queueReplicatedAudioPacket(QSharedPointer<ReceivedMessage> packet);
    void removeHRTFsForFinishedInjector(const QUuid& streamID);
    void start();
 
private:
    // mixing helpers
    std::chrono::microseconds timeFrame();
    void throttle(std::chrono::microseconds frameDuration, int frame);
 
    AudioMixerClientData* getOrCreateClientData(Node* node);
 
    QString percentageForMixStats(int counter);
 
    void parseSettingsObject(const QJsonObject& settingsObject);
    void clearDomainSettings();
 
    p_high_resolution_clock::time_point _idealFrameTimestamp;
    p_high_resolution_clock::time_point _startFrameTimestamp;
 
    float _trailingMixRatio { 0.0f };
    float _throttlingRatio { 0.0f };
 
    int _numSilentPackets { 0 };
 
    int _numStatFrames { 0 };
    AudioMixerStats _stats;
 
    AudioMixerWorkerPool _workerPool { _workerSharedData };
 
    class Timer {
    public:
        class Timing{
        public:
            Timing(uint64_t& sum);
            ~Timing();
        private:
            p_high_resolution_clock::time_point _timing;
            uint64_t& _sum;
        };
 
        Timing timer() { return Timing(_sum); }
        void get(uint64_t& timing, uint64_t& trailing);
    private:
        static const int TIMER_TRAILING_SECONDS = 10;
 
        uint64_t _sum { 0 };
        uint64_t _trailing { 0 };
        uint64_t _history[TIMER_TRAILING_SECONDS] {};
        int _index { 0 };
    };
 
    Timer _ticTiming;
    Timer _checkTimeTiming;
    Timer _sleepTiming;
    Timer _frameTiming;
    Timer _prepareTiming;
    Timer _mixTiming;
    Timer _eventsTiming;
    Timer _packetsTiming;
 
    static int _numStaticJitterFrames; // -1 denotes dynamic jitter buffering
    static float _noiseMutingThreshold;
    static float _attenuationPerDoublingInDistance;
    static std::map<QString, CodecPluginPointer> _availableCodecs;
    static QStringList _codecPreferenceOrder;
 
    static std::unordered_map<QString, ZoneSettings> _audioZones;
 
    float _throttleStartTarget = 0.9f;
    float _throttleBackoffTarget = 0.44f;
 
    AudioMixerWorker::SharedData _workerSharedData;
 
    void setupEntityQuery();
 
    // Attach to entity tree for audio zone info.
    EntityTreeHeadlessViewer _entityViewer;
};
 
#endif // hifi_AudioMixer_h