OpenShot Library | libopenshot
0.2.2
include
effects
Pixelate.h
Go to the documentation of this file.
1
/**
2
* @file
3
* @brief Header file for Pixelate effect 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_PIXELATE_EFFECT_H
29
#define OPENSHOT_PIXELATE_EFFECT_H
30
31
#include "../EffectBase.h"
32
33
#include <cmath>
34
#include <stdio.h>
35
#include <memory>
36
#include "../Color.h"
37
#include "../Json.h"
38
#include "../KeyFrame.h"
39
40
41
using namespace
std;
42
43
namespace
openshot
44
{
45
46
/**
47
* @brief This class pixelates an image, and can be animated with openshot::Keyframe curves over time.
48
*
49
* Pixelating the image is the process of increasing the size of visible pixels, thus loosing visual
50
* clarity of the image. The area to pixelate can be set and animated with keyframes also.
51
*/
52
class
Pixelate
:
public
EffectBase
53
{
54
private
:
55
/// Init effect settings
56
void
init_effect_details();
57
58
59
public
:
60
Keyframe
pixelization
;
///< Amount of pixelization
61
Keyframe
left
;
///< Size of left margin
62
Keyframe
top
;
///< Size of top margin
63
Keyframe
right
;
///< Size of right margin
64
Keyframe
bottom
;
///< Size of bottom margin
65
66
/// Blank constructor, useful when using Json to load the effect properties
67
Pixelate
();
68
69
/// Default constructor, which takes 5 curves. These curves animate the pixelization effect over time.
70
///
71
/// @param pixelization The curve to adjust the amount of pixelization (0 to 1)
72
/// @param left The curve to adjust the left margin size (between 0 and 1)
73
/// @param top The curve to adjust the top margin size (between 0 and 1)
74
/// @param right The curve to adjust the right margin size (between 0 and 1)
75
/// @param bottom The curve to adjust the bottom margin size (between 0 and 1)
76
Pixelate
(
Keyframe
pixelization,
Keyframe
left,
Keyframe
top,
Keyframe
right,
Keyframe
bottom);
77
78
/// @brief This method is required for all derived classes of EffectBase, and returns a
79
/// modified openshot::Frame object
80
///
81
/// The frame object is passed into this method, and a frame_number is passed in which
82
/// tells the effect which settings to use from it's keyframes (starting at 1).
83
///
84
/// @returns The modified openshot::Frame object
85
/// @param frame The frame object that needs the effect applied to it
86
/// @param frame_number The frame number (starting at 1) of the effect on the timeline.
87
std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
88
89
/// Get and Set JSON methods
90
string
Json();
///< Generate JSON string of this object
91
void
SetJson(
string
value);
///< Load JSON string into this object
92
Json::Value JsonValue();
///< Generate Json::JsonValue for this object
93
void
SetJsonValue(Json::Value root);
///< Load Json::JsonValue into this object
94
95
/// Get all properties for a specific frame (perfect for a UI to display the current state
96
/// of all properties at any time)
97
string
PropertiesJSON(int64_t requested_frame);
98
};
99
100
}
101
102
#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::Pixelate::pixelization
Keyframe pixelization
Amount of pixelization.
Definition:
Pixelate.h:60
openshot::Pixelate
This class pixelates an image, and can be animated with openshot::Keyframe curves over time.
Definition:
Pixelate.h:52
openshot::Pixelate::bottom
Keyframe bottom
Size of bottom margin.
Definition:
Pixelate.h:64
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::Pixelate::right
Keyframe right
Size of right margin.
Definition:
Pixelate.h:63
openshot::Pixelate::left
Keyframe left
Size of left margin.
Definition:
Pixelate.h:61
openshot::Pixelate::top
Keyframe top
Size of top margin.
Definition:
Pixelate.h:62
Generated on Thu Jul 29 2021 05:37:29 for OpenShot Library | libopenshot by
1.8.17