TweetFollow Us on Twitter

Developing Applications With The QuickTime For Cocoa Kit

Volume Number: 21 (2005)
Issue Number: 6
Column Tag: Programming

QuickTime Toolkit

Back To The Future, Part II

by Tim Monroe

Developing Applications With The QuickTime For Cocoa Kit

In the previous QuickTime Toolkit article ("Back to the Future" in MacTech, May 2005), we began looking at Apple's new Cocoa framework for displaying and modifying QuickTime movies, called the QuickTime For Cocoa Kit or the QTKit. We saw how to open and display a movie in a window of a Cocoa document-based application; we also saw how to manipulate movies using command-line tools, which would be quite useful for batch processing via shell scripts or other scripting mechanisms.

Introduction

In this article, we'll continue our investigation of the QTKit framework, which is available in QuickTime 7 on both Panther and Tiger. We'll see how to extend the sample application KitEez that we began developing in the previous article to support the complete set of standard document behaviors (Save, Save As, Revert, and so forth). Toward the end of this article, we'll see how to restrict the file types displayed in the file-opening dialog box. Then in the next article, we'll wrap up our tour of the QTKit by looking at some advanced uses of its classes and methods.

Document Behaviors

So far, our sample application KitEez is able to open any kind of file that QuickTime can handle -- standard movies files, Flash files, MP3 files, MPEG-4 files, AIFF files, text files, and so forth -- and display the movie data in a Cocoa document window. Figure 1 shows a typical KitEez document window. As you can see, the movie and the movie controller bar completely fill the content region of the window. As you can also see from the hourglass shape of the thumb in the movie controller bar, the movie is editable using the items in the Edit menu or their standard keyboard shortcuts.


Figure 1. A window that contains a QTMovieView

Because movies opened using KitEez are editable, we'll want to support all the standard document behaviors: Undo/Redo, Save, Save As, Revert to the last saved version, and so forth. If you have developed Cocoa document-based applications before, then you'll know that Cocoa provides a sophisticated document architecture that tracks changes to a document and responds appropriately to user actions. For instance, if the user tries to close an edited but unsaved document window, Cocoa will display a sheet that prompts the user to save or discard those changes. The Cocoa document architecture, however, has no knowledge of what it means to save a QuickTime movie, so we'll need to override a few NSDocument methods to add that and other standard document behaviors to our sample application.

Supporting Editing Operations

It's actually trivially easy to support the standard undo and redo mechanism for edits made to a QuickTime movie that is displayed in a QTMovieView in a Cocoa document window. All we need to do is make the associated QTMovie object editable, and we saw how to do this in the previous article with this single line of code:

[movie setAttribute:[NSNumber numberWithBool:YES] 
                  forKey:QTMovieEditableAttribute];

Once we've executed this line of code, the movie can be edited using QTMovieView methods like cut:, copy:, paste:, trim:, and the like. Indeed, the default behavior of the Edit menu items is to issue these IB actions, so we need to write exactly 1 line of code (shown above) to have a full-fledged movie editing application.

QTKit provides the standard multiple-level undo and redo processing. A user can cut, copy, and paste to his or her heart's content and then undo all those editing operations. Also, QTKit automatically provides the standard drag-and-drop editing operations. A user can drag a movie segment out of a movie window and into any other object that can accept dragged movie data. Figure 2 shows the drag image being dragged out of a movie window.


Figure 2. A dragged movie segment

The performance of the dragging in QTKit-based applications is vastly improved over that provided by the standard movie controller. In some benchmarks, the creation of the drag image alone was over 3000 times faster in QTKit applications than in applications using the movie controller's drag-and-drop capability.

Saving an Edited Movie

When the user selects the Save item in the File menu, the first responder's saveDocument: method is executed. The NSDocument implementation of this method checks to see whether a file is already associated with the document; if not, it displays the file-saving sheet to elicit a filename and location from the user. This will never actually happen in KitEez, since we only ever open movies from existing files. But it might happen that an edited movie cannot be saved into the file it was opened from. For instance, KitEez is able to open MP3 files as QuickTime movies (transparently invoking its MP3 import component), which are then fully editable. But QuickTime does not provide an MP3 export component, so KitEez is unable to save the edited data back into the original MP3 file. In that case, we'd want to display the file-saving sheet so that the user can save the data as a QuickTime movie file (.mov).

The QTMovie class provides a method that we can use to determine whether a movie object can be saved into its associated file, canUpdateMovieFile. Listing 1 shows our override of the saveDocument: method.

Listing 1: Saving a document

- (IBAction)saveDocument:(id)sender
{
   if ([[movieView movie] canUpdateMovieFile])
      [super saveDocument:sender];
   else
      [super saveDocumentAs:sender];
}

This is simple enough: if the movie can be saved into the file it was opened from, then we just call NSDocument's saveDocument: method; otherwise we call its saveDocumentAs: method.

NSDocument's saveDocument: and saveDocumentAs: methods internally call writeWithBackupToFile:ofType:saveOperation: to actually write the document data into the associated file. We can override that method to save the edited movie data into the original movie file or into the newly-selected destination file. Listing 2 shows our override method.

Listing 2: Writing out the movie data

- (BOOL)writeWithBackupToFile:(NSString *)fileName 
      ofType:(NSString *)documentTypeName 
      saveOperation:(NSSaveOperationType)saveOperationType
{
   BOOL success = NO;

   if (saveOperationType == NSSaveOperation)
      success = [[movieView movie] updateMovieFile];
   else if (saveOperationType == NSSaveAsOperation) {
      success = [[movieView movie]writeToFile:fileName 
                                                withAttributes:nil];
      if (success) {
         QTMovie *newMovie = [QTMovie movieWithFile:fileName error:nil];

         [movieView setMovie:newMovie];
         [self initializeMovieWindow];
      }
   }
	
   return success;
}

When the requested operation is NSSaveOperation, we simply call the updateMovieFile method to update the movie atom in the movie file. When the requested operation is NSSaveAsOperation, we need to do a little more work. As you can see, we first call the QTMovie method writeToFile:withAttributes: with a nil dictionary of attributes. This has the effect of writing only the movie atom into the destination file. What we end up with in this case is a reference movie, that is, a movie whose media data is located in some other file. If instead we wanted a self-contained movie file, we could call writeToFile:withAttributes: with a dictionary that indicates that we want the movie to be flattened into the destination file, like this:

success = [[movieView movie] writeToFile:fileName
                                          withAttributes:[NSDictionary 
            dictionaryWithObject:[NSNumber numberWithBool:YES] 
            forKey:QTMovieFlatten]];

I'll leave it as an easy exercise for the reader to add an accessory view to the save panel that allows the user to determine whether a movie is saved as a reference movie or as a self-contained movie, like the one displayed by the QuickTime Player application (Figure 3).


Figure 3. An accessory view in a save panel

As you know, the standard behavior when performing a Save As operation is to replace the movie in the movie view with the movie in the new destination file. So, once we've called writeToFile:withAttributes:, we then need to open the movie in the new file and set it as the movie displayed in the movie view. Then we need to perform any movie configuration that must happen when a movie is opened. As you can see, we call the method initializeMovieWindow, defined in Listing 3. This code is lifted wholesale from the windowControllerDidLoadNib: method we considered in the previous article on QTKit.

Listing 3: Initializing a movie and its window

- (void)initializeMovieWindow
{
   QTMovie *movie = [movieView movie];

   // make the movie editable
	
[movie setAttribute:[NSNumber numberWithBool:YES] 
                forKey:QTMovieEditableAttribute];

   // use the QTKit's resize indicator, not NSWindow's

[[movieView window] setShowsResizeIndicator:NO];
   [movieView setShowsResizeIndicator:YES];

   // add a listener for size-changed notifications

   [[NSNotificationCenter defaultCenter] addObserver:self 
         selector:@selector(boundsDidChange:) 
         name:QTMovieSizeDidChangeNotification object:movie];
}

It's perhaps worth mentioning that the writeWithBackupToFile:ofType:saveOperation: method is deprecated in Mac OS X version 10.4 and later. Since however we want our application to run under all environments supporting QTKit, including Mac OS X version 10.3.9, we'll stick with this method.

Reverting to the Last Saved Version of a Movie

There remains just one document behavior for us to implement, namely reverting to the last saved version of a movie file. When the user selects the Revert item in the File menu, the Cocoa document handling code displays the sheet shown in Figure 4.


Figure 4. The Revert sheet

If the user presses the Revert button, the revertDocumentToSaved: method in the first responder is invoked. We won't override that method, so that method in the NSDocument class will be called. Rather, we'll override the revertToSavedFromFile:ofType: method, as shown in Listing 4.

Listing 4: Reverting to a saved movie file

- (BOOL)revertToSavedFromFile:(NSString *)fileName 
            ofType:(NSString *)type
{
   QTMovie *newMovie = [QTMovie movieWithFile:fileName error:nil];

   [movieView setMovie:newMovie];
   [self initializeMovieWindow];

   return YES;
}

As in the Save As case shown in Listing 3, we open the specified file and assign it to the movie view; then we perform the required initialization of the movie and movie window. Also, we return the value YES to make sure that the change count of the document is cleared.

So, we have successfully implemented a reasonably complete set of document-related behaviors in our sample application KitEez, using just a very few QTMovie methods: canUpdateMovieFile, updateMovieFile, and writeToFile:withAttributes:. At no point did we need to step outside the methods provided by QTKit into the underlying Carbon APIs. This stands in stark contrast to the work we needed to do in our earlier Cocoa movie-playing application MooVeez, which relied on the now-deprecated Cocoa classes NSMovie and NSMovieView for its QuickTime support. I invite you to take a second look at the article describing those classes ("The Cocoanuts" in MacTech, December 2002); by comparing the Carbon-laced methods we had to write there with the purely Cocoa-based methods we've seen here, you will get a very good appreciation of how big an advancement the QTKit is over those earlier classes.

Openable File Types

In the previous article introducing QTKit, we saw that we can very easily configure the file-opening dialog box to list all files openable by QuickTime by overriding the panel:shouldShowFilename: method and calling the canInitWithFile: class method. That method returns YES just in case a specified file can be used to initialize a QTMovie object. For certain purposes, however, we might want to restrict the types of files that the user can open to some more limited set. For instance, as you probably know, QuickTime can open text files with its text movie importer -- which converts the text into a series of frames in a text track. (See "Word is Out" in MacTech, November 2000 for more information on QuickTime's text-handling capabilities.) But it's doubtful that most applications that can open and display QuickTime movies would want to allow text files to be opened by the user. Ditto for HTML files. Ditto for PDF files.

QTKit provides an easy way to allow the user to open only the kinds of files that would normally be considered as media files and hence openable by a QuickTime application. Instead of using the canInitWithFile: method, we can use the movieFileTypes: method. This too is a class method, so you don't need to have an existing QTMovie object in order to call it.

The movieFileTypes: method returns an NSArray of file types and file extensions that can be opened by QuickTime. This method takes one parameter, which indicates the kinds of file types that you want to be included in the array. Currently these flags are defined for specifying file types:

typedef enum {
   QTIncludeStillImageTypes         = 1 << 0,
   QTIncludeTranslatableTypes       = 1 << 1,
   QTIncludeAggressiveTypes         = 1 << 2,
   QTIncludeCommonTypes             = 0,
   QTIncludeAllTypes                = 0xffff
} QTMovieFileTypeOptions;

Passing the value QTIncludeCommonTypes indicates that you want the array to contain only those file types and extensions that are commonly thought of as openable by QuickTime; this includes the extensions .mov and .mqv, as well as any file types that can be imported in place by QuickTime. (Recall that to be able to import a file in place is to be able to import the file without having to create a new file to hold the imported data.)

The QTIncludeStillImageTypes flag indicates that you want the array to include, in addition to the common file types, all types of files that can be opened by QuickTime using one of its available graphics importers. The QTIncludeTranslatableTypes flag indicates that you want the array to include also those file types that can be opened by QuickTime using one of its available movie importers, whether or not the file data can be imported in place; this array excludes however any file types that would require an aggressive importer. (An aggressive importer is one that can handle file types like text or HTML that would not normally be considered openable by QuickTime.) Finally, the QTIncludeAggressiveTypes flag indicates that you want the array to include file types that require an aggressive importer.

Obviously, the QTIncludeAllTypes flag sets all the bits in the options parameter and requests that the returned array include file types and file extensions for all files that QuickTime can open, using any available graphics or movie importer. Passing the array associated with the QTIncludeAllTypes flag to NSOpenPanel's runModalForTypes: method is essentially identical to using the canInitWithFile: method inside our panel:shouldShowFilename: override method.

It's important to realize that, for instance, the array returned when specifying the QTIncludeStillImageTypes flag will include all file types and extensions for still image files as well as all file types and extensions for the common movie types. That is to say, that array does not contain only the file types and extensions for still image types. If you wanted an array like that, you would need to use Component Manager functions to iterate through all installed components and select only those of type GraphicsImporterComponentType. Listing 5 shows how you might do that.

Listing 5: Finding still image types

0
fileTypes = [NSMutableArray array];
ComponentDescription findCD = {0, 0, 0, 0, 0};
ComponentDescription infoCD = {0, 0, 0, 0, 0};
Component comp = NULL;
OSErr err = noErr;

findCD.componentType = GraphicsImporterComponentType;
findCD.componentSubType = 0;
findCD.componentManufacturer = 0;
findCD.componentFlags = 0;
findCD.componentFlagsMask = cmpIsMissing | 
                                       graphicsExporterIsBaseExporter;

while (comp = FindNextComponent(comp, &findCD)) {
   err = GetComponentInfo(comp, &infoCD, nil, nil, nil);
   if (err == noErr) {
      if (infoCD.componentFlags & 
                        movieImportSubTypeIsFileExtension)
         [fileTypes addObject:[[[NSString 
            stringWithCString:(char *)&infoCD.componentSubType 
            length:sizeof(OSType)] 
            stringByTrimmingCharactersInSet:[NSCharacterSet 
               whitespaceCharacterSet]] lowercaseString]];
      else 
         [fileTypes addObject:[NSString 
            stringWithFormat:@"\'%@\'", [NSString 
            stringWithCString:(char *)&infoCD.componentSubType 
            length:sizeof(OSType)]]];
   }
}

Conclusion

In this article, we've added the standard document-handling behaviors to our KitEez sample application. We've seen how to use QTKit methods to support saving an edited movie into its original file or into a new file, and we've seen how to revert to the last saved version of a movie file. KitEez is now a reasonably complete multi-document movie opening and editing application.

In the next article, we'll take a look at some of the more advanced operations we can use the QTKit framework to perform. We'll see how to add images to an existing QuickTime movie, work with notifications and delegates, and execute QTKit methods on a secondary thread.


Tim Monroe is a member of the QuickTime engineering team at Apple. You can contact him at monroe@mactech.com. The views expressed here are not necessarily shared by his employer.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Catalina Cache Cleaner 15.0 - Clear cach...
Catalina Cache Cleaner is an award-winning general-purpose tool for macOS X. CCC makes system maintenance simple with an easy point-and-click interface to many macOS X functions. Novice and expert... Read more
Amadeus Pro 2.6.2 - Multitrack sound rec...
Amadeus Pro lets you use your Mac for any audio-related task, such as live audio recording, digitizing tapes and records, converting between a variety of sound formats, etc. Thanks to its outstanding... Read more
Scrivener 3.1.4 - Project management and...
Scrivener is a project management and writing tool for writers of all kinds that stays with you from that first unformed idea all the way through to the first - or even final - draft. Outline and... Read more
DxO PhotoLab 2.3.2.44 - Image enhancemen...
DxO PhotoLab (was DxO Optics Pro) provides a complete set of smart assisted corrections that you can manually fine-tune at any time. Take control on every aspect of your photos: effectively remove... Read more
iFinance 4.5.17 - Comprehensively manage...
iFinance allows you to keep track of your income and spending -- from your lunchbreak coffee to your new car -- in the most convenient and fastest way. Clearly arranged transaction lists of all your... Read more
Google Chrome 77.0.3865.120 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
SoftRAID 5.8 - High-quality RAID managem...
SoftRAID allows you to create and manage disk arrays to increase performance and reliability. SoftRAID allows the user to create and manage RAID 4 and 5 volumes, RAID 1+0, and RAID 1 (Mirror) and... Read more
ClamXav 3.0.14 - Virus checker based on...
ClamXav is a popular virus checker for OS X. Time to take control ClamXAV keeps threats at bay and puts you firmly in charge of your Mac’s security. Scan a specific file or your entire hard drive.... Read more
Thunderbird 68.1.2 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Malwarebytes 3.9.32.2826 - Adware remova...
Malwarebytes (was AdwareMedic) helps you get your Mac experience back. Malwarebytes scans for and removes code that degrades system performance or attacks your system. Making your Mac once again your... Read more

Latest Forum Discussions

See All

Hellrule is an auto-runner inspired by G...
Hellrule is an upcoming auto-runner game from independent developer Pedrocorp where players will take control of a dapperly dressed gentlemen who comes equipped with a razor-sharp umbrella for slicing up his foes. The game will be available for... | Read more »
Grobo is a gravity bending puzzle platfo...
Grobo is a 2D puzzle platformer that marks the first release from developers Hot Chocolate Games. You'll find yourself manipulating gravity as you make your through this title that's available now for iOS and Android. [Read more] | Read more »
Adrenaline, Compulsive Entertainment’s h...
Compulsive Entertainment’s high-octane arcade racer, Adrenaline, has now made its way to the App Store following a successful launch on Google Play. It’s a ton of challenging, fast-paced fun, boasting easy-to-learn controls and a varied selection... | Read more »
Mario Kart Tour is adding Super Mario Ga...
Earlier today on Twitter, Nintendo announced that Mario Kart Tour is getting a new racer and track. Fans of Super Mario Galaxy will be pleased to hear that Rosalina is the first post-launch character being added, while the iconic Rainbow Road is... | Read more »
$100,000 up for grabs at World of Tanks...
The fourth annual Blitz Twister Cup will be held in Minsk (Belarus) on November 9th. For those not in the know, the Blitz Twister Cup is an eSports championship for the hugely popular World of Tanks Blitz. [Read more] | Read more »
Brown Dust’s crossover event with That T...
Brown Dust, Neowiz’s epic fantasy RPG, is no stranger to special events, though its latest crossover might be its most exciting yet. On top of a challenging new dungeon, fan-favourite characters from the hit anime series That Time I Got... | Read more »
Call of Duty Mobile first impressions: A...
After many months of waiting, Tencent and Activision’s Call of Duty Mobile is finally out. The ambitious twitch shooter looks to bring the core COD experience to mobile with few concessions. Achieving such a goal is no small feat, even with all... | Read more »
The best iOS games to get you in the Hal...
We’re getting closer and closer to Halloween every day, which means everyone’s gearing up to watch their favorite horror movies, make weekend trips out to pumpkin patches, and do all kinds of other, fun seasonal stuff before this month ends and... | Read more »
Playond isn't a scam, it just has s...
Last week, I wrote about Playond, a service by Bending Spoons that has been acquiring the mobile publishing rights to premium games and re-releasing them behind a subscription paywall. Since writing the piece, I received quite a few replies about... | Read more »
Mario Kart Tour launches today for iOS a...
ID: 100374 The much-anticipated Mario Kart Tour is set to launch today on the App Store and Google Play. It’s the latest free-to-play mobile title from Nintendo, one which I hope doesn’t follow in the footsteps of the disappointingly desperate,... | Read more »

Price Scanner via MacPrices.net

13″ 1.6GHz/128GB MacBook Air on sale today fo...
Amazon has new 2019 13″ 1.6GHz/128GB Space Gray MacBook Airs on sale for $100 off Apple’s MSRP, only $999, including free shipping. Be sure to select Amazon as the seller during checkout, rather than... Read more
Trade in your iPhone 6 at Verizon and get $10...
Holding onto an older iPhone 6 or 6s and ready to upgrade to a new Apple iPhone 11? Verizon is offering Apple’s new iPhone 11 models for $300 off MSRP to new customers with an eligible trade-in (see... Read more
Weekend Sale: New 2019 13″ 2.4GHz 4-Core MacB...
Amazon has new 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros on sale this weekend for $200 off Apple’s MSRP, starting at $1599. These are the same MacBook Pros sold by Apple in its retail and online... Read more
Weekend Sale: 2019 15″ MacBook Pros for up to...
Amazon has new 2019 15″ 6-Core and 8-Core MacBook Pros on sale this weekend for up to $300 off Apple’s MSRP. Shipping is free. These are the same MacBook Pros sold by Apple in its retail and online... Read more
Columbus Day Sale: New 2019 10.2″ iPads for $...
Abt Electronics has new 2019 10.2″ WiFi iPads on sale for $14-$34 off Apple’s MSRP as part of their Columbus Day sale. Prices start at $315, and shipping is free: – 10.2″ 32GB WiFi iPad: $315 $14 off... Read more
Apple resellers have new 10.5″ iPad Airs in s...
Amazon has Apple’s new 10.5″ iPad Airs on sale today for up to $52 off MSRP with prices starting at $459. Shipping is free: – 10.5″ 64GB WiFi iPad Air: $459 $40 off MSRP – 10.5″ 256GB WiFi + Cellular... Read more
Save up to $420 on a 2019 15″ MacBook Pro wit...
Apple has a full line of 2019 15″ 6-Core and 8-Core Touch Bar MacBook Pros, Certified Refurbished, available for up to $420 off the cost of new models. Each model features a new outer case, shipping... Read more
Get an iPhone 8 for $100 off Apple’s MSRP tod...
Boost Mobile has Apple 2018 iPhone 8 models now available starting at only $349: – 32GB iPhone 8: $349.99 – 256GB iPhone 8: $499.99 – 32GB iPhone 8 Plus: $449.99 – 256GB iPhone 8 Plus: $599.99 Their... Read more
Apple iPhone 7 available starting at only $24...
Total Wireless has Apple 32GB iPhone 7 models available starting at $249. That’s $100 off the price other carriers are charging for this model and $150 less than the iPhone 7 models available in... Read more
Apple now offering a full line of refurbished...
Apple has a full line of Certified Refurbished 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros now available starting at $1099 and up to $230 off MSRP. Apple’s one-year warranty is included, shipping... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**734646BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 001220-Issaquah-Store **Job Description:** The Read more
*Apple* Mobile Master - Best Buy (United Sta...
**740646BR** **Job Title:** Apple Mobile Master **Job Category:** Store Associates **Location Number:** 001031-Boulder-Store **Job Description:** **What does a Best Read more
Geek Squad *Apple* Master Consultation Agen...
**739536BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000442-Bay Shore-Store Read more
Best Buy *Apple* Computing Master - Best Bu...
**726409BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 001124-Grand Junction-Store **Job Description:** **What does Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**727680BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Location Number:** 000245- Apple Valley-Store **Job Description:** At Best Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.