Deinterlace.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for De-interlace class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 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_DEINTERLACE_EFFECT_H
#define OPENSHOT_DEINTERLACE_EFFECT_H
#include "../EffectBase.h"
#include <cmath>
#include <ctime>
#include <iostream>
#include <omp.h>
#include <stdio.h>
#include <memory>
#include "../Color.h"
#include "../Exceptions.h"
#include "../Json.h"
#include "../KeyFrame.h"
namespace openshot
{
/**
* @brief This class uses the ImageMagick++ libraries, to de-interlace the image, which
* removes the EVEN or ODD horizontal lines (which represent different points of time).
*
* This is most useful when converting video made for traditional TVs to computers,
* which are not interlaced.
*/
class Deinterlace : public EffectBase
{
private:
bool isOdd;
/// Init effect settings
void init_effect_details();
public:
/// Blank constructor, useful when using Json to load the effect properties
Deinterlace();
/// Default constructor
Deinterlace(bool isOdd);
/// @brief This method is required for all derived classes of EffectBase, and returns a
/// modified openshot::Frame object
///
/// The frame object is passed into this method, and a frame_number is passed in which
/// tells the effect which settings to use from its keyframes (starting at 1).
///
/// @returns The modified openshot::Frame object
/// @param frame The frame object that needs the effect applied to it
/// @param frame_number The frame number (starting at 1) of the effect on the timeline.
std::shared_ptr<Frame> GetFrame(std::shared_ptr<Frame> frame, int64_t frame_number);
/// Get and Set JSON methods
std::string Json() const override; ///< Generate JSON string of this object
void SetJson(const std::string value); ///< Load JSON string into this object
Json::Value JsonValue() const override; ///< Generate Json::Value for this object
void SetJsonValue(const Json::Value root); ///< Load Json::Value into this object
// Get all properties for a specific frame
std::string PropertiesJSON(int64_t requested_frame) const override;
};
}
#endif
openshot::Deinterlace
This class uses the ImageMagick++ libraries, to de-interlace the image, which removes the EVEN or ODD...
Definition: Deinterlace.h:58
openshot::Deinterlace::SetJson
void SetJson(const std::string value)
Load JSON string into this object.
Definition: Deinterlace.cpp:118
openshot::Deinterlace::Json
std::string Json() const override
Get and Set JSON methods.
Definition: Deinterlace.cpp:99
openshot::Deinterlace::Deinterlace
Deinterlace()
Blank constructor, useful when using Json to load the effect properties.
Definition: Deinterlace.cpp:36
openshot::Deinterlace::SetJsonValue
void SetJsonValue(const Json::Value root)
Load Json::Value into this object.
Definition: Deinterlace.cpp:135
openshot::Deinterlace::GetFrame
std::shared_ptr< Frame > GetFrame(std::shared_ptr< Frame > frame, int64_t frame_number)
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame...
Definition: Deinterlace.cpp:65
openshot::Deinterlace::PropertiesJSON
std::string PropertiesJSON(int64_t requested_frame) const override
Definition: Deinterlace.cpp:146
openshot::Deinterlace::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: Deinterlace.cpp:106
openshot::EffectBase
This abstract class is the base class, used by all effects in libopenshot.
Definition: EffectBase.h:67
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39