OpenShot Library | libopenshot  0.3.3
Frame.h
Go to the documentation of this file.
1 
9 // Copyright (c) 2008-2019 OpenShot Studios, LLC
10 //
11 // SPDX-License-Identifier: LGPL-3.0-or-later
12 
13 #ifndef OPENSHOT_FRAME_H
14 #define OPENSHOT_FRAME_H
15 
16 #ifdef USE_OPENCV
17  #define int64 opencv_broken_int
18  #define uint64 opencv_broken_uint
19  #include <opencv2/imgproc/imgproc.hpp>
20  #undef uint64
21  #undef int64
22 #endif
23 
24 #include <memory>
25 #include <mutex>
26 #include <sstream>
27 #include <queue>
28 
29 #include "ChannelLayouts.h"
30 #include "Fraction.h"
31 
32 #include <QColor>
33 #include <QImage>
34 
35 class QApplication;
36 
37 namespace juce {
38  template <typename Type> class AudioBuffer;
39 }
40 
41 namespace openshot
42 {
43  class AudioBufferSource;
44  class AudioResampler;
90  class Frame
91  {
92  private:
93  std::shared_ptr<QImage> image;
94  std::shared_ptr<QImage> wave_image;
95 
96  std::shared_ptr<QApplication> previewApp;
97  std::recursive_mutex addingImageMutex;
98  std::recursive_mutex addingAudioMutex;
99  openshot::Fraction pixel_ratio;
100  int channels;
101  ChannelLayout channel_layout;
102  int width;
103  int height;
104  int sample_rate;
105  std::string color;
106  int64_t max_audio_sample;
107  bool audio_reversed;
108 
109 #ifdef USE_OPENCV
110  cv::Mat imagecv;
111 #endif
112 
114  int constrain(int color_value);
115 
116  public:
117  std::shared_ptr<juce::AudioBuffer<float>> audio;
118  int64_t number;
121 
122 
124  Frame();
125 
127  Frame(int64_t number, int width, int height, std::string color);
128 
130  Frame(int64_t number, int samples, int channels);
131 
133  Frame(int64_t number, int width, int height, std::string color, int samples, int channels);
134 
136  Frame ( const Frame &other );
137 
139  Frame& operator= (const Frame& other);
140 
142  virtual ~Frame();
143 
145  void AddColor(int new_width, int new_height, std::string new_color);
146 
148  void AddColor(const QColor& new_color);
149 
151  void AddImage(int new_width, int new_height, int bytes_per_pixel, QImage::Format type, const unsigned char *pixels_);
152 
154  void AddImage(std::shared_ptr<QImage> new_image);
155 
157  void AddImage(std::shared_ptr<QImage> new_image, bool only_odd_lines);
158 
160  void AddAudio(bool replaceSamples, int destChannel, int destStartSample, const float* source, int numSamples, float gainToApplyToSource);
161 
163  void AddAudioSilence(int numSamples);
164 
166  void ApplyGainRamp(int destChannel, int destStartSample, int numSamples, float initial_gain, float final_gain);
167 
171 
172  // Set the channel layout of audio samples (i.e. mono, stereo, 5 point surround, etc...)
173  void ChannelsLayout(openshot::ChannelLayout new_channel_layout) { channel_layout = new_channel_layout; };
174 
176  void ClearWaveform();
177 
179  void DeepCopy(const Frame& other);
180 
182  void Display();
183 
185  void DisplayWaveform();
186 
188  float GetAudioSample(int channel, int sample, int magnitude_range);
189 
191  float* GetAudioSamples(int channel);
192 
194  float* GetInterleavedAudioSamples(int* sample_count);
195 
197  int GetAudioChannelsCount();
198 
200  int GetAudioSamplesCount();
201 
203 
205  int64_t GetBytes();
206 
208  std::shared_ptr<QImage> GetImage();
209 
211  openshot::Fraction GetPixelRatio() { return pixel_ratio; };
212 
214  const unsigned char* GetPixels();
215 
217  const unsigned char* GetPixels(int row);
218 
220  bool CheckPixel(int row, int col, int red, int green, int blue, int alpha, int threshold);
221 
223  int GetHeight();
224 
226  int GetSamplesPerFrame(openshot::Fraction fps, int sample_rate, int channels);
227 
229  static int GetSamplesPerFrame(int64_t frame_number, openshot::Fraction fps, int sample_rate, int channels);
230 
232  std::shared_ptr<QImage> GetWaveform(int width, int height, int Red, int Green, int Blue, int Alpha);
233 
235  const unsigned char* GetWaveformPixels(int width, int height, int Red, int Green, int Blue, int Alpha);
236 
238  int GetWidth();
239 
241  void ResizeAudio(int channels, int length, int sample_rate, openshot::ChannelLayout channel_layout);
242 
244  int SampleRate();
245 
247  void SampleRate(int orig_sample_rate) { sample_rate = orig_sample_rate; };
248 
251  void ReverseAudio();
252 
254  void Save(std::string path, float scale, std::string format="PNG", int quality=100);
255 
257  void SetFrameNumber(int64_t number);
258 
260  void SetPixelRatio(int num, int den);
261 
264  void Thumbnail(std::string path, int new_width, int new_height, std::string mask_path, std::string overlay_path,
265  std::string background_color, bool ignore_aspect, std::string format="png", int quality=100, float rotate=0.0);
266 
268  void Play();
269 
270 #ifdef USE_OPENCV
271  cv::Mat Qimage2mat( std::shared_ptr<QImage>& qimage);
273 
275  std::shared_ptr<QImage> Mat2Qimage(cv::Mat img);
276 
278  cv::Mat GetImageCV();
279 
281  void SetImageCV(cv::Mat _image);
282 #endif
283  };
284 
285 }
286 
287 #endif
openshot::Frame::GetWaveformPixels
const unsigned char * GetWaveformPixels(int width, int height, int Red, int Green, int Blue, int Alpha)
Get an audio waveform image pixels.
Definition: Frame.cpp:258
openshot::Frame::SampleRate
int SampleRate()
Get the original sample rate of this frame's audio data.
Definition: Frame.cpp:502
ChannelLayouts.h
Header file for ChannelLayout class.
openshot::Frame::operator=
Frame & operator=(const Frame &other)
Assignment operator.
Definition: Frame.cpp:78
Fraction.h
Header file for Fraction class.
openshot::Frame::GetAudioSamples
float * GetAudioSamples(int channel)
Get an array of sample data (and optional reverse the sample values)
Definition: Frame.cpp:314
openshot::Frame::SetFrameNumber
void SetFrameNumber(int64_t number)
Set frame number.
Definition: Frame.cpp:450
openshot::Frame::has_audio_data
bool has_audio_data
This frame has been loaded with audio data.
Definition: Frame.h:119
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
juce::AudioBuffer
Definition: Frame.h:38
openshot::Fraction
This class represents a fraction.
Definition: Fraction.h:30
openshot::Frame::GetPixelRatio
openshot::Fraction GetPixelRatio()
Set Pixel Aspect Ratio.
Definition: Frame.h:211
openshot::Frame::Thumbnail
void Thumbnail(std::string path, int new_width, int new_height, std::string mask_path, std::string overlay_path, std::string background_color, bool ignore_aspect, std::string format="png", int quality=100, float rotate=0.0)
Definition: Frame.cpp:543
openshot::Frame
This class represents a single frame of video (i.e. image & audio data)
Definition: Frame.h:90
openshot::Frame::ChannelsLayout
void ChannelsLayout(openshot::ChannelLayout new_channel_layout)
Definition: Frame.h:173
openshot::Frame::has_image_data
bool has_image_data
This frame has been loaded with pixel data.
Definition: Frame.h:120
openshot::Frame::AddAudioSilence
void AddAudioSilence(int numSamples)
Add audio silence.
Definition: Frame.cpp:987
openshot::Frame::GetBytes
int64_t GetBytes()
Get the size in bytes of this frame (rough estimate)
Definition: Frame.cpp:380
openshot::Frame::ResizeAudio
void ResizeAudio(int channels, int length, int sample_rate, openshot::ChannelLayout channel_layout)
Resize audio container to hold more (or less) samples and channels.
Definition: Frame.cpp:792
openshot::Frame::ReverseAudio
void ReverseAudio()
Definition: Frame.cpp:807
openshot::Frame::GetPixels
const unsigned char * GetPixels()
Get pixel data (as packets)
Definition: Frame.cpp:397
openshot::Frame::AddImage
void AddImage(int new_width, int new_height, int bytes_per_pixel, QImage::Format type, const unsigned char *pixels_)
Add (or replace) pixel data to the frame.
Definition: Frame.cpp:700
juce
Definition: Robotization.h:29
openshot::Frame::ApplyGainRamp
void ApplyGainRamp(int destChannel, int destStartSample, int numSamples, float initial_gain, float final_gain)
Apply gain ramp (i.e. fading volume)
Definition: Frame.cpp:847
openshot::Frame::GetAudioChannelsCount
int GetAudioChannelsCount()
Get number of audio channels.
Definition: Frame.cpp:358
openshot::Frame::GetHeight
int GetHeight()
Get height of image.
Definition: Frame.cpp:490
path
path
Definition: FFmpegWriter.cpp:1479
openshot::Frame::GetSamplesPerFrame
int GetSamplesPerFrame(openshot::Fraction fps, int sample_rate, int channels)
Calculate the # of samples per video frame (for the current frame number)
Definition: Frame.cpp:484
openshot::Frame::GetInterleavedAudioSamples
float * GetInterleavedAudioSamples(int *sample_count)
Get an array of sample data (all channels interleaved together), using any sample rate.
Definition: Frame.cpp:324
openshot::Frame::CheckPixel
bool CheckPixel(int row, int col, int red, int green, int blue, int alpha, int threshold)
Check a specific pixel color value (returns True/False)
Definition: Frame.cpp:421
openshot::Frame::GetWaveform
std::shared_ptr< QImage > GetWaveform(int width, int height, int Red, int Green, int Blue, int Alpha)
Get an audio waveform image.
Definition: Frame.cpp:159
openshot::Frame::AddAudio
void AddAudio(bool replaceSamples, int destChannel, int destStartSample, const float *source, int numSamples, float gainToApplyToSource)
Add audio samples to a specific channel.
Definition: Frame.cpp:816
openshot::Frame::SampleRate
void SampleRate(int orig_sample_rate)
Set the original sample rate of this frame's audio data.
Definition: Frame.h:247
openshot::Frame::GetWidth
int GetWidth()
Get height of image.
Definition: Frame.cpp:496
openshot::Frame::audio
std::shared_ptr< juce::AudioBuffer< float > > audio
Definition: Frame.h:117
openshot::Frame::ClearWaveform
void ClearWaveform()
Clear the waveform image (and deallocate its memory)
Definition: Frame.cpp:251
openshot::Frame::SetPixelRatio
void SetPixelRatio(int num, int den)
Set Pixel Aspect Ratio.
Definition: Frame.cpp:443
openshot::Frame::Save
void Save(std::string path, float scale, std::string format="PNG", int quality=100)
Save the frame image to the specified path. The image format can be BMP, JPG, JPEG,...
Definition: Frame.cpp:515
openshot::Frame::GetImage
std::shared_ptr< QImage > GetImage()
Get pointer to Qt QImage image object.
Definition: Frame.cpp:856
openshot::Frame::GetImageCV
cv::Mat GetImageCV()
Get pointer to OpenCV Mat image object.
Definition: Frame.cpp:880
openshot::Frame::ChannelsLayout
openshot::ChannelLayout ChannelsLayout()
Definition: Frame.cpp:508
openshot::Frame::GetAudioSampleBuffer
juce::AudioBuffer< float > * GetAudioSampleBuffer()
Definition: Frame.cpp:374
openshot::ChannelLayout
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Definition: ChannelLayouts.h:28
openshot::Frame::Play
void Play()
Play audio samples for this frame.
Definition: Frame.cpp:916
openshot::Frame::DeepCopy
void DeepCopy(const Frame &other)
Copy data and pointers from another Frame instance.
Definition: Frame.cpp:87
openshot::Frame::GetAudioSample
float GetAudioSample(int channel, int sample, int magnitude_range)
Get magnitude of range of samples (if channel is -1, return average of all channels for that sample)
Definition: Frame.cpp:301
openshot::Frame::number
int64_t number
This is the frame number (starting at 1)
Definition: Frame.h:118
openshot::Frame::Mat2Qimage
std::shared_ptr< QImage > Mat2Qimage(cv::Mat img)
Convert OpenCV Mat to QImage.
Definition: Frame.cpp:894
openshot::Frame::SetImageCV
void SetImageCV(cv::Mat _image)
Set pointer to OpenCV image object.
Definition: Frame.cpp:908
openshot::Frame::Display
void Display()
Display the frame image to the screen (primarily used for debugging reasons)
Definition: Frame.cpp:120
openshot::Frame::~Frame
virtual ~Frame()
Destructor.
Definition: Frame.cpp:110
openshot::Frame::Qimage2mat
cv::Mat Qimage2mat(std::shared_ptr< QImage > &qimage)
Convert Qimage to Mat.
Definition: Frame.cpp:869
openshot::Frame::Frame
Frame()
Constructor - blank frame.
Definition: Frame.cpp:59
openshot::Frame::GetAudioSamplesCount
int GetAudioSamplesCount()
Get number of audio samples.
Definition: Frame.cpp:368
openshot::Frame::AddColor
void AddColor(int new_width, int new_height, std::string new_color)
Add (or replace) pixel data to the frame (based on a solid color)
Definition: Frame.cpp:677
openshot::Frame::DisplayWaveform
void DisplayWaveform()
Display the wave form.
Definition: Frame.cpp:268