macosx: Add ability to hide knob to VLCSlider
[vlc.git] / modules / gui / macosx / VLCSliderCell.m
1 /*****************************************************************************
2  * VLCSliderCell.m
3  *****************************************************************************
4  * Copyright (C) 2017 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Marvin Scholz <epirat07 at gmail dot com>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (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
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #import "VLCSliderCell.h"
25 #import "CompatibilityFixes.h"
26
27 @interface VLCSliderCell () {
28     NSInteger _animationPosition;
29     double _lastTime;
30     double _deltaToLastFrame;
31     CVDisplayLinkRef _displayLink;
32 }
33 @end
34
35 @implementation VLCSliderCell
36
37 - (instancetype)initWithCoder:(NSCoder *)coder
38 {
39     self = [super initWithCoder:coder];
40     if (self) {
41         [self setSliderStyleLight];
42         _animationWidth = [[self controlView] bounds].size.width;
43
44         [self initDisplayLink];
45     }
46     return self;
47 }
48
49 - (void)setSliderStyleLight
50 {
51     // Color Declarations
52     _gradientColor = [NSColor colorWithCalibratedRed: 0.663 green: 0.663 blue: 0.663 alpha: 1];
53     _gradientColor2 = [NSColor colorWithCalibratedRed: 0.749 green: 0.749 blue: 0.753 alpha: 1];
54     _trackStrokeColor = [NSColor colorWithCalibratedRed: 0.619 green: 0.624 blue: 0.623 alpha: 1];
55     _filledTrackColor = [NSColor colorWithCalibratedRed: 0.55 green: 0.55 blue: 0.55 alpha: 1];
56     _knobFillColor = [NSColor colorWithCalibratedRed: 1 green: 1 blue: 1 alpha: 1];
57     _activeKnobFillColor = [NSColor colorWithCalibratedRed: 0.95 green: 0.95 blue: 0.95 alpha: 1];
58     _shadowColor = [NSColor colorWithCalibratedRed: 0.32 green: 0.32 blue: 0.32 alpha: 1];
59     _knobStrokeColor = [NSColor colorWithCalibratedRed: 0.592 green: 0.596 blue: 0.596 alpha: 1];
60
61     // Gradient Declarations
62     _trackGradient = [[NSGradient alloc] initWithColorsAndLocations:
63                       _gradientColor, 0.0,
64                       [_gradientColor blendedColorWithFraction:0.5 ofColor:_gradientColor2], 0.60,
65                       _gradientColor2, 1.0, nil];
66
67     // Shadow Declarations
68     _knobShadow = [[NSShadow alloc] init];
69     _knobShadow.shadowColor = _shadowColor;
70     _knobShadow.shadowOffset = NSMakeSize(0, 0);
71     _knobShadow.shadowBlurRadius = 2;
72
73     _highlightBackground = [NSColor colorWithCalibratedRed:0.20 green:0.55 blue:0.91 alpha:1.0];
74     NSColor *highlightAccent = [NSColor colorWithCalibratedRed:0.4588235294 green:0.7254901961 blue:0.9882352941 alpha:1.0];
75     _highlightGradient = [[NSGradient alloc] initWithColors:@[
76                                                               _highlightBackground,
77                                                               highlightAccent,
78                                                               _highlightBackground
79                                                               ]];
80 }
81
82 - (void)setSliderStyleDark
83 {
84     // Color Declarations
85     _gradientColor = [NSColor colorWithCalibratedRed: 0.24 green: 0.24 blue: 0.24 alpha: 1];
86     _gradientColor2 = [NSColor colorWithCalibratedRed: 0.15 green: 0.15 blue: 0.15 alpha: 1];
87     _trackStrokeColor = [NSColor colorWithCalibratedRed: 0.23 green: 0.23 blue: 0.23 alpha: 1];
88     _filledTrackColor = [NSColor colorWithCalibratedRed: 0.15 green: 0.15 blue: 0.15 alpha: 1];
89     _knobFillColor = [NSColor colorWithCalibratedRed: 1 green: 1 blue: 1 alpha: 1];
90     _activeKnobFillColor = [NSColor colorWithCalibratedRed: 0.95 green: 0.95 blue: 0.95 alpha: 1];
91     _shadowColor = [NSColor colorWithCalibratedRed: 0.32 green: 0.32 blue: 0.32 alpha: 1];
92     _knobStrokeColor = [NSColor colorWithCalibratedRed: 0.592 green: 0.596 blue: 0.596 alpha: 1];
93
94     // Gradient Declarations
95     _trackGradient = [[NSGradient alloc] initWithColorsAndLocations:
96                       _gradientColor, 0.0,
97                       [_gradientColor blendedColorWithFraction:0.5 ofColor:_gradientColor2], 0.60,
98                       _gradientColor2, 1.0, nil];
99
100     // Shadow Declarations
101     _knobShadow = [[NSShadow alloc] init];
102     _knobShadow.shadowColor = _shadowColor;
103     _knobShadow.shadowOffset = NSMakeSize(0, 0);
104     _knobShadow.shadowBlurRadius = 2;
105
106     _highlightBackground = [NSColor colorWithCalibratedRed:0.20 green:0.55 blue:0.91 alpha:1.0];
107     NSColor *highlightAccent = [NSColor colorWithCalibratedRed:0.4588235294 green:0.7254901961 blue:0.9882352941 alpha:1.0];
108     _highlightGradient = [[NSGradient alloc] initWithColors:@[
109                                                               _highlightBackground,
110                                                               highlightAccent,
111                                                               _highlightBackground
112                                                               ]];
113 }
114
115 - (void)dealloc
116 {
117     CVDisplayLinkRelease(_displayLink);
118 }
119
120 static CVReturn DisplayLinkCallback(CVDisplayLinkRef displayLink, const CVTimeStamp *inNow, const CVTimeStamp *inOutputTime, CVOptionFlags flagsIn, CVOptionFlags *flagsOut, void *displayLinkContext)
121 {
122     CVTimeStamp inNowCopy = *inNow;
123     dispatch_async(dispatch_get_main_queue(), ^{
124         VLCSliderCell *sliderCell = (__bridge VLCSliderCell*)displayLinkContext;
125         [sliderCell displayLink:displayLink tickWithTime:&inNowCopy];
126     });
127     return kCVReturnSuccess;
128 }
129
130 - (void)displayLink:(CVDisplayLinkRef)displayLink tickWithTime:(const CVTimeStamp*)inNow
131 {
132     if (_lastTime == 0) {
133         _deltaToLastFrame = 0;
134     } else {
135         _deltaToLastFrame = (double)(inNow->videoTime - _lastTime) / inNow->videoTimeScale;
136     }
137     _lastTime = inNow->videoTime;
138
139     [self.controlView setNeedsDisplay:YES];
140 }
141
142 - (void)initDisplayLink
143 {
144     CVReturn ret = CVDisplayLinkCreateWithActiveCGDisplays(&_displayLink);
145     if (ret != kCVReturnSuccess) {
146         // TODO: Handle error
147         return;
148     }
149     CVDisplayLinkSetOutputCallback(_displayLink, DisplayLinkCallback, (__bridge void*) self);
150 }
151
152 - (double)myNormalizedDouble
153 {
154     double min;
155     double max;
156     double current;
157
158     min = [self minValue];
159     max = [self maxValue];
160     current = [self doubleValue];
161
162     max -= min;
163     current -= min;
164
165     return current / max;
166 }
167
168 - (NSRect)knobRectFlipped:(BOOL)flipped
169 {
170 #pragma clang diagnostic push
171 #pragma clang diagnostic ignored "-Wpartial-availability"
172     // This is our own implementation, so no need to guard it on < 10.9
173     NSRect barRect = [self barRectFlipped:NO];
174 #pragma clang diagnostic pop
175     CGFloat knobThickness = barRect.size.height;
176     double val = [self myNormalizedDouble];
177
178     NSRect rect = NSMakeRect((NSWidth(barRect) - knobThickness) * val, 0, knobThickness, knobThickness);
179     return [[self controlView] backingAlignedRect:rect options:NSAlignAllEdgesNearest];
180 }
181
182 #pragma mark -
183 #pragma mark Normal slider drawing
184
185 - (void)drawKnob:(NSRect)knobRect
186 {
187     if (_isKnobHidden)
188         return;
189
190     // Draw knob
191     NSBezierPath* knobPath = [NSBezierPath bezierPathWithOvalInRect:NSInsetRect(knobRect, 2.0, 2.0)];
192     if (self.isHighlighted) {
193         [_activeKnobFillColor setFill];
194     } else {
195         [_knobFillColor setFill];
196     }
197
198     [knobPath fill];
199
200     [_knobStrokeColor setStroke];
201     knobPath.lineWidth = 0.5;
202
203     [NSGraphicsContext saveGraphicsState];
204     if (self.isHighlighted)
205         [_knobShadow set];
206     [knobPath stroke];
207     [NSGraphicsContext restoreGraphicsState];
208 }
209
210 - (NSRect)barRectFlipped:(BOOL)flipped
211 {
212     return [[self controlView] bounds];
213 }
214
215 - (void)drawBarInside:(NSRect)rect flipped:(BOOL)flipped
216 {
217     // Inset rect
218     rect = NSInsetRect(rect, 1.0, 1.0);
219
220     // Empty Track Drawing
221     NSBezierPath* emptyTrackPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:3 yRadius:3];
222     [_trackGradient drawInBezierPath:emptyTrackPath angle:-90];
223
224     if (_isKnobHidden) {
225         [_trackStrokeColor setStroke];
226         emptyTrackPath.lineWidth = 1;
227         [emptyTrackPath stroke];
228         return;
229     }
230
231     // Calculate filled track
232     NSRect filledTrackRect = rect;
233     NSRect knobRect = [self knobRectFlipped:NO];
234     filledTrackRect.size.width = knobRect.origin.x + (self.knobThickness / 2);
235
236     // Filled Track Drawing
237     CGFloat filledTrackCornerRadius = 2;
238     NSBezierPath* filledTrackPath = [NSBezierPath bezierPathWithRoundedRect:filledTrackRect
239                                                                     xRadius:filledTrackCornerRadius
240                                                                     yRadius:filledTrackCornerRadius];
241
242     [_filledTrackColor setFill];
243     [filledTrackPath fill];
244
245     [_trackStrokeColor setStroke];
246     emptyTrackPath.lineWidth = 1;
247     [emptyTrackPath stroke];
248 }
249
250 #pragma mark -
251 #pragma mark Indefinite slider drawing
252
253
254 - (void)drawHighlightInRect:(NSRect)rect
255 {
256     [_highlightGradient drawInRect:rect angle:0];
257 }
258
259
260 - (void)drawHighlightBackgroundInRect:(NSRect)rect
261 {
262     rect = NSInsetRect(rect, 1.0, 1.0);
263     NSBezierPath *fullPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:2.0 yRadius:2.0];
264     [_highlightBackground setFill];
265     [fullPath fill];
266 }
267
268 - (void)drawAnimationInRect:(NSRect)rect
269 {
270     [self drawHighlightBackgroundInRect:rect];
271
272     [NSGraphicsContext saveGraphicsState];
273     rect = NSInsetRect(rect, 1.0, 1.0);
274     NSBezierPath *fullPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:2.0 yRadius:2.0];
275     [fullPath setClip];
276
277     // Use previously calculated position
278     rect.origin.x = _animationPosition;
279
280     // Calculate new position for next Frame
281     if (_animationPosition < (rect.size.width + _animationWidth)) {
282         _animationPosition += (rect.size.width + _animationWidth) * _deltaToLastFrame;
283     } else {
284         _animationPosition = -(_animationWidth);
285     }
286
287     rect.size.width = _animationWidth;
288
289
290     [self drawHighlightInRect:rect];
291     [NSGraphicsContext restoreGraphicsState];
292     _deltaToLastFrame = 0;
293 }
294
295
296 - (void)drawWithFrame:(NSRect)cellFrame inView:(NSView *)controlView
297 {
298     if (_indefinite)
299         return [self drawAnimationInRect:cellFrame];
300
301     [super drawWithFrame:cellFrame inView:controlView];
302
303 }
304
305 #pragma mark -
306 #pragma mark Animation handling
307
308 - (void)beginAnimating
309 {
310     CVReturn err = CVDisplayLinkStart(_displayLink);
311     if (err != kCVReturnSuccess) {
312         // TODO: Handle error
313     }
314     _animationPosition = -(_animationWidth);
315     [self setEnabled:NO];
316 }
317
318 - (void)endAnimating
319 {
320     CVDisplayLinkStop(_displayLink);
321     [self setEnabled:YES];
322
323 }
324
325 - (void)setIndefinite:(BOOL)indefinite
326 {
327     if (_indefinite == indefinite)
328         return;
329
330     if (indefinite)
331         [self beginAnimating];
332     else
333         [self endAnimating];
334     _indefinite = indefinite;
335 }
336
337 - (void)setKnobHidden:(BOOL)isKnobHidden
338 {
339     _isKnobHidden = isKnobHidden;
340     [self.controlView setNeedsDisplay:YES];
341 }
342
343
344 @end