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
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
|
/* HBCore.m $
This file is part of the HandBrake source code.
Homepage: <http://handbrake.fr/>.
It may be used under the terms of the GNU General Public License. */
#import "HBCore.h"
#import "HBJob.h"
#import "HBJob+HBJobConversion.h"
#import "HBDVDDetector.h"
#import "HBUtilities.h"
#import "HBImageUtilities.h"
#import "HBStateFormatter+Private.h"
#import "HBTitle+Private.h"
#import "HBJob+Private.h"
#include <dlfcn.h>
static BOOL globalInitialized = NO;
static void (^errorHandler)(NSString *error) = NULL;
static void hb_error_handler(const char *errmsg)
{
NSString *error = @(errmsg);
if (error)
{
errorHandler(error);
}
}
typedef void (^HBCoreCleanupHandler)(void);
/**
* Private methods of HBCore.
*/
@interface HBCore ()
/// Pointer to a hb_state_s struct containing the detailed state information of libhb.
@property (nonatomic, readonly) hb_state_t *hb_state;
/// Pointer to a libhb handle used by this HBCore instance.
@property (nonatomic, readonly) hb_handle_t *hb_handle;
/// Current state of HBCore.
@property (nonatomic, readwrite) HBState state;
/// Timer used to poll libhb for state changes.
@property (nonatomic, readwrite) dispatch_source_t updateTimer;
@property (nonatomic, readonly) dispatch_queue_t updateTimerQueue;
/// Current scanned titles.
@property (nonatomic, readwrite, copy) NSArray<HBTitle *> *titles;
/// Progress handler.
@property (nonatomic, readwrite, copy) HBCoreProgressHandler progressHandler;
/// Completion handler.
@property (nonatomic, readwrite, copy) HBCoreCompletionHandler completionHandler;
/// Cleanup handle, used for internal HBCore cleanup.
@property (nonatomic, readwrite, copy) HBCoreCleanupHandler cleanupHandler;
/// Progress
@property (nonatomic, readwrite) NSProgress *progress;
@end
@implementation HBCore
+ (void)setDVDNav:(BOOL)enabled
{
hb_dvd_set_dvdnav(enabled);
}
+ (void)initGlobal
{
hb_global_init();
globalInitialized = YES;
}
+ (void)closeGlobal
{
NSAssert(globalInitialized, @"[HBCore closeGlobal] global closed but not initialized");
hb_global_close();
}
+ (void)registerErrorHandler:(void (^)(NSString *error))handler
{
errorHandler = [handler copy];
hb_register_error_handler(&hb_error_handler);
}
- (instancetype)init
{
return [self initWithLogLevel:0 queue:dispatch_get_main_queue()];
}
- (instancetype)initWithLogLevel:(NSInteger)level queue:(dispatch_queue_t)queue
{
self = [super init];
if (self)
{
_name = @"HBCore";
_automaticallyPreventSleep = YES;
_state = HBStateIdle;
_updateTimerQueue = queue;
_titles = @[];
_stateFormatter = [[HBStateFormatter alloc] init];
_hb_state = malloc(sizeof(hb_state_t));
bzero(_hb_state, sizeof(hb_state_t));
_logLevel = level;
_hb_handle = hb_init((int)level);
if (!_hb_handle)
{
return nil;
}
}
return self;
}
- (instancetype)initWithLogLevel:(NSInteger)level name:(NSString *)name
{
self = [self initWithLogLevel:level queue:dispatch_get_main_queue()];
if (self)
{
_name = [name copy];
}
return self;
}
/**
* Releases resources.
*/
- (void)dealloc
{
[self stopUpdateTimer];
hb_close(&_hb_handle);
_hb_handle = NULL;
free(_hb_state);
}
- (void)setLogLevel:(NSInteger)logLevel
{
_logLevel = logLevel;
hb_log_level_set(_hb_handle, (int)logLevel);
}
- (void)preventSleep
{
NSAssert(!self.automaticallyPreventSleep, @"[HBCore preventSleep:] called with automaticallyPreventSleep enabled.");
hb_system_sleep_prevent(_hb_handle);
[HBUtilities writeToActivityLog:"%s prevented sleep", self.name.UTF8String];
}
- (void)allowSleep
{
NSAssert(!self.automaticallyPreventSleep, @"[HBCore allowSleep:] called with automaticallyPreventSleep enabled.");
hb_system_sleep_allow(_hb_handle);
[HBUtilities writeToActivityLog:"%s stopped preventing sleep", self.name.UTF8String];
}
- (void)preventAutoSleep
{
if (self.automaticallyPreventSleep)
{
hb_system_sleep_prevent(_hb_handle);
}
}
- (void)allowAutoSleep
{
if (self.automaticallyPreventSleep)
{
hb_system_sleep_allow(_hb_handle);
}
}
#pragma mark - Scan
- (BOOL)canScan:(NSURL *)url error:(NSError * __autoreleasing *)error
{
NSAssert(url, @"[HBCore canScan:] called with nil url.");
#ifdef __SANDBOX_ENABLED__
BOOL accessingSecurityScopedResource = [url startAccessingSecurityScopedResource];
#endif
if (![[NSFileManager defaultManager] fileExistsAtPath:url.path]) {
if (error) {
*error = [NSError errorWithDomain:@"HBErrorDomain"
code:100
userInfo:@{ NSLocalizedDescriptionKey: @"Unable to find the file at the specified URL" }];
}
return NO;
}
HBDVDDetector *detector = [HBDVDDetector detectorForPath:url.path];
if (detector.isVideoDVD || detector.isVideoBluRay)
{
[HBUtilities writeToActivityLog:"%s trying to open a physical disc at: %s", self.name.UTF8String, url.path.UTF8String];
void *lib = NULL;
if (detector.isVideoDVD)
{
lib = dlopen("libdvdcss.2.dylib", RTLD_LAZY);
}
else if (detector.isVideoBluRay)
{
lib = dlopen("libaacs.dylib", RTLD_LAZY);
}
if (lib)
{
dlclose(lib);
[HBUtilities writeToActivityLog:"%s library found for decrypting physical disc", self.name.UTF8String];
}
else
{
// Notify the user that we don't support removal of copy protection.
[HBUtilities writeToActivityLog:"%s, library not found for decrypting physical disc", self.name.UTF8String];
if (error) {
*error = [NSError errorWithDomain:@"HBErrorDomain"
code:101
userInfo:@{ NSLocalizedDescriptionKey: @"library not found for decrypting physical disc" }];
}
}
}
#ifdef __SANDBOX_ENABLED__
if (accessingSecurityScopedResource)
{
[url stopAccessingSecurityScopedResource];
}
#endif
return YES;
}
- (void)scanURL:(NSURL *)url titleIndex:(NSUInteger)index previews:(NSUInteger)previewsNum minDuration:(NSUInteger)seconds progressHandler:(HBCoreProgressHandler)progressHandler completionHandler:(HBCoreCompletionHandler)completionHandler
{
NSAssert(self.state == HBStateIdle, @"[HBCore scanURL:] called while another scan or encode already in progress");
NSAssert(url, @"[HBCore scanURL:] called with nil url.");
#ifdef __SANDBOX_ENABLED__
__block HBSecurityAccessToken *token = [HBSecurityAccessToken tokenWithObject:url];
self.cleanupHandler = ^{ token = nil; };
#endif
// Reset the titles array
self.titles = @[];
// Copy the progress/completion blocks
self.progressHandler = progressHandler;
self.completionHandler = completionHandler;
// convert minTitleDuration from seconds to the internal HB time
uint64_t min_title_duration_ticks = 90000LL * seconds;
// If there is no title number passed to scan, we use 0
// which causes the default behavior of a full source scan
if (index > 0)
{
[HBUtilities writeToActivityLog:"%s scanning specifically for title: %d", self.name.UTF8String, index];
}
else
{
// minimum title duration doesn't apply to title-specific scan
// it doesn't apply to batch scan either, but we can't tell it apart from DVD & BD folders here
[HBUtilities writeToActivityLog:"%s scanning titles with a duration of %d seconds or more", self.name.UTF8String, seconds];
}
[self preventAutoSleep];
hb_scan(_hb_handle, url.fileSystemRepresentation,
(int)index, (int)previewsNum,
1, min_title_duration_ticks);
// Start the timer to handle libhb state changes
[self startUpdateTimerWithInterval:0.2];
// Set the state, so the UI can be update
// to reflect the current state instead of
// waiting for libhb to set it in a background thread.
self.state = HBStateScanning;
}
/**
* Creates an array of lightweight HBTitles instances.
*/
- (HBCoreResult)scanDone
{
hb_title_set_t *title_set = hb_get_title_set(_hb_handle);
NSMutableArray *titles = [NSMutableArray array];
for (int i = 0; i < hb_list_count(title_set->list_title); i++)
{
hb_title_t *title = (hb_title_t *) hb_list_item(title_set->list_title, i);
[titles addObject:[[HBTitle alloc] initWithTitle:title handle:self.hb_handle featured:(title->index == title_set->feature)]];
}
self.titles = [titles copy];
[HBUtilities writeToActivityLog:"%s scan done", self.name.UTF8String];
return (self.titles.count > 0) ? HBCoreResultDone : HBCoreResultFailed;
}
- (void)cancelScan
{
hb_scan_stop(_hb_handle);
[HBUtilities writeToActivityLog:"%s scan canceled", self.name.UTF8String];
}
#pragma mark - Preview images
- (CGImageRef)copyImageAtIndex:(NSUInteger)index
forTitle:(HBTitle *)title
pictureFrame:(HBPicture *)frame
deinterlace:(BOOL)deinterlace
rotate:(int)angle
flipped:(BOOL)flipped CF_RETURNS_RETAINED
{
CGImageRef img = NULL;
hb_geometry_settings_t geo;
memset(&geo, 0, sizeof(geo));
geo.geometry.width = frame.displayWidth;
geo.geometry.height = frame.height;
// ignore the par.
geo.geometry.par.num = 1;
geo.geometry.par.den = 1;
int crop[4] = {frame.cropTop, frame.cropBottom, frame.cropLeft, frame.cropRight};
memcpy(geo.crop, crop, sizeof(int[4]));
hb_image_t *image = hb_get_preview2(_hb_handle, title.index, (int)index, &geo, deinterlace);
if (image)
{
// Create an CGImageRef and copy the libhb image into it.
// The image data returned by hb_get_preview2 is 4 bytes per pixel, BGRA format.
// Alpha is ignored.
CFMutableDataRef imgData = CFDataCreateMutable(kCFAllocatorDefault, 0);
CFDataSetLength(imgData, 3 * image->width * image->height);
UInt8 *src_line = image->data;
UInt8 *dst = CFDataGetMutableBytePtr(imgData);
for (int r = 0; r < image->height; r++)
{
UInt8 *src = src_line;
for (int c = 0; c < image->width; c++)
{
*dst++ = src[2];
*dst++ = src[1];
*dst++ = src[0];
src += 4;
}
src_line += image->plane[0].stride;
}
CGDataProviderRef provider = CGDataProviderCreateWithCFData(imgData);
CGBitmapInfo bitmapInfo = kCGBitmapByteOrderDefault | kCGImageAlphaNone;
CGColorSpaceRef colorSpace = copyColorSpace(title.hb_title->color_prim,
title.hb_title->color_transfer,
title.hb_title->color_matrix);
img = CGImageCreate(image->width,
image->height,
8,
24,
image->width * 3,
colorSpace,
bitmapInfo,
provider,
NULL,
NO,
kCGRenderingIntentDefault);
CGColorSpaceRelease(colorSpace);
CGDataProviderRelease(provider);
CFRelease(imgData);
hb_image_close(&image);
}
if (img && (angle || flipped))
{
CGImageRef rotatedImg = CGImageRotated(img, angle, flipped);
CGImageRelease(img);
return rotatedImg;
}
else
{
return img;
}
}
- (NSUInteger)imagesCountForTitle:(HBTitle *)title
{
return title.hb_title->preview_count;
}
#pragma mark - Encodes
- (void)encodeJob:(HBJob *)job progressHandler:(HBCoreProgressHandler)progressHandler completionHandler:(HBCoreCompletionHandler)completionHandler
{
NSAssert(self.state == HBStateIdle, @"[HBCore encodeJob:] called while another scan or encode already in progress");
NSAssert(job, @"[HBCore encodeJob:] called with nil job");
// Copy the progress/completion blocks
self.progressHandler = progressHandler;
self.completionHandler = completionHandler;
#ifdef __SANDBOX_ENABLED__
HBJob *jobCopy = [job copy];
__block HBSecurityAccessToken *token = [HBSecurityAccessToken tokenWithObject:jobCopy];
self.cleanupHandler = ^{ token = nil; };
#endif
// Add the job to libhb
hb_job_t *hb_job = job.hb_job;
hb_job_set_file(hb_job, job.completeOutputURL.fileSystemRepresentation);
hb_add(_hb_handle, hb_job);
// Free the job
hb_job_close(&hb_job);
[self preventAutoSleep];
[self startProgressReporting:job.completeOutputURL];
hb_start(_hb_handle);
// Start the timer to handle libhb state changes
[self startUpdateTimerWithInterval:0.5];
// Set the state, so the UI can be update
// to reflect the current state instead of
// waiting for libhb to set it in a background thread.
self.state = HBStateWorking;
[HBUtilities writeToActivityLog:"%s started encoding %s", self.name.UTF8String, job.outputFileName.UTF8String];
[HBUtilities writeToActivityLog:"%s with preset %s", self.name.UTF8String, job.presetName.UTF8String];
}
- (HBCoreResult)workDone
{
[self stopProgressReporting];
// HB_STATE_WORKDONE happens as a result of libhb finishing all its jobs
// or someone calling hb_stop. In the latter case, hb_stop does not clear
// out the remaining passes/jobs in the queue. We'll do that here.
hb_job_t *job;
while ((job = hb_job(_hb_handle, 0)))
{
hb_rem(_hb_handle, job);
}
HBCoreResult result = HBCoreResultDone;
switch (_hb_state->param.working.error)
{
case HB_ERROR_NONE:
result = HBCoreResultDone;
[HBUtilities writeToActivityLog:"%s work done", self.name.UTF8String];
break;
case HB_ERROR_CANCELED:
result = HBCoreResultCanceled;
[HBUtilities writeToActivityLog:"%s work canceled", self.name.UTF8String];
break;
default:
result = HBCoreResultFailed;
[HBUtilities writeToActivityLog:"%s work failed", self.name.UTF8String];
break;
}
return result;
}
- (void)cancelEncode
{
hb_stop(_hb_handle);
[HBUtilities writeToActivityLog:"%s encode canceled", self.name.UTF8String];
}
- (void)pause
{
hb_pause(_hb_handle);
self.state = HBStatePaused;
[self allowAutoSleep];
}
- (void)resume
{
hb_resume(_hb_handle);
self.state = HBStateWorking;
[self preventAutoSleep];
}
#pragma mark - Progress
- (void)startProgressReporting:(NSURL *)fileURL
{
if (fileURL)
{
NSDictionary *userInfo = @{NSProgressFileURLKey : fileURL};
self.progress = [[NSProgress alloc] initWithParent:nil userInfo:userInfo];
self.progress.totalUnitCount = 100;
self.progress.kind = NSProgressKindFile;
self.progress.pausable = NO;
self.progress.cancellable = NO;
[self.progress publish];
}
}
- (void)stopProgressReporting
{
self.progress.completedUnitCount = 100;
[self.progress unpublish];
self.progress = nil;
}
#pragma mark - State updates
/**
* Starts the timer used to polls libhb for state changes.
*
* @param seconds The number of seconds between firings of the timer.
*/
- (void)startUpdateTimerWithInterval:(NSTimeInterval)seconds
{
if (!self.updateTimer)
{
dispatch_source_t timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, _updateTimerQueue);
if (timer)
{
dispatch_source_set_timer(timer, dispatch_walltime(NULL, 0), (uint64_t)(seconds * NSEC_PER_SEC), (uint64_t)(seconds * NSEC_PER_SEC / 10));
dispatch_source_set_event_handler(timer, ^{
[self updateState];
});
dispatch_resume(timer);
}
self.updateTimer = timer;
}
}
/**
* Stops the update timer.
*/
- (void)stopUpdateTimer
{
if (self.updateTimer)
{
dispatch_source_cancel(self.updateTimer);
self.updateTimer = NULL;
}
}
/**
* This method polls libhb continuously for state changes and processes them.
* Additional processing for each state is performed in methods that start
* with 'handle'.
*/
- (void)updateState
{
hb_get_state(_hb_handle, _hb_state);
if (_hb_state->state == HB_STATE_IDLE)
{
// Libhb reported HB_STATE_IDLE, so nothing interesting has happened.
return;
}
// Update HBCore state to reflect the current state of libhb
if (_state != _hb_state->state)
{
self.state = _hb_state->state;
}
// Call the handler for the current state
if (_hb_state->state == HB_STATE_WORKDONE || _hb_state->state == HB_STATE_SCANDONE)
{
[self handleCompletion];
}
else
{
[self handleProgress];
}
}
#pragma mark - Blocks callbacks
/**
* Processes progress state information.
*/
- (void)handleProgress
{
if (self.progressHandler)
{
hb_state_t state = *(self.hb_state);
HBProgress progress = {0, 0, 0, 0};
progress.percent = [self.stateFormatter stateToPercentComplete:state];
if (state.state == HB_STATE_WORKING || state.state == HB_STATE_PAUSED)
{
progress.hours = state.param.working.hours;
progress.minutes = state.param.working.minutes;
progress.seconds = state.param.working.seconds;
}
NSString *info = [self.stateFormatter stateToString:state];
self.progressHandler(self.state, progress, info);
if (state.state != HB_STATE_SEARCHING &&
self.progress.completedUnitCount < progress.percent * 100)
{
self.progress.completedUnitCount = progress.percent * 100;
}
}
}
/**
* Processes completion state information.
*/
- (void)handleCompletion
{
// Libhb reported HB_STATE_WORKDONE or HB_STATE_SCANDONE,
// so nothing interesting will happen after this point, stop the timer.
[self stopUpdateTimer];
// Set the state to idle, because the update timer won't fire again.
self.state = HBStateIdle;
// Reallow system sleep.
[self allowAutoSleep];
// Call the completion block and clean ups the handlers
self.progressHandler = nil;
#ifdef __SANDBOX_ENABLED__
self.cleanupHandler();
self.cleanupHandler = nil;
#endif
HBCoreResult result = (_hb_state->state == HB_STATE_WORKDONE) ? [self workDone] : [self scanDone];
[self runCompletionBlockAndCleanUpWithResult:result];
}
/**
* Runs the completion block and clean ups the internal blocks.
*
* @param result the result to pass to the completion block.
*/
- (void)runCompletionBlockAndCleanUpWithResult:(HBCoreResult)result
{
if (self.completionHandler)
{
// Retain the completion block, because it could be replaced
// inside the same block.
HBCoreCompletionHandler completionHandler = self.completionHandler;
self.completionHandler = nil;
completionHandler(result);
}
}
@end
|