]> git.sesse.net Git - kdenlive/blob - src/colorpickerwidget.cpp
Color Picker: Fix miscalculations when picking average color
[kdenlive] / src / colorpickerwidget.cpp
1 /***************************************************************************
2  *   Copyright (C) 2010 by Till Theato (root@ttill.de)                     *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
18  ***************************************************************************/
19
20
21 #include "colorpickerwidget.h"
22
23 #include <QMouseEvent>
24 #include <QHBoxLayout>
25 #include <QPushButton>
26 #include <QLabel>
27 #include <QSpinBox>
28 #include <QDesktopWidget>
29
30 #include <KApplication>
31 #include <KIcon>
32 #include <KLocalizedString>
33
34 #ifdef Q_WS_X11
35 #include <X11/Xutil.h>
36 #include <fixx11h.h>
37
38 class KCDPickerFilter: public QWidget
39 {
40 public:
41     KCDPickerFilter(QWidget* parent): QWidget(parent) {}
42
43     virtual bool x11Event(XEvent* event) {
44         if (event->type == ButtonRelease) {
45             QMouseEvent e(QEvent::MouseButtonRelease, QPoint(),
46             QPoint(event->xmotion.x_root, event->xmotion.y_root) , Qt::NoButton, Qt::NoButton, Qt::NoModifier);
47             QApplication::sendEvent(parentWidget(), &e);
48             return true;
49         }
50         return false;
51     }
52 };
53 #endif 
54
55
56 ColorPickerWidget::ColorPickerWidget(QWidget *parent) :
57         QWidget(parent),
58         m_filterActive(false)
59 {
60 #ifdef Q_WS_X11
61     m_filter = 0;
62 #endif
63     m_image = 0;
64
65     QHBoxLayout *layout = new QHBoxLayout(this);
66
67     QPushButton *button = new QPushButton(this);
68     button->setIcon(KIcon("color-picker"));
69     button->setToolTip(i18n("Pick a color on the screen"));
70     connect(button, SIGNAL(clicked()), this, SLOT(slotSetupEventFilter()));
71
72     m_size = new QSpinBox(this);
73     m_size->setMinimum(1);
74     // Use qMin here, as we might run into troubles with the cursor otherwise.
75     m_size->setMaximum(qMin(qApp->desktop()->geometry().width(), qApp->desktop()->geometry().height()));
76     m_size->setValue(1);
77
78     layout->addWidget(button);
79     layout->addStretch(1);
80     layout->addWidget(new QLabel(i18n("Width of square to pick color from:")));
81     layout->addWidget(m_size);
82 }
83
84 ColorPickerWidget::~ColorPickerWidget()
85 {
86 #ifdef Q_WS_X11
87     if (m_filterActive && kapp)
88         kapp->removeX11EventFilter(m_filter);
89 #endif
90 }
91
92 QColor ColorPickerWidget::averagePickedColor(const QPoint pos)
93 {
94     int size = m_size->value();
95     int x0 = qMax(0, pos.x() - size / 2);
96     int y0 = qMax(0, pos.y() - size / 2);
97     int x1 = qMin(qApp->desktop()->geometry().width(), pos.x() + size / 2);
98     int y1 = qMin(qApp->desktop()->geometry().height(), pos.y() + size / 2);
99
100     // take care of loss when dividing odd sizes
101     if (size % 2 != 0) {
102         ++x1;
103         ++y1;
104     }
105
106     int numPixel = (x1 - x0) * (y1 - y0);
107
108     int sumR = 0;
109     int sumG = 0;
110     int sumB = 0;
111
112     // only show message for size > 200 because for smaller values it slows down to much
113     if (size > 200)
114         emit displayMessage(i18n("Requesting color information..."), 0);
115
116     /*
117      Only getting the image once for the whole rect
118      results in a vast speed improvement.
119     */
120 #ifdef Q_WS_X11
121     Window root = RootWindow(QX11Info::display(), QX11Info::appScreen());
122     m_image = XGetImage(QX11Info::display(), root, x0, y0, x1 - x0, y1 - y0, -1, ZPixmap);
123 #else
124     QWidget *desktop = QApplication::desktop();
125     m_image = QPixmap::grabWindow(desktop->winId(), x0, y0, x1 - x0, y1 - y0).toImage();
126 #endif
127
128     for (int i = x0; i < x1; ++i) {
129         for (int j = y0; j < y1; ++j) {
130             QColor color;
131             color = grabColor(QPoint(i - x0, j - y0), false);
132             sumR += color.red();
133             sumG += color.green();
134             sumB += color.blue();
135         }
136
137         // Warning: slows things down, so don't do it for every pixel (the inner for loop)
138         if (size > 200)
139             emit displayMessage(i18n("Requesting color information..."), (int)(((i - x0) * (y1 - y0)) / (qreal)numPixel * 100));
140     }
141
142 #ifdef Q_WS_X11
143     XDestroyImage(m_image);
144 #endif
145     m_image = 0;
146
147     if (size > 200)
148         emit displayMessage(i18n("Calculated average color for rectangle."), -1);
149
150     return QColor(sumR / numPixel, sumG / numPixel, sumB / numPixel);
151 }
152
153 void ColorPickerWidget::mousePressEvent(QMouseEvent* event)
154 {
155     if (event->button() != Qt::LeftButton) {
156         closeEventFilter();
157         event->accept();
158         return;
159     }
160     QWidget::mousePressEvent(event);
161 }
162
163 void ColorPickerWidget::mouseReleaseEvent(QMouseEvent *event)
164 {
165     if (m_filterActive) {
166         closeEventFilter();
167
168         if (m_size->value() == 1)
169             emit colorPicked(grabColor(event->globalPos()));
170         else
171             emit colorPicked(averagePickedColor(event->globalPos()));
172
173         return;
174     }
175     QWidget::mouseReleaseEvent(event);
176 }
177
178 void ColorPickerWidget::keyPressEvent(QKeyEvent *event)
179 {
180     if (m_filterActive) {
181         // "special keys" (non letter, numeral) do not work, so close for every key
182         //if (event->key() == Qt::Key_Escape)
183         closeEventFilter();
184         event->accept();
185         return;
186     }
187     QWidget::keyPressEvent(event);
188 }
189
190 void ColorPickerWidget::slotSetupEventFilter()
191 {
192     m_filterActive = true;
193 #ifdef Q_WS_X11
194     m_filter = new KCDPickerFilter(this);
195     kapp->installX11EventFilter(m_filter);
196 #endif
197     if (m_size->value() < 10)
198         grabMouse(QCursor(KIcon("color-picker").pixmap(22, 22), 0, 21));
199     else
200         grabMouse(QCursor(KIcon("kdenlive-select-all").pixmap(m_size->value(), m_size->value())));
201     grabKeyboard();
202 }
203
204 void ColorPickerWidget::closeEventFilter()
205 {
206     m_filterActive = false;
207 #ifdef Q_WS_X11
208     kapp->removeX11EventFilter(m_filter);
209     delete m_filter;
210     m_filter = 0;
211 #endif
212     releaseMouse();
213     releaseKeyboard();
214 }
215
216 QColor ColorPickerWidget::grabColor(const QPoint &p, bool destroyImage)
217 {
218 #ifdef Q_WS_X11
219     /*
220      we use the X11 API directly in this case as we are not getting back a valid
221      return from QPixmap::grabWindow in the case where the application is using
222      an argb visual
223     */
224     if( !qApp->desktop()->geometry().contains( p ))
225         return QColor();
226     unsigned long xpixel;
227     if (m_image == 0) {
228         Window root = RootWindow(QX11Info::display(), QX11Info::appScreen());
229         m_image = XGetImage(QX11Info::display(), root, p.x(), p.y(), 1, 1, -1, ZPixmap);
230         xpixel = XGetPixel(m_image, 0, 0);
231     } else {
232         xpixel = XGetPixel(m_image, p.x(), p.y());
233     }
234     if (destroyImage) {
235         XDestroyImage(m_image);
236         m_image = 0;
237     }
238     XColor xcol;
239     xcol.pixel = xpixel;
240     xcol.flags = DoRed | DoGreen | DoBlue;
241     XQueryColor(QX11Info::display(),
242                 DefaultColormap(QX11Info::display(), QX11Info::appScreen()),
243                 &xcol);
244     return QColor::fromRgbF(xcol.red / 65535.0, xcol.green / 65535.0, xcol.blue / 65535.0);
245 #else
246     if (m_image == 0) {
247         QWidget *desktop = QApplication::desktop();
248         QPixmap pm = QPixmap::grabWindow(desktop->winId(), p.x(), p.y(), 1, 1);
249         QImage i = pm.toImage();
250         return i.pixel(0, 0);
251     } else {
252         return m_image.pixel(p.x(), p.y());
253     }
254 #endif
255 }
256
257 #include "colorpickerwidget.moc"