src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-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 /** @file  src/decoder.h
  21  *  @brief Parent class for decoders of content.
  22  */
  23
  24 #ifndef DCPOMATIC_DECODER_H
  25 #define DCPOMATIC_DECODER_H
  26
  27 #include <vector>
  28 #include <string>
  29 #include <stdint.h>
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/signals2.hpp>
  32 #include "video_source.h"
  33 #include "audio_source.h"
  34 #include "film.h"
  35
  36 class Image;
  37 class Log;
  38 class DelayLine;
  39 class TimedSubtitle;
  40 class Subtitle;
  41 class FilterGraph;
  42
  43 /** @class Decoder.
  44  *  @brief Parent class for decoders of content.
  45  */
  46 class Decoder
  47 {
  48 public:
  49         Decoder (boost::shared_ptr<const Film>);
  50         virtual ~Decoder () {}
  51
  52         /** Perform one decode pass of the content, which may or may not
  53          *  cause the object to emit some data.
  54          */
  55         virtual void pass () = 0;
  56
  57         /** Seek this decoder to as close as possible to some time,
  58          *  expressed relative to our source's start.
  59          *  @param t Time.
  60          *  @param a true to try hard to be accurate, otherwise false.
  61          */
  62         virtual void seek (Time) = 0;
  63
  64         /** Seek back one video frame */
  65         virtual void seek_back () = 0;
  66
  67         /** Seek forward one video frame */
  68         virtual void seek_forward () = 0;
  69
  70         /** @return Approximate time of the next content that we will emit,
  71          *  expressed relative to the start of our source.
  72          */
  73         virtual Time next () const = 0;
  74
  75         virtual bool done () const = 0;
  76
  77 protected:
  78
  79         /** The Film that we are decoding in */
  80         boost::weak_ptr<const Film> _film;
  81
  82 private:
  83         /** This will be called when our Film emits Changed */
  84         virtual void film_changed (Film::Property) {}
  85
  86         /** Connection to our Film */
  87         boost::signals2::scoped_connection _film_connection;
  88 };
  89
  90 #endif