src/lib/cinema_sound_processor.h

   1 /*
   2     Copyright (C) 2012-2014 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/cinema_sound_processor.h
  21  *  @brief CinemaSoundProcessor class
  22  */
  23
  24 #ifndef DCPOMATIC_CINEMA_SOUND_PROCESSOR_H
  25 #define DCPOMATIC_CINEMA_SOUND_PROCESSOR_H
  26
  27 #include <boost/utility.hpp>
  28 #include <string>
  29 #include <vector>
  30
  31 /** @class CinemaSoundProcessor
  32  *  @brief Class to describe a cimema's sound processor.
  33  *
  34  *  In other words, the box in the rack that handles sound decoding and processing
  35  *  in a cinema.
  36  */
  37 class CinemaSoundProcessor : public boost::noncopyable
  38 {
  39 public:
  40         CinemaSoundProcessor (std::string i, std::string n);
  41
  42         virtual float db_for_fader_change (float from, float to) const = 0;
  43
  44         /** @return id for our use */
  45         std::string id () const {
  46                 return _id;
  47         }
  48
  49         /** @return user-visible name for this sound processor */
  50         std::string name () const {
  51                 return _name;
  52         }
  53
  54         static std::vector<CinemaSoundProcessor const *> all ();
  55         static void setup_cinema_sound_processors ();
  56         static CinemaSoundProcessor const * from_id (std::string id);
  57         static CinemaSoundProcessor const * from_index (int);
  58         static int as_index (CinemaSoundProcessor const *);
  59
  60 private:
  61         /** id for our use */
  62         std::string _id;
  63         /** user-visible name for this sound processor */
  64         std::string _name;
  65
  66         /** sll available cinema sound processors */
  67         static std::vector<CinemaSoundProcessor const *> _cinema_sound_processors;
  68 };
  69
  70 #endif