VTK  9.0.20201202
vtkFFMPEGWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkFFMPEGWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
32 #ifndef vtkFFMPEGWriter_h
33 #define vtkFFMPEGWriter_h
34 
35 #include "vtkGenericMovieWriter.h"
36 #include "vtkIOFFMPEGModule.h" // For export macro
37 
38 class vtkFFMPEGWriterInternal;
39 
40 class VTKIOFFMPEG_EXPORT vtkFFMPEGWriter : public vtkGenericMovieWriter
41 {
42 public:
43  static vtkFFMPEGWriter* New();
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
48 
52  void Start() override;
53  void Write() override;
54  void End() override;
56 
58 
63  vtkSetClampMacro(Quality, int, 0, 2);
64  vtkGetMacro(Quality, int);
66 
68 
72  vtkSetMacro(Compression, bool);
73  vtkGetMacro(Compression, bool);
74  vtkBooleanMacro(Compression, bool);
76 
78 
81  vtkSetClampMacro(Rate, int, 1, 5000);
82  vtkGetMacro(Rate, int);
84 
86 
89  vtkSetMacro(BitRate, int);
90  vtkGetMacro(BitRate, int);
92 
94 
97  vtkSetMacro(BitRateTolerance, int);
98  vtkGetMacro(BitRateTolerance, int);
100 
101 protected:
102  vtkFFMPEGWriter();
103  ~vtkFFMPEGWriter() override;
104 
105  vtkFFMPEGWriterInternal* Internals;
106 
108  int Quality;
109  int Rate;
110  int BitRate;
113 
114 private:
115  vtkFFMPEGWriter(const vtkFFMPEGWriter&) = delete;
116  void operator=(const vtkFFMPEGWriter&) = delete;
117 };
118 
119 #endif
vtkFFMPEGWriter::Compression
bool Compression
Definition: vtkFFMPEGWriter.h:112
vtkGenericMovieWriter.h
vtkFFMPEGWriter::Initialized
int Initialized
Definition: vtkFFMPEGWriter.h:107
vtkFFMPEGWriter
Uses the FFMPEG library to write video files.
Definition: vtkFFMPEGWriter.h:40
vtkGenericMovieWriter::Write
virtual void Write()=0
vtkFFMPEGWriter::Rate
int Rate
Definition: vtkFFMPEGWriter.h:109
vtkGenericMovieWriter::End
virtual void End()=0
vtkFFMPEGWriter::Quality
int Quality
Definition: vtkFFMPEGWriter.h:108
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkFFMPEGWriter::BitRate
int BitRate
Definition: vtkFFMPEGWriter.h:110
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkGenericMovieWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGenericMovieWriter
an abstract movie writer class.
Definition: vtkGenericMovieWriter.h:36
vtkGenericMovieWriter::Start
virtual void Start()=0
These methods start writing an Movie file, write a frame to the file and then end the writing process...
vtkFFMPEGWriter::Internals
vtkFFMPEGWriterInternal * Internals
Definition: vtkFFMPEGWriter.h:105
vtkFFMPEGWriter::BitRateTolerance
int BitRateTolerance
Definition: vtkFFMPEGWriter.h:111