src/lib/cinema_sound_processor.h

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