Merge branch 'master' into 1.0

[dcpomatic.git] / src / lib / processor.h

diff --git a/src/lib/processor.h b/src/lib/processor.h
index 53e5dae2b7e0a8e27b908be06ef3257bd97aee57..7b7735faafa139a43b60f69f1796387edf79e413 100644 (file)
--- a/src/lib/processor.h
+++ b/src/lib/processor.h
@@ -17,8 +17,12 @@
 
 */
 
-#ifndef DVDOMATIC_PROCESSOR_H
-#define DVDOMATIC_PROCESSOR_H
+/** @file  src/processor.h
+ *  @brief Parent class for classes which accept and then emit video or audio data.
+ */
+
+#ifndef DCPOMATIC_PROCESSOR_H
+#define DCPOMATIC_PROCESSOR_H
 
 #include "video_source.h"
 #include "video_sink.h"
@@ -27,42 +31,85 @@
 
 class Log;
 
+/** @class Processor
+ *  @brief Base class for processors.
+ */
 class Processor
 {
 public:
-       Processor (Log* log)
+       /** Construct a Processor.
+        *  @param log Log to use.
+        */
+       Processor (boost::shared_ptr<Log> log)
                : _log (log)
        {}
-       
-       virtual void process_begin () {}
+
+       virtual ~Processor() {}
+
+       /** Will be called at the end of a processing run */
        virtual void process_end () {}
 
 protected:
-       Log* _log;
+       boost::shared_ptr<Log> _log; ///< log to write to
 };
 
+/** @class AudioVideoProcessor
+ *  @brief A processor which handles both video and audio data.
+ */
 class AudioVideoProcessor : public Processor, public VideoSource, public VideoSink, public AudioSource, public AudioSink
 {
 public:
-       AudioVideoProcessor (Log* log)
+       /** Construct an AudioVideoProcessor.
+        *  @param log Log to write to.
+        */
+       AudioVideoProcessor (boost::shared_ptr<Log> log)
+               : Processor (log)
+       {}
+};
+
+class TimedAudioVideoProcessor : public Processor, public TimedVideoSource, public TimedVideoSink, public TimedAudioSource, public TimedAudioSink
+{
+public:
+       TimedAudioVideoProcessor (boost::shared_ptr<Log> log)
                : Processor (log)
        {}
 };
+                               
 
+/** @class AudioProcessor
+ *  @brief A processor which handles just audio data.
+ */
 class AudioProcessor : public Processor, public AudioSource, public AudioSink
 {
 public:
-       AudioProcessor (Log* log)
+       /** Construct an AudioProcessor.
+        *  @param log Log to write to.
+        */
+       AudioProcessor (boost::shared_ptr<Log> log)
                : Processor (log)
        {}
 };
 
+/** @class VideoProcessor
+ *  @brief A processor which handles just video data.
+ */
 class VideoProcessor : public Processor, public VideoSource, public VideoSink
 {
 public:
-       VideoProcessor (Log* log)
+       /** Construct an VideoProcessor.
+        *  @param log Log to write to.
+        */
+       VideoProcessor (boost::shared_ptr<Log> log)
                : Processor (log)
        {}
 };
 
+class TimedVideoProcessor : public Processor, public TimedVideoSource, public TimedVideoSink
+{
+public:
+       TimedVideoProcessor (boost::shared_ptr<Log> log)
+               : Processor (log)
+       {}
+};     
+
 #endif