src/lib/sound_processor.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/sound_processor.h
  21  *  @brief A class to describe a sound processor.
  22  */
  23
  24 #ifndef DCPOMATIC_SOUND_PROCESSOR_H
  25 #define DCPOMATIC_SOUND_PROCESSOR_H
  26
  27 #include <string>
  28 #include <vector>
  29
  30 /** @class SoundProcessor
  31  *  @brief Class to describe a sound processor.
  32  */
  33 class SoundProcessor
  34 {
  35 public:
  36         SoundProcessor (std::string i, std::string n);
  37
  38         virtual float db_for_fader_change (float from, float to) const = 0;
  39
  40         /** @return id for our use */
  41         std::string id () const {
  42                 return _id;
  43         }
  44
  45         /** @return user-visible name for this sound processor */
  46         std::string name () const {
  47                 return _name;
  48         }
  49
  50         static std::vector<SoundProcessor const *> all ();
  51         static void setup_sound_processors ();
  52         static SoundProcessor const * from_id (std::string id);
  53         static SoundProcessor const * from_index (int);
  54         static int as_index (SoundProcessor const *);
  55
  56 private:
  57         /** id for our use */
  58         std::string _id;
  59         /** user-visible name for this sound processor */
  60         std::string _name;
  61
  62         /** sll available sound processors */
  63         static std::vector<SoundProcessor const *> _sound_processors;
  64 };
  65
  66 #endif