OpenShot Library | libopenshot
0.2.2
include
effects
Saturation.h
Go to the documentation of this file.
1
/**
2
* @file
3
* @brief Header file for Saturation class
4
* @author Jonathan Thomas <jonathan@openshot.org>
5
*
6
* @section LICENSE
7
*
8
* Copyright (c) 2008-2014 OpenShot Studios, LLC
9
* <http://www.openshotstudios.com/>. This file is part of
10
* OpenShot Library (libopenshot), an open-source project dedicated to
11
* delivering high quality video editing and animation solutions to the
12
* world. For more information visit <http://www.openshot.org/>.
13
*
14
* OpenShot Library (libopenshot) is free software: you can redistribute it
15
* and/or modify it under the terms of the GNU Lesser General Public License
16
* as published by the Free Software Foundation, either version 3 of the
17
* License, or (at your option) any later version.
18
*
19
* OpenShot Library (libopenshot) is distributed in the hope that it will be
20
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22
* GNU Lesser General Public License for more details.
23
*
24
* You should have received a copy of the GNU Lesser General Public License
25
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
26
*/
27
28
#ifndef OPENSHOT_SATURATION_EFFECT_H
29
#define OPENSHOT_SATURATION_EFFECT_H
30
31
#include "../EffectBase.h"
32
33
#include <cmath>
34
#include <ctime>
35
#include <iostream>
36
#include <omp.h>
37
#include <stdio.h>
38
#include <memory>
39
#include "../Color.h"
40
#include "../Exceptions.h"
41
#include "../Json.h"
42
#include "../KeyFrame.h"
43
#include "../ReaderBase.h"
44
#include "../FFmpegReader.h"
45
#include "../QtImageReader.h"
46
#include "../ChunkReader.h"
47
48
using namespace
std;
49
50
namespace
openshot
51
{
52
53
/**
54
* @brief This class adjusts the saturation of color on a frame's image.
55
*
56
* This can be animated by passing in a Keyframe. Animating the color saturation can create
57
* some very cool effects.
58
*/
59
class
Saturation
:
public
EffectBase
60
{
61
private
:
62
/// Init effect settings
63
void
init_effect_details();
64
65
public
:
66
Keyframe
saturation
;
///< The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation
67
68
/// Blank constructor, useful when using Json to load the effect properties
69
Saturation
();
70
71
/// Default constructor, which takes 1 curve, to adjust the color saturation over time.
72
///
73
/// @param new_saturation The curve to adjust the saturation of the frame's image (0.0 = black and white, 1.0 = normal, 2.0 = double saturation)
74
Saturation
(
Keyframe
new_saturation);
75
76
/// @brief This method is required for all derived classes of EffectBase, and returns a
77
/// modified openshot::Frame object
78
///
79
/// The frame object is passed into this method, and a frame_number is passed in which
80
/// tells the effect which settings to use from it's keyframes (starting at 1).
81
///
82
/// @returns The modified openshot::Frame object
83
/// @param frame The frame object that needs the effect applied to it
84
/// @param frame_number The frame number (starting at 1) of the effect on the timeline.
85
std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
86
87
/// Get and Set JSON methods
88
string
Json();
///< Generate JSON string of this object
89
void
SetJson(
string
value);
///< Load JSON string into this object
90
Json::Value JsonValue();
///< Generate Json::JsonValue for this object
91
void
SetJsonValue(Json::Value root);
///< Load Json::JsonValue into this object
92
93
/// Get all properties for a specific frame (perfect for a UI to display the current state
94
/// of all properties at any time)
95
string
PropertiesJSON(int64_t requested_frame);
96
};
97
98
}
99
100
#endif
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition:
EffectBase.h:66
openshot
This namespace is the default namespace for all code in the openshot library.
Definition:
AudioBufferSource.h:45
openshot::Saturation
This class adjusts the saturation of color on a frame's image.
Definition:
Saturation.h:59
openshot::Keyframe
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
Definition:
KeyFrame.h:64
openshot::Saturation::saturation
Keyframe saturation
The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation.
Definition:
Saturation.h:66
Generated on Wed Mar 25 2020 17:42:00 for OpenShot Library | libopenshot by
1.8.17