Settings.h
Go to the documentation of this file.
/**
* @file
* @brief Header file for global Settings 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_SETTINGS_H
#define OPENSHOT_SETTINGS_H
#include <iostream>
#include <iomanip>
#include <fstream>
#include <stdlib.h>
#include <string>
#include <sstream>
#include <stdio.h>
#include <time.h>
#include <zmq.hpp>
#include <unistd.h>
#include "JuceHeader.h"
namespace openshot {
/**
* @brief This class is contains settings used by libopenshot (and can be safely toggled at any point)
*
* Settings class is used primarily to toggle scale settings between preview and rendering, and adjust
* other runtime related settings.
*/
class Settings {
private:
/// Default constructor
Settings(){}; // Don't allow user to create an instance of this singleton
#if __GNUC__ >=7
/// Default copy method
Settings(Settings const&) = delete; // Don't allow the user to assign this instance
/// Default assignment operator
Settings & operator=(Settings const&) = delete; // Don't allow the user to assign this instance
#else
/// Default copy method
Settings(Settings const&) {}; // Don't allow the user to assign this instance
/// Default assignment operator
Settings & operator=(Settings const&); // Don't allow the user to assign this instance
#endif
/// Private variable to keep track of singleton instance
static Settings * m_pInstance;
public:
/**
* @brief Use video codec for faster video decoding (if supported)
*
* 0 - No acceleration,
* 1 - Linux VA-API,
* 2 - nVidia NVDEC,
* 3 - Windows D3D9,
* 4 - Windows D3D11,
* 5 - MacOS / VideoToolBox,
* 6 - Linux VDPAU,
* 7 - Intel QSV
*/
int HARDWARE_DECODER = 0;
/// Scale mode used in FFmpeg decoding and encoding (used as an optimization for faster previews)
bool HIGH_QUALITY_SCALING = false;
/// Maximum width for image data (useful for optimzing for a smaller preview or render)
int MAX_WIDTH = 0;
/// Maximum height for image data (useful for optimzing for a smaller preview or render)
int MAX_HEIGHT = 0;
/// Wait for OpenMP task to finish before continuing (used to limit threads on slower systems)
bool WAIT_FOR_VIDEO_PROCESSING_TASK = false;
/// Number of threads of OpenMP
int OMP_THREADS = 12;
/// Number of threads that ffmpeg uses
int FF_THREADS = 8;
/// Maximum rows that hardware decode can handle
int DE_LIMIT_HEIGHT_MAX = 1100;
/// Maximum columns that hardware decode can handle
int DE_LIMIT_WIDTH_MAX = 1950;
/// Which GPU to use to decode (0 is the first)
int HW_DE_DEVICE_SET = 0;
/// Which GPU to use to encode (0 is the first)
int HW_EN_DEVICE_SET = 0;
/// The audio device name to use during playback
std::string PLAYBACK_AUDIO_DEVICE_NAME = "";
/// Create or get an instance of this logger singleton (invoke the class with this method)
static Settings * Instance();
};
}
#endif
openshot::Settings
This class is contains settings used by libopenshot (and can be safely toggled at any point)
Definition: Settings.h:56
openshot::Settings::DE_LIMIT_WIDTH_MAX
int DE_LIMIT_WIDTH_MAX
Maximum columns that hardware decode can handle.
Definition: Settings.h:116
openshot::Settings::OMP_THREADS
int OMP_THREADS
Number of threads of OpenMP.
Definition: Settings.h:107
openshot::Settings::PLAYBACK_AUDIO_DEVICE_NAME
std::string PLAYBACK_AUDIO_DEVICE_NAME
The audio device name to use during playback.
Definition: Settings.h:125
openshot::Settings::MAX_WIDTH
int MAX_WIDTH
Maximum width for image data (useful for optimzing for a smaller preview or render)
Definition: Settings.h:98
openshot::Settings::HW_DE_DEVICE_SET
int HW_DE_DEVICE_SET
Which GPU to use to decode (0 is the first)
Definition: Settings.h:119
openshot::Settings::WAIT_FOR_VIDEO_PROCESSING_TASK
bool WAIT_FOR_VIDEO_PROCESSING_TASK
Wait for OpenMP task to finish before continuing (used to limit threads on slower systems)
Definition: Settings.h:104
openshot::Settings::DE_LIMIT_HEIGHT_MAX
int DE_LIMIT_HEIGHT_MAX
Maximum rows that hardware decode can handle.
Definition: Settings.h:113
openshot::Settings::Instance
static Settings * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: Settings.cpp:41
openshot::Settings::HARDWARE_DECODER
int HARDWARE_DECODER
Use video codec for faster video decoding (if supported)
Definition: Settings.h:92
openshot::Settings::HIGH_QUALITY_SCALING
bool HIGH_QUALITY_SCALING
Scale mode used in FFmpeg decoding and encoding (used as an optimization for faster previews)
Definition: Settings.h:95
openshot::Settings::FF_THREADS
int FF_THREADS
Number of threads that ffmpeg uses.
Definition: Settings.h:110
openshot::Settings::MAX_HEIGHT
int MAX_HEIGHT
Maximum height for image data (useful for optimzing for a smaller preview or render)
Definition: Settings.h:101
openshot::Settings::HW_EN_DEVICE_SET
int HW_EN_DEVICE_SET
Which GPU to use to encode (0 is the first)
Definition: Settings.h:122
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39