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 std::string to_string () const = 0;
  45 };
  46
  47 /** @class AudioStream
  48  *  @brief A stream of audio data.
  49  */
  50 struct AudioStream : public Stream
  51 {
  52 public:
  53         AudioStream (int r, int64_t l)
  54                 : _sample_rate (r)
  55                 , _channel_layout (l)
  56         {}
  57
  58         /* Only used for backwards compatibility for state file version < 1 */
  59         void set_sample_rate (int s) {
  60                 _sample_rate = s;
  61         }
  62
  63         int channels () const {
  64                 return av_get_channel_layout_nb_channels (_channel_layout);
  65         }
  66
  67         int sample_rate () const {
  68                 return _sample_rate;
  69         }
  70
  71         int64_t channel_layout () const {
  72                 return _channel_layout;
  73         }
  74
  75 protected:
  76         AudioStream ()
  77                 : _sample_rate (0)
  78                 , _channel_layout (0)
  79         {}
  80
  81         int _sample_rate;
  82         int64_t _channel_layout;
  83 };
  84
  85 /** @class SubtitleStream
  86  *  @brief A stream of subtitle data.
  87  */
  88 class SubtitleStream : public Stream
  89 {
  90 public:
  91         SubtitleStream (std::string n, int i)
  92                 : _name (n)
  93                 , _id (i)
  94         {}
  95
  96         std::string to_string () const;
  97
  98         std::string name () const {
  99                 return _name;
 100         }
 101
 102         int id () const {
 103                 return _id;
 104         }
 105
 106         static boost::shared_ptr<SubtitleStream> create (std::string t, boost::optional<int> v);
 107
 108 private:
 109         friend class stream_test;
 110
 111         SubtitleStream (std::string t, boost::optional<int> v);
 112
 113         std::string _name;
 114         int _id;
 115 };
 116
 117 boost::shared_ptr<AudioStream> audio_stream_factory (std::string t, boost::optional<int> version);
 118 boost::shared_ptr<SubtitleStream> subtitle_stream_factory (std::string t, boost::optional<int> version);
 119
 120 #endif