/usr/include/libopenshot/Frame.h is in libopenshot-dev 0.1.9+dfsg1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | /**
* @file
* @brief Header file for Frame class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_FRAME_H
#define OPENSHOT_FRAME_H
/// Do not include the juce unittest headers, because it collides with unittest++
#ifndef __JUCE_UNITTEST_JUCEHEADER__
#define __JUCE_UNITTEST_JUCEHEADER__
#endif
#ifndef _NDEBUG
// Define NO debug for JUCE on mac os
#define _NDEBUG
#endif
#include <iomanip>
#include <sstream>
#include <queue>
#include <QtWidgets/QApplication>
#include <QtGui/QImage>
#include <QtGui/QColor>
#include <QtGui/QBitmap>
#include <QtCore/QString>
#include <QtCore/QVector>
#include <QtGui/QPainter>
#include <QtWidgets/QHBoxLayout>
#include <QtWidgets/QWidget>
#include <QtWidgets/QLabel>
#include <memory>
#include <unistd.h>
#include "ZmqLogger.h"
#ifdef USE_IMAGEMAGICK
#include "Magick++.h"
#endif
#include "JuceLibraryCode/JuceHeader.h"
#include "ChannelLayouts.h"
#include "AudioBufferSource.h"
#include "AudioResampler.h"
#include "Fraction.h"
using namespace std;
namespace openshot
{
/**
* @brief This class represents a single frame of video (i.e. image & audio data)
*
* FileReaders (such as FFmpegReader) use instances of this class to store the individual frames of video,
* which include both the image data (i.e. pixels) and audio samples. An openshot::Frame also has many debug
* methods, such as the ability to display the image (using X11), play the audio samples (using JUCE), or
* display the audio waveform as an image.
*
* FileWriters (such as FFmpegWriter) use instances of this class to create new video files, image files, or
* video streams. So, think of these openshot::Frame instances as the smallest unit of work in a video
* editor.
*
* There are many ways to create an instance of an openshot::Frame:
* @code
*
* // Most basic: a blank frame (300x200 blank image, 48kHz audio silence)
* Frame();
*
* // Image only settings (48kHz audio silence)
* Frame(1, // Frame number
* 720, // Width of image
* 480, // Height of image
* "#000000" // HTML color code of background color
* );
*
* // Audio only (300x200 blank image)
* Frame(number, // Frame number
* 44100, // Sample rate of audio stream
* 2 // Number of audio channels
* );
*
* // Image and Audio settings (user defines all key settings)
* Frame(number, // Frame number
* 720, // Width of image
* 480, // Height of image
* "#000000" // HTML color code of background color
* 44100, // Sample rate of audio stream
* 2 // Number of audio channels
* );
*
* // Some methods require a shared pointer to an openshot::Frame object.
* std::shared_ptr<Frame> f(new Frame(1, 720, 480, "#000000", 44100, 2));
*
* @endcode
*/
class Frame
{
private:
std::shared_ptr<QImage> image;
std::shared_ptr<QImage> wave_image;
std::shared_ptr<juce::AudioSampleBuffer> audio;
std::shared_ptr<QApplication> previewApp;
CriticalSection addingImageSection;
CriticalSection addingAudioSection;
const unsigned char *qbuffer;
Fraction pixel_ratio;
int channels;
ChannelLayout channel_layout;
int width;
int height;
int sample_rate;
/// Constrain a color value from 0 to 255
int constrain(int color_value);
public:
int64_t number; ///< This is the frame number (starting at 1)
bool has_audio_data; ///< This frame has been loaded with audio data
bool has_image_data; ///< This frame has been loaded with pixel data
/// Constructor - blank frame (300x200 blank image, 48kHz audio silence)
Frame();
/// Constructor - image only (48kHz audio silence)
Frame(int64_t number, int width, int height, string color);
/// Constructor - audio only (300x200 blank image)
Frame(int64_t number, int samples, int channels);
/// Constructor - image & audio
Frame(int64_t number, int width, int height, string color, int samples, int channels);
/// Copy constructor
Frame ( const Frame &other );
/// Assignment operator
//Frame& operator= (const Frame& other);
/// Destructor
~Frame();
/// Add (or replace) pixel data to the frame (based on a solid color)
void AddColor(int new_width, int new_height, string color);
/// Add (or replace) pixel data to the frame
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
void AddImage(std::shared_ptr<QImage> new_image);
/// Add (or replace) pixel data to the frame (for only the odd or even lines)
void AddImage(std::shared_ptr<QImage> new_image, bool only_odd_lines);
#ifdef USE_IMAGEMAGICK
/// Add (or replace) pixel data to the frame from an ImageMagick Image
void AddMagickImage(std::shared_ptr<Magick::Image> new_image);
#endif
/// Add audio samples to a specific channel
void AddAudio(bool replaceSamples, int destChannel, int destStartSample, const float* source, int numSamples, float gainToApplyToSource);
/// Add audio silence
void AddAudioSilence(int numSamples);
/// Apply gain ramp (i.e. fading volume)
void ApplyGainRamp(int destChannel, int destStartSample, int numSamples, float initial_gain, float final_gain);
/// Channel Layout of audio samples. A frame needs to keep track of this, since Writers do not always
/// know the original channel layout of a frame's audio samples (i.e. mono, stereo, 5 point surround, etc...)
ChannelLayout ChannelsLayout();
// Set the channel layout of audio samples (i.e. mono, stereo, 5 point surround, etc...)
void ChannelsLayout(ChannelLayout new_channel_layout) { channel_layout = new_channel_layout; };
/// Clean up buffer after QImage is deleted
static void cleanUpBuffer(void *info);
/// Clear the waveform image (and deallocate it's memory)
void ClearWaveform();
/// Copy data and pointers from another Frame instance
void DeepCopy(const Frame& other);
/// Display the frame image to the screen (primarily used for debugging reasons)
void Display();
/// Display the wave form
void DisplayWaveform();
/// Get magnitude of range of samples (if channel is -1, return average of all channels for that sample)
float GetAudioSample(int channel, int sample, int magnitude_range);
/// Get an array of sample data
float* GetAudioSamples(int channel);
/// Get an array of sample data (all channels interleaved together), using any sample rate
float* GetInterleavedAudioSamples(int new_sample_rate, AudioResampler* resampler, int* sample_count);
// Get a planar array of sample data, using any sample rate
float* GetPlanarAudioSamples(int new_sample_rate, AudioResampler* resampler, int* sample_count);
/// Get number of audio channels
int GetAudioChannelsCount();
/// Get number of audio samples
int GetAudioSamplesCount();
juce::AudioSampleBuffer *GetAudioSampleBuffer();
/// Get the size in bytes of this frame (rough estimate)
int64_t GetBytes();
/// Get pointer to Qt QImage image object
std::shared_ptr<QImage> GetImage();
#ifdef USE_IMAGEMAGICK
/// Get pointer to ImageMagick image object
std::shared_ptr<Magick::Image> GetMagickImage();
#endif
/// Set Pixel Aspect Ratio
Fraction GetPixelRatio() { return pixel_ratio; };
/// Get pixel data (as packets)
const unsigned char* GetPixels();
/// Get pixel data (for only a single scan-line)
const unsigned char* GetPixels(int row);
/// Get height of image
int GetHeight();
/// Calculate the # of samples per video frame (for the current frame number)
int GetSamplesPerFrame(Fraction fps, int sample_rate, int channels);
/// Calculate the # of samples per video frame (for a specific frame number and frame rate)
static int GetSamplesPerFrame(int64_t frame_number, Fraction fps, int sample_rate, int channels);
/// Get an audio waveform image
std::shared_ptr<QImage> GetWaveform(int width, int height, int Red, int Green, int Blue, int Alpha);
/// Get an audio waveform image pixels
const unsigned char* GetWaveformPixels(int width, int height, int Red, int Green, int Blue, int Alpha);
/// Get height of image
int GetWidth();
/// Resize audio container to hold more (or less) samples and channels
void ResizeAudio(int channels, int length, int sample_rate, ChannelLayout channel_layout);
/// Get the original sample rate of this frame's audio data
int SampleRate();
/// Set the original sample rate of this frame's audio data
void SampleRate(int orig_sample_rate) { sample_rate = orig_sample_rate; };
/// Save the frame image to the specified path. The image format can be BMP, JPG, JPEG, PNG, PPM, XBM, XPM
void Save(string path, float scale, string format="PNG", int quality=100);
/// Set frame number
void SetFrameNumber(int64_t number);
/// Set Pixel Aspect Ratio
void SetPixelRatio(int num, int den);
/// Thumbnail the frame image with tons of options to the specified path. The image format is determined from the extension (i.e. image.PNG, image.JPEG).
/// This method allows for masks, overlays, background color, and much more accurate resizing (including padding and centering)
void Thumbnail(string path, int new_width, int new_height, string mask_path, string overlay_path,
string background_color, bool ignore_aspect, string format="png", int quality=100);
/// Play audio samples for this frame
void Play();
};
}
#endif
|