lmms
Cross-platform music production software
Loading...
Searching...
No Matches
AutomationEditor.h
Go to the documentation of this file.
1/*
2 * AutomationEditor.h - declaration of class AutomationEditor which is a window
3 * where you can edit dynamic values in an easy way
4 *
5 * Copyright (c) 2006-2008 Javier Serrano Polo <jasp00/at/users.sourceforge.net>
6 *
7 * This file is part of LMMS - https://lmms.io
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public
20 * License along with this program (see COPYING); if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 * Boston, MA 02110-1301 USA.
23 *
24 */
25
26#ifndef LMMS_GUI_AUTOMATION_EDITOR_H
27#define LMMS_GUI_AUTOMATION_EDITOR_H
28
29#include <QWidget>
30#include <array>
31
32#include "AutomationClip.h"
33#include "ComboBoxModel.h"
34#include "Editor.h"
35#include "JournallingObject.h"
36#include "LmmsTypes.h"
37#include "MidiClip.h"
38#include "SampleClip.h"
39#include "TimePos.h"
40
41class QPushButton;
42class QScrollBar;
43
44namespace lmms
45{
46namespace gui
47{
48
49class ComboBox;
50class Knob;
51class TimeLineWidget;
52
53
54
55class AutomationEditor : public QWidget, public JournallingObject
56{
57 Q_OBJECT
58 Q_PROPERTY(QColor barLineColor MEMBER m_barLineColor)
59 Q_PROPERTY(QColor beatLineColor MEMBER m_beatLineColor)
60 Q_PROPERTY(QColor lineColor MEMBER m_lineColor)
61 Q_PROPERTY(QColor nodeInValueColor MEMBER m_nodeInValueColor)
62 Q_PROPERTY(QColor nodeOutValueColor MEMBER m_nodeOutValueColor)
64 Q_PROPERTY(QBrush scaleColor MEMBER m_scaleColor)
65 Q_PROPERTY(QBrush graphColor MEMBER m_graphColor)
66 Q_PROPERTY(QColor crossColor MEMBER m_crossColor)
67 Q_PROPERTY(QColor backgroundShade MEMBER m_backgroundShade)
68 Q_PROPERTY(QColor ghostNoteColor MEMBER m_ghostNoteColor)
69 Q_PROPERTY(QColor detuningNoteColor MEMBER m_detuningNoteColor)
70 Q_PROPERTY(QColor ghostSampleColor MEMBER m_ghostSampleColor)
71 Q_PROPERTY(QColor outOfBoundsShade MEMBER m_outOfBoundsShade)
72public:
73 void setCurrentClip(AutomationClip * new_clip);
74 void setGhostMidiClip(MidiClip* newMidiClip);
75 void setGhostSample(SampleClip* newSample);
76
77 inline const AutomationClip * currentClip() const
78 {
79 return m_clip;
80 }
81
82 inline bool validClip() const
83 {
84 return m_clip != nullptr;
85 }
86
87 void saveSettings(QDomDocument & doc, QDomElement & parent) override;
88 void loadSettings(const QDomElement & parent) override;
89 QString nodeName() const override
90 {
91 return "automationeditor";
92 }
93
94 enum class EditMode
95 {
96 Draw,
97 Erase,
98 DrawOutValues,
99 EditTangents
100 };
101
102public slots:
103 void update();
105
106
107protected:
109
110 void keyPressEvent(QKeyEvent * ke) override;
111 void leaveEvent(QEvent * e) override;
112 void mousePressEvent(QMouseEvent * mouseEvent) override;
113 void mouseDoubleClickEvent(QMouseEvent * mouseEvent) override;
114 void mouseReleaseEvent(QMouseEvent * mouseEvent) override;
115 void mouseMoveEvent(QMouseEvent * mouseEvent) override;
116 void paintEvent(QPaintEvent * pe) override;
117 void resizeEvent(QResizeEvent * re) override;
118 void wheelEvent(QWheelEvent * we) override;
119
120 float getLevel( int y );
121 int xCoordOfTick( int tick );
122 float yCoordOfLevel( float level );
123 inline void drawLevelTick(QPainter & p, int tick, float value);
124
126 //
135 timeMap::iterator getNodeAt(int x, int y, bool outValue = false, int r = 5);
136
140 timeMap::iterator getClosestNode(int x);
141
142 void drawLine( int x0, float y0, int x1, float y1 );
143 bool fineTuneValue(timeMap::iterator node, bool editingOutValue);
144
145protected slots:
146 void play();
147 void stop();
148
149 void horScrolled( int new_pos );
150 void verScrolled( int new_pos );
151
153 void setEditMode(int mode);
154
156
162 void setProgressionType(int type);
163 void setTension();
164
165 void updatePosition();
166
167 void zoomingXChanged();
168 void zoomingYChanged();
169
170 void updateYDelta();
171
173 void setQuantization();
174
176 {
177 m_ghostNotes = nullptr;
178 m_ghostSample = nullptr;
179 update();
180 }
181
182private:
183
184 enum class Action
185 {
187 MoveValue,
188 EraseValues,
189 MoveOutValue,
190 ResetOutValues,
191 DrawLine,
192 MoveTangent,
193 ResetTangents
194 } ;
195
196 // some constants...
197 static const int SCROLLBAR_SIZE = 12;
198 static const int TOP_MARGIN = 16;
199
200 static const int DEFAULT_Y_DELTA = 6;
201 static const int DEFAULT_STEPS_PER_BAR = 16;
202 static const int DEFAULT_PPB = 12 * DEFAULT_STEPS_PER_BAR;
203
204 static const int VALUES_WIDTH = 64;
205
206 static const int NOTE_HEIGHT = 10;
207 static const int NOTE_MARGIN = 40;
208 static const int MIN_NOTE_RANGE = 20;
209 static const int SAMPLE_MARGIN = 40;
210 static constexpr int MAX_SAMPLE_HEIGHT = 400; // constexpr for use in min
211
214 ~AutomationEditor() override;
215
216 QPixmap m_toolDraw = embed::getIconPixmap("edit_draw");
217 QPixmap m_toolErase = embed::getIconPixmap("edit_erase");
218 QPixmap m_toolDrawOut = embed::getIconPixmap("edit_draw_outvalue");
219 QPixmap m_toolEditTangents = embed::getIconPixmap("edit_tangent");
220 QPixmap m_toolMove = embed::getIconPixmap("edit_move");
223
227
228 static const std::array<float, 7> m_zoomXLevels;
229
231
235 float m_step;
239
240 // QPointers to set to nullptr on deletion
241 QPointer<MidiClip> m_ghostNotes = nullptr;
242 QPointer<SampleClip> m_ghostSample = nullptr;
243 bool m_renderSample = false;
244
247
248 QScrollBar * m_leftRightScroll;
249 QScrollBar * m_topBottomScroll;
250
251 void adjustLeftRightScoll(int value);
252
254
256
258
261
262 int m_ppb;
265
268
271
274
276
278 bool m_mouseDownRight; //true if right click is being held down
279
282
283 void drawCross(QPainter & p );
284 void drawAutomationPoint( QPainter & p, timeMap::iterator it );
285 void drawAutomationTangents(QPainter& p, timeMap::iterator it);
286 bool inPatternEditor();
287
302
303
305
306
307signals:
309} ;
310
311
312
313
315{
316 Q_OBJECT
317
318 static const int INITIAL_WIDTH = 860;
319 static const int INITIAL_HEIGHT = 480;
320public:
322 ~AutomationEditorWindow() override = default;
323
324 void setCurrentClip(AutomationClip* clip);
326 void setGhostSample(SampleClip* newSample) { m_editor->setGhostSample(newSample); };
327
329
330 void dropEvent( QDropEvent * _de ) override;
331 void dragEnterEvent( QDragEnterEvent * _dee ) override;
332
333 void open(AutomationClip* clip);
334
336
337 QSize sizeHint() const override;
338
339public slots:
340 void clearCurrentClip();
341
342signals:
344
345protected:
346 void focusInEvent(QFocusEvent * event) override;
347
348protected slots:
349 void play() override;
350 void stop() override;
351
352private slots:
353 void updateWindowTitle();
354 void setProgressionType(int progType);
355
358 void updateEditTanButton();
359
360private:
361 QAction* m_drawAction;
365
369
372
374
378
379 QPushButton* m_resetGhostNotes;
380};
381
382} // namespace gui
383
384} // namespace lmms
385
386#endif // LMMS_GUI_AUTOMATION_EDITOR_H
Definition AutomationClip.h:52
QMap< int, AutomationNode > timeMap
Definition AutomationClip.h:62
ProgressionType
Definition AutomationClip.h:56
Definition ComboBoxModel.h:39
Definition AutomatableModel.h:476
JournallingObject()
Definition JournallingObject.cpp:35
Definition MidiClip.h:46
Definition SampleClip.h:47
Definition TimePos.h:68
Definition AutomationEditor.h:56
int m_draggedTangentTick
The tick from the node whose tangent is being dragged.
Definition AutomationEditor.h:270
int xCoordOfTick(int tick)
Definition AutomationEditor.cpp:1426
bool m_mouseDownRight
Definition AutomationEditor.h:278
void setProgressionType(AutomationClip::ProgressionType type)
Definition AutomationEditor.cpp:1753
void updateYDelta()
Definition AutomationEditor.cpp:1831
void zoomingXChanged()
Definition AutomationEditor.cpp:1812
void updatePosition()
Definition AutomationEditor.cpp:1784
QColor m_detuningNoteColor
Definition AutomationEditor.h:299
QColor m_outOfBoundsShade
Definition AutomationEditor.h:301
float yCoordOfLevel(float level)
Definition AutomationEditor.cpp:1435
QColor m_barLineColor
Definition AutomationEditor.h:288
void drawLine(int x0, float y0, int x1, float y1)
Definition AutomationEditor.cpp:303
void resetGhostNotes()
Definition AutomationEditor.h:175
bool m_renderSample
Definition AutomationEditor.h:243
void paintEvent(QPaintEvent *pe) override
Definition AutomationEditor.cpp:1026
QBrush m_scaleColor
Definition AutomationEditor.h:295
QColor m_ghostNoteColor
Definition AutomationEditor.h:298
QPointer< MidiClip > m_ghostNotes
Definition AutomationEditor.h:241
QColor nodeInValueColor
Definition AutomationEditor.h:61
void keyPressEvent(QKeyEvent *ke) override
Definition AutomationEditor.cpp:252
void updateAfterClipChange()
Definition AutomationEditor.cpp:207
bool fineTuneValue(timeMap::iterator node, bool editingOutValue)
Definition AutomationEditor.cpp:337
QBrush scaleColor
Definition AutomationEditor.h:64
QColor m_nodeTangentLineColor
Definition AutomationEditor.h:294
Action m_action
Definition AutomationEditor.h:255
QColor m_beatLineColor
Definition AutomationEditor.h:289
static const int DEFAULT_Y_DELTA
Definition AutomationEditor.h:200
QColor barLineColor
Definition AutomationEditor.h:58
static const int SAMPLE_MARGIN
Definition AutomationEditor.h:209
const AutomationClip * currentClip() const
Definition AutomationEditor.h:77
static const int NOTE_MARGIN
Total border margin for notes.
Definition AutomationEditor.h:207
void wheelEvent(QWheelEvent *we) override
Definition AutomationEditor.cpp:1547
QBrush graphColor
Definition AutomationEditor.h:65
static const int MIN_NOTE_RANGE
Min number of keys for fixed size.
Definition AutomationEditor.h:208
QColor backgroundShade
Definition AutomationEditor.h:67
int m_ppb
Definition AutomationEditor.h:262
void setQuantization()
Updates the clip's quantization using the current user selected value.
Definition AutomationEditor.cpp:1857
QPixmap m_toolDraw
Definition AutomationEditor.h:216
FloatModel * m_tensionModel
Definition AutomationEditor.h:230
QColor ghostSampleColor
Definition AutomationEditor.h:70
static const int VALUES_WIDTH
Definition AutomationEditor.h:204
QColor m_nodeInValueColor
Definition AutomationEditor.h:292
float m_drawLastLevel
Definition AutomationEditor.h:259
void loadSettings(const QDomElement &parent) override
Definition AutomationEditor.cpp:199
void stop()
Definition AutomationEditor.cpp:1692
QPixmap m_toolXFlip
Definition AutomationEditor.h:222
QPixmap m_toolYFlip
Definition AutomationEditor.h:221
QColor m_crossColor
Definition AutomationEditor.h:296
static constexpr int MAX_SAMPLE_HEIGHT
Definition AutomationEditor.h:210
QPointer< SampleClip > m_ghostSample
Definition AutomationEditor.h:242
QPixmap m_toolMove
Definition AutomationEditor.h:220
void drawAutomationPoint(QPainter &p, timeMap::iterator it)
Definition AutomationEditor.cpp:953
void mouseDoubleClickEvent(QMouseEvent *mouseEvent) override
Definition AutomationEditor.cpp:657
friend class AutomationEditorWindow
Definition AutomationEditor.h:304
QPixmap m_toolErase
Definition AutomationEditor.h:217
static const int DEFAULT_STEPS_PER_BAR
Definition AutomationEditor.h:201
void mouseMoveEvent(QMouseEvent *mouseEvent) override
Definition AutomationEditor.cpp:718
void adjustLeftRightScoll(int value)
Definition AutomationEditor.cpp:1539
void centerTopBottomScroll()
Definition AutomationEditor.cpp:1481
float m_step
Definition AutomationEditor.h:235
void horScrolled(int new_pos)
Definition AutomationEditor.cpp:1712
void setCurrentClip(AutomationClip *new_clip)
Definition AutomationEditor.cpp:170
QColor nodeTangentLineColor
Definition AutomationEditor.h:63
QColor ghostNoteColor
Definition AutomationEditor.h:68
TimeLineWidget * m_timeLine
Definition AutomationEditor.h:280
ComboBoxModel m_quantizeModel
Definition AutomationEditor.h:226
QPixmap m_toolEditTangents
Definition AutomationEditor.h:219
QColor lineColor
Definition AutomationEditor.h:60
QColor m_ghostSampleColor
Definition AutomationEditor.h:300
static const int NOTE_HEIGHT
Height of individual notes.
Definition AutomationEditor.h:206
tick_t m_drawLastTick
Definition AutomationEditor.h:260
QColor nodeOutValueColor
Definition AutomationEditor.h:62
void mousePressEvent(QMouseEvent *mouseEvent) override
Definition AutomationEditor.cpp:386
bool m_mouseDownLeft
Definition AutomationEditor.h:277
int m_moveXOffset
Definition AutomationEditor.h:257
QScrollBar * m_leftRightScroll
Definition AutomationEditor.h:248
void zoomingYChanged()
Definition AutomationEditor.cpp:1825
float m_minLevel
Definition AutomationEditor.h:233
QScrollBar * m_topBottomScroll
Definition AutomationEditor.h:249
float m_scrollLevel
Definition AutomationEditor.h:236
AutomationClip * m_clip
Definition AutomationEditor.h:232
float m_maxLevel
Definition AutomationEditor.h:234
void drawCross(QPainter &p)
Definition AutomationEditor.cpp:918
timeMap::iterator getClosestNode(int x)
Given a mouse X coordinate, returns a timeMap::iterator that points to the closest node.
Definition AutomationEditor.cpp:1955
QColor m_backgroundShade
Definition AutomationEditor.h:297
QColor m_lineColor
Definition AutomationEditor.h:290
AutomationEditor(const AutomationEditor &)
bool m_scrollBack
Definition AutomationEditor.h:281
float m_bottomLevel
Definition AutomationEditor.h:237
void leaveEvent(QEvent *e) override
Definition AutomationEditor.cpp:292
QColor crossColor
Definition AutomationEditor.h:66
void setEditMode(AutomationEditor::EditMode mode)
Definition AutomationEditor.cpp:1732
void setTension()
Definition AutomationEditor.cpp:1772
float m_topLevel
Definition AutomationEditor.h:238
void resizeEvent(QResizeEvent *re) override
Definition AutomationEditor.cpp:1505
Action
Definition AutomationEditor.h:185
QString nodeName() const override
Definition AutomationEditor.h:89
ComboBoxModel m_zoomingXModel
Definition AutomationEditor.h:224
float m_y_delta
Definition AutomationEditor.h:263
QPixmap m_toolDrawOut
Definition AutomationEditor.h:218
QColor outOfBoundsShade
Definition AutomationEditor.h:71
int m_draggedOutValueKey
Time position (key) of automation node whose outValue is being dragged.
Definition AutomationEditor.h:267
bool m_draggedOutTangent
Whether the tangent being dragged is the InTangent or OutTangent.
Definition AutomationEditor.h:273
AutomationEditor()
Definition AutomationEditor.cpp:68
void setGhostSample(SampleClip *newSample)
Definition AutomationEditor.cpp:1019
QColor beatLineColor
Definition AutomationEditor.h:59
timeMap::iterator getNodeAt(int x, int y, bool outValue=false, int r=5)
Returns the automation node at a given mouse position, if any.
Definition AutomationEditor.cpp:1914
float getLevel(int y)
Definition AutomationEditor.cpp:1624
static const int DEFAULT_PPB
Definition AutomationEditor.h:202
void setGhostMidiClip(MidiClip *newMidiClip)
Definition AutomationEditor.cpp:1012
static const std::array< float, 7 > m_zoomXLevels
Definition AutomationEditor.h:228
void verScrolled(int new_pos)
Definition AutomationEditor.cpp:1722
AutomationClip::timeMap timeMap
Definition AutomationEditor.h:108
EditMode m_editMode
Definition AutomationEditor.h:275
QColor detuningNoteColor
Definition AutomationEditor.h:69
QColor m_nodeOutValueColor
Definition AutomationEditor.h:293
bool inPatternEditor()
Definition AutomationEditor.cpp:1641
void drawAutomationTangents(QPainter &p, timeMap::iterator it)
Definition AutomationEditor.cpp:979
void update()
Definition AutomationEditor.cpp:238
void drawLevelTick(QPainter &p, int tick, float value)
Definition AutomationEditor.cpp:1451
void saveSettings(QDomDocument &doc, QDomElement &parent) override
Definition AutomationEditor.cpp:191
void play()
Definition AutomationEditor.cpp:1649
bool m_y_auto
Definition AutomationEditor.h:264
TimePos m_currentPosition
Definition AutomationEditor.h:253
bool validClip() const
Definition AutomationEditor.h:82
void updateTopBottomLevels()
Definition AutomationEditor.cpp:1867
QBrush m_graphColor
Definition AutomationEditor.h:291
EditMode
Definition AutomationEditor.h:95
static const int TOP_MARGIN
Definition AutomationEditor.h:198
static const int SCROLLBAR_SIZE
Definition AutomationEditor.h:197
ComboBoxModel m_zoomingYModel
Definition AutomationEditor.h:225
void mouseReleaseEvent(QMouseEvent *mouseEvent) override
Definition AutomationEditor.cpp:684
QAction * m_flipXAction
Definition AutomationEditor.h:371
void dropEvent(QDropEvent *_de) override
Definition AutomationEditor.cpp:2221
QAction * m_drawOutAction
Definition AutomationEditor.h:363
QAction * m_linearAction
Definition AutomationEditor.h:367
AutomationEditorWindow()
Definition AutomationEditor.cpp:2001
void stop() override
Definition AutomationEditor.cpp:2284
void setGhostMidiClip(MidiClip *clip)
Definition AutomationEditor.h:325
void updateWindowTitle()
Definition AutomationEditor.cpp:2289
ComboBox * m_zoomingYComboBox
Definition AutomationEditor.h:376
QAction * m_eraseAction
Definition AutomationEditor.h:362
QAction * m_editTanAction
Definition AutomationEditor.h:364
QAction * m_flipYAction
Definition AutomationEditor.h:370
QAction * m_cubicHermiteAction
Definition AutomationEditor.h:368
void open(AutomationClip *clip)
Definition AutomationEditor.cpp:2254
QAction * m_discreteAction
Definition AutomationEditor.h:366
void play() override
Definition AutomationEditor.cpp:2278
QSize sizeHint() const override
Definition AutomationEditor.cpp:2262
ComboBox * m_quantizeComboBox
Definition AutomationEditor.h:377
AutomationEditor * m_editor
Definition AutomationEditor.h:335
Knob * m_tensionKnob
Definition AutomationEditor.h:373
void setCurrentClip(AutomationClip *clip)
Definition AutomationEditor.cpp:2162
void dragEnterEvent(QDragEnterEvent *_dee) override
Definition AutomationEditor.cpp:2246
void setProgressionType(int progType)
Definition AutomationEditor.cpp:2300
QAction * m_drawAction
Definition AutomationEditor.h:361
~AutomationEditorWindow() override=default
void focusInEvent(QFocusEvent *event) override
Definition AutomationEditor.cpp:2273
QPushButton * m_resetGhostNotes
Definition AutomationEditor.h:379
ComboBox * m_zoomingXComboBox
Definition AutomationEditor.h:375
static const int INITIAL_WIDTH
Definition AutomationEditor.h:318
void updateEditTanButton()
Definition AutomationEditor.cpp:2306
void setGhostSample(SampleClip *newSample)
Definition AutomationEditor.h:326
static const int INITIAL_HEIGHT
Definition AutomationEditor.h:319
const AutomationClip * currentClip()
Definition AutomationEditor.cpp:2216
void clearCurrentClip()
Definition AutomationEditor.cpp:2267
Definition ComboBox.h:38
Editor(bool record=false, bool stepRecord=false)
Definition Editor.cpp:91
Definition Knob.h:47
Definition TimeLineWidget.h:54
auto getIconPixmap(std::string_view name, int width, int height, const char *const *xpm) -> QPixmap
Return an image for the icon pixmap cache.
Definition embed.cpp:107
Definition AudioPortAudio.cpp:209
Definition RemotePluginBase.cpp:34
std::int32_t tick_t
Definition LmmsTypes.h:35
@ None
Definition LadspaBase.h:49