MASpeakerController.hpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ 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, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */

#pragma once

#include "sound/MASoundBase.hpp"
#include "sound/MASpeakerDevice.hpp"
#include "MAController.hpp"

#include <MCThreadLocalData.hpp>

#include <boost/shared_ptr.hpp>
#include <boost/tuple/tuple.hpp>
#include <boost/unordered_map.hpp>

#include <map>
#include <string>

class MARobotState;
class MASpeakerController;

namespace MA
{
extern MCThreadLocalData<MASpeakerController> Speaker;

typedef boost::tuple<int, int, int64_t, int> PlaybackDescriptor;
typedef std::multimap<MA::SoundBaseSPtr, PlaybackDescriptor> SoundPlaybackMap;
}

class MASpeakerController : public MAController
{
public:
  MASpeakerController();
  virtual ~MASpeakerController();

private:
  virtual void UpdateRobotState(MARobotState& state) override;

public:
  virtual MA::DeviceList GetMotors() const override;

  static void RegisterFutureSound(const int id, const std::string& name, const int duration);

  bool IsFree() const;

  void SwitchSoundProfile();

  std::string GetSoundProfileName() const;

  void SetSoundProfileName(const std::string& profile_name);

  virtual void LoadSoundProfile();

  virtual void SaveSoundProfile();

  virtual void LoadVolumeControl();

  virtual void SaveVolumeControl();

  bool Preload(const std::string& name);

  void FreePreloadedSound(const std::string& name);

  int Play(const std::string& name);

  int Play(MA::SoundBaseSPtr sound);

  bool IsPlayed(const int playback_id) const;

  bool IsPlayed(const std::string& sound_name) const;

  void SetVolume(const MA::VolumeType new_volume);
protected:
  void MixNextBuffer(int16_t* target_buffer, bool limit_non_cached = true);
  unsigned int GetRemainingPlaybackTime() const;
  bool IsOnlyEffectsPlayed() const;
  virtual MA::DeviceGeneratorsMap GetSkitTransitionGenerators(MA::SkitBaseSPtr skit) override;

protected:
  int BufferSize;
  MA::SoundPlaybackMap Playbacks;
  boost::shared_ptr<MASpeakerDevice> SpeakerDevice;
};