VTK  9.2.20230321
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 =========================================================================*/
54 #ifndef vtkFFMPEGWriter_h
55 #define vtkFFMPEGWriter_h
56 
57 #include "vtkGenericMovieWriter.h"
58 #include "vtkIOFFMPEGModule.h" // For export macro
59 
60 VTK_ABI_NAMESPACE_BEGIN
61 class vtkFFMPEGWriterInternal;
62 
63 class VTKIOFFMPEG_EXPORT vtkFFMPEGWriter : public vtkGenericMovieWriter
64 {
65 public:
66  static vtkFFMPEGWriter* New();
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
71 
75  void Start() override;
76  void Write() override;
77  void End() override;
79 
81 
86  vtkSetClampMacro(Quality, int, 0, 2);
87  vtkGetMacro(Quality, int);
89 
91 
95  vtkSetMacro(Compression, bool);
96  vtkGetMacro(Compression, bool);
97  vtkBooleanMacro(Compression, bool);
99 
101 
104  vtkSetClampMacro(Rate, int, 1, 5000);
105  vtkGetMacro(Rate, int);
107 
109 
112  vtkSetMacro(BitRate, int);
113  vtkGetMacro(BitRate, int);
115 
117 
120  vtkSetMacro(BitRateTolerance, int);
121  vtkGetMacro(BitRateTolerance, int);
123 
124 protected:
126  ~vtkFFMPEGWriter() override;
127 
128  vtkFFMPEGWriterInternal* Internals;
129 
131  int Quality;
132  int Rate;
133  int BitRate;
136 
137 private:
138  vtkFFMPEGWriter(const vtkFFMPEGWriter&) = delete;
139  void operator=(const vtkFFMPEGWriter&) = delete;
140 };
141 
142 VTK_ABI_NAMESPACE_END
143 #endif
Uses the FFMPEG library to write video files.
vtkFFMPEGWriterInternal * Internals
void Write() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
void End() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
static vtkFFMPEGWriter * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkFFMPEGWriter() override
void Start() override
These methods start writing an Movie file, write a frame to the file and then end the writing process...
an abstract movie writer class.
a simple class to control print indentation
Definition: vtkIndent.h:120