-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing2.html
executable file
·571 lines (487 loc) · 21.4 KB
/
listing2.html
1
2
3
4
5
6
7
8
9
10
11
12
13
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>OpenGLCaptureToMovie - /FrameCompressor.m</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/GraphicsImaging/index.html">Graphics & Imaging</a> > <a href="../../samplecode/GraphicsImaging/idxOpenGL-date.html">OpenGL</a> > <A HREF="javascript:location.replace('index.html');">OpenGLCaptureToMovie</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">OpenGLCaptureToMovie</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/FrameCompressor.m</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/FrameCompressor.h</option>
<option value="listing2.html">/FrameCompressor.m</option>
<option value="listing3.html">/FrameMovieExporter.h</option>
<option value="listing4.html">/FrameMovieExporter.m</option>
<option value="listing5.html">/FrameReader.h</option>
<option value="listing6.html">/FrameReader.m</option>
<option value="listing7.html">/main.m</option>
<option value="listing8.html">/MyController.h</option>
<option value="listing9.html">/MyController.m</option>
<option value="listing10.html">/Queue.h</option>
<option value="listing11.html">/Queue.m</option>
<option value="listing12.html">/QueueController.h</option>
<option value="listing13.html">/QueueController.m</option></select>
</p>
</form>
<p><strong><a href="OpenGLScreenCapture.zip">Download Sample</a></strong> (“OpenGLScreenCapture.zip”, 97.0K)<BR>
<strong><a href="OpenGLScreenCapture.dmg">Download Sample</a></strong> (“OpenGLScreenCapture.dmg”, 139.3K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: FrameCompressor.m
Abstract: Declares the implementation for the FrameCompressor abstract class
which wraps a QuickTime compression session and allows compression of
CVPixelBuffers using arbitrary codecs. The FrameCompressor is initialized
with the compression codec to use, the dimensions of the CVPixelBuffers
to be passed and compression session options (cannot be nil). Compressing
frames is achieved by calling -compressFrameOnSeparateThread and passing
the CVPixelBuffer representing the frame along with optional timestamp
and duration (pass -1.0 if undefined). When the frame is compressed,
the -doneCompressingFrame method is called with the resulting encoded
frame (this method is implemented by subclasses). Use the method -flushFrames
to ensure no frames are pending for compression.
Version: 1.0
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple
Computer, Inc. ("Apple") in consideration of your agreement to the
following terms, and your use, installation, modification or
redistribution of this Apple software constitutes acceptance of these
terms. If you do not agree with these terms, please do not use,
install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and
subject to these terms, Apple grants you a personal, non-exclusive
license, under Apple's copyrights in this original Apple software (the
"Apple Software"), to use, reproduce, modify and redistribute the Apple
Software, with or without modifications, in source and/or binary forms;
provided that if you redistribute the Apple Software in its entirety and
without modifications, you must retain this notice and the following
text and disclaimers in all such redistributions of the Apple Software.
Neither the name, trademarks, service marks or logos of Apple Computer,
Inc. may be used to endorse or promote products derived from the Apple
Software without specific prior written permission from Apple. Except
as expressly stated in this notice, no other rights or licenses, express
or implied, are granted by Apple herein, including but not limited to
any patent rights that may be infringed by your derivative works or by
other works in which the Apple Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Copyright (C) 2007 Apple Inc. All Rights Reserved.
*/
#import <OpenGL/CGLMacro.h>
#import "FrameReader.h"
#import "FrameCompressor.h"
#import "MyController.h"
static ICMCompressionSessionRef mCompressionSession = NULL;
// Called when image compression for a frame has completed. Compression
// is initiated by the ICMCompressionSessionEncodeFrame function. Once
// compression of the frame has completed, we add it to the track media for
// the movie.
static OSStatus FrameOutputCallback(void* encodedFrameOutputRefCon, ICMCompressionSessionRef session, OSStatus error, ICMEncodedFrameRef frame, void* reserved)
{
if(error == noErr)
{
//Simply forward to the FrameMovieExporter instance
[FrameMovieExporter doneCompressingFrame:frame];
}
return error;
}
// During image compression this routine is called to indicate the status of
// the compression operation. We'll use this to determine when the buffer
// is free so we can mark the reader object as free/available.
static void SourceFrameTrackingCallback(void *sourceTrackingRefCon, ICMSourceTrackingFlags sourceTrackingFlags, void *sourceFrameRefCon, void *reserved)
{
/*
* Indicates that this is the last call for this sourceFrameRefCon.
*/
if (sourceTrackingFlags & kICMSourceTracking_LastCall)
{
}
/*
* Indicates that the session is done with the source pixel buffer
* and has released any reference to it that it had.
*/
if (sourceTrackingFlags & kICMSourceTracking_ReleasedPixelBuffer)
{
FrameReader *readerObj = (FrameReader *)sourceTrackingRefCon;
QueueController *frameQController = [readerObj queueController];
// The compressor is finished with the reader object, so let's
// put it back into the free queue so it can be used again
[frameQController addItemToFreeQ:readerObj];
}
}
@interface FrameCompressor (PrivateMethods)
+(void)createSharedCompressionSession:(CodecType)codec pixelsWide:(unsigned)width pixelsHigh:(unsigned)height options:(ICMCompressionSessionOptionsRef)options compressionTimeScale:(TimeScale)timescale;
- (void)compressFrameSynchronized:(id)param;
@end
@implementation FrameCompressor (PrivateMethods)
// Create a single shared compression session for use with all subclasses
// of the FrameCompressor class. This compression session is used to
// compress screen reader frames so that they may be subsequently added
// to our movie.
+(void)createSharedCompressionSession:(CodecType)codec pixelsWide:(unsigned)width pixelsHigh:(unsigned)height options:(ICMCompressionSessionOptionsRef)options compressionTimeScale:(TimeScale)timescale
{
ICMEncodedFrameOutputRecord record = {FrameOutputCallback, NULL, NULL};
OSStatus theError;
if (!mCompressionSession)
{
//Create compression session
theError = ICMCompressionSessionCreate(kCFAllocatorDefault, width, height, codec, timescale, options, NULL, &record, &mCompressionSession);
if(theError)
{
NSLog(@"ICMCompressionSessionCreate() failed with error %i", theError);
}
}
}
// Compress a frame.
// This routine makes use of the @synchronized
// directive for locking the block of code which performs
// the compression operation.
// The @synchronized directive takes a single parameter
// which is the object you want to be used as the key
// for locking the code. The compiler then creates a
// mutex lock based on that object. Threads attempting
// to lock the same object block until the current
// synchronized block finishes executing.
- (void)compressFrameSynchronized:(id)param
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
@synchronized([FrameCompressor class])
{
FrameReader *frameReaderObj = (FrameReader *)param;
// This blocks until the async texture transfer from
// the GPU to system memory is complete.
CVPixelBufferRef pixelBuffer = [frameReaderObj readScreenAsyncFinish];
if (pixelBuffer)
{
OSStatus theError = -1;
// compress the frame using our compression session
ICMSourceTrackingCallbackRecord callBackRec =
{
/*
* The callback function pointer.
*/
SourceFrameTrackingCallback,
/*
* The callback's reference value.
*/
param // sourceTrackingRefCon
};
NSTimeInterval timestamp = [(FrameReader *)param bufferReadTime];
NSTimeInterval duration = NAN;
TimeScale compressionTimeScale = ICMCompressionSessionGetTimeScale (mCompressionSession);
// Present frames to the compression session. Encoded frames may or
// may not be output before the function returns.
theError = ICMCompressionSessionEncodeFrame(mCompressionSession, pixelBuffer,
(timestamp >= 0.0 ? (SInt64)(timestamp * compressionTimeScale) : 0),
(duration >= 0.0 ? (SInt64)(duration * compressionTimeScale) : 0),
((timestamp >= 0.0 ? kICMValidTime_DisplayTimeStampIsValid : 0) | (duration >= 0.0 ? kICMValidTime_DisplayDurationIsValid : 0)),
NULL, &callBackRec, (void *)NULL);
if(theError)
{
NSLog(@"ICMCompressionSessionEncodeFrame() failed with error %i", theError);
}
}
else // an error occurred
{
// we got an error, so put this reader object back into the free queue
QueueController *frameQController = [frameReaderObj queueController];
[frameQController addItemToFreeQ:frameReaderObj];
}
}
[pool release];
}
@end
@implementation FrameCompressor
#pragma mark ---------- Initialization/Cleanup ----------
+ (void) initialize
{
//Make sure QuickTime is initialized
EnterMovies();
}
- (id) init
{
//Make sure client goes through designated initializer
[self doesNotRecognizeSelector:_cmd];
return nil;
}
// Initialize a FrameCompressor object with the specified codec,
// width/height, compressor options and timescale
- (id) initWithCodec:(CodecType)codec pixelsWide:(unsigned)width pixelsHigh:(unsigned)height options:(ICMCompressionSessionOptionsRef)options compressionTimeScale:(TimeScale)timescale
{
//Check parameters
if((codec == 0) || (width == 0) || (height == 0) || (options == NULL) || timescale == 0) {
[self release];
return nil;
}
self = [super init];
{
[FrameCompressor createSharedCompressionSession:codec pixelsWide:width pixelsHigh:height options:options compressionTimeScale:timescale];
}
return self;
}
+ (id) alloc
{
//Prevent direct allocation of this abstract class
if(self == [FrameCompressor class])
{
[self doesNotRecognizeSelector:_cmd];
}
return [super alloc];
}
- (void) dealloc
{
//Release resources
if(mCompressionSession)
{
ICMCompressionSessionRelease(mCompressionSession);
mCompressionSession = NULL;
}
[super dealloc];
}
#pragma mark ---------- Compression Options ----------
// Display the compression dialog for the user, but first restore the settings
// from the previous user defaults
+ (ICMCompressionSessionOptionsRef) userOptions:(CodecType*)outCodecType frameRate:(double*)outFrameRate autosaveName:(NSString*)name
{
long flags = scAllowEncodingWithCompressionSession;
ICMMultiPassStorageRef nullStorage = NULL;
SCTemporalSettings temporalSettings;
SCSpatialSettings spatialSettings;
ComponentResult theError;
ICMCompressionSessionOptionsRef options;
ComponentInstance component;
QTAtomContainer container;
NSData* data;
Boolean enable = true;
//Open default compression dialog component
component = OpenDefaultComponent(StandardCompressionType, StandardCompressionSubType);
if(component == NULL) {
NSLog(@"Compression component opening failed");
return NULL;
}
SCSetInfo(component, scPreferenceFlagsType, &flags);
//Restore compression settings from user defaults
if([name length]) {
data = [[NSUserDefaults standardUserDefaults] objectForKey:name];
if(data) {
container = NewHandle([data length]);
if(container) {
[data getBytes:*container];
theError = SCSetSettingsFromAtomContainer(component, container);
if(theError)
NSLog(@"SCSetSettingsFromAtomContainer() failed with error %i", theError);
QTDisposeAtomContainer(container);
}
}
}
//Display compression dialog to user
theError = SCRequestSequenceSettings(component);
if(theError) {
if(theError != 1)
NSLog(@"SCRequestSequenceSettings() failed with error %i", theError);
CloseComponent(component);
return NULL;
}
//Save compression settings in user defaults
if([name length]) {
theError = SCGetSettingsAsAtomContainer(component, &container);
if(theError)
NSLog(@"SCSetSettingsFromAtomContainer() failed with error %i", theError);
else {
data = [NSData dataWithBytes:*container length:GetHandleSize(container)];
[[NSUserDefaults standardUserDefaults] setObject:data forKey:name];
QTDisposeAtomContainer(container);
}
}
//Copy settings from compression dialog
theError = SCCopyCompressionSessionOptions(component, &options);
if(theError) {
NSLog(@"SCCopyCompressionSessionOptions() failed with error %i", theError);
CloseComponent(component);
return NULL;
}
if(outCodecType) {
SCGetInfo(component, scSpatialSettingsType, &spatialSettings);
*outCodecType = spatialSettings.codecType;
}
if(outFrameRate) {
SCGetInfo(component, scTemporalSettingsType, &temporalSettings);
*outFrameRate = Fix2X(temporalSettings.frameRate);
}
CloseComponent(component);
//Explicitely turn off multipass compression in case it was enabled by the user as we do not support it
theError = ICMCompressionSessionOptionsSetProperty(options, kQTPropertyClass_ICMCompressionSessionOptions, kICMCompressionSessionOptionsPropertyID_MultiPassStorage, sizeof(ICMMultiPassStorageRef), &nullStorage);
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetProperty() failed with error %i", theError);
}
// We must set this flag to enable P or B frames.
theError = ICMCompressionSessionOptionsSetAllowTemporalCompression( options, true );
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetAllowTemporalCompression() failed with error %i", theError);
}
// We must set this flag to enable B frames.
theError = ICMCompressionSessionOptionsSetAllowFrameReordering( options, true );
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetAllowFrameReordering() failed with error %i", theError);
}
// Set the maximum key frame interval, also known as the key frame rate.
theError = ICMCompressionSessionOptionsSetMaxKeyFrameInterval( options, 30 );
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetMaxKeyFrameInterval() failed with error %i", theError);
}
// This allows the compressor more flexibility (ie, dropping and coalescing frames).
theError = ICMCompressionSessionOptionsSetAllowFrameTimeChanges( options, true );
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetAllowFrameTimeChanges() failed with error %i", theError);
}
// We need durations when we store frames.
theError = ICMCompressionSessionOptionsSetDurationsNeeded( options, true );
if( theError ) {
NSLog(@"ICMCompressionSessionOptionsSetDurationsNeeded() failed with error %i", theError);
}
// Enable the compressor to call the encoded-frame callback from a different thread.
theError = ICMCompressionSessionOptionsSetProperty(options, kQTPropertyClass_ICMCompressionSessionOptions, kICMCompressionSessionOptionsPropertyID_AllowAsyncCompletion, sizeof(Boolean), &enable);
if( theError ) {
NSLog(@"SCCopyCompressionSessionOptions() failed with error %i", theError);
}
return (ICMCompressionSessionOptionsRef)[(id)options autorelease];
}
#pragma mark ---------- Compression Methods ----------
// Call another routine to perform the compression on a separate thread
- (BOOL) compressFrameOnSeparateThread:(FrameReader *)frameReaderObj
{
[NSThread detachNewThreadSelector:@selector(compressFrameSynchronized:) toTarget:self withObject:frameReaderObj];
return YES;
}
// Force the compression session to complete encoding frames.
+ (BOOL) flushFrames
{
OSStatus theError;
// we must make sure only one thread at a time is accessing
// the compression session
@synchronized([FrameCompressor class])
{
//Flush pending frames in compression session
theError = ICMCompressionSessionCompleteFrames(mCompressionSession, true, 0, 0);
if(theError)
NSLog(@"ICMCompressionSessionCompleteFrames() failed with error %i", theError);
}
return (theError == noErr ? YES : NO);
}
// Placeholder for additional processing you may want to do
+ (void) doneCompressingFrame:(ICMEncodedFrameRef)frame
{
//Do any additional processing here
}
@end
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/OpenGLScreenCapture/listing2.html%3Fid%3DDTS10004445-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/OpenGLScreenCapture/listing2.html%3Fid%3DDTS10004445-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/OpenGLScreenCapture/listing2.html%3Fid%3DDTS10004445-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>