/*
 * File: engineRobotAudioClient.h
 *
 * Author: Jordan Rivas
 * Created: 9/14/2017
 *
 * Description: This is a subclass of AudioMuxClient which provides communication between itself and an
 *              EndingRobotAudioInput by means of EngineToRobot and RobotToEngine messages. It's purpose is to provide
 *              an interface to perform audio tasks and respond to audio callbacks sent from the audio engine in the
 *              animation process to engine process.
 *
 *
 * Copyright: Anki, Inc. 2017
 */


#ifndef __Cozmo_Basestation_EngineRobotAudioClient_H__
#define __Cozmo_Basestation_EngineRobotAudioClient_H__


#include "audioEngine/multiplexer/audioMuxClient.h"
#include "util/entityComponent/iDependencyManagedComponent.h"
#include "engine/robotComponents_fwd.h"
#include "engine/events/ankiEvent.h"
#include "proto/external_interface/settings.pb.h"
#include <memory>
#include <vector>


namespace Anki {
namespace Vector {
namespace RobotInterface {
class RobotToEngine;
}
class Robot;

namespace Audio {
class AudioBehaviorStackListener;

class EngineRobotAudioClient : public IDependencyManagedComponent<RobotComponentID>, 
                               public AudioEngine::Multiplexer::AudioMuxClient 
{
public:
  using CurveType = AudioEngine::Multiplexer::CurveType;

  EngineRobotAudioClient();

  //////
  // IDependencyManagedComponent functions
  //////
  virtual void InitDependent(Vector::Robot* robot, const RobotCompMap& dependentComps) override;
  virtual void GetInitDependencies(RobotCompIDSet& dependencies) const override {
    dependencies.insert(RobotComponentID::CozmoContextWrapper);
  };
  virtual void GetUpdateDependencies(RobotCompIDSet& dependencies) const override {};
  //////
  // end IDependencyManagedComponent functions
  //////


  // Engine Robot Audio Client Helper Methods
  //--------------------------------------------------------------------------------------------------------------------
  void SetRobotMasterVolume( external_interface::Volume volume );


  // Basic Audio Client Methods
  //--------------------------------------------------------------------------------------------------------------------
  
  // Perform event
  // Provide a callback lambda to get all event callbacks; Duration, Marker, Complete & Error.
  virtual CallbackIdType PostEvent( AudioMetaData::GameEvent::GenericEvent event,
                                    AudioMetaData::GameObjectType gameObject = AudioMetaData::GameObjectType::Invalid,
                                    CallbackFunc&& callback = nullptr ) override;
  
  virtual void StopAllEvents( AudioMetaData::GameObjectType gameObject = AudioMetaData::GameObjectType::Invalid ) override;
  
  virtual void PostGameState( AudioMetaData::GameState::StateGroupType gameStateGroup,
                              AudioMetaData::GameState::GenericState gameState ) override;
  
  virtual  void PostSwitchState( AudioMetaData::SwitchState::SwitchGroupType switchGroup,
                                 AudioMetaData::SwitchState::GenericSwitch switchState,
                                 AudioMetaData::GameObjectType gameObject = AudioMetaData::GameObjectType::Invalid ) override;
  
  virtual void PostParameter( AudioMetaData::GameParameter::ParameterType parameter,
                              float parameterValue,
                              AudioMetaData::GameObjectType gameObject = AudioMetaData::GameObjectType::Invalid,
                              int32_t timeInMilliSeconds = 0,
                              CurveType curve = CurveType::Linear ) const override;

private:
  
  Robot* _robot = nullptr;
  std::unique_ptr<AudioBehaviorStackListener> _behaviorListener;
  std::vector<Signal::SmartHandle>            _signalHandles;

  void SubscribeAudioCallbackMessages( Robot* robot );
  
  void HandleRobotEngineMessage( const AnkiEvent<RobotInterface::RobotToEngine>& message );

};


} // Audio
} // Cozmo
} // Anki



#endif /* __Cozmo_Basestation_EngineRobotAudioClient_H__ */