Saturation.h

Go to the documentation of this file.

/**
 * @file
 * @brief Header file for Saturation 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_SATURATION_EFFECT_H
#define OPENSHOT_SATURATION_EFFECT_H

#include "../EffectBase.h"

#include <cmath>
#include <ctime>
#include <iostream>
#include <omp.h>
#include <stdio.h>
#include <tr1/memory>
#include "../Color.h"
#include "../Exceptions.h"
#include "../Json.h"
#include "../KeyFrame.h"
#include "../ReaderBase.h"
#include "../FFmpegReader.h"
#include "../QtImageReader.h"
#include "../ChunkReader.h"

using namespace std;

namespace openshot
{

        /**
         * @brief This class adjusts the saturation of color on a frame's image.
         *
         * This can be animated by passing in a Keyframe. Animating the color saturation can create
         * some very cool effects.
         */
        class Saturation : public EffectBase
        {
        private:
                /// Constrain a color value from 0 to 255
                int constrain(int color_value);

                /// Init effect settings
                void init_effect_details();

        public:
                Keyframe saturation;    ///< The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation

                /// Blank constructor, useful when using Json to load the effect properties
                Saturation();

                /// Default constructor, which takes 1 curve, to adjust the color saturation over time.
                ///
                /// @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)
                Saturation(Keyframe new_saturation);

                /// @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 it's 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.
                tr1::shared_ptr<Frame> GetFrame(tr1::shared_ptr<Frame> frame, long int frame_number);

                /// Get and Set JSON methods
                string Json(); ///< Generate JSON string of this object
                void SetJson(string value) throw(InvalidJSON); ///< Load JSON string into this object
                Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
                void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object

                /// Get all properties for a specific frame (perfect for a UI to display the current state
                /// of all properties at any time)
                string PropertiesJSON(long int requested_frame);
        };

}

#endif