MAAudio.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 "core/MANum.hpp"
#include "MARobotStateUpdater.hpp"

#include <MCTypes.hpp>

namespace MA
{
typedef enum
{
  UnknownSoundEvent = 0,           
  AmbientNoise = 1,                
  BabyCry = 2,                     
  Bell = 3,                        
  CatMeow = 4,                     
  Cicada = 5,                      
  DogBark = 6,                     
  Fart = 7,                        
  Guitar = 8,                      
  Laugh = 9,                       
  Parrot = 10,                     
  Piano = 11,                      
  Speech = 12,                     
  Traffic = 13,                    
  VacuumCleaner = 14,              
  MaxSoundEvents = VacuumCleaner,  
} SoundEventType;

extern const MC::StringList SoundEventTypeStrs;
}

struct MAAudio : public MARobotStateUpdater
{
  MAAudio();

private:
  // Update the sensor indicators
  virtual void UpdateRobotState(MARobotState& state) override;

public:
  /*
   * The speaker volume
   * 0 - muted 1 - low 2 - normal 3 - high
   */
  MANum<int> SpeakerVolume;
  /*
   * The remaining audio duration being played
   * 0 - No audio >0 - The remaining playback duration in msec
   */
  MANum<int> RemainingPlaybackTime;
  /*
   * Volume control type
   * 0 - Adaptive volume control 1 - Full volume
   */
  MANum<int> FullVolume;
  MANum<int> LeftMicrophonePower;
  MANum<int> RightMicrophonePower;
  MANum<int> BackgroundSoundPower;
  MANum<int> CurrentSoundEvent;
  MANum<int> SoundEventVotes[MA::MaxSoundEvents+1];
  /*
   * Deafness support
   * 0 - No deafness 1 - Any of the ears is deaf
   */
  MANum<int> Deafness;
  MANum<int> EffectsPlayed;
};