From bc9458cbe39a24d22c199c82efab524208dc347d Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Wed, 2 Jul 2014 09:47:11 +0100 Subject: Clarify that Encoder really just manages video encoding. --- src/lib/encoder.h | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'src/lib/encoder.h') diff --git a/src/lib/encoder.h b/src/lib/encoder.h index 4502b7151..51df0176b 100644 --- a/src/lib/encoder.h +++ b/src/lib/encoder.h @@ -52,31 +52,28 @@ class ServerFinder; class PlayerVideo; /** @class Encoder - * @brief Encoder to J2K and WAV for DCP. + * @brief Class to manage encoding to JPEG2000. * - * Video is supplied to process_video as RGB frames, and audio - * is supplied as uncompressed PCM in blocks of various sizes. + * This class keeps a queue of frames to be encoded and distributes + * the work around threads and encoding servers. */ class Encoder : public boost::noncopyable, public ExceptionStore { public: - Encoder (boost::shared_ptr f, boost::weak_ptr); + Encoder (boost::shared_ptr f, boost::weak_ptr, boost::shared_ptr); virtual ~Encoder (); /** Called to indicate that a processing run is about to begin */ - void process_begin (); + void begin (); /** Call with a frame of video. * @param f Video frame. */ - void process_video (boost::shared_ptr f); - - /** Call with some audio data */ - void process_audio (boost::shared_ptr); + void enqueue (boost::shared_ptr f); /** Called when a processing run has finished */ - void process_end (); + void end (); float current_encoding_rate () const; int video_frames_out () const; -- cgit v1.2.3