src/lib/cinema_sound_processor.h

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file src/cinema_sound_processor.h
  22  *  @brief CinemaSoundProcessor class
  23  */
  24
  25 #ifndef DCPOMATIC_CINEMA_SOUND_PROCESSOR_H
  26 #define DCPOMATIC_CINEMA_SOUND_PROCESSOR_H
  27
  28 #include <boost/utility.hpp>
  29 #include <string>
  30 #include <vector>
  31
  32 /** @class CinemaSoundProcessor
  33  *  @brief Class to describe a cimema's sound processor.
  34  *
  35  *  In other words, the box in the rack that handles sound decoding and processing
  36  *  in a cinema.
  37  */
  38 class CinemaSoundProcessor : public boost::noncopyable
  39 {
  40 public:
  41         CinemaSoundProcessor (std::string i, std::string n, float knee, float below, float above);
  42         virtual ~CinemaSoundProcessor () {}
  43
  44         float db_for_fader_change (float from, float to) const;
  45
  46         /** @return id for our use */
  47         std::string id () const {
  48                 return _id;
  49         }
  50
  51         /** @return user-visible name for this sound processor */
  52         std::string name () const {
  53                 return _name;
  54         }
  55
  56         static std::vector<CinemaSoundProcessor const *> all ();
  57         static void setup_cinema_sound_processors ();
  58         static CinemaSoundProcessor const * from_id (std::string id);
  59         static CinemaSoundProcessor const * from_index (int);
  60         static int as_index (CinemaSoundProcessor const *);
  61
  62 private:
  63         /** id for our use */
  64         std::string _id;
  65         /** user-visible name for this sound processor */
  66         std::string _name;
  67         float _knee;
  68         float _below;
  69         float _above;
  70
  71         /** sll available cinema sound processors */
  72         static std::vector<CinemaSoundProcessor const *> _cinema_sound_processors;
  73 };
  74
  75 #endif