VTK  9.2.5
vtkFFMPEGVideoSource.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkFFMPEGVideoSource.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=========================================================================*/
30#ifndef vtkFFMPEGVideoSource_h
31#define vtkFFMPEGVideoSource_h
32
33#include "vtkIOFFMPEGModule.h" // For export macro
34#include "vtkMultiThreader.h" // for ivar
35#include "vtkNew.h" // for ivar
36#include "vtkVideoSource.h"
37#include <condition_variable> // for std::condition_variable_any
38#include <functional> // for audio callback
39#include <mutex> // for std::mutex
40
41class vtkFFMPEGVideoSourceInternal;
43
44// audio callback struct, outside the class so that we
45// can forward ref it
47{
53 bool Packed;
54 unsigned char** Data;
57};
58
59// video callback struct, outside the class so that we
60// can forward ref it
62{
63 int Height;
64 int LineSize[8];
65 unsigned char* Data[8]; // nullptr for empty planes
68};
69
70class VTKIOFFMPEG_EXPORT vtkFFMPEGVideoSource : public vtkVideoSource
71{
72public:
75 void PrintSelf(ostream& os, vtkIndent indent) override;
76
80 void Record() override;
81
85 void Play() override;
86
90 void Stop() override;
91
95 void Grab() override;
96
98
101 void SetFrameSize(int x, int y, int z) override;
102 void SetFrameSize(int dim[3]) override { this->SetFrameSize(dim[0], dim[1], dim[2]); }
104
108 void SetFrameRate(float rate) override;
109
113 void SetOutputFormat(int format) override;
114
119 void Initialize() override;
120
125 void ReleaseSystemResources() override;
126
128
134
140 void InternalGrab() override;
141
142 // is the video at the end of file?
143 // Useful for while loops
144 vtkGetMacro(EndOfFile, bool);
145
146 // Is the video stream stereo 3d
147 vtkGetMacro(Stereo3D, bool);
148
149 // we do not use Invoke Observers here because this callback
150 // will happen in a different thread that could conflict
151 // with events from other threads. In this function you should
152 // not block the thread (for example waiting for audio to play)
153 // instead you should have enough buffering that you can consume
154 // the provided data and return. Typically even 1 second of
155 // buffer storage is enough to prevent blocking.
156 typedef std::function<void(vtkFFMPEGVideoSourceAudioCallbackData const& data)> AudioCallbackType;
157 void SetAudioCallback(AudioCallbackType cb, void* clientData)
158 {
159 this->AudioCallback = cb;
160 this->AudioCallbackClientData = clientData;
161 }
162
163 // we do not use Invoke Observers here because this callback
164 // will happen in a different thread that could conflict
165 // with events from other threads. In this function you should
166 // not block the thread (for example waiting for video to play)
167 // instead you should have enough buffering that you can consume
168 // the provided data and return.
169 typedef std::function<void(vtkFFMPEGVideoSourceVideoCallbackData const& data)> VideoCallbackType;
170 void SetVideoCallback(VideoCallbackType cb, void* clientData)
171 {
172 this->VideoCallback = cb;
173 this->VideoCallbackClientData = clientData;
174 }
175
177
182 vtkSetMacro(DecodingThreads, int);
183 vtkGetMacro(DecodingThreads, int);
185
186protected:
189
192
194
198
202
204
205 std::condition_variable_any FeedCondition;
206 std::mutex FeedMutex;
207 std::condition_variable_any FeedAudioCondition;
208 std::mutex FeedAudioMutex;
212
213 char* FileName;
214
215 vtkFFMPEGVideoSourceInternal* Internal;
216
217 void ReadFrame();
218
220
223
224private:
226 void operator=(const vtkFFMPEGVideoSource&) = delete;
227};
228
229#endif
Reader for ffmpeg supported formats.
static void * DrainAudioThread(vtkMultiThreader::ThreadInfo *data)
std::function< void(vtkFFMPEGVideoSourceVideoCallbackData const &data)> VideoCallbackType
vtkFFMPEGVideoSourceInternal * Internal
std::function< void(vtkFFMPEGVideoSourceAudioCallbackData const &data)> AudioCallbackType
void * Drain(vtkMultiThreader::ThreadInfo *data)
void SetVideoCallback(VideoCallbackType cb, void *clientData)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetFrameSize(int dim[3]) override
Request a particular frame size (set the third value to 1).
std::condition_variable_any FeedAudioCondition
void Record() override
Standard VCR functionality: Record incoming video.
~vtkFFMPEGVideoSource() override
void Stop() override
Standard VCR functionality: Stop recording or playing.
void * DrainAudio(vtkMultiThreader::ThreadInfo *data)
void Play() override
Standard VCR functionality: Play recorded video.
void InternalGrab() override
The internal function which actually does the grab.
static void * FeedThread(vtkMultiThreader::ThreadInfo *data)
static void * DrainThread(vtkMultiThreader::ThreadInfo *data)
void SetFrameSize(int x, int y, int z) override
Request a particular frame size (set the third value to 1).
VideoCallbackType VideoCallback
void SetFrameRate(float rate) override
Request a particular frame rate (default 30 frames per second).
static vtkFFMPEGVideoSource * New()
void SetAudioCallback(AudioCallbackType cb, void *clientData)
std::condition_variable_any FeedCondition
void Grab() override
Grab a single video frame.
AudioCallbackType AudioCallback
void ReleaseSystemResources() override
Free the driver (this is called automatically inside the destructor).
void SetOutputFormat(int format) override
Request a particular output format (default: VTK_RGB).
vtkSetFilePathMacro(FileName)
Specify file name of the video.
vtkGetFilePathMacro(FileName)
Specify file name of the video.
void Initialize() override
Initialize the driver (this is called automatically when the first grab is done).
void * Feed(vtkMultiThreader::ThreadInfo *data)
a simple class to control print indentation
Definition: vtkIndent.h:40
This is the structure that is passed to the thread that is created from the SingleMethodExecute,...
Superclass of video input devices for VTK.