macosx/HBQueueController.h

   1 /* HBQueueController
   2
   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. */
   6
   7
   8 #include <Cocoa/Cocoa.h>
   9 #include "hb.h"
  10
  11 @class HBController;
  12 @class HBJob;
  13 @class HBJobGroup;
  14
  15 #define HB_QUEUE_DRAGGING 0             // <--- NOT COMPLETELY FUNCTIONAL YET
  16 #define HB_OUTLINE_METRIC_CONTROLS 0    // for tweaking the outline cell spacings
  17
  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);
  24
  25 typedef enum _HBQueueJobGroupStatus
  26 {
  27     HBStatusNone          = 0,
  28     HBStatusPending       = 1,
  29     HBStatusWorking       = 2,
  30     HBStatusCompleted     = 3,
  31     HBStatusCanceled      = 4
  32 } HBQueueJobGroupStatus;
  33
  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;
  38
  39 //------------------------------------------------------------------------------------
  40 // As usual, we need to subclass NSOutlineView to handle a few special cases:
  41 //
  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.
  48 //
  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.
  52 //
  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.
  56
  57 @interface HBQueueOutlineView : NSOutlineView
  58 {
  59 #if HB_QUEUE_DRAGGING
  60 BOOL                        fIsDragging;
  61 #endif
  62 }
  63 #if HB_QUEUE_DRAGGING
  64 - (BOOL) isDragging;
  65 #endif
  66 @end
  67
  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 //------------------------------------------------------------------------------------
  72
  73 @interface HBJob : NSObject
  74 {
  75     HBJobGroup                   *jobGroup;         // The group this job belongs to
  76
  77     // The following fields match up with similar fields found in hb_job_t and it's
  78     // various substructures.
  79 @public
  80     // from hb_job_s
  81     int                         sequence_id;        // This is how we xref to the jobs inside libhb
  82
  83     int                         chapter_start;
  84     int                         chapter_end;
  85     int                         chapter_markers;
  86     int                         crop[4];
  87     int                         deinterlace;
  88     int                         width;              // source dimensions
  89     int                         height;
  90     int                         output_width;       // output dimensions
  91     int                         output_height;
  92     int                         anamorphic_width;   // anamorphic dimensions
  93     int                         anamorphic_height;
  94     int                         keep_ratio;
  95     int                         grayscale;
  96     int                         pixel_ratio;
  97     int                         pixel_aspect_width;
  98     int                         pixel_aspect_height;
  99     int                         vcodec;
 100     float                       vquality;
 101     int                         vbitrate;
 102     int                         vrate;
 103     int                         vrate_base;
 104     int                         pass;
 105     int                         h264_level;
 106     int                         crf;
 107     NSString                    *x264opts;
 108
 109     int                         audio_mixdowns[8];
 110     int                         acodec;
 111     int                         abitrate;
 112     int                         arate;
 113     int                         subtitle;
 114
 115     int                         mux;
 116     NSString                    *file;
 117
 118     // from hb_title_s
 119     NSString                    *titleName;
 120     int                         titleIndex;
 121     int                         titleWidth;
 122     int                         titleHeight;
 123
 124     // from hb_subtitle_s
 125     NSString                    *subtitleLang;
 126 }
 127
 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;
 142
 143 // Attributes used by attributedDescriptionWithIcon:::::::::
 144 + (NSMutableParagraphStyle *) descriptionParagraphStyle;
 145 + (NSDictionary *) descriptionDetailAttribute;
 146 + (NSDictionary *) descriptionDetailBoldAttribute;
 147 + (NSDictionary *) descriptionTitleAttribute;
 148 + (NSDictionary *) descriptionShortHeightAttribute;
 149
 150 @end
 151
 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 //------------------------------------------------------------------------------------
 158
 159 @interface HBJobGroup : NSObject
 160 {
 161     NSMutableArray               *fJobs;   // array of HBJob
 162     NSMutableAttributedString    *fDescription;
 163     BOOL                         fNeedsDescription;
 164     float                        fLastDescriptionHeight;
 165     float                        fLastDescriptionWidth;
 166     HBQueueJobGroupStatus        fStatus;
 167     NSString                     *fPresetName;
 168 }
 169
 170 // Creating a job group
 171 + (HBJobGroup *)       jobGroup;
 172
 173 // Adding jobs
 174 - (void)               addJob: (HBJob *)aJob;
 175
 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;
 186 - (NSString *)         name;
 187
 188 // Creating a description
 189 - (void)               setNeedsDescription: (BOOL)flag;
 190 - (NSMutableAttributedString *) attributedDescription;
 191 - (float)              heightOfDescriptionForWidth:(float)width;
 192 - (float)              lastDescriptionHeight;
 193
 194 @end
 195
 196 //------------------------------------------------------------------------------------
 197
 198 @interface HBQueueController : NSObject
 199 {
 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.
 206
 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;
 212
 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;
 218 #endif
 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
 221
 222     //  +---------------fQueueWindow----------------+
 223     //  |+-------------fCurrentJobPane-------------+|
 224     //  ||                                         ||
 225     //  ||                                         ||
 226     //  ||                                         ||
 227     //  |+-----------------------------------------+|
 228     //  |+---------------fQueuePane----------------+|
 229     //  ||                                         ||
 230     //  ||                                         ||
 231     //  ||                                         ||
 232     //  ||                                         ||
 233     //  ||                                         ||
 234     //  ||                                         ||
 235     //  ||                                         ||
 236     //  |+-----------------------------------------+|
 237     //  +-------------------------------------------+
 238
 239     IBOutlet NSWindow            *fQueueWindow;
 240
 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;
 247
 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
 255 #endif
 256
 257 }
 258
 259 - (void)setHandle: (hb_handle_t *)handle;
 260 - (void)setHBController: (HBController *)controller;
 261 - (void)libhbStateChanged: (hb_state_t &)state;
 262 - (void)libhbWillStop;
 263
 264 // Adding items to the queue
 265 - (void) addJobGroup: (HBJobGroup *) aJobGroup;
 266
 267 // Getting the currently processing job group
 268 - (HBJobGroup *) currentJobGroup;
 269 - (HBJob *) currentJob;
 270
 271 // Getting job groups
 272 - (HBJobGroup *) pendingJobGroupWithDestinationPath: (NSString *)path;
 273
 274 // Getting queue statistics
 275 - (unsigned int) pendingCount;
 276 - (unsigned int) completedCount;
 277 - (unsigned int) canceledCount;
 278 - (unsigned int) workingCount;
 279
 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;
 286
 287 #if HB_OUTLINE_METRIC_CONTROLS
 288 - (IBAction)imageSpacingChanged: (id)sender;
 289 - (IBAction)indentChanged: (id)sender;
 290 #endif
 291
 292 @end
 293