Audacity  2.2.0
Experimental.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  Experimental.h
6 
7  Dominic Mazzoni
8  James Crook
9 
10  Used for #includes and #defines for experimental features.
11 
12  When the features become mainstream the #include files will
13  move out of here and into the files which need them. The
14  #defines will then be retired.
15 
16 
17 
18  JKC: This file solves a problem of how to avoid forking the
19  code base when working on NEW features e.g:
20  - Additional displays in Audacity
21  - Modular architecture.
22  Add #defines in here for the NEW features, and make your code
23  conditional on those #defines.
24 
25  All the #defines are positive, i.e., when defined,
26  they enable the feature.
27 
28 **********************************************************************/
29 
30 #ifndef __EXPERIMENTAL__
31 #define __EXPERIMENTAL__
32 
33 // ACH 08 Jan 2014
34 // EQ accelerated code
35 //#define EXPERIMENTAL_EQ_SSE_THREADED
36 
37 // LLL, 09 Nov 2013:
38 // Allow all WASAPI devices, not just loopback
39 #define EXPERIMENTAL_FULL_WASAPI
40 
41 // JKC (effect by Norm C, 02 Oct 2013)
42 #define EXPERIMENTAL_SCIENCE_FILTERS
43 
44 // LLL, 01 Oct 2013:
45 // NEW key assignment view for preferences
46 #define EXPERIMENTAL_KEY_VIEW
47 
48 // feature to link audio tracks to a label track
49 #define EXPERIMENTAL_SYNC_LOCK
50 
51 // JKC: Enable to get extra buttons in the screenshot tools.
52 //#define EXPERIMENTAL_DOCS_AUTOMATION
53 // JKC: Enable to get experiemental code to move
54 // mod-script-pipe towards being mainstream.
55 //#define EXPERIMENTAL_AUTOMATION
56 
57 // DA: Enables dark audacity theme and customisations.
58 //#define EXPERIMENTAL_DA
59 
60 // Define this so that sync-lock tiles shine through spectrogram.
61 // The spectrogram pastes a bitmap over the tiles.
62 // This makes it use alpha blending, most transparent where least intense.
63 #define EXPERIMENTAL_SPECTROGRAM_OVERLAY
64 
65 // Define this so that sync-lock tiles shine through note/MIDI track.
66 // The note track then relies on the same code for drawing background as
67 // Wavetrack, and draws its notes and lines over the top.
68 #define EXPERIMENTAL_NOTETRACK_OVERLAY
69 
70 // EXPERIMENTAL_THEMING is mostly mainstream now.
71 // the define is still present to mark out old code before theming, that we might
72 // conceivably need.
73 // TODO: Agree on and then tidy this code.
74 #define EXPERIMENTAL_THEMING
75 
76 //August 2009 - Theming not locked down enough for a stable release.
77 // This turns on the Theme panel in Prefs dialog. It is independent of EXPERIMENTAL_THEMING.
78 //#define EXPERIMENTAL_THEME_PREFS
79 
80 //Next line enables Mic monitoring at times when it was previously off.
81 //More work is needed as after recording or playing it results in an
82 //unwanted record-cursor on the wave track.
83 //#define EXPERIMENTAL_EXTRA_MONITORING
84 
85 //#define EXPERIMENTAL_ROLL_UP_DIALOG
86 //#define EXPERIMENTAL_RIGHT_ALIGNED_TEXTBOXES
87 //#define EXPERIMENTAL_VOICE_DETECTION
88 
89 // Effect categorisation. Adds support for arranging effects in categories
90 // and displaying those categories as submenus in the Effect menu.
91 // This was a 2008 GSoC project that was making good progress at the half-way point
92 // but then the student didn't contribute after that. It needs a bit of work to finish it off.
93 // As a minimum, if this is turned on for a release,
94 // it should have an easy mechanism to disable it at run-time, such as a menu item or a pref,
95 // preferrably disabled until other work is done. Martyn 22/12/2008.
96 //
97 
98 // JKC Apr 2015, Menu item to manage effects.
99 #define EXPERIMENTAL_EFFECT_MANAGEMENT
100 
101 // Andreas Micheler, 20.Nov 2007:
102 // A spectrumLogF-like view mode with notes quantization.
103 // Just select the "Find Notes" checkbox in the spectrum prefs
104 // to activate it instead of the Spectrum log(f) mode.
105 //#define EXPERIMENTAL_FIND_NOTES
106 
107 // AM, 22.Nov 2007:
108 // A Frequency Grid for the Spectrum Log(f) & Find Notes modes
109 //#define EXPERIMENTAL_FFT_Y_GRID
110 
111 // Andy Coder, 03.Mar 2009:
112 // Allow keyboard seeking before initial playback position
113 //#define EXPERIMENTAL_SEEK_BEHIND_CURSOR
114 
115 // Michael Chinen, 08.Oct 2009
116 // Use on-demand importing for FLAC. Has issues with opening projects that
117 // have not been fully imported in builds without FLAC support, so disabled for
118 // 2.0 release
119 //#define EXPERIMENTAL_OD_FLAC
120 // similarly for FFmpeg:
121 // Won't build on Fedora 17 or Windows VC++, per http://bugzilla.audacityteam.org/show_bug.cgi?id=539.
122 //#define EXPERIMENTAL_OD_FFMPEG 1
123 
124 // Paul Licameli (PRL) 5 Oct 2014
125 #define EXPERIMENTAL_SPECTRAL_EDITING
126 
127 // Paul Licameli (PRL) 29 Nov 2014
128 // #define EXPERIMENTAL_IMPROVED_SEEKING
129 
130 #ifdef USE_MIDI
131 // RBD, 1 Sep 2008
132 // Enables MIDI Output of NoteTrack (MIDI) data during playback
133 // USE_MIDI must be defined in order for EXPERIMENTAL_MIDI_OUT to work
134 #define EXPERIMENTAL_MIDI_OUT
135 // JKC, 17 Aug 2017
136 // Enables the MIDI note stretching feature, which currently
137 // a) Is broken on Linux (Bug 1646)
138 // b) Crashes with Sync-Lock (Bug 1719)
139 // c) Needs UI design review.
140 //#define EXPERIMENTAL_MIDI_STRETCHING
141 #endif
142 
143 // USE_MIDI must be defined in order for EXPERIMENTAL_SCOREALIGN to work
144 #ifdef USE_MIDI
145 //#define EXPERIMENTAL_SCOREALIGN
146 #endif
147 
148 //If you want any of these files, ask JKC. They are not
149 //yet checked in to Audacity SVN as of 12-Feb-2010
150 #ifdef EXPERIMENTAL_NOTEBOOK
151  #include "widgets/GuiFactory.h"
152  #include "widgets/APanel.h"
153  extern void AddPages( AudacityProject * pProj, GuiFactory & Factory, wxNotebook * pNotebook );
154 #endif
155 
156 #ifdef EXPERIMENTAL_NYQUIST_INSPECTOR
157  #include "NyquistAdapter.h"
158 #endif
159 
160 #if USE_PORTMIXER
161  //Automatically tries to find an acceptable input volume
162  //#define EXPERIMENTAL_AUTOMATED_INPUT_LEVEL_ADJUSTMENT
163 #endif
164 
165 // John (Thales) work to make the display show the result of the pan and gain sliders, rather than their input.
166 // First committed by Martyn, 30th May 2013.
167 //#define EXPERIMENTAL_OUTPUT_DISPLAY
168 
169 // Module prefs provides a panel in prefs where users can choose which modules
170 // to enable.
171 #define EXPERIMENTAL_MODULE_PREFS
172 
173 // Define to allow realtime processing in Audacity effects that have been converted.
174 #define EXPERIMENTAL_REALTIME_AUDACITY_EFFECTS
175 
176 // Define to include the effects rack (such as it is).
177 //#define EXPERIMENTAL_EFFECTS_RACK
178 
179 // Define to make the meters look like a row of LEDs
180 //#define EXPERIMENTAL_METER_LED_STYLE
181 
182 // Define to enable the device change handler
183 //#define EXPERIMENTAL_DEVICE_CHANGE_HANDLER
184 
185 // Define for NEW noise reduction effect from Paul Licameli.
186 #define EXPERIMENTAL_NOISE_REDUCTION
187 
188 // Define to enable Nyquist audio clip boundary control (Steve Daulton Dec 2014)
189 #define EXPERIMENTAL_NYQUIST_SPLIT_CONTROL
190 
191 // Paul Licameli (PRL) 16 Apr 2015
192 // Support for scrubbing in the AudioIO engine, without calls to it
193 #define EXPERIMENTAL_SCRUBBING_SUPPORT
194 #ifdef EXPERIMENTAL_SCRUBBING_SUPPORT
195  // The following enable parts of the scrubbing user interface.
196  #define EXPERIMENTAL_SCRUBBING_BASIC
197  #ifdef EXPERIMENTAL_SCRUBBING_BASIC
198  #define EXPERIMENTAL_SCRUBBING_SCROLL_WHEEL
199  #endif
200 #endif
201 
202 // Paul Licameli (PRL) 24 May 2015
203 // Allow scrolling up to one half of a screenful beyond either end of the project,
204 // if you turn on the appropriate Tracks preference.
205 // This allows smooth-scrolling scrub to work more reasonably at the ends.
206 #define EXPERIMENTAL_SCROLLING_LIMITS
207 
208 // Paul Licameli (PRL) 28 May 2015
209 // Draw negative numbers on the time ruler in a different color, when
210 // scrolling past zero is enabled. Perhaps that lessens confusion.
211 #define EXPERIMENTAL_TWO_TONE_TIME_RULER
212 
213 #ifndef IN_RC
214 // Define to include crash reporting
215 #include <wx/defs.h>
216 #define EXPERIMENTAL_CRASH_REPORT
217 #if !defined(wxUSE_DEBUGREPORT) || !wxUSE_DEBUGREPORT
218 #undef EXPERIMENTAL_CRASH_REPORT
219 #endif
220 #endif
221 
222 // Paul Licameli (PRL) 31 May 2015
223 // Zero-padding factor for spectrograms can smooth the display of spectrograms by
224 // interpolating in frequency domain.
225 #define EXPERIMENTAL_ZERO_PADDED_SPECTROGRAMS
226 
227 // PRL 11 Jul 2017
228 // Highlight more things in TrackPanel when the mouse moves over them,
229 // using delibrately ugly pens and brushes until there is better cooperation
230 // with themes
231 //#define EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
232 
233 #endif
AudacityProject provides the main window, with tools and tracks contained within it.
Definition: Project.h:161