src/lib/processor.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/processor.h
  21  *  @brief Parent class for classes which accept and then emit video or audio data.
  22  */
  23
  24 #ifndef DCPOMATIC_PROCESSOR_H
  25 #define DCPOMATIC_PROCESSOR_H
  26
  27 #include "video_source.h"
  28 #include "video_sink.h"
  29 #include "audio_source.h"
  30 #include "audio_sink.h"
  31
  32 class Log;
  33
  34 /** @class Processor
  35  *  @brief Base class for processors.
  36  */
  37 class Processor
  38 {
  39 public:
  40         /** Construct a Processor.
  41          *  @param log Log to use.
  42          */
  43         Processor (boost::shared_ptr<Log> log)
  44                 : _log (log)
  45         {}
  46
  47         virtual ~Processor() {}
  48
  49         /** Will be called at the end of a processing run */
  50         virtual void process_end () {}
  51
  52 protected:
  53         boost::shared_ptr<Log> _log; ///< log to write to
  54 };
  55
  56 /** @class AudioVideoProcessor
  57  *  @brief A processor which handles both video and audio data.
  58  */
  59 class AudioVideoProcessor : public Processor, public VideoSource, public VideoSink, public AudioSource, public AudioSink
  60 {
  61 public:
  62         /** Construct an AudioVideoProcessor.
  63          *  @param log Log to write to.
  64          */
  65         AudioVideoProcessor (boost::shared_ptr<Log> log)
  66                 : Processor (log)
  67         {}
  68 };
  69
  70 /** @class AudioProcessor
  71  *  @brief A processor which handles just audio data.
  72  */
  73 class AudioProcessor : public Processor, public AudioSource, public AudioSink
  74 {
  75 public:
  76         /** Construct an AudioProcessor.
  77          *  @param log Log to write to.
  78          */
  79         AudioProcessor (boost::shared_ptr<Log> log)
  80                 : Processor (log)
  81         {}
  82 };
  83
  84 /** @class VideoProcessor
  85  *  @brief A processor which handles just video data.
  86  */
  87 class VideoProcessor : public Processor, public VideoSource, public VideoSink
  88 {
  89 public:
  90         /** Construct an VideoProcessor.
  91          *  @param log Log to write to.
  92          */
  93         VideoProcessor (boost::shared_ptr<Log> log)
  94                 : Processor (log)
  95         {}
  96 };
  97
  98 #endif