macosx: Improve VLCSlider knob positioning
[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         // Color Declarations
42         _gradientColor = [NSColor colorWithCalibratedRed: 0.663 green: 0.663 blue: 0.663 alpha: 1];
43         _gradientColor2 = [NSColor colorWithCalibratedRed: 0.749 green: 0.749 blue: 0.753 alpha: 1];
44         _trackStrokeColor = [NSColor colorWithCalibratedRed: 0.619 green: 0.624 blue: 0.623 alpha: 1];
45         _filledTrackColor = [NSColor colorWithCalibratedRed: 0.596 green: 0.596 blue: 0.596 alpha: 1];
46         _knobFillColor = [NSColor colorWithCalibratedRed: 1 green: 1 blue: 1 alpha: 1];
47         _activeKnobFillColor = [NSColor colorWithCalibratedRed: 0.95 green: 0.95 blue: 0.95 alpha: 1];
48         _shadowColor = [NSColor colorWithCalibratedRed: 0.32 green: 0.32 blue: 0.32 alpha: 1];
49         _knobStrokeColor = [NSColor colorWithCalibratedRed: 0.592 green: 0.596 blue: 0.596 alpha: 1];
50
51         // Gradient Declarations
52         _trackGradient = [[NSGradient alloc] initWithColorsAndLocations:
53                           _gradientColor, 0.0,
54                           [_gradientColor blendedColorWithFraction:0.5 ofColor:_gradientColor2], 0.60,
55                           _gradientColor2, 1.0, nil];
56
57         // Shadow Declarations
58         _knobShadow = [[NSShadow alloc] init];
59         _knobShadow.shadowColor = _shadowColor;
60         _knobShadow.shadowOffset = NSMakeSize(0, 0);
61         _knobShadow.shadowBlurRadius = 2;
62
63         _highlightBackground = [NSColor colorWithCalibratedRed:0.20 green:0.55 blue:0.91 alpha:1.0];
64         NSColor *highlightAccent = [NSColor colorWithCalibratedRed:0.4588235294 green:0.7254901961 blue:0.9882352941 alpha:1.0];
65         _highlightGradient = [[NSGradient alloc] initWithColors:@[
66                                                                   _highlightBackground,
67                                                                   highlightAccent,
68                                                                   _highlightBackground
69                                                                   ]];
70         _animationWidth = [[self controlView] bounds].size.width;
71
72         [self initDisplayLink];
73     }
74     return self;
75 }
76
77 - (void)dealloc
78 {
79     CVDisplayLinkRelease(_displayLink);
80 }
81
82 static CVReturn DisplayLinkCallback(CVDisplayLinkRef displayLink, const CVTimeStamp *inNow, const CVTimeStamp *inOutputTime, CVOptionFlags flagsIn, CVOptionFlags *flagsOut, void *displayLinkContext)
83 {
84     CVTimeStamp inNowCopy = *inNow;
85     dispatch_async(dispatch_get_main_queue(), ^{
86         VLCSliderCell *sliderCell = (__bridge VLCSliderCell*)displayLinkContext;
87         [sliderCell displayLink:displayLink tickWithTime:&inNowCopy];
88     });
89     return kCVReturnSuccess;
90 }
91
92 - (void)displayLink:(CVDisplayLinkRef)displayLink tickWithTime:(const CVTimeStamp*)inNow
93 {
94     if (_lastTime == 0) {
95         _deltaToLastFrame = 0;
96     } else {
97         _deltaToLastFrame = (double)(inNow->videoTime - _lastTime) / inNow->videoTimeScale;
98     }
99     _lastTime = inNow->videoTime;
100
101     [self.controlView setNeedsDisplay:YES];
102 }
103
104 - (void)initDisplayLink
105 {
106     CVReturn ret = CVDisplayLinkCreateWithActiveCGDisplays(&_displayLink);
107     if (ret != kCVReturnSuccess) {
108         // TODO: Handle error
109         return;
110     }
111     CVDisplayLinkSetOutputCallback(_displayLink, DisplayLinkCallback, (__bridge void*) self);
112 }
113
114 - (double)myNormalizedDouble
115 {
116     double min;
117     double max;
118     double current;
119
120     min = [self minValue];
121     max = [self maxValue];
122     current = [self doubleValue];
123
124     max -= min;
125     current -= min;
126
127     return current / max;
128 }
129
130 - (NSRect)knobRectFlipped:(BOOL)flipped
131 {
132 #pragma clang diagnostic push
133 #pragma clang diagnostic ignored "-Wpartial-availability"
134     // This is our own implementation, so no need to guard it on < 10.9
135     NSRect barRect = [self barRectFlipped:NO];
136 #pragma clang diagnostic pop
137     CGFloat knobThickness = barRect.size.height;
138     double val = [self myNormalizedDouble];
139
140     NSRect rect = NSMakeRect((NSWidth(barRect) - knobThickness) * val, 0, knobThickness, knobThickness);
141     return [[self controlView] backingAlignedRect:rect options:NSAlignAllEdgesNearest];
142 }
143
144 #pragma mark -
145 #pragma mark Normal slider drawing
146
147 - (void)drawKnob:(NSRect)knobRect
148 {
149     // Draw knob
150     NSBezierPath* knobPath = [NSBezierPath bezierPathWithOvalInRect:NSInsetRect(knobRect, 2.0, 2.0)];
151     if (self.isHighlighted) {
152         [_activeKnobFillColor setFill];
153     } else {
154         [_knobFillColor setFill];
155     }
156
157     [knobPath fill];
158
159     [_knobStrokeColor setStroke];
160     knobPath.lineWidth = 0.5;
161
162     [NSGraphicsContext saveGraphicsState];
163     if (self.isHighlighted)
164         [_knobShadow set];
165     [knobPath stroke];
166     [NSGraphicsContext restoreGraphicsState];
167 }
168
169 - (NSRect)barRectFlipped:(BOOL)flipped
170 {
171     return [[self controlView] bounds];
172 }
173
174 - (void)drawBarInside:(NSRect)rect flipped:(BOOL)flipped
175 {
176     // Inset rect
177     rect = NSInsetRect(rect, 1.0, 1.0);
178
179     // Empty Track Drawing
180     NSBezierPath* emptyTrackPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:3 yRadius:3];
181     [_trackGradient drawInBezierPath:emptyTrackPath angle:-90];
182     [_trackStrokeColor setStroke];
183     emptyTrackPath.lineWidth = 1;
184     [emptyTrackPath stroke];
185
186     // Calculate filled track
187     NSRect filledTrackRect = rect;
188     NSRect knobRect = [self knobRectFlipped:NO];
189     filledTrackRect.size.width = knobRect.origin.x + (self.knobThickness / 2);
190
191     // Filled Track Drawing
192     CGFloat filledTrackCornerRadius = 2;
193     NSRect filledTrackInnerRect = NSInsetRect(filledTrackRect, filledTrackCornerRadius, filledTrackCornerRadius);
194     NSBezierPath* filledTrackPath = [NSBezierPath bezierPathWithRoundedRect:filledTrackInnerRect
195                                                                     xRadius:filledTrackCornerRadius
196                                                                     yRadius:filledTrackCornerRadius];
197
198     [_filledTrackColor setFill];
199     [filledTrackPath fill];
200 }
201
202 #pragma mark -
203 #pragma mark Indefinite slider drawing
204
205
206 - (void)drawHighlightInRect:(NSRect)rect
207 {
208     [_highlightGradient drawInRect:rect angle:0];
209 }
210
211
212 - (void)drawHighlightBackgroundInRect:(NSRect)rect
213 {
214     rect = NSInsetRect(rect, 1.0, 1.0);
215     NSBezierPath *fullPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:2.0 yRadius:2.0];
216     [_highlightBackground setFill];
217     [fullPath fill];
218 }
219
220 - (void)drawAnimationInRect:(NSRect)rect
221 {
222     [self drawHighlightBackgroundInRect:rect];
223
224     [NSGraphicsContext saveGraphicsState];
225     rect = NSInsetRect(rect, 1.0, 1.0);
226     NSBezierPath *fullPath = [NSBezierPath bezierPathWithRoundedRect:rect xRadius:2.0 yRadius:2.0];
227     [fullPath setClip];
228
229     // Use previously calculated position
230     rect.origin.x = _animationPosition;
231
232     // Calculate new position for next Frame
233     if (_animationPosition < (rect.size.width + _animationWidth)) {
234         _animationPosition += (rect.size.width + _animationWidth) * _deltaToLastFrame;
235     } else {
236         _animationPosition = -(_animationWidth);
237     }
238
239     rect.size.width = _animationWidth;
240
241
242     [self drawHighlightInRect:rect];
243     [NSGraphicsContext restoreGraphicsState];
244     _deltaToLastFrame = 0;
245 }
246
247
248 - (void)drawWithFrame:(NSRect)cellFrame inView:(NSView *)controlView
249 {
250     if (_indefinite)
251         return [self drawAnimationInRect:cellFrame];
252
253     [super drawWithFrame:cellFrame inView:controlView];
254
255 }
256
257 #pragma mark -
258 #pragma mark Animation handling
259
260 - (void)beginAnimating
261 {
262     CVReturn err = CVDisplayLinkStart(_displayLink);
263     if (err != kCVReturnSuccess) {
264         // TODO: Handle error
265     }
266     _animationPosition = -(_animationWidth);
267     [self setEnabled:NO];
268 }
269
270 - (void)endAnimating
271 {
272     CVDisplayLinkStop(_displayLink);
273     [self setEnabled:YES];
274
275 }
276
277 - (void)setIndefinite:(BOOL)indefinite
278 {
279     if (_indefinite == indefinite)
280         return;
281
282     if (indefinite)
283         [self beginAnimating];
284     else
285         [self endAnimating];
286     _indefinite = indefinite;
287 }
288
289
290 @end