src/lib/audio_content.h

   1 /*
   2     Copyright (C) 2013 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 #ifndef DCPOMATIC_AUDIO_CONTENT_H
  21 #define DCPOMATIC_AUDIO_CONTENT_H
  22
  23 #include "content.h"
  24 #include "audio_mapping.h"
  25
  26 namespace cxml {
  27         class Node;
  28 }
  29
  30 class AudioContentProperty
  31 {
  32 public:
  33         static int const AUDIO_CHANNELS;
  34         static int const AUDIO_LENGTH;
  35         static int const AUDIO_FRAME_RATE;
  36         static int const AUDIO_GAIN;
  37         static int const AUDIO_DELAY;
  38         static int const AUDIO_MAPPING;
  39 };
  40
  41 class AudioContent : public virtual Content
  42 {
  43 public:
  44         typedef int64_t Frame;
  45
  46         AudioContent (boost::shared_ptr<const Film>, Time);
  47         AudioContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  48         AudioContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  49
  50         void as_xml (xmlpp::Node *) const;
  51         std::string technical_summary () const;
  52
  53         virtual int audio_channels () const = 0;
  54         virtual AudioContent::Frame audio_length () const = 0;
  55         virtual int content_audio_frame_rate () const = 0;
  56         virtual int output_audio_frame_rate () const = 0;
  57         virtual AudioMapping audio_mapping () const = 0;
  58         virtual void set_audio_mapping (AudioMapping) = 0;
  59
  60         void analyse_audio (boost::function<void()>);
  61         boost::filesystem::path audio_analysis_path () const;
  62
  63         void set_audio_gain (float);
  64         void set_audio_delay (int);
  65
  66         float audio_gain () const {
  67                 boost::mutex::scoped_lock lm (_mutex);
  68                 return _audio_gain;
  69         }
  70
  71         int audio_delay () const {
  72                 boost::mutex::scoped_lock lm (_mutex);
  73                 return _audio_delay;
  74         }
  75
  76 private:
  77         /** Gain to apply to audio in dB */
  78         float _audio_gain;
  79         /** Delay to apply to audio (positive moves audio later) in milliseconds */
  80         int _audio_delay;
  81 };
  82
  83 #endif