VTK: IO/FFMPEG/vtkFFMPEGWriter.h Source File

| VTK 9.3.1

vtkFFMPEGWriter.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
32 #ifndef vtkFFMPEGWriter_h
33 #define vtkFFMPEGWriter_h
34
35 #include "vtkGenericMovieWriter.h"
36 #include "vtkIOFFMPEGModule.h" // For export macro
37
38 VTK_ABI_NAMESPACE_BEGIN
39 class vtkFFMPEGWriterInternal;
40
41 class VTKIOFFMPEG_EXPORT vtkFFMPEGWriter : public vtkGenericMovieWriter
42 {
43 public:
44 static vtkFFMPEGWriter* New();
45 vtkTypeMacro(vtkFFMPEGWriter, vtkGenericMovieWriter);
46 void PrintSelf(ostream& os, vtkIndent indent) override;
47
49
53 void Start() override;
54 void Write() override;
55 void End() override;
57
59
64 vtkSetClampMacro(Quality, int, 0, 2);
65 vtkGetMacro(Quality, int);
67
69
73 vtkSetMacro(Compression, bool);
74 vtkGetMacro(Compression, bool);
75 vtkBooleanMacro(Compression, bool);
77
79
82 vtkSetClampMacro(Rate, int, 1, 5000);
83 vtkGetMacro(Rate, int);
85
87
90 vtkSetMacro(BitRate, int);
91 vtkGetMacro(BitRate, int);
93
95
98 vtkSetMacro(BitRateTolerance, int);
99 vtkGetMacro(BitRateTolerance, int);
101
102 protected:
103 vtkFFMPEGWriter();
104 ~vtkFFMPEGWriter() override;
105
106 vtkFFMPEGWriterInternal* Internals;
107
108 int Initialized;
109 int Quality;
110 int Rate;
111 int BitRate;
112 int BitRateTolerance;
113 bool Compression;
114
115 private:
116 vtkFFMPEGWriter(const vtkFFMPEGWriter&) = delete;
117 void operator=(const vtkFFMPEGWriter&) = delete;
118 };
119
120 VTK_ABI_NAMESPACE_END
121 #endif
vtkFFMPEGWriter
Uses the FFMPEG library to write video files.
Definition: vtkFFMPEGWriter.h:42
vtkFFMPEGWriter::BitRate
int BitRate
Definition: vtkFFMPEGWriter.h:111
vtkFFMPEGWriter::Rate
int Rate
Definition: vtkFFMPEGWriter.h:110
vtkFFMPEGWriter::Internals
vtkFFMPEGWriterInternal * Internals
Definition: vtkFFMPEGWriter.h:106
vtkFFMPEGWriter::Write
void Write() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
vtkFFMPEGWriter::Initialized
int Initialized
Definition: vtkFFMPEGWriter.h:108
vtkFFMPEGWriter::Compression
bool Compression
Definition: vtkFFMPEGWriter.h:113
vtkFFMPEGWriter::End
void End() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
vtkFFMPEGWriter::BitRateTolerance
int BitRateTolerance
Definition: vtkFFMPEGWriter.h:112
vtkFFMPEGWriter::New
static vtkFFMPEGWriter * New()
vtkFFMPEGWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkFFMPEGWriter::~vtkFFMPEGWriter
~vtkFFMPEGWriter() override
vtkFFMPEGWriter::Quality
int Quality
Definition: vtkFFMPEGWriter.h:109
vtkFFMPEGWriter::vtkFFMPEGWriter
vtkFFMPEGWriter()
vtkFFMPEGWriter::Start
void Start() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
vtkGenericMovieWriter
an abstract movie writer class.
Definition: vtkGenericMovieWriter.h:26
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkGenericMovieWriter.h