1/*
2 * libjingle
3 * Copyright 2014, Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 *  1. Redistributions of source code must retain the above copyright notice,
9 *     this list of conditions and the following disclaimer.
10 *  2. Redistributions in binary form must reproduce the above copyright notice,
11 *     this list of conditions and the following disclaimer in the documentation
12 *     and/or other materials provided with the distribution.
13 *  3. The name of the author may not be used to endorse or promote products
14 *     derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#import <Foundation/Foundation.h>
29#if TARGET_OS_IPHONE
30#import <GLKit/GLKit.h>
31#else
32#import <AppKit/NSOpenGL.h>
33#endif
34
35@class RTCI420Frame;
36
37// RTCOpenGLVideoRenderer issues appropriate OpenGL commands to draw a frame to
38// the currently bound framebuffer. Supports OpenGL 3.2 and OpenGLES 2.0. OpenGL
39// framebuffer creation and management should be handled elsewhere using the
40// same context used to initialize this class.
41@interface RTCOpenGLVideoRenderer : NSObject
42
43// The last successfully drawn frame. Used to avoid drawing frames unnecessarily
44// hence saving battery life by reducing load.
45@property(nonatomic, readonly) RTCI420Frame* lastDrawnFrame;
46
47#if TARGET_OS_IPHONE
48- (instancetype)initWithContext:(EAGLContext*)context;
49#else
50- (instancetype)initWithContext:(NSOpenGLContext*)context;
51#endif
52
53// Draws |frame| onto the currently bound OpenGL framebuffer. |setupGL| must be
54// called before this function will succeed.
55- (BOOL)drawFrame:(RTCI420Frame*)frame;
56
57// The following methods are used to manage OpenGL resources. On iOS
58// applications should release resources when placed in background for use in
59// the foreground application. In fact, attempting to call OpenGLES commands
60// while in background will result in application termination.
61
62// Sets up the OpenGL state needed for rendering.
63- (void)setupGL;
64// Tears down the OpenGL state created by |setupGL|.
65- (void)teardownGL;
66
67#ifndef DOXYGEN_SHOULD_SKIP_THIS
68// Disallow init and don't add to documentation
69- (id)init __attribute__((
70    unavailable("init is not a supported initializer for this class.")));
71#endif /* DOXYGEN_SHOULD_SKIP_THIS */
72
73@end
74