macosx.m 24.3 KB
Newer Older
Pierre's avatar
Pierre committed
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * macosx.m: MacOS X OpenGL provider
Pierre's avatar
Pierre committed
3
 *****************************************************************************
4
 * Copyright (C) 2001-2013 VLC authors and VideoLAN
Pierre's avatar
Pierre committed
5
6
 * $Id$
 *
7
 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
Pierre's avatar
Pierre committed
8
9
10
11
 *          Eric Petit <titer@m0k.org>
 *          Benjamin Pracht <bigben at videolan dot org>
 *          Damien Fouilleul <damienf at videolan dot org>
 *          Pierre d'Herbemont <pdherbemont at videolan dot org>
12
 *          Felix Paul Kühne <fkuehne at videolan dot org>
13
 *          David Fuhrmann <david dot fuhrmann at googlemail dot com>
14
15
16
 *          Rémi Denis-Courmont
 *          Juho Vähä-Herttua <juhovh at iki dot fi>
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
Pierre's avatar
Pierre committed
17
 *
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
18
19
20
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
Pierre's avatar
Pierre committed
21
22
23
24
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
25
26
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
Pierre's avatar
Pierre committed
27
 *
Jean-Baptiste Kempf's avatar
LGPL    
Jean-Baptiste Kempf committed
28
29
30
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Pierre's avatar
Pierre committed
31
32
33
34
35
36
37
38
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

#import <Cocoa/Cocoa.h>
#import <OpenGL/OpenGL.h>
39
#import <dlfcn.h>
Pierre's avatar
Pierre committed
40
41
42
43
44
45
46
47

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_vout_display.h>
48
#include <vlc_opengl.h>
49
#include <vlc_dialog.h>
Pierre's avatar
Pierre committed
50
51
#include "opengl.h"

52
53
54
55
56
57
58
/* compilation support for 10.5 and 10.6 */
#define OSX_LION NSAppKitVersionNumber >= 1115.2
#ifndef MAC_OS_X_VERSION_10_7

@interface NSView (IntroducedInLion)
- (NSRect)convertRectToBacking:(NSRect)aRect;
- (void)setWantsBestResolutionOpenGLSurface:(BOOL)aBool;
Felix Paul Kühne's avatar
Felix Paul Kühne committed
59
@end
60
61
62

#endif

Pierre's avatar
Pierre committed
63
64
65
/**
 * Forward declarations
 */
66
67
static int Open (vlc_object_t *);
static void Close (vlc_object_t *);
Pierre's avatar
Pierre committed
68

69
70
71
static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count);
static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture);
Pierre's avatar
Pierre committed
72
73
static int Control (vout_display_t *vd, int query, va_list ap);

74
75
static void *OurGetProcAddress(vlc_gl_t *, const char *);

76
77
78
static int OpenglLock (vlc_gl_t *gl);
static void OpenglUnlock (vlc_gl_t *gl);
static void OpenglSwap (vlc_gl_t *gl);
Pierre's avatar
Pierre committed
79
80
81
82
83
84

/**
 * Module declaration
 */
vlc_module_begin ()
    /* Will be loaded even without interface module. see voutgl.m */
85
86
87
    set_shortname ("Mac OS X")
    set_description (N_("Mac OS X OpenGL video output (requires drawable-nsobject)"))
    set_category (CAT_VIDEO)
88
    set_subcategory (SUBCAT_VIDEO_VOUT)
89
90
91
92
    set_capability ("vout display", 300)
    set_callbacks (Open, Close)

    add_shortcut ("macosx", "vout_macosx")
Pierre's avatar
Pierre committed
93
94
95
96
97
98
99
100
101
102
103
104
105
vlc_module_end ()

/**
 * Obj-C protocol declaration that drawable-nsobject should follow
 */
@protocol VLCOpenGLVideoViewEmbedding <NSObject>
- (void)addVoutSubview:(NSView *)view;
- (void)removeVoutSubview:(NSView *)view;
@end

@interface VLCOpenGLVideoView : NSOpenGLView
{
    vout_display_t *vd;
106
    BOOL _hasPendingReshape;
Pierre's avatar
Pierre committed
107
108
}
- (void)setVoutDisplay:(vout_display_t *)vd;
109
- (void)setVoutFlushing:(BOOL)flushing;
Pierre's avatar
Pierre committed
110
@end
Pierre's avatar
Pierre committed
111

Pierre's avatar
Pierre committed
112
113
114
115
116
117

struct vout_display_sys_t
{
    VLCOpenGLVideoView *glView;
    id<VLCOpenGLVideoViewEmbedding> container;

118
    vout_window_t *embed;
119
    vlc_gl_t gl;
120
    vout_display_opengl_t *vgl;
Pierre's avatar
Pierre committed
121

Pierre's avatar
Pierre committed
122
123
124
    picture_pool_t *pool;
    picture_t *current;
    bool has_first_frame;
125
126

    vout_display_place_t place;
Pierre's avatar
Pierre committed
127
128
};

129
130
131
132
133
134
135
136

static void *OurGetProcAddress(vlc_gl_t *gl, const char *name)
{
    VLC_UNUSED(gl);

    return dlsym(RTLD_DEFAULT, name);
}

137
static int Open (vlc_object_t *this)
Pierre's avatar
Pierre committed
138
139
{
    vout_display_t *vd = (vout_display_t *)this;
140
    vout_display_sys_t *sys = calloc (1, sizeof(*sys));
Pierre's avatar
Pierre committed
141
142
143
144
145
    NSAutoreleasePool *nsPool = nil;

    if (!sys)
        return VLC_ENOMEM;

146
    if (!CGDisplayUsesOpenGLAcceleration (kCGDirectMainDisplay)) {
147
148
        msg_Err (this, "no OpenGL hardware acceleration found. this can lead to slow output and unexpected results");
        dialog_Fatal (this, _("OpenGL acceleration is not supported on your Mac"), _("Your Mac lacks Quartz Extreme acceleration, which is required for video output. It will still work, but much slower and with possibly unexpected results."));
149
    } else
150
        msg_Dbg (this, "Quartz Extreme acceleration is active");
151

Pierre's avatar
Pierre committed
152
153
154
    vd->sys = sys;
    sys->pool = NULL;
    sys->gl.sys = NULL;
155
    sys->embed = NULL;
Pierre's avatar
Pierre committed
156

Pierre's avatar
Pierre committed
157
    /* Get the drawable object */
158
    id container = var_CreateGetAddress (vd, "drawable-nsobject");
159
    if (container)
160
        vout_display_DeleteWindow (vd, NULL);
161
    else {
162
163
164
165
166
167
168
169
170
171
172
173
174
        vout_window_cfg_t wnd_cfg;

        memset (&wnd_cfg, 0, sizeof (wnd_cfg));
        wnd_cfg.type = VOUT_WINDOW_TYPE_NSOBJECT;
        wnd_cfg.x = var_InheritInteger (vd, "video-x");
        wnd_cfg.y = var_InheritInteger (vd, "video-y");
        wnd_cfg.width  = vd->cfg->display.width;
        wnd_cfg.height = vd->cfg->display.height;

        sys->embed = vout_display_NewWindow (vd, &wnd_cfg);
        if (sys->embed)
            container = sys->embed->handle.nsobject;

175
        if (!container) {
176
            msg_Err(vd, "No drawable-nsobject nor vout_window_t found, passing over.");
177
178
            goto error;
        }
Pierre's avatar
Pierre committed
179
180
181
182
183
184
185
186
    }

    /* This will be released in Close(), on
     * main thread, after we are done using it. */
    sys->container = [container retain];

    /* Get our main view*/
    nsPool = [[NSAutoreleasePool alloc] init];
Pierre's avatar
Pierre committed
187

188
    [VLCOpenGLVideoView performSelectorOnMainThread:@selector(getNewView:) withObject:[NSValue valueWithPointer:&sys->glView] waitUntilDone:YES];
Pierre's avatar
Pierre committed
189
190
191
192
193
194
195
196
    if (!sys->glView)
        goto error;

    [sys->glView setVoutDisplay:vd];

    /* We don't wait, that means that we'll have to be careful about releasing
     * container.
     * That's why we'll release on main thread in Close(). */
197
198
    if ([(id)container respondsToSelector:@selector(addVoutSubview:)])
        [(id)container performSelectorOnMainThread:@selector(addVoutSubview:) withObject:sys->glView waitUntilDone:NO];
199
    else if ([container isKindOfClass:[NSView class]]) {
200
201
        NSView *parentView = container;
        [parentView performSelectorOnMainThread:@selector(addSubview:) withObject:sys->glView waitUntilDone:NO];
202
        [sys->glView performSelectorOnMainThread:@selector(setFrameToBoundsOfView:) withObject:[NSValue valueWithPointer:parentView] waitUntilDone:NO];
203
    } else {
204
205
206
207
208
        msg_Err(vd, "Invalid drawable-nsobject object. drawable-nsobject must either be an NSView or comply to the @protocol VLCOpenGLVideoViewEmbedding.");
        goto error;
    }


Pierre's avatar
Pierre committed
209
210
211
212
213
214
215
    [nsPool release];
    nsPool = nil;

    /* Initialize common OpenGL video display */
    sys->gl.lock = OpenglLock;
    sys->gl.unlock = OpenglUnlock;
    sys->gl.swap = OpenglSwap;
216
    sys->gl.getProcAddress = OurGetProcAddress;
Pierre's avatar
Pierre committed
217
    sys->gl.sys = sys;
218
219
    const vlc_fourcc_t *subpicture_chromas;
    video_format_t fmt = vd->fmt;
Pierre's avatar
Pierre committed
220

221
    sys->vgl = vout_display_opengl_New (&vd->fmt, &subpicture_chromas, &sys->gl);
222
    if (!sys->vgl) {
223
        msg_Err(vd, "Error while initializing opengl display.");
Pierre's avatar
Pierre committed
224
225
226
227
228
229
230
        sys->gl.sys = NULL;
        goto error;
    }

    /* */
    vout_display_info_t info = vd->info;
    info.has_pictures_invalid = false;
231
232
    info.has_event_thread = true;
    info.subpicture_chromas = subpicture_chromas;
233
    info.has_hide_mouse = true;
Pierre's avatar
Pierre committed
234

Pierre's avatar
Pierre committed
235
236
    /* Setup vout_display_t once everything is fine */
    vd->info = info;
Pierre's avatar
Pierre committed
237

Pierre's avatar
Pierre committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
    vd->pool = Pool;
    vd->prepare = PictureRender;
    vd->display = PictureDisplay;
    vd->control = Control;

    /* */
    vout_display_SendEventDisplaySize (vd, vd->source.i_visible_width, vd->source.i_visible_height, false);

    return VLC_SUCCESS;

error:
    [nsPool release];
    Close(this);
    return VLC_EGENERIC;
}

254
void Close (vlc_object_t *this)
Pierre's avatar
Pierre committed
255
256
257
258
259
260
{
    vout_display_t *vd = (vout_display_t *)this;
    vout_display_sys_t *sys = vd->sys;

    [sys->glView setVoutDisplay:nil];

261
    var_Destroy (vd, "drawable-nsobject");
262
263
264
    if ([(id)sys->container respondsToSelector:@selector(removeVoutSubview:)])
        /* This will retain sys->glView */
        [(id)sys->container performSelectorOnMainThread:@selector(removeVoutSubview:) withObject:sys->glView waitUntilDone:NO];
265

Pierre's avatar
Pierre committed
266
267
268
    /* release on main thread as explained in Open() */
    [(id)sys->container performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
    [sys->glView performSelectorOnMainThread:@selector(removeFromSuperview) withObject:nil waitUntilDone:NO];
Pierre's avatar
Pierre committed
269

Pierre's avatar
Pierre committed
270
    if (sys->gl.sys != NULL)
271
        vout_display_opengl_Delete (sys->vgl);
Pierre's avatar
Pierre committed
272

273
274
    [sys->glView release];

275
    if (sys->embed)
276
        vout_display_DeleteWindow (vd, sys->embed);
Pierre's avatar
Pierre committed
277
278
279
280
281
282
283
    free (sys);
}

/*****************************************************************************
 * vout display callbacks
 *****************************************************************************/

284
static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
Pierre's avatar
Pierre committed
285
286
287
288
{
    vout_display_sys_t *sys = vd->sys;

    if (!sys->pool)
289
        sys->pool = vout_display_opengl_GetPool (sys->vgl, requested_count);
Pierre's avatar
Pierre committed
290
291
292
293
    assert(sys->pool);
    return sys->pool;
}

294
static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
Pierre's avatar
Pierre committed
295
296
297
{

    vout_display_sys_t *sys = vd->sys;
Pierre's avatar
Pierre committed
298

299
    vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
Pierre's avatar
Pierre committed
300
301
}

302
static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
Pierre's avatar
Pierre committed
303
304
{
    vout_display_sys_t *sys = vd->sys;
305
    [sys->glView setVoutFlushing:YES];
306
    vout_display_opengl_Display (sys->vgl, &vd->source);
307
    [sys->glView setVoutFlushing:NO];
Pierre's avatar
Pierre committed
308
309
    picture_Release (pic);
    sys->has_first_frame = true;
310

311
312
    if (subpicture)
        subpicture_Delete(subpicture);
Pierre's avatar
Pierre committed
313
314
315
316
317
}

static int Control (vout_display_t *vd, int query, va_list ap)
{
    vout_display_sys_t *sys = vd->sys;
Pierre's avatar
Pierre committed
318

319
320
321
322
323
324
    if (!vd->sys)
        return VLC_EGENERIC;

    if (!sys->embed)
        return VLC_EGENERIC;

Pierre's avatar
Pierre committed
325
326
    switch (query)
    {
Pierre's avatar
Pierre committed
327
        case VOUT_DISPLAY_CHANGE_FULLSCREEN:
328
        {
329
330
331
332
333
            const vout_display_cfg_t *cfg = va_arg (ap, const vout_display_cfg_t *);
            if (vout_window_SetFullScreen (sys->embed, cfg->is_fullscreen))
                return VLC_EGENERIC;

            return VLC_SUCCESS;
334
        }
335
336
337
        case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
        {
            unsigned state = va_arg (ap, unsigned);
338
            return vout_window_SetState (sys->embed, state);            
339
        }
Pierre's avatar
Pierre committed
340
341
342
343
        case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
        case VOUT_DISPLAY_CHANGE_ZOOM:
        case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
        case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
344
        case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
Pierre's avatar
Pierre committed
345
        {
346
            NSAutoreleasePool * o_pool = [[NSAutoreleasePool alloc] init];
347
348

            id o_window = [sys->glView window];
David Fuhrmann's avatar
David Fuhrmann committed
349
350
            if (!o_window) {
                [o_pool release];
351
                return VLC_SUCCESS; // this is okay, since the event will occur again when we have a window
David Fuhrmann's avatar
David Fuhrmann committed
352
            }
353

354
            NSSize windowMinSize = [o_window minSize];
355
356
357
358
359

            const vout_display_cfg_t *cfg;
            const video_format_t *source;
            bool is_forced = false;

360
            if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP) {
361
362
                source = (const video_format_t *)va_arg (ap, const video_format_t *);
                cfg = vd->cfg;
363
            } else {
364
365
366
367
368
                source = &vd->source;
                cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
                if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
                    is_forced = (bool)va_arg (ap, int);
            }
369

370
371
372
            if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE && is_forced
                && (cfg->display.width != vd->cfg->display.width
                    || cfg->display.height != vd->cfg->display.height)
David Fuhrmann's avatar
David Fuhrmann committed
373
374
                && vout_window_SetSize (sys->embed, cfg->display.width, cfg->display.height)) {
                [o_pool release];
375
                return VLC_EGENERIC;
David Fuhrmann's avatar
David Fuhrmann committed
376
            }
377
 
David Fuhrmann's avatar
David Fuhrmann committed
378
            /* we always use our current frame here, because we have some size constraints
379
               in the ui vout provider */
380
            vout_display_cfg_t cfg_tmp = *cfg;
381
382
383
384
385
386
387
388
            NSRect bounds;
            /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
            if (OSX_LION)
                bounds = [sys->glView convertRectToBacking:[sys->glView bounds]];
            else
                bounds = [sys->glView bounds];
            cfg_tmp.display.width = bounds.size.width;
            cfg_tmp.display.height = bounds.size.height;
389

390
391
392
393
394
            vout_display_place_t place;
            vout_display_PlacePicture (&place, source, &cfg_tmp, false);
            @synchronized (sys->glView) {
                sys->place = place;
            }
395

396
397
398
            /* For resize, we call glViewport in reshape and not here.
               This has the positive side effect that we avoid erratic sizing as we animate every resize. */
            if (query != VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
399
                // x / y are top left corner, but we need the lower left one
400
                glViewport (place.x, cfg_tmp.display.height - (place.y + place.height), place.width, place.height);
401

402

403
            [o_pool release];
404
            return VLC_SUCCESS;
Pierre's avatar
Pierre committed
405
        }
406

Pierre's avatar
Pierre committed
407
        case VOUT_DISPLAY_HIDE_MOUSE:
408
409
        {
            [NSCursor setHiddenUntilMouseMoves: YES];
Pierre's avatar
Pierre committed
410
            return VLC_SUCCESS;
411
        }
Pierre's avatar
Pierre committed
412

Pierre's avatar
Pierre committed
413
414
        case VOUT_DISPLAY_GET_OPENGL:
        {
415
            vlc_gl_t **gl = va_arg (ap, vlc_gl_t **);
Pierre's avatar
Pierre committed
416
417
418
            *gl = &sys->gl;
            return VLC_SUCCESS;
        }
Pierre's avatar
Pierre committed
419

Pierre's avatar
Pierre committed
420
421
422
423
424
425
426
427
428
429
430
        case VOUT_DISPLAY_RESET_PICTURES:
            assert (0);
        default:
            msg_Err (vd, "Unknown request in Mac OS X vout display");
            return VLC_EGENERIC;
    }
}

/*****************************************************************************
 * vout opengl callbacks
 *****************************************************************************/
431
static int OpenglLock (vlc_gl_t *gl)
Pierre's avatar
Pierre committed
432
433
{
    vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
434
435
436
    if (!sys->glView || ![sys->glView respondsToSelector:@selector(openGLContext)])
        return 1;

Pierre's avatar
Pierre committed
437
    NSOpenGLContext *context = [sys->glView openGLContext];
438
    CGLError err = CGLLockContext ([context CGLContextObj]);
439
    if (kCGLNoError == err) {
Pierre's avatar
Pierre committed
440
441
442
        [context makeCurrentContext];
        return 0;
    }
Pierre's avatar
Pierre committed
443
    return 1;
Pierre's avatar
Pierre committed
444
445
}

446
static void OpenglUnlock (vlc_gl_t *gl)
Pierre's avatar
Pierre committed
447
448
{
    vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
449
    CGLUnlockContext ([[sys->glView openGLContext] CGLContextObj]);
Pierre's avatar
Pierre committed
450
451
}

452
static void OpenglSwap (vlc_gl_t *gl)
Pierre's avatar
Pierre committed
453
454
455
456
457
458
459
460
461
462
463
464
{
    vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
    [[sys->glView openGLContext] flushBuffer];
}

/*****************************************************************************
 * Our NSView object
 *****************************************************************************/
@implementation VLCOpenGLVideoView

#define VLCAssertMainThread() assert([[NSThread currentThread] isMainThread])

465

466
467
468
469
470
471
+ (void)getNewView:(NSValue *)value
{
    id *ret = [value pointerValue];
    *ret = [[self alloc] init];
}

Pierre's avatar
Pierre committed
472
473
474
475
476
/**
 * Gets called by the Open() method.
 */
- (id)init
{
477
478
    VLCAssertMainThread();

Pierre's avatar
Pierre committed
479
480
481
482
483
484
485
486
487
488
489
490
491
    /* Warning - this may be called on non main thread */

    NSOpenGLPixelFormatAttribute attribs[] =
    {
        NSOpenGLPFADoubleBuffer,
        NSOpenGLPFAAccelerated,
        NSOpenGLPFANoRecovery,
        NSOpenGLPFAColorSize, 24,
        NSOpenGLPFAAlphaSize, 8,
        NSOpenGLPFADepthSize, 24,
        NSOpenGLPFAWindow,
        0
    };
Pierre's avatar
Pierre committed
492

493
    NSOpenGLPixelFormat *fmt = [[NSOpenGLPixelFormat alloc] initWithAttributes:attribs];
Pierre's avatar
Pierre committed
494

Pierre's avatar
Pierre committed
495
496
497
498
    if (!fmt)
        return nil;

    self = [super initWithFrame:NSMakeRect(0,0,10,10) pixelFormat:fmt];
Pierre's avatar
Pierre committed
499
500
    [fmt release];

Pierre's avatar
Pierre committed
501
502
503
    if (!self)
        return nil;

504
    /* enable HiDPI support on OS X 10.7 and later */
505
    if (OSX_LION)
506
507
        [self setWantsBestResolutionOpenGLSurface:YES];

Pierre's avatar
Pierre committed
508
509
510
511
    /* Swap buffers only during the vertical retrace of the monitor.
     http://developer.apple.com/documentation/GraphicsImaging/
     Conceptual/OpenGL/chap5/chapter_5_section_44.html */
    GLint params[] = { 1 };
512
    CGLSetParameter ([[self openGLContext] CGLContextObj], kCGLCPSwapInterval, params);
Pierre's avatar
Pierre committed
513

514
515
516
517
518
519
520
521
522
    [[NSNotificationCenter defaultCenter] addObserverForName:NSApplicationDidChangeScreenParametersNotification
                                                      object:[NSApplication sharedApplication]
                                                       queue:nil
                                                  usingBlock:^(NSNotification *notification) {
                                                      [self performSelectorOnMainThread:@selector(reshape)
                                                                             withObject:nil
                                                                          waitUntilDone:NO];
                                                  }];

523
    [self setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
Pierre's avatar
Pierre committed
524
    return self;
Pierre's avatar
Pierre committed
525
526
}

527
528
529
530
531
532
- (void)dealloc
{
    [[NSNotificationCenter defaultCenter] removeObserver:self];
    [super dealloc];
}

533
534
535
/**
 * Gets called by the Open() method.
 */
536
- (void)setFrameToBoundsOfView:(NSValue *)value
537
{
538
    NSView *parentView = [value pointerValue];
539
    [self setFrame:[parentView bounds]];
540
541
}

Pierre's avatar
Pierre committed
542
543
544
545
546
547
548
549
550
551
552
/**
 * Gets called by the Close and Open methods.
 * (Non main thread).
 */
- (void)setVoutDisplay:(vout_display_t *)aVd
{
    @synchronized(self) {
        vd = aVd;
    }
}

553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
/**
 * Gets called when the vout will aquire the lock and flush.
 * (Non main thread).
 */
- (void)setVoutFlushing:(BOOL)flushing
{
    if (!flushing)
        return;
    @synchronized(self) {
        _hasPendingReshape = NO;
    }
}

/**
 * Can -drawRect skip rendering?.
 */
- (BOOL)canSkipRendering
{
    VLCAssertMainThread();

    @synchronized(self) {
        BOOL hasFirstFrame = vd && vd->sys->has_first_frame;
        return !_hasPendingReshape && hasFirstFrame;
    }
}


Pierre's avatar
Pierre committed
580
581
582
583
584
585
/**
 * Local method that locks the gl context.
 */
- (BOOL)lockgl
{
    VLCAssertMainThread();
586
    NSOpenGLContext *context = [self openGLContext];
587
    CGLError err = CGLLockContext ([context CGLContextObj]);
588
589
    if (err == kCGLNoError)
        [context makeCurrentContext];
Pierre's avatar
Pierre committed
590
591
592
593
594
595
596
597
598
    return err == kCGLNoError;
}

/**
 * Local method that unlocks the gl context.
 */
- (void)unlockgl
{
    VLCAssertMainThread();
599
    CGLUnlockContext ([[self openGLContext] CGLContextObj]);
Pierre's avatar
Pierre committed
600
601
602
603
604
605
606
607
608
609
}

/**
 * Local method that force a rendering of a frame.
 * This will get called if Cocoa forces us to redraw (via -drawRect).
 */
- (void)render
{
    VLCAssertMainThread();

610
611
612
613
614
615
    // We may have taken some times to take the opengl Lock.
    // Check here to see if we can just skip the frame as well.
    if ([self canSkipRendering])
        return;

    BOOL hasFirstFrame;
Pierre's avatar
Pierre committed
616
    @synchronized(self) { // vd can be accessed from multiple threads
617
618
        hasFirstFrame = vd && vd->sys->has_first_frame;
    }
Pierre's avatar
Pierre committed
619

620
    if (hasFirstFrame)
621
        // This will lock gl.
622
        vout_display_opengl_Display (vd->sys->vgl, &vd->source);
623
    else
624
        glClear (GL_COLOR_BUFFER_BIT);
Pierre's avatar
Pierre committed
625
626
627
628
629
630
631
632
}

/**
 * Method called by Cocoa when the view is resized.
 */
- (void)reshape
{
    VLCAssertMainThread();
Pierre's avatar
Pierre committed
633

634
635
    NSRect bounds;
    /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
636
    if (OSX_LION)
637
638
639
        bounds = [self convertRectToBacking:[self bounds]];
    else
        bounds = [self bounds];
640
641
    vout_display_place_t place;
    
Pierre's avatar
Pierre committed
642
643
    @synchronized(self) {
        if (vd) {
644
645
646
            vout_display_cfg_t cfg_tmp = *(vd->cfg);
            cfg_tmp.display.width  = bounds.size.width;
            cfg_tmp.display.height = bounds.size.height;
Pierre's avatar
Pierre committed
647

648
649
            vout_display_PlacePicture (&place, &vd->source, &cfg_tmp, false);
            vd->sys->place = place;
650
            vout_display_SendEventDisplaySize (vd, bounds.size.width, bounds.size.height, vd->cfg->is_fullscreen);
Pierre's avatar
Pierre committed
651
652
        }
    }
Pierre's avatar
Pierre committed
653

654
    if ([self lockgl]) {
655
656
        // x / y are top left corner, but we need the lower left one
        glViewport (place.x, bounds.size.height - (place.y + place.height), place.width, place.height);
657

658
659
660
661
662
663
664
        @synchronized(self) {
            // This may be cleared before -drawRect is being called,
            // in this case we'll skip the rendering.
            // This will save us for rendering two frames (or more) for nothing
            // (one by the vout, one (or more) by drawRect)
            _hasPendingReshape = YES;
        }
665

666
        [self unlockgl];
Pierre's avatar
Pierre committed
667

668
669
        [super reshape];
    }
Pierre's avatar
Pierre committed
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
}

/**
 * Method called by Cocoa when the view is resized or the location has changed.
 * We just need to make sure we are locking here.
 */
- (void)update
{
    VLCAssertMainThread();
    BOOL success = [self lockgl];
    if (!success)
        return;

    [super update];

    [self unlockgl];
}

/**
 * Method called by Cocoa to force redraw.
 */
- (void)drawRect:(NSRect) rect
{
    VLCAssertMainThread();
694
695
696
697

    if ([self canSkipRendering])
        return;

Pierre's avatar
Pierre committed
698
699
700
701
702
703
704
705
706
    BOOL success = [self lockgl];
    if (!success)
        return;

    [self render];

    [self unlockgl];
}

707
708
709
710
711
- (void)renewGState
{
    NSWindow *window = [self window];

    // Remove flashes with splitter view.
712
713
    if ([window respondsToSelector:@selector(disableScreenUpdatesUntilFlush)])
        [window disableScreenUpdatesUntilFlush];
714
715
716
717

    [super renewGState];
}

Pierre's avatar
Pierre committed
718
719
720
721
- (BOOL)isOpaque
{
    return YES;
}
722

723
724
725
726
727
#pragma mark -
#pragma mark Mouse handling

- (void)mouseDown:(NSEvent *)o_event
{
728
729
730
731
732
733
734
    @synchronized (self) {
        if (vd) {
            if ([o_event type] == NSLeftMouseDown && !([o_event modifierFlags] &  NSControlKeyMask)) {
                if ([o_event clickCount] <= 1)
                    vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_LEFT);
            }
        }
735
736
737
738
739
740
741
    }

    [super mouseDown:o_event];
}

- (void)otherMouseDown:(NSEvent *)o_event
{
742
743
744
745
    @synchronized (self) {
        if (vd)
            vout_display_SendEventMousePressed (vd, MOUSE_BUTTON_CENTER);
    }
746
747
748
749
750
751

    [super otherMouseDown: o_event];
}

- (void)mouseUp:(NSEvent *)o_event
{
752
753
754
755
756
757
    @synchronized (self) {
        if (vd) {
            if ([o_event type] == NSLeftMouseUp)
                vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_LEFT);
        }
    }
758
759
760
761
762
763

    [super mouseUp: o_event];
}

- (void)otherMouseUp:(NSEvent *)o_event
{
764
765
766
767
    @synchronized (self) {
        if (vd)
            vout_display_SendEventMouseReleased (vd, MOUSE_BUTTON_CENTER);
    }
768
769
770
771
772
773
774
775
776
777

    [super otherMouseUp: o_event];
}

- (void)mouseMoved:(NSEvent *)o_event
{
    NSPoint ml;
    NSRect s_rect;
    BOOL b_inside;

778
    /* on HiDPI displays, the point bounds don't equal the actual pixel based bounds */
779
    if (OSX_LION)
780
781
782
        s_rect = [self convertRectToBacking:[self bounds]];
    else
        s_rect = [self bounds];
783
784
    ml = [self convertPoint: [o_event locationInWindow] fromView: nil];
    b_inside = [self mouse: ml inRect: s_rect];
785
    
786
787
788
    if (b_inside) {
        @synchronized (self) {
            if (vd) {
789
                vout_display_place_t place = vd->sys->place;
790

791
                if (place.width > 0 && place.height > 0) {
792
793
794
795
796
797
798
799
                    const int x = vd->source.i_x_offset +
                    (int64_t)(ml.x - place.x) * vd->source.i_visible_width / place.width;
                    const int y = vd->source.i_y_offset +
                    (int64_t)((int)s_rect.size.height - (int)ml.y - place.y) * vd->source.i_visible_height / place.height;

                    vout_display_SendEventMouseMoved (vd, x, y);
                }
            }
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
        }
    }

    [super mouseMoved: o_event];
}

- (void)mouseDragged:(NSEvent *)o_event
{
    [self mouseMoved: o_event];
    [super mouseDragged: o_event];
}

- (void)otherMouseDragged:(NSEvent *)o_event
{
    [self mouseMoved: o_event];
    [super otherMouseDragged: o_event];
}

- (void)rightMouseDragged:(NSEvent *)o_event
{
    [self mouseMoved: o_event];
    [super rightMouseDragged: o_event];
}

- (BOOL)acceptsFirstResponder
{
    return YES;
}

- (BOOL)mouseDownCanMoveWindow
{
    return YES;
}

Pierre's avatar
Pierre committed
834
@end