src/sound_mxf.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/sound_mxf.h
  21  *  @brief SoundMXF class
  22  */
  23
  24 #ifndef LIBDCP_SOUND_MXF_H
  25 #define LIBDCP_SOUND_MXF_H
  26
  27 #include "mxf.h"
  28 #include "types.h"
  29 #include "metadata.h"
  30
  31 namespace dcp
  32 {
  33
  34 class SoundFrame;
  35 class SoundMXFWriter;
  36
  37 /** @class SoundMXF
  38  *  @brief Representation of a MXF file containing sound
  39  */
  40 class SoundMXF : public MXF
  41 {
  42 public:
  43         SoundMXF (boost::filesystem::path file);
  44         SoundMXF (Fraction edit_rate, int sampling_rate, int channels);
  45
  46         boost::shared_ptr<SoundMXFWriter> start_write (boost::filesystem::path file, Standard standard);
  47
  48         bool equals (
  49                 boost::shared_ptr<const Content> other,
  50                 EqualityOptions opt,
  51                 boost::function<void (NoteType, std::string)> note
  52                 ) const;
  53
  54         boost::shared_ptr<const SoundFrame> get_frame (int n) const;
  55
  56         /** @return number of channels */
  57         int channels () const {
  58                 return _channels;
  59         }
  60
  61         /** @return sampling rate in Hz */
  62         int sampling_rate () const {
  63                 return _sampling_rate;
  64         }
  65
  66 private:
  67         std::string key_type () const;
  68         std::string asdcp_kind () const {
  69                 return "Sound";
  70         }
  71
  72         int _channels;      ///< number of channels
  73         int _sampling_rate; ///< sampling rate in Hz
  74 };
  75
  76 }
  77
  78 #endif