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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
|
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="QueueService.cs" company="HandBrake Project (http://handbrake.fr)">
// This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
// </copyright>
// <summary>
// The HandBrake Queue
// </summary>
// --------------------------------------------------------------------------------------------------------------------
namespace HandBrakeWPF.Services.Queue
{
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.IO;
using System.Linq;
using System.Windows;
using HandBrake.Interop.Interop.Json.Queue;
using HandBrake.Interop.Model;
using HandBrake.Interop.Utilities;
using HandBrakeWPF.Factories;
using HandBrakeWPF.Helpers;
using HandBrakeWPF.Properties;
using HandBrakeWPF.Services.Encode;
using HandBrakeWPF.Services.Encode.Factories;
using HandBrakeWPF.Services.Encode.Interfaces;
using HandBrakeWPF.Services.Encode.Model;
using HandBrakeWPF.Services.Interfaces;
using HandBrakeWPF.Services.Logging.Interfaces;
using HandBrakeWPF.Services.Queue.Interfaces;
using HandBrakeWPF.Services.Queue.JobEventArgs;
using HandBrakeWPF.Services.Queue.Model;
using HandBrakeWPF.Utilities;
using Newtonsoft.Json;
using EncodeCompletedEventArgs = Encode.EventArgs.EncodeCompletedEventArgs;
using Execute = Caliburn.Micro.Execute;
using GeneralApplicationException = Exceptions.GeneralApplicationException;
using ILog = Logging.Interfaces.ILog;
using QueueCompletedEventArgs = EventArgs.QueueCompletedEventArgs;
using QueueProgressEventArgs = EventArgs.QueueProgressEventArgs;
public class QueueService : IQueueService
{
private static readonly object QueueLock = new object();
private readonly List<ActiveJob> activeJobs = new List<ActiveJob>();
private readonly IUserSettingService userSettingService;
private readonly ILog logService;
private readonly IErrorService errorService;
private readonly ILogInstanceManager logInstanceManager;
private readonly DelayedActionProcessor delayedQueueBackupProcessor = new DelayedActionProcessor();
private readonly IPortService portService;
private readonly ObservableCollection<QueueTask> queue = new ObservableCollection<QueueTask>();
private readonly string queueFile;
private readonly object queueFileLock = new object();
private readonly QueueResourceService hardwareResourceManager;
private int allowedInstances;
private int jobIdCounter = 0;
private bool processIsolationEnabled;
private EncodeTaskFactory encodeTaskFactory;
public QueueService(IUserSettingService userSettingService, ILog logService, IErrorService errorService, ILogInstanceManager logInstanceManager, IPortService portService)
{
this.userSettingService = userSettingService;
this.hardwareResourceManager = new QueueResourceService(userSettingService);
this.logService = logService;
this.errorService = errorService;
this.logInstanceManager = logInstanceManager;
this.portService = portService;
// If this is the first instance, just use the main queue file, otherwise add the instance id to the filename.
this.queueFile = string.Format("{0}{1}.json", QueueRecoveryHelper.QueueFileName, GeneralUtilities.ProcessId);
this.allowedInstances = this.userSettingService.GetUserSetting<int>(UserSettingConstants.SimultaneousEncodes);
this.processIsolationEnabled = this.userSettingService.GetUserSetting<bool>(UserSettingConstants.ProcessIsolationEnabled);
this.encodeTaskFactory = new EncodeTaskFactory(this.userSettingService);
this.hardwareResourceManager.Init();
}
public event EventHandler<QueueProgressEventArgs> JobProcessingStarted;
public event EventHandler QueueChanged;
public event EventHandler<QueueCompletedEventArgs> QueueCompleted;
public event EventHandler QueuePaused;
public event EventHandler QueueJobStatusChanged;
public event EventHandler<EncodeCompletedEventArgs> EncodeCompleted;
public int Count
{
get
{
return this.queue.Count(item => item.Status == QueueItemStatus.Waiting);
}
}
public int ErrorCount
{
get
{
return this.queue.Count(item => item.Status == QueueItemStatus.Error);
}
}
public int CompletedCount => this.queue.Count(item => item.Status == QueueItemStatus.Completed);
public bool IsPaused { get; private set; }
public bool IsProcessing { get; private set; }
public bool IsEncoding => this.activeJobs.Any(service => service.IsEncoding);
public ObservableCollection<QueueTask> Queue
{
get
{
return this.queue;
}
}
public void Add(QueueTask job)
{
lock (QueueLock)
{
this.queue.Add(job);
this.InvokeQueueChanged(EventArgs.Empty);
if (this.IsEncoding)
{
this.ProcessNextJob();
}
}
}
public void Add(List<QueueTask> tasks)
{
lock (QueueLock)
{
foreach (var job in tasks)
{
this.queue.Add(job);
}
this.InvokeQueueChanged(EventArgs.Empty);
if (this.IsEncoding)
{
this.ProcessNextJob();
}
}
}
public void BackupQueue(string exportPath)
{
lock (this.queueFileLock)
{
string appDataPath = DirectoryUtilities.GetUserStoragePath(VersionHelper.IsNightly());
string tempPath = !string.IsNullOrEmpty(exportPath)
? exportPath
: Path.Combine(appDataPath, string.Format(this.queueFile, string.Empty));
// Make a copy of the file before we replace it. This way, if we crash we can recover.
if (File.Exists(tempPath))
{
File.Copy(tempPath, tempPath + ".last");
}
using (StreamWriter writer = new StreamWriter(tempPath))
{
List<QueueTask> tasks = this.queue.Where(item => item.Status != QueueItemStatus.Completed).ToList();
string queueJson = JsonConvert.SerializeObject(tasks, Formatting.Indented);
writer.Write(queueJson);
}
if (File.Exists(tempPath + ".last"))
{
File.Delete(tempPath + ".last");
}
}
}
public void ExportCliJson(string exportPath)
{
List<QueueTask> jobs = this.queue.Where(item => item.Status != QueueItemStatus.Completed).ToList();
List<EncodeTask> workUnits = jobs.Select(job => job.Task).ToList();
HBConfiguration config = HBConfigurationFactory.Create(); // Default to current settings for now. These will hopefully go away in the future.
string json = this.GetQueueJson(workUnits, config);
using (var strm = new StreamWriter(exportPath, false))
{
strm.Write(json);
strm.Close();
strm.Dispose();
}
}
public void ExportJson(string exportPath)
{
List<QueueTask> jobs = this.queue.Where(item => item.Status != QueueItemStatus.Completed).ToList();
JsonSerializerSettings settings = new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore };
string json = JsonConvert.SerializeObject(jobs, Formatting.Indented, settings);
using (var strm = new StreamWriter(exportPath, false))
{
strm.Write(json);
strm.Close();
strm.Dispose();
}
}
public void ImportJson(string path)
{
using (StreamReader reader = new StreamReader(path))
{
string fileContent = reader.ReadToEnd();
if (string.IsNullOrEmpty(fileContent))
{
return;
}
List<QueueTask> reloadedQueue = JsonConvert.DeserializeObject<List<QueueTask>>(fileContent);
if (reloadedQueue == null)
{
return;
}
List<QueueTask> duplicates = queue.Where(task => reloadedQueue.Any(queueTask => queueTask.TaskId == task.TaskId)).ToList();
bool replaceDuplicates = false;
if (duplicates.Any())
{
MessageBoxResult result = this.errorService.ShowMessageBox(
Properties.Resources.QueueService_DuplicatesQuestion,
Properties.Resources.QueueService_DuplicatesTitle,
MessageBoxButton.YesNo,
MessageBoxImage.Question);
if (result == MessageBoxResult.Yes)
{
this.Stop(true);
foreach (QueueTask task in duplicates)
{
this.queue.Remove(task);
}
replaceDuplicates = true;
}
}
foreach (QueueTask task in reloadedQueue)
{
// Reset the imported jobs that were running in a previous session.
if (task.Status == QueueItemStatus.InProgress || task.Status == QueueItemStatus.Paused)
{
task.Status = QueueItemStatus.Waiting;
task.Statistics.Reset();
}
// Ignore jobs if the user has chosen not to replace them.
if (!replaceDuplicates && this.queue.Any(s => s.TaskId == task.TaskId))
{
continue;
}
// If the above conditions are not met, add it back in.
this.queue.Add(task);
}
if (reloadedQueue.Count > 0)
{
this.InvokeQueueChanged(EventArgs.Empty);
}
}
}
public bool CheckForDestinationPathDuplicates(string destination)
{
foreach (QueueTask job in this.queue)
{
if (string.Equals(
job.Task.Destination,
destination.Replace("\\\\", "\\"),
StringComparison.OrdinalIgnoreCase) && (job.Status == QueueItemStatus.Waiting || job.Status == QueueItemStatus.InProgress))
{
return true;
}
}
return false;
}
public void RetryJob(QueueTask task)
{
if (task == null)
{
return;
}
task.Status = QueueItemStatus.Waiting;
task.Statistics.Reset();
this.BackupQueue(null);
this.InvokeQueueChanged(EventArgs.Empty);
}
public void Clear()
{
List<QueueTask> deleteList = this.queue.Where(i => i.Status != QueueItemStatus.InProgress).ToList();
foreach (QueueTask item in deleteList)
{
this.queue.Remove(item);
}
this.InvokeQueueChanged(EventArgs.Empty);
}
public void ClearCompleted()
{
Execute.OnUIThread(
() =>
{
List<QueueTask> deleteList =
this.queue.Where(task => task.Status == QueueItemStatus.Completed).ToList();
foreach (QueueTask item in deleteList)
{
this.queue.Remove(item);
}
this.InvokeQueueChanged(EventArgs.Empty);
});
}
public QueueTask GetNextJobForProcessing()
{
if (this.queue.Count > 0)
{
QueueTask task = this.queue.FirstOrDefault(q => q.Status == QueueItemStatus.Waiting);
if (task != null)
{
task.TaskToken = this.hardwareResourceManager.GetToken(task.Task);
return task;
}
}
return null;
}
public void MoveDown(int index)
{
if (index < this.queue.Count - 1)
{
QueueTask item = this.queue[index];
this.queue.RemoveAt(index);
this.queue.Insert((index + 1), item);
}
this.InvokeQueueChanged(EventArgs.Empty);
}
public void MoveUp(int index)
{
if (index > 0)
{
QueueTask item = this.queue[index];
this.queue.RemoveAt(index);
this.queue.Insert((index - 1), item);
}
this.InvokeQueueChanged(EventArgs.Empty);
}
public void Remove(QueueTask job)
{
lock (QueueLock)
{
ActiveJob activeJob = null;
foreach (ActiveJob ajob in this.activeJobs)
{
if (Equals(ajob.Job, job))
{
activeJob = ajob;
ajob.Stop();
}
}
if (activeJob != null)
{
this.activeJobs.Remove(activeJob);
}
this.queue.Remove(job);
this.InvokeQueueChanged(EventArgs.Empty);
}
}
public void ResetJobStatusToWaiting(QueueTask job)
{
if (job.Status != QueueItemStatus.Error && job.Status != QueueItemStatus.Completed)
{
throw new GeneralApplicationException(
Resources.Error, Resources.Queue_UnableToResetJob, null);
}
job.Status = QueueItemStatus.Waiting;
}
public void RestoreQueue(string importPath)
{
string appDataPath = DirectoryUtilities.GetUserStoragePath(VersionHelper.IsNightly());
string tempPath = !string.IsNullOrEmpty(importPath)
? importPath
: (appDataPath + string.Format(this.queueFile, string.Empty));
if (File.Exists(tempPath))
{
bool invokeUpdate = false;
using (StreamReader stream = new StreamReader(!string.IsNullOrEmpty(importPath) ? importPath : tempPath))
{
string queueJson = stream.ReadToEnd();
List<QueueTask> list;
try
{
list = JsonConvert.DeserializeObject<List<QueueTask>>(queueJson);
}
catch (Exception exc)
{
throw new GeneralApplicationException(Resources.Queue_UnableToRestoreFile, Resources.Queue_UnableToRestoreFileExtended, exc);
}
if (list != null)
{
foreach (QueueTask item in list)
{
if (item.Status != QueueItemStatus.Completed)
{
// Reset InProgress/Error to Waiting so it can be processed
if (item.Status == QueueItemStatus.InProgress || item.Status == QueueItemStatus.Paused)
{
item.Status = QueueItemStatus.Error;
}
this.queue.Add(item);
}
}
}
invokeUpdate = true;
}
if (invokeUpdate)
{
this.InvokeQueueChanged(EventArgs.Empty);
}
}
}
public void Pause(bool pauseJobs)
{
if (pauseJobs)
{
foreach (ActiveJob job in this.activeJobs)
{
if (job.IsEncoding && !job.IsPaused)
{
job.Pause();
}
}
}
this.IsProcessing = false;
this.IsPaused = true;
this.InvokeQueuePaused(EventArgs.Empty);
}
public void Start()
{
if (this.IsProcessing)
{
return;
}
this.IsPaused = false;
this.allowedInstances = this.userSettingService.GetUserSetting<int>(UserSettingConstants.SimultaneousEncodes);
this.processIsolationEnabled = this.userSettingService.GetUserSetting<bool>(UserSettingConstants.ProcessIsolationEnabled);
// Unpause all active jobs.
foreach (ActiveJob job in this.activeJobs)
{
job.Start();
this.InvokeJobProcessingStarted(new QueueProgressEventArgs(job.Job));
}
this.ProcessNextJob();
this.IsProcessing = true;
}
public void Stop(bool stopExistingJobs)
{
if (stopExistingJobs)
{
foreach (ActiveJob job in this.activeJobs)
{
if (job.IsEncoding || job.IsPaused)
{
job.Stop();
}
}
}
this.IsProcessing = false;
this.IsPaused = false;
if (stopExistingJobs || this.activeJobs.Count == 0)
{
this.InvokeQueueChanged(EventArgs.Empty);
this.InvokeQueueCompleted(new QueueCompletedEventArgs(true));
}
}
public List<QueueProgressStatus> GetQueueProgressStatus()
{
// TODO make thread safe.
List<QueueProgressStatus> statuses = new List<QueueProgressStatus>();
foreach (ActiveJob job in this.activeJobs)
{
statuses.Add(job.Job.JobProgress);
}
return statuses;
}
public List<string> GetActiveJobDestinationDirectories()
{
// TODO need to make thread safe.
List<string> directories = new List<string>();
foreach (ActiveJob job in this.activeJobs)
{
directories.Add(job.Job.Task.Destination);
}
return directories;
}
private void InvokeJobProcessingStarted(QueueProgressEventArgs e)
{
this.JobProcessingStarted?.Invoke(this, e);
}
private void InvokeQueueChanged(EventArgs e)
{
try
{
delayedQueueBackupProcessor.PerformTask(() => this.BackupQueue(string.Empty), 200);
}
catch (Exception)
{
// Do Nothing.
}
EventHandler handler = this.QueueChanged;
if (handler != null)
{
handler(this, e);
}
}
private void ProcessNextJob()
{
if (!this.processIsolationEnabled)
{
this.allowedInstances = 1;
}
if (this.activeJobs.Count >= this.allowedInstances)
{
return;
}
if (this.userSettingService.GetUserSetting<bool>(UserSettingConstants.ClearCompletedFromQueue))
{
this.ClearCompleted();
}
QueueTask job = this.GetNextJobForProcessing();
if (job != null)
{
// Hardware encoders can typically only have 1 or two instances running at any given time. As such, we must have a HardwareResourceToken to continue.
if (job.TaskToken == Guid.Empty)
{
return; // Hardware is busy, we'll try again later when another job completes.
}
if (CheckDiskSpace(job))
{
return; // Don't start the next job.
}
this.jobIdCounter = this.jobIdCounter + 1;
IEncode libEncode = new LibEncode(this.userSettingService, this.logInstanceManager, this.jobIdCounter, this.portService);
ActiveJob activeJob = new ActiveJob(job, libEncode);
activeJob.JobFinished += this.ActiveJob_JobFinished;
activeJob.JobStatusUpdated += this.ActiveJob_JobStatusUpdated;
this.activeJobs.Add(activeJob);
activeJob.Start();
this.IsProcessing = true;
this.InvokeQueueChanged(EventArgs.Empty);
this.InvokeJobProcessingStarted(new QueueProgressEventArgs(job));
this.BackupQueue(string.Empty);
this.ProcessNextJob();
}
else
{
this.BackupQueue(string.Empty);
if (!this.activeJobs.Any(a => a.IsEncoding))
{
// Fire the event to tell connected services.
this.InvokeQueueCompleted(new QueueCompletedEventArgs(false));
}
}
}
private void ActiveJob_JobStatusUpdated(object sender, Encode.EventArgs.EncodeProgressEventArgs e)
{
this.OnQueueJobStatusChanged();
}
private void ActiveJob_JobFinished(object sender, ActiveJobCompletedEventArgs e)
{
this.hardwareResourceManager.ReleaseToken(e.Job.Job.Task.VideoEncoder, e.Job.Job.TaskToken);
this.activeJobs.Remove(e.Job);
this.OnEncodeCompleted(e.EncodeEventArgs);
if (!this.IsPaused && this.IsProcessing)
{
this.ProcessNextJob();
}
else
{
this.InvokeQueueChanged(EventArgs.Empty);
this.InvokeQueueCompleted(new QueueCompletedEventArgs(true));
}
}
private void InvokeQueueCompleted(QueueCompletedEventArgs e)
{
this.IsProcessing = false;
this.QueueCompleted?.Invoke(this, e);
}
private void OnQueueJobStatusChanged()
{
// TODO add support for delayed notificaitons here to avoid overloading the UI when we run multiple encodes.
this.QueueJobStatusChanged?.Invoke(this, EventArgs.Empty);
}
private void OnEncodeCompleted(EncodeCompletedEventArgs e)
{
this.EncodeCompleted?.Invoke(this, e);
}
private void InvokeQueuePaused(EventArgs e)
{
this.IsProcessing = false;
EventHandler handler = this.QueuePaused;
handler?.Invoke(this, e);
}
private string GetQueueJson(List<EncodeTask> tasks, HBConfiguration configuration)
{
JsonSerializerSettings settings = new JsonSerializerSettings
{
NullValueHandling = NullValueHandling.Ignore,
};
List<Task> queueJobs = new List<Task>();
foreach (var item in tasks)
{
Task task = new Task { Job = this.encodeTaskFactory.Create(item, configuration) };
queueJobs.Add(task);
}
return JsonConvert.SerializeObject(queueJobs, Formatting.Indented, settings);
}
private bool CheckDiskSpace(QueueTask job)
{
if (this.userSettingService.GetUserSetting<bool>(UserSettingConstants.PauseOnLowDiskspace) && !DriveUtilities.HasMinimumDiskSpace(job.Task.Destination, this.userSettingService.GetUserSetting<long>(UserSettingConstants.PauseQueueOnLowDiskspaceLevel)))
{
this.logService.LogMessage(Resources.PauseOnLowDiskspace);
job.Status = QueueItemStatus.Waiting;
this.Pause(true);
this.BackupQueue(string.Empty);
return true; // Don't start the next job.
}
return false;
}
}
}
|