src/lib/stream.h

   1 /*
   2     Copyright (C) 2012 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/lib/stream.h
  21  *  @brief Representations of audio and subtitle streams.
  22  *
  23  *  Some content may have multiple `streams' of audio and/or subtitles; perhaps
  24  *  for multiple languages, or for stereo / surround mixes.  These classes represent
  25  *  those streams, and know about their details.
  26  */
  27
  28 #ifndef DVDOMATIC_STREAM_H
  29 #define DVDOMATIC_STREAM_H
  30
  31 #include <stdint.h>
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/optional.hpp>
  34 extern "C" {
  35 #include <libavutil/audioconvert.h>
  36 }
  37
  38 /** @class Stream
  39  *  @brief Parent class for streams.
  40  */
  41 class Stream
  42 {
  43 public:
  44         virtual ~Stream () {}
  45         virtual std::string to_string () const = 0;
  46 };
  47
  48 /** @class AudioStream
  49  *  @brief A stream of audio data.
  50  */
  51 struct AudioStream : public Stream
  52 {
  53 public:
  54         AudioStream (int r, int64_t l)
  55                 : _sample_rate (r)
  56                 , _channel_layout (l)
  57         {}
  58
  59         /* Only used for backwards compatibility for state file version < 1 */
  60         void set_sample_rate (int s) {
  61                 _sample_rate = s;
  62         }
  63
  64         int channels () const {
  65                 return av_get_channel_layout_nb_channels (_channel_layout);
  66         }
  67
  68         int sample_rate () const {
  69                 return _sample_rate;
  70         }
  71
  72         int64_t channel_layout () const {
  73                 return _channel_layout;
  74         }
  75
  76 protected:
  77         AudioStream ()
  78                 : _sample_rate (0)
  79                 , _channel_layout (0)
  80         {}
  81
  82         int _sample_rate;
  83         int64_t _channel_layout;
  84 };
  85
  86 /** @class SubtitleStream
  87  *  @brief A stream of subtitle data.
  88  */
  89 class SubtitleStream : public Stream
  90 {
  91 public:
  92         SubtitleStream (std::string n, int i)
  93                 : _name (n)
  94                 , _id (i)
  95         {}
  96
  97         std::string to_string () const;
  98
  99         std::string name () const {
 100                 return _name;
 101         }
 102
 103         int id () const {
 104                 return _id;
 105         }
 106
 107         static boost::shared_ptr<SubtitleStream> create (std::string t, boost::optional<int> v);
 108
 109 private:
 110         friend class stream_test;
 111
 112         SubtitleStream (std::string t, boost::optional<int> v);
 113
 114         std::string _name;
 115         int _id;
 116 };
 117
 118 boost::shared_ptr<AudioStream> audio_stream_factory (std::string t, boost::optional<int> version);
 119 boost::shared_ptr<SubtitleStream> subtitle_stream_factory (std::string t, boost::optional<int> version);
 120
 121 #endif