ios2.m 17.4 KB
Newer Older
1 2 3
/*****************************************************************************
 * ios2.m: iOS OpenGL ES 2 provider
 *****************************************************************************
Felix Paul Kühne's avatar
Felix Paul Kühne committed
4
 * Copyright (C) 2001-2014 VLC authors and VideoLAN
5 6
 * $Id$
 *
Felix Paul Kühne's avatar
Felix Paul Kühne committed
7
 * Authors: Pierre d'Herbemont <pdherbemont at videolan dot org>
8 9 10 11
 *          Felix Paul Kühne <fkuehne at videolan dot org>
 *          David Fuhrmann <david dot fuhrmann at googlemail dot com>
 *          Rémi Denis-Courmont
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
Felix Paul Kühne's avatar
Felix Paul Kühne committed
12 13
 *          Eric Petit <titer@m0k.org>
 *
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
 *
 * 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
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * 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.
 *****************************************************************************/

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

#import <UIKit/UIKit.h>
#import <OpenGLES/EAGL.h>
#import <OpenGLES/ES2/gl.h>
#import <QuartzCore/QuartzCore.h>
#import <dlfcn.h>

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

#include <vlc_common.h>
#include <vlc_plugin.h>
#include <vlc_vout_display.h>
#include <vlc_opengl.h>
#include <vlc_dialog.h>
#include "opengl.h"

/**
 * Forward declarations
 */
Felix Paul Kühne's avatar
Felix Paul Kühne committed
54 55
static int Open(vlc_object_t *);
static void Close(vlc_object_t *);
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

static picture_pool_t* PicturePool(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);
static int Control(vout_display_t* vd, int query, va_list ap);

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

static int OpenglESClean(vlc_gl_t* gl);
static void OpenglESSwap(vlc_gl_t* gl);

/**
 * Module declaration
 */
vlc_module_begin ()
Felix Paul Kühne's avatar
Felix Paul Kühne committed
71 72 73 74 75 76 77 78
    set_shortname("iOS vout")
    set_description(N_("iOS OpenGL video output"))
    set_category(CAT_VIDEO)
    set_subcategory(SUBCAT_VIDEO_VOUT)
    set_capability("vout display", 300)
    set_callbacks(Open, Close)

    add_shortcut("vout_ios2")
79 80
vlc_module_end ()

Felix Paul Kühne's avatar
Felix Paul Kühne committed
81
@interface VLCOpenGLES2VideoView : UIView {
82 83 84 85 86 87
    vout_display_t *_voutDisplay;
    EAGLContext *_eaglContext;
    GLuint _renderBuffer;
    GLuint _frameBuffer;

    BOOL _bufferNeedReset;
88
    BOOL _appActive;
89 90 91
}
@property (readwrite) vout_display_t* voutDisplay;
@property (readonly) EAGLContext* eaglContext;
92
@property (readonly) BOOL isAppActive;
93 94 95 96 97 98 99 100 101 102

- (void)createBuffers;
- (void)destroyBuffers;
- (void)resetBuffers;
@end

struct vout_display_sys_t
{
    VLCOpenGLES2VideoView *glESView;
    UIView* viewContainer;
103
    UITapGestureRecognizer *tapRecognizer;
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

    vlc_gl_t gl;
    vout_display_opengl_t *vgl;

    picture_pool_t *picturePool;
    bool has_first_frame;

    vout_display_place_t place;
};

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

    return dlsym(RTLD_DEFAULT, name);
}

static int Open(vlc_object_t *this)
{
    vout_display_t *vd = (vout_display_t *)this;
124 125 126 127

    if (vout_display_IsWindowed(vd))
        return VLC_EGENERIC;

128 129 130 131 132 133 134 135 136 137 138 139 140 141
    vout_display_sys_t *sys = calloc (1, sizeof(*sys));
    NSAutoreleasePool *autoreleasePool = nil;

    if (!sys)
        return VLC_ENOMEM;

    vd->sys = sys;
    sys->picturePool = NULL;
    sys->gl.sys = NULL;

    autoreleasePool = [[NSAutoreleasePool alloc] init];

    /* get the object we will draw into */
    UIView* viewContainer = var_CreateGetAddress (vd, "drawable-nsobject");
142 143 144 145
    if (!viewContainer)
        goto bailout;

    if (![viewContainer isKindOfClass:[UIView class]])
146 147 148 149 150 151 152 153
        goto bailout;

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

    /* setup the actual OpenGL ES view */
    sys->glESView = [[VLCOpenGLES2VideoView alloc] initWithFrame:[viewContainer bounds]];
154
    sys->glESView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
155 156 157 158 159 160

    if (!sys->glESView)
        goto bailout;

    [sys->glESView setVoutDisplay:vd];

Felix Paul Kühne's avatar
Felix Paul Kühne committed
161 162 163
    [sys->viewContainer performSelectorOnMainThread:@selector(addSubview:)
                                         withObject:sys->glESView
                                      waitUntilDone:YES];
164

165
    /* add tap gesture recognizer for DVD menus and stuff */
166 167
    sys->tapRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:sys->glESView
                                                                 action:@selector(tapRecognized:)];
168 169 170
    if (sys->viewContainer.window) {
        if (sys->viewContainer.window.rootViewController) {
            if (sys->viewContainer.window.rootViewController.view)
171
                [sys->viewContainer.superview addGestureRecognizer:sys->tapRecognizer];
172 173
        }
    }
174
    sys->tapRecognizer.cancelsTouchesInView = NO;
175

176 177 178 179 180 181 182 183 184
    /* Initialize common OpenGL video display */
    sys->gl.lock = OpenglESClean;
    sys->gl.unlock = nil;
    sys->gl.swap = OpenglESSwap;
    sys->gl.getProcAddress = OurGetProcAddress;
    sys->gl.sys = sys;
    const vlc_fourcc_t *subpicture_chromas;
    video_format_t fmt = vd->fmt;

Felix Paul Kühne's avatar
Felix Paul Kühne committed
185
    sys->vgl = vout_display_opengl_New(&vd->fmt, &subpicture_chromas, &sys->gl);
186 187 188 189 190 191 192 193 194 195
    if (!sys->vgl) {
        sys->gl.sys = NULL;
        goto bailout;
    }

    /* */
    vout_display_info_t info = vd->info;
    info.has_pictures_invalid = false;
    info.has_event_thread = true;
    info.subpicture_chromas = subpicture_chromas;
196
    info.has_hide_mouse = false;
197 198 199 200 201 202 203 204 205

    /* Setup vout_display_t once everything is fine */
    vd->info = info;

    vd->pool = PicturePool;
    vd->prepare = PictureRender;
    vd->display = PictureDisplay;
    vd->control = Control;

206 207 208
    /* forward our dimensions to the vout core */
    CGSize viewSize = sys->viewContainer.frame.size;
    vout_display_SendEventFullscreen(vd, false);
209
    vout_display_SendEventDisplaySize(vd, (int)viewSize.width, (int)viewSize.height);
210

211
    /* */
Felix Paul Kühne's avatar
Felix Paul Kühne committed
212 213 214 215 216 217 218 219 220 221 222
    [[NSNotificationCenter defaultCenter] addObserver:sys->glESView
                                             selector:@selector(applicationStateChanged:)
                                                 name:UIApplicationWillResignActiveNotification
                                               object:nil];
    [[NSNotificationCenter defaultCenter] addObserver:sys->glESView
                                             selector:@selector(applicationStateChanged:)
                                                 name:UIApplicationDidBecomeActiveNotification
                                               object:nil];
    [sys->glESView performSelectorOnMainThread:@selector(reshape)
                                    withObject:nil
                                 waitUntilDone:YES];
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

    [autoreleasePool release];
    return VLC_SUCCESS;

bailout:
    [autoreleasePool release];
    Close(this);
    return VLC_EGENERIC;
}

void Close (vlc_object_t *this)
{
    vout_display_t *vd = (vout_display_t *)this;
    vout_display_sys_t *sys = vd->sys;

238 239 240
    if (sys->tapRecognizer) {
        [sys->tapRecognizer.view removeGestureRecognizer:sys->tapRecognizer];
        [sys->tapRecognizer release];
241 242
    }

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
    [sys->glESView setVoutDisplay:nil];

    var_Destroy (vd, "drawable-nsobject");
    [sys->viewContainer performSelectorOnMainThread:@selector(release) withObject:nil waitUntilDone:NO];
    [sys->glESView performSelectorOnMainThread:@selector(removeFromSuperview) withObject:nil waitUntilDone:NO];

    if (sys->gl.sys != NULL) {
        msg_Dbg(this, "deleting display");
        vout_display_opengl_Delete(sys->vgl);
    }

    [sys->glESView release];

    free(sys);
}

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

static int Control(vout_display_t *vd, int query, va_list ap)
{
    vout_display_sys_t *sys = vd->sys;

Felix Paul Kühne's avatar
Felix Paul Kühne committed
267
    switch (query) {
268 269 270
        case VOUT_DISPLAY_HIDE_MOUSE:
            return VLC_EGENERIC;

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
        case VOUT_DISPLAY_CHANGE_ZOOM:
        case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
        case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
        case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
        {
            if (!vd->sys)
                return VLC_EGENERIC;

            NSAutoreleasePool * autoreleasePool = [[NSAutoreleasePool alloc] init];

            const vout_display_cfg_t *cfg;
            const video_format_t *source;

            if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP) {
                source = (const video_format_t *)va_arg(ap, const video_format_t *);
                cfg = vd->cfg;
            } else {
                source = &vd->source;
                cfg = (const vout_display_cfg_t*)va_arg(ap, const vout_display_cfg_t *);
            }

Felix Paul Kühne's avatar
Felix Paul Kühne committed
293 294
            /* we don't adapt anything here regardless of what the vout core
             * wants since we are not in a traditional desktop window */
295 296 297
            if (!cfg)
                return VLC_EGENERIC;

298
            vout_display_cfg_t cfg_tmp = *cfg;
299 300
            CGSize viewSize;
            viewSize = [sys->glESView bounds].size;
301

Felix Paul Kühne's avatar
Felix Paul Kühne committed
302
            /* on HiDPI displays, the point bounds don't equal the actual pixels */
303
            CGFloat scaleFactor = sys->glESView.contentScaleFactor;
304 305
            cfg_tmp.display.width = viewSize.width * scaleFactor;
            cfg_tmp.display.height = viewSize.height * scaleFactor;
306 307 308 309 310 311 312

            vout_display_place_t place;
            vout_display_PlacePicture(&place, source, &cfg_tmp, false);
            @synchronized (sys->glESView) {
                sys->place = place;
            }

313 314 315 316
            // x / y are top left corner, but we need the lower left one
            if (query != VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
                glViewport(place.x, cfg_tmp.display.height - (place.y + place.height), place.width, place.height);

317 318 319 320 321
            [autoreleasePool release];
            return VLC_SUCCESS;
        }

        case VOUT_DISPLAY_RESET_PICTURES:
322
            vlc_assert_unreachable ();
323
        default:
324
            msg_Err(vd, "Unknown request %d", query);
325
        case VOUT_DISPLAY_CHANGE_FULLSCREEN:
326 327 328 329 330 331 332 333
            return VLC_EGENERIC;
    }
}

static void PictureDisplay(vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
{
    vout_display_sys_t *sys = vd->sys;
    sys->has_first_frame = true;
334 335 336 337
    @synchronized (sys->glESView) {
        if (likely([sys->glESView isAppActive]))
            vout_display_opengl_Display(sys->vgl, &vd->source);
    }
338 339 340 341 342 343 344 345 346 347 348

    picture_Release(pic);

    if (subpicture)
        subpicture_Delete(subpicture);
}

static void PictureRender(vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
{
    vout_display_sys_t *sys = vd->sys;

349
    if (likely([sys->glESView isAppActive]))
350
        vout_display_opengl_Prepare(sys->vgl, pic, subpicture);
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
}

static picture_pool_t *PicturePool(vout_display_t *vd, unsigned requested_count)
{
    vout_display_sys_t *sys = vd->sys;

    if (!sys->picturePool)
        sys->picturePool = vout_display_opengl_GetPool(sys->vgl, requested_count);
    assert(sys->picturePool);
    return sys->picturePool;
}

/*****************************************************************************
 * vout opengl callbacks
 *****************************************************************************/
static int OpenglESClean(vlc_gl_t *gl)
{
    vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
369 370
    if (likely([sys->glESView isAppActive]))
        [sys->glESView resetBuffers];
371 372 373 374 375 376
    return 0;
}

static void OpenglESSwap(vlc_gl_t *gl)
{
    vout_display_sys_t *sys = (vout_display_sys_t *)gl->sys;
377
    if (likely([sys->glESView isAppActive]))
378
        [[sys->glESView eaglContext] presentRenderbuffer:GL_RENDERBUFFER];
379 380 381 382 383 384
}

/*****************************************************************************
 * Our UIView object
 *****************************************************************************/
@implementation VLCOpenGLES2VideoView
385
@synthesize voutDisplay = _voutDisplay, eaglContext = _eaglContext, isAppActive = _appActive;
386 387 388 389 390 391 392 393

+ (Class)layerClass
{
    return [CAEAGLLayer class];
}

- (id)initWithFrame:(CGRect)frame
{
Felix Paul Kühne's avatar
Felix Paul Kühne committed
394
    self = [super initWithFrame:frame];
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

    if (!self)
        return nil;

    CAEAGLLayer * layer = (CAEAGLLayer *)self.layer;
    layer.drawableProperties = [NSDictionary dictionaryWithObject:kEAGLColorFormatRGBA8 forKey: kEAGLDrawablePropertyColorFormat];
    layer.opaque = YES;

    _eaglContext = [[EAGLContext alloc] initWithAPI:kEAGLRenderingAPIOpenGLES2];
    if (!_eaglContext)
        return nil;
    [EAGLContext setCurrentContext:_eaglContext];

    [self performSelectorOnMainThread:@selector(createBuffers) withObject:nil waitUntilDone:YES];
    [self performSelectorOnMainThread:@selector(reshape) withObject:nil waitUntilDone:NO];
    [self setAutoresizingMask: UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight];

412 413 414
    @synchronized (self) {
        _appActive = ([UIApplication sharedApplication].applicationState == UIApplicationStateActive);
    }
415

416 417 418 419 420
    return self;
}

- (void)dealloc
{
421
    [[NSNotificationCenter defaultCenter] removeObserver:self];
422 423 424 425
    [_eaglContext release];
    [super dealloc];
}

426
- (void)didMoveToWindow
427
{
428 429
    self.contentScaleFactor = self.window.screen.scale;
    _bufferNeedReset = YES;
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
}

- (void)createBuffers
{
    /* make sure the current context is us */
    [EAGLContext setCurrentContext:_eaglContext];

    /* create render buffer */
    glGenRenderbuffers(1, &_renderBuffer);
    glBindRenderbuffer(GL_RENDERBUFFER, _renderBuffer);

    /* create frame buffer */
    glGenFramebuffers(1, &_frameBuffer);
    glBindFramebuffer(GL_FRAMEBUFFER, _frameBuffer);

    /* allocate storage for the pixels we are going to to draw to */
    [_eaglContext renderbufferStorage:GL_RENDERBUFFER fromDrawable:(id<EAGLDrawable>)self.layer];

    /* bind render buffer to frame buffer */
    glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_RENDERBUFFER, _renderBuffer);

    /* make sure that our shape is ok */
    [self performSelectorOnMainThread:@selector(reshape) withObject:nil waitUntilDone:NO];
}

- (void)destroyBuffers
{
    /* re-set current context */
    [EAGLContext setCurrentContext:_eaglContext];

    /* clear frame buffer */
    glDeleteFramebuffers(1, &_frameBuffer);
    _frameBuffer = 0;

    /* clear render buffer */
    glDeleteRenderbuffers(1, &_renderBuffer);
    _renderBuffer = 0;
}

- (void)resetBuffers
{
    if (_bufferNeedReset) {
        [self destroyBuffers];
        [self createBuffers];
        _bufferNeedReset = NO;
    }
}

- (void)layoutSubviews
{
    /* this method is called as soon as we are resized.
     * so set a variable to re-create our buffers on the next clean event */
    _bufferNeedReset = YES;
}

- (void)reshape
{
    assert([[NSThread currentThread] isMainThread]);

489 490
    [EAGLContext setCurrentContext:_eaglContext];

491
    CGSize viewSize = [self bounds].size;
492 493 494

    vout_display_place_t place;

495
    @synchronized (self) {
496 497 498 499
        if (_voutDisplay) {
            vout_display_cfg_t cfg_tmp = *(_voutDisplay->cfg);
            CGFloat scaleFactor = self.contentScaleFactor;

500 501
            cfg_tmp.display.width  = viewSize.width * scaleFactor;
            cfg_tmp.display.height = viewSize.height * scaleFactor;
502 503 504

            vout_display_PlacePicture(&place, &_voutDisplay->source, &cfg_tmp, false);
            _voutDisplay->sys->place = place;
Felix Paul Kühne's avatar
Felix Paul Kühne committed
505
            vout_display_SendEventDisplaySize(_voutDisplay, viewSize.width * scaleFactor,
506
                                              viewSize.height * scaleFactor);
507 508 509 510 511 512 513
        }
    }

    // x / y are top left corner, but we need the lower left one
    glViewport(place.x, place.y, place.width, place.height);
}

514
- (void)tapRecognized:(UITapGestureRecognizer *)tapRecognizer
515
{
516 517
    UIGestureRecognizerState state = [tapRecognizer state];
    CGPoint touchPoint = [tapRecognizer locationInView:self];
518
    CGFloat scaleFactor = self.contentScaleFactor;
519
    vout_display_SendMouseMovedDisplayCoordinates(_voutDisplay, ORIENT_NORMAL,
520
                                                  (int)touchPoint.x * scaleFactor, (int)touchPoint.y * scaleFactor,
521 522 523 524 525 526
                                                  &_voutDisplay->sys->place);

    vout_display_SendEventMousePressed(_voutDisplay, MOUSE_BUTTON_LEFT);
    vout_display_SendEventMouseReleased(_voutDisplay, MOUSE_BUTTON_LEFT);
}

527 528
- (void)applicationStateChanged:(NSNotification *)notification
{
529
    @synchronized (self) {
Felix Paul Kühne's avatar
Felix Paul Kühne committed
530 531 532
    if ([[notification name] isEqualToString:UIApplicationWillResignActiveNotification]
        || [[notification name] isEqualToString:UIApplicationDidEnterBackgroundNotification]
        || [[notification name] isEqualToString:UIApplicationWillTerminateNotification])
533 534 535
        _appActive = NO;
    else
        _appActive = YES;
536
    }
537 538
}

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
- (void)updateConstraints
{
    [self reshape];
    [super updateConstraints];
}

- (BOOL)isOpaque
{
    return YES;
}

- (BOOL)acceptsFirstResponder
{
    return YES;
}

@end