3 This file is part of the HandBrake source code.
4 Homepage: <http://handbrake.m0k.org/>.
5 It may be used under the terms of the GNU General Public License. */
8 #include <Cocoa/Cocoa.h>
15 #define HB_QUEUE_DRAGGING 0 // <--- NOT COMPLETELY FUNCTIONAL YET
16 #define HB_OUTLINE_METRIC_CONTROLS 0 // for tweaking the outline cell spacings
18 // hb_job_t contains a sequence_id field. The high word is a unique job group id.
19 // The low word contains the "sequence id" which is a value starting at 0 and
20 // incremented for each pass in the job group. Use the function below to create and
21 // interpret a sequence_id field.
22 int MakeJobID(int jobGroupID, int sequenceNum);
23 bool IsFirstPass(int jobID);
25 typedef enum _HBQueueJobGroupStatus
30 HBStatusCompleted = 3,
32 } HBQueueJobGroupStatus;
34 // Notification sent whenever the status of a HBJobGroup changes (via setStatus). The
35 // user info contains one object, @"HBOldJobGroupStatus", which is an NSNumber
36 // containing the previous status of the job group.
37 extern NSString * HBJobGroupStatusNotification;
39 //------------------------------------------------------------------------------------
40 // As usual, we need to subclass NSOutlineView to handle a few special cases:
42 // (1) variable row heights during live resizes
43 // HBQueueOutlineView exists solely to get around a bug in variable row height outline
44 // views in which row heights get messed up during live resizes. See this discussion:
45 // http://lists.apple.com/archives/cocoa-dev/2005/Oct/msg00871.html
46 // However, the recommeneded fix (override drawRect:) does not work. Instead, this
47 // subclass implements viewDidEndLiveResize in order to recalculate all row heights.
49 // (2) prevent expanding of items during drags
50 // During dragging operations, we don't want outline items to expand, since a queue
51 // doesn't really have children items.
53 // (3) generate a drag image that incorporates more than just the first column
54 // By default, NSTableView only drags an image of the first column. Change this to
55 // drag an image of the queue's icon and desc columns.
57 @interface HBQueueOutlineView : NSOutlineView
68 //------------------------------------------------------------------------------------
69 // HBJob is the UI's equivalent to libhb's hb_job_t struct. It is used mainly for
70 // drawing the job's description. HBJob are referred to in the UI as 'passes'.
71 //------------------------------------------------------------------------------------
73 @interface HBJob : NSObject
75 HBJobGroup *jobGroup; // The group this job belongs to
77 // The following fields match up with similar fields found in hb_job_t and it's
78 // various substructures.
81 int sequence_id; // This is how we xref to the jobs inside libhb
88 int width; // source dimensions
90 int output_width; // output dimensions
92 int anamorphic_width; // anamorphic dimensions
93 int anamorphic_height;
97 int pixel_aspect_width;
98 int pixel_aspect_height;
109 int audio_mixdowns[8];
124 // from hb_subtitle_s
125 NSString *subtitleLang;
128 + (HBJob*) jobWithLibhbJob: (hb_job_t *) job;
129 - (id) initWithLibhbJob: (hb_job_t *) job;
130 - (HBJobGroup *) jobGroup;
131 - (void) setJobGroup: (HBJobGroup *)aJobGroup;
132 - (NSMutableAttributedString *) attributedDescriptionWithIcon: (BOOL)withIcon
133 withTitle: (BOOL)withTitle
134 withPassName: (BOOL)withPassName
135 withFormatInfo: (BOOL)withFormatInfo
136 withDestination: (BOOL)withDestination
137 withPictureInfo: (BOOL)withPictureInfo
138 withVideoInfo: (BOOL)withVideoInfo
139 withx264Info: (BOOL)withx264Info
140 withAudioInfo: (BOOL)withAudioInfo
141 withSubtitleInfo: (BOOL)withSubtitleInfo;
143 // Attributes used by attributedDescriptionWithIcon:::::::::
144 + (NSMutableParagraphStyle *) descriptionParagraphStyle;
145 + (NSDictionary *) descriptionDetailAttribute;
146 + (NSDictionary *) descriptionDetailBoldAttribute;
147 + (NSDictionary *) descriptionTitleAttribute;
148 + (NSDictionary *) descriptionShortHeightAttribute;
152 //------------------------------------------------------------------------------------
153 // HBJobGroup is what's referred to in the UI as an 'encode'. A job group contains
154 // multiple HBJobs, one for each 'pass' of the encode. Whereas libhb keeps a simple
155 // list of jobs in it's queue, the queue controller presents them to the user as a
156 // series of encodes and passes (HBJObGroups and HBJobs).
157 //------------------------------------------------------------------------------------
159 @interface HBJobGroup : NSObject
161 NSMutableArray *fJobs; // array of HBJob
162 NSMutableAttributedString *fDescription;
163 BOOL fNeedsDescription;
164 float fLastDescriptionHeight;
165 float fLastDescriptionWidth;
166 HBQueueJobGroupStatus fStatus;
167 NSString *fPresetName;
170 // Creating a job group
171 + (HBJobGroup *) jobGroup;
174 - (void) addJob: (HBJob *)aJob;
176 // Querying a job group
177 - (unsigned int) count;
178 - (HBJob *) jobAtIndex: (unsigned)index;
179 - (unsigned int) indexOfJob: (HBJob *)aJob;
180 - (NSEnumerator *) jobEnumerator;
181 - (void) setStatus: (HBQueueJobGroupStatus)status;
182 - (HBQueueJobGroupStatus) status;
183 - (void) setPresetName: (NSString *)name;
184 - (NSString *) presetName;
185 - (NSString *) destinationPath;
188 // Creating a description
189 - (void) setNeedsDescription: (BOOL)flag;
190 - (NSMutableAttributedString *) attributedDescription;
191 - (float) heightOfDescriptionForWidth:(float)width;
192 - (float) lastDescriptionHeight;
196 //------------------------------------------------------------------------------------
198 @interface HBQueueController : NSObject
200 hb_handle_t *fHandle; // reference to libhb
201 HBController *fHBController; // reference to HBController
202 NSMutableArray *fJobGroups; // libhb's job list organized in a hierarchy of HBJobGroup and HBJob
203 HBJobGroup *fCurrentJobGroup; // the HJobGroup currently being processed by libhb
204 HBJob *fCurrentJob; // the HJob (pass) currently being processed by libhb
205 int fCurrentJobID; // this is how we track when hbib has started processing a different job. This is the job's sequence_id.
207 unsigned int fPendingCount; // Number of various kinds of job groups in fJobGroups.
208 unsigned int fCompletedCount; // Don't access these directly as they may not always be up-to-date.
209 unsigned int fCanceledCount; // Use the accessor functions instead.
210 unsigned int fWorkingCount;
211 BOOL fJobGroupCountsNeedUpdating;
213 BOOL fCurrentJobPaneShown; // NO when fCurrentJobPane has been shifted out of view (see showCurrentJobPane)
214 NSMutableIndexSet *fSavedExpandedItems; // used by save/restoreOutlineViewState to preserve which items are expanded
215 NSMutableIndexSet *fSavedSelectedItems; // used by save/restoreOutlineViewState to preserve which items are selected
216 #if HB_QUEUE_DRAGGING
217 NSArray *fDraggedNodes;
219 NSTimer *fAnimationTimer; // animates the icon of the current job in the queue outline view
220 int fAnimationIndex; // used to generate name of image used to animate the current job in the queue outline view
222 // +---------------fQueueWindow----------------+
223 // |+-------------fCurrentJobPane-------------+|
227 // |+-----------------------------------------+|
228 // |+---------------fQueuePane----------------+|
236 // |+-----------------------------------------+|
237 // +-------------------------------------------+
239 IBOutlet NSWindow *fQueueWindow;
241 // fCurrentJobPane - visible only when processing a job
242 IBOutlet NSView *fCurrentJobPane;
243 IBOutlet NSImageView *fJobIconView;
244 IBOutlet NSTextField *fJobDescTextField;
245 IBOutlet NSProgressIndicator *fProgressBar;
246 IBOutlet NSTextField *fProgressTextField;
248 // fQueuePane - always visible; fills entire window when fCurrentJobPane is hidden
249 IBOutlet NSView *fQueuePane;
250 IBOutlet HBQueueOutlineView *fOutlineView;
251 IBOutlet NSTextField *fQueueCountField;
252 #if HB_OUTLINE_METRIC_CONTROLS
253 IBOutlet NSSlider *fIndentation; // debug
254 IBOutlet NSSlider *fSpacing; // debug
259 - (void)setHandle: (hb_handle_t *)handle;
260 - (void)setHBController: (HBController *)controller;
261 - (void)libhbStateChanged: (hb_state_t &)state;
262 - (void)libhbWillStop;
264 // Adding items to the queue
265 - (void) addJobGroup: (HBJobGroup *) aJobGroup;
267 // Getting the currently processing job group
268 - (HBJobGroup *) currentJobGroup;
269 - (HBJob *) currentJob;
271 // Getting job groups
272 - (HBJobGroup *) pendingJobGroupWithDestinationPath: (NSString *)path;
274 // Getting queue statistics
275 - (unsigned int) pendingCount;
276 - (unsigned int) completedCount;
277 - (unsigned int) canceledCount;
278 - (unsigned int) workingCount;
280 - (IBAction)showQueueWindow: (id)sender;
281 - (IBAction)removeSelectedJobGroups: (id)sender;
282 - (IBAction)revealSelectedJobGroups: (id)sender;
283 - (IBAction)cancelCurrentJob: (id)sender;
284 - (IBAction)toggleStartCancel: (id)sender;
285 - (IBAction)togglePauseResume: (id)sender;
287 #if HB_OUTLINE_METRIC_CONTROLS
288 - (IBAction)imageSpacingChanged: (id)sender;
289 - (IBAction)indentChanged: (id)sender;