/*

File: MovieWritier.h

Author: QuickTime DTS

Change History (most recent first):

    <2> 09/19/06 modified for QTExtractAndConvertToMovie

    <1> 11/10/05 initial release as part of ExtractMovieAudioToAIFF

© Copyright 2005 - 2006 Apple Computer, Inc. All rights reserved.

IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc. ("Apple") in

consideration of your agreement to the following terms, and your use, installation,

modification or redistribution of this Apple software constitutes acceptance of these

terms.  If you do not agree with these terms, please do not use, install, modify or

redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and subject to these

terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in

this original Apple software (the "Apple Software"), to use, reproduce, modify and

redistribute the Apple Software, with or without modifications, in source and/or binary

forms; provided that if you redistribute the Apple Software in its entirety and without

modifications, you must retain this notice and the following text and disclaimers in all

such redistributions of the Apple Software. Neither the name, trademarks, service marks

or logos of Apple Computer, Inc. may be used to endorse or promote products derived from

the Apple Software without specific prior written permission from Apple.  Except as

expressly stated in this notice, no other rights or licenses, express or implied, are

granted by Apple herein, including but not limited to any patent rights that may be

infringed by your derivative works or by other works in which the Apple Software may be

incorporated.

The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO WARRANTIES,

EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF

NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE

APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE

USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER

CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT

LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#import <Cocoa/Cocoa.h>

#import <AudioToolbox/AudioToolbox.h>

#import <QTKit/QTKit.h>

#import <QuickTime/QuickTime.h>

#import "AudioConverter.h"

// maximum size in frames of the MovieAudioExtractionFillBuffer calls

#define kMaxExtractionFrameCount 4096

// this object is busy exporting error code

#define kObjectInUseErr 1000

// constants for shouldContinueOperation delegate method

typedef enum {

    MovieWriterExportBegin   = 0,

    MovieWriterExportPercent = 10,

    MovieWriterExportEnd     = 20

} MovieWriterExportOperationPhase;

// ProgressInfo object passed back to the delegate

// if it implements shouldContinueOperationWithProgressInfo:

// progressValue will contain a valid NSNumber object with a

// value between 0 and 1.0 when phase is MovieWriterExportPercent

@interface MovieWriterProgressInfo : NSObject

{

@private

    MovieWriterExportOperationPhase phase;  // one of the state enums

    NSNumber *progressValue;                // value is between 0 and 1.0 valid only for MovieWriterExportPercent phase

    NSError  *exportStatus;

    BOOL     continueOperation;

}

- (MovieWriterExportOperationPhase)phase;

- (NSNumber *)progressValue;

- (NSError *)exportStatus;

- (void)setContinueOperation:(BOOL)value;

@end

// invoked on a delegate to provide progress

@interface NSObject (MovieWriterExportDelegate)

- (BOOL)shouldContinueOperationWithProgressInfo:(id)inProgressInfo;

@end

// MovieWriter object

// A single instance of this object can be used to extract/covert audio

// from a QuickTime movie (via a QTKit Movie object) and will write a movie file

@interface MovieWriter : NSObject

{

@private

    NSString                        *mFileName;                     // file name for the new .aiff file

    FSRef                           mParentRef;                     // parent directory ref

    CFURLRef                        mOutputMovieFileURL;

    QTMovie                         *mQTMovie;                      // movie to extract audio from

    Float64                         mMovieDuration;                 // movie duration

    Movie                           mCloneMovie;                    // copy of the source movie for thread migration

    MovieAudioExtractionRef         mAudioExtractionSession;        // Movie audio extraction session ref

    AudioConverter                  *mMyAudioConverter;              // pointer to the obj-c audio converter wrapper class

    BOOL                            mExtractionComplete;            // set when audio extraction is done

    BOOL                            mConversionComplete;            // set during conversion

    BOOL                            mIsConverting;                  // is the object busy

    SInt64                          mLocationInFile;                // location to write new data

    SInt64                          mOutputFramesCompleted;         // hom much have we done - used to drive progress UI

    SInt64                          mTotalNumberOfOutputFrames;     // total amount to write

    SInt64                          mOneSegmentOfOutputFrames;      // amount of output in each write

    Movie                           mOutputMovie;

    DataHandler                     mOutputMovieStorageDH;

    Media                           mSoundMedia;

    SoundDescriptionHandle          mSoundDescription;

    char                            *mExtractionBuffer;             // buffer for extracted audio

    UInt32                          mExtractionBufferSize;

    AudioBufferList                 *mExtractionBuffList;

    char                            *mOutputBuffer;                 // buffer for conversion

    UInt32                          mOutputBufferSize;

    AudioBufferList                 *mOutputBufferList;

    UInt32                          mMaxPacketSize;

    AudioStreamPacketDescription    *mPacketDescriptions;           // required for externally framed formats

    NSLock                          *mLock;                         // lock protecting reentrance

    MovieWriterProgressInfo         *mProgressInfo;                 // progress info object passed to the progress callback

    id                              mDelegate;                      // a delegate object to call with progress info...

    BOOL                            mDelegateShouldContinueOp;      // ...but only if it actually implemented the callback

}

- (OSStatus)exportFromMovie:(QTMovie *)inMovie toFile:(NSString *)inFullPath;

- (BOOL)isConverting;

@end

// the client of MovieWriter should set itself as a delegate if it

// wants to handle shouldContinueOperationWithProgressInfo

@interface MovieWriter (MovieWriterDelegate)

- (id)delegate;

- (void)setDelegate:(id)delegate;

@end