OpenShot Library | libopenshot 0.2.7
Settings.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Header file for global Settings class
4 * @author Jonathan Thomas <jonathan@openshot.org>
5 *
6 * @ref License
7 */
8
9/* LICENSE
10 *
11 * Copyright (c) 2008-2019 OpenShot Studios, LLC
12 * <http://www.openshotstudios.com/>. This file is part of
13 * OpenShot Library (libopenshot), an open-source project dedicated to
14 * delivering high quality video editing and animation solutions to the
15 * world. For more information visit <http://www.openshot.org/>.
16 *
17 * OpenShot Library (libopenshot) is free software: you can redistribute it
18 * and/or modify it under the terms of the GNU Lesser General Public License
19 * as published by the Free Software Foundation, either version 3 of the
20 * License, or (at your option) any later version.
21 *
22 * OpenShot Library (libopenshot) is distributed in the hope that it will be
23 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License for more details.
26 *
27 * You should have received a copy of the GNU Lesser General Public License
28 * along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
29 */
30
31#ifndef OPENSHOT_SETTINGS_H
32#define OPENSHOT_SETTINGS_H
33
34#include <string>
35
36namespace openshot {
37
38 /**
39 * @brief This class is contains settings used by libopenshot (and can be safely toggled at any point)
40 *
41 * Settings class is used primarily to toggle scale settings between preview and rendering, and adjust
42 * other runtime related settings.
43 */
44 class Settings {
45 private:
46
47 /// Default constructor
48 Settings(){}; // Don't allow user to create an instance of this singleton
49
50#if __GNUC__ >=7
51 /// Default copy method
52 Settings(Settings const&) = delete; // Don't allow the user to assign this instance
53
54 /// Default assignment operator
55 Settings & operator=(Settings const&) = delete; // Don't allow the user to assign this instance
56#else
57 /// Default copy method
58 Settings(Settings const&) {}; // Don't allow the user to assign this instance
59
60 /// Default assignment operator
61 Settings & operator=(Settings const&); // Don't allow the user to assign this instance
62#endif
63
64 /// Private variable to keep track of singleton instance
65 static Settings * m_pInstance;
66
67 public:
68 /**
69 * @brief Use video codec for faster video decoding (if supported)
70 *
71 * 0 - No acceleration,
72 * 1 - Linux VA-API,
73 * 2 - nVidia NVDEC,
74 * 3 - Windows D3D9,
75 * 4 - Windows D3D11,
76 * 5 - MacOS / VideoToolBox,
77 * 6 - Linux VDPAU,
78 * 7 - Intel QSV
79 */
81
82 /// Scale mode used in FFmpeg decoding and encoding (used as an optimization for faster previews)
84
85 /// Number of threads of OpenMP
86 int OMP_THREADS = 12;
87
88 /// Number of threads that ffmpeg uses
89 int FF_THREADS = 8;
90
91 /// Maximum rows that hardware decode can handle
93
94 /// Maximum columns that hardware decode can handle
96
97 /// Which GPU to use to decode (0 is the first)
99
100 /// Which GPU to use to encode (0 is the first)
102
103 /// The audio device name to use during playback
105
106 /// The current install path of OpenShot (needs to be set when using Timeline(path), since certain
107 /// paths depend on the location of OpenShot transitions and files)
108 std::string PATH_OPENSHOT_INSTALL = "";
109
110 /// Whether to dump ZeroMQ debug messages to stderr
111 bool DEBUG_TO_STDERR = false;
112
113 /// Create or get an instance of this logger singleton (invoke the class with this method)
114 static Settings * Instance();
115 };
116
117}
118
119#endif
This class is contains settings used by libopenshot (and can be safely toggled at any point)
Definition: Settings.h:44
int DE_LIMIT_WIDTH_MAX
Maximum columns that hardware decode can handle.
Definition: Settings.h:95
int OMP_THREADS
Number of threads of OpenMP.
Definition: Settings.h:86
std::string PLAYBACK_AUDIO_DEVICE_NAME
The audio device name to use during playback.
Definition: Settings.h:104
std::string PATH_OPENSHOT_INSTALL
Definition: Settings.h:108
int HW_DE_DEVICE_SET
Which GPU to use to decode (0 is the first)
Definition: Settings.h:98
int DE_LIMIT_HEIGHT_MAX
Maximum rows that hardware decode can handle.
Definition: Settings.h:92
static Settings * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: Settings.cpp:41
int HARDWARE_DECODER
Use video codec for faster video decoding (if supported)
Definition: Settings.h:80
bool HIGH_QUALITY_SCALING
Scale mode used in FFmpeg decoding and encoding (used as an optimization for faster previews)
Definition: Settings.h:83
int FF_THREADS
Number of threads that ffmpeg uses.
Definition: Settings.h:89
int HW_EN_DEVICE_SET
Which GPU to use to encode (0 is the first)
Definition: Settings.h:101
bool DEBUG_TO_STDERR
Whether to dump ZeroMQ debug messages to stderr.
Definition: Settings.h:111
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:47