/* Copyright (C) 2013
 * swift Project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

#ifndef BLACKCORE_VOICE_H
#define BLACKCORE_VOICE_H

#include "blackcore/audiomixer.h"
#include "blackcore/blackcoreexport.h"

#include <QObject>
#include <QSharedPointer>
#include <memory>

namespace BlackCore
{
    class IAudioInputDevice;
    class IAudioOutputDevice;
    class IVoiceChannel;

    //! Interface to a connection to a ATC voice server for use in flight simulation.
    class BLACKCORE_EXPORT IVoice : public QObject
    {
        Q_OBJECT

    public:

        /*!
         * \brief Default constructor with parent
         * \param parent
         */
        IVoice(QObject *parent = nullptr);

        //! Virtual destructor.
        virtual ~IVoice() {}

        //! Create voice channel object
        virtual QSharedPointer<IVoiceChannel> createVoiceChannel() = 0;

        //! Create input device object
        virtual std::unique_ptr<IAudioInputDevice> createInputDevice() = 0;

        //! Create output device object
        virtual std::unique_ptr<IAudioOutputDevice> createOutputDevice() = 0;

        //! Create audio mixer object
        virtual std::unique_ptr<IAudioMixer> createAudioMixer() = 0;

        //! Connect audio input device to audio mixer
        virtual void connectVoice(IAudioInputDevice *device, IAudioMixer *mixer, IAudioMixer::InputPort inputPort) = 0;

        //! Connect voice channel to audio mixer
        virtual void connectVoice(IVoiceChannel *channel, IAudioMixer *mixer, IAudioMixer::InputPort inputPort) = 0;

        //! Connect audio mixer to audio output device
        virtual void connectVoice(IAudioMixer *mixer, IAudioMixer::OutputPort outputPort, IAudioOutputDevice *device) = 0;

        //! Connect audio mixer to audio input device
        virtual void connectVoice(IAudioMixer *mixer, IAudioMixer::OutputPort outputPort, IVoiceChannel *channel) = 0;

        //! Disconnect input device
        virtual void disconnectVoice(IAudioInputDevice *device) = 0;

        //! Disconnect voice channel
        virtual void disconnectVoice(IVoiceChannel *channel) = 0;

        //! Disconnect audio mixer output port
        virtual void disconnectVoice(IAudioMixer *mixer, IAudioMixer::OutputPort outputPort) = 0;
    };

} // namespace BlackCore

#endif // guard