Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / preferences.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef PREFERENCES_H
23 #define PREFERENCES_H
24
25 #include "asset.inc"
26 #include "audioconfig.inc"
27 #include "bchash.inc"
28 #include "guicast.h"
29 #include "maxchannels.h"
30 #include "mutex.inc"
31 #include "preferences.inc"
32 #include "probeprefs.inc"
33 #include "shbtnprefs.inc"
34 #include "videoconfig.inc"
35
36
37 class Preferences
38 {
39 public:
40         Preferences();
41         ~Preferences();
42
43         Preferences& operator=(Preferences &that);
44         void copy_from(Preferences *that);
45         int load_defaults(BC_Hash *defaults);
46         int save_defaults(BC_Hash *defaults);
47         void boundaries();
48
49         static void print_channels(char *string,
50                 int *channel_positions,
51                 int channels);
52         static void scan_channels(char *string,
53                 int *channel_positions,
54                 int channels);
55
56         void add_node(const char *text, int port, int enabled, float rate);
57         void delete_node(int number);
58         void delete_nodes();
59         void reset_rates();
60 // Get average frame rate or 1.0
61         float get_avg_rate(int use_master_node);
62         void sort_nodes();
63         void edit_node(int number, const char *new_text, int port, int enabled);
64         int get_enabled_nodes();
65         const char* get_node_hostname(int number);
66         int get_node_port(int number);
67         int get_asset_file_path(Asset *asset, char *path);
68 // Copy frame rates.  Always used where the argument is the renderfarm and this is
69 // the master preferences.  This way, the value for master node is properly
70 // translated from a unix socket to the local_rate.
71         void copy_rates_from(Preferences *preferences);
72 // Set frame rate for a node.  Node -1 is the master node.
73 // The node number is relative to the enabled nodes.
74         void set_rate(float rate, int node);
75         float get_rate(int node);
76 // Calculate the number of cpus to use.
77 // Determined by /proc/cpuinfo and force_uniprocessor.
78 // interactive forces it to ignore force_uniprocessor
79         int calculate_processors(int interactive = 0);
80 // file probe armed
81         int get_file_probe_armed(const char *nm);
82         void set_file_probe_armed(const char *nm, int v);
83 // ================================= Performance ================================
84 // directory to look in for indexes
85         char index_directory[BCTEXTLEN];
86 // size of index file in bytes
87         int64_t index_size;
88         int index_count;
89 // Use thumbnails in AWindow assets.
90         int use_thumbnails;
91         int keyframe_reticle;
92         int perpetual_session;
93         int trap_sigsegv;
94         int trap_sigintr;
95 // media thumbnail size
96         int awindow_picon_h;
97         int vicon_size, vicon_color_mode;
98 // Title of theme
99         char theme[BCTEXTLEN];
100 // plugin icon set
101         char plugin_icons[BCTEXTLEN];
102 // snapshot directory path
103         char snapshot_path[BCTEXTLEN];
104         double render_preroll;
105         int brender_preroll;
106         int force_uniprocessor;
107         int project_smp;
108 // The number of cpus to use when rendering.
109 // Determined by /proc/cpuinfo and force_uniprocessor
110         int processors;
111 // Number of processors for interactive operations.
112         int real_processors;
113 // ffmpeg builds marker indexes as it builds idx files
114         int ffmpeg_marker_indexes;
115 // warning
116         int warn_indexes;
117         int warn_version;
118         int bd_warn_root;
119 // grab input focus on enter notify
120         int grab_input_focus;
121 // popup menus activate on button release
122         int popupmenu_btnup;
123 // textbox focus policy: click, leave
124         int textbox_focus_policy;
125 // forward playback starts next frame, not this frame
126         int forward_render_displacement;
127 // use dvd yuv420p interlace format
128         int dvd_yuv420p_interlace;
129 // highlight inversion color
130         int highlight_inverse;
131 // yuv color space/range
132         int yuv_color_space;
133         int yuv_color_range;
134 // autocolor asset edit title
135         int autocolor_assets;
136 // ctrl_toggle && !ctrl_down() clears selection before toggle
137         int ctrl_toggle;
138 // Default positions for channels
139         int channel_positions[MAXCHANNELS][MAXCHANNELS];
140
141         Asset *brender_asset;
142         int use_brender;
143 // Number of frames in a brender job.
144         int brender_fragment;
145 // Size of cache in bytes.
146 // Several caches of cache_size exist so multiply by 4.
147 // rendering, playback, timeline, preview
148         int64_t cache_size;
149
150         int use_renderfarm;
151         int renderfarm_port;
152 // If the node starts with a / it's on the localhost using a path as the socket.
153         ArrayList<char*> renderfarm_nodes;
154         ArrayList<int>   renderfarm_ports;
155         ArrayList<int>   renderfarm_enabled;
156         ArrayList<float> renderfarm_rate;
157 // Rate of master node
158         float local_rate;
159         char renderfarm_mountpoint[BCTEXTLEN];
160 // Use virtual filesystem
161         int renderfarm_vfs;
162 // Jobs per node
163         int renderfarm_job_count;
164 // Consolidate output files
165         int renderfarm_consolidate;
166 // watchdog timeout, zero disabled
167         int renderfarm_watchdog_timeout;
168
169 // Tip of the day
170         int use_tipwindow;
171 // Scan for commercials
172         int scan_commercials;
173 // Android remote control
174         int android_remote;
175         int android_port;
176         char android_pin[BCSTRLEN];
177 // shell cmd line menu ops
178         ArrayList<ShBtnPref *> shbtn_prefs;
179 // file open probe order
180         ArrayList<ProbePref *> file_probes;
181
182 // ====================================== Plugin Set ==============================
183         char plugin_dir[BCTEXTLEN];
184         char lv2_path[BCTEXTLEN];
185         int autostart_lv2ui;
186
187 // Required when updating renderfarm rates
188         Mutex *preferences_lock;
189 };
190
191 #endif