DelegateOnlyImageCodec/DelegateOnly_CodecDispatch.h

/*
    File:        DelegateOnly_CodecDispatch.h
    
    Description: Dispatcher for the delegate component
 
    Author:     dts
 
    Copyright:  © Copyright 2003-2005 Apple Computer, Inc. All rights reserved.
    
    Disclaimer: 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.
                
    Change History (most recent first): 10/10/05 - Updated for QuickTime 7, Universal Biniaries
                                        2003     - initial release
*/
 
/*  A Quick Course in ComponentDispatchHelper.c
 
    ComponentRangeCount
    The number (0 based) of discrete, continuous ranges of selectors that are used in the macro.  The
    'range shift' & 'range mask' determine the size of the range.
 
    ComponentRangeShift
    ComponentRangeMask
    The mask == 2^shift -1.  This is used to define size of the range of selectors.
 
    For ImageCodecs as an example, the ranges are in size of 0x100:
    
       Range 0 = -0xFF to -0x01   Standard Component Calls
       Range 1 = 0x000 to 0x0FF    Generic codecs 
       Range 2 = 0x100 to 0x1FF    Specific to QT Photo JPEG codecs
       Range 3 = 0x200 to 0x2FF    Base Decompressor Client codecs
       Range 4 = 0x300 to 0x3FF    Effect codecs
      
    ComponentRangeBegin & ComponentRangeEnd
    Use these macros to bracket the start/stop of each range of selectors.  First range use (0), for the Nth
    range use (N-1).
 
    ComponentRangeUnused
    Used to skip a range of selectors.
 
    ComponentSelectorOffset
    Since the 'default' selectors are negative numbers, an offset must be specified.  For example, if the first
    default selector supported was kComponentUnregisterSelect (-7), then the offset would have to be 7.
 
    StdComponentCall
    Used to dispatch to one of the standard compoenent routines, such as Open(), Close(), Register(), etc. that
    are implemented in the component.
 
    ComponentError
    Returns an error without trying to do anything.  Use this for the selectors that will NEVER be implmented
    or delegated.  Additionally, it can be used to fill in a 'blank' in a range of selectors to get the range
    continuous. For example, if there were selectors that corresponded to 10,11,12, 14, but NO 13, merely put
    ComponentError (0) between the selectors for 12 & 14.
    
    ComponentNoError
    Returns 'noErr' without trying to do anything.
 
    ComponentDelegate
    Delagates the call to the specified delagate component.
 
    ComponentCall
    This dispatches to the appropriate routine in that is implemented in the component.
 
    ComponentComment
    Allows comments to be placed in the big macro.
*/
 
    ComponentSelectorOffset (-kQTRemoveComponentPropertyListenerSelect)
 
    ComponentRangeCount (3)
    ComponentRangeShift (8)
    ComponentRangeMask  (FF)
 
    ComponentRangeBegin (0)
        ComponentError   (RemoveComponentPropertyListener)
        ComponentError   (AddComponentPropertyListener)
        ComponentError   (SetComponentProperty)
        ComponentError   (GetComponentProperty)
        ComponentError   (GetComponentPropertyInfo)
 
        ComponentError   (GetPublicResource)
        ComponentError   (ExecuteWiredAction)
        ComponentError   (GetMPWorkFunction)
        ComponentError   (Unregister)
        ComponentError   (Target)
        ComponentError   (Register)
        
        StdComponentCall (Version)
        StdComponentCall (CanDo)
        StdComponentCall (Close)
        StdComponentCall (Open)
    ComponentRangeEnd (0)
        
    ComponentRangeBegin (1)
        ComponentDelegate (GetCodecInfo)
        ComponentDelegate (GetCompressionTime)
        ComponentDelegate (GetMaxCompressionSize)
        ComponentDelegate (PreCompress)
        ComponentDelegate (BandCompress)
        ComponentDelegate (PreDecompress)
        ComponentDelegate (BandDecompress)
        ComponentDelegate (Busy)
        ComponentDelegate (GetCompressedImageSize)
        ComponentDelegate (GetSimilarity)
        ComponentDelegate (TrimImage)
        ComponentDelegate (RequestSettings)
        ComponentDelegate (GetSettings)
        ComponentDelegate (SetSettings)
        ComponentDelegate (Flush)
        ComponentDelegate (SetTimeCode)
        ComponentDelegate (IsImageDescriptionEquivalent)
        ComponentDelegate (NewMemory)
        ComponentDelegate (DisposeMemory)
        ComponentDelegate (HitTestData)
        ComponentDelegate (NewImageBufferMemory)
        ComponentDelegate (ExtractAndCombineFields)
        ComponentDelegate (GetMaxCompressionSizeWithSources)
        ComponentDelegate (SetTimeBase)
        ComponentDelegate (SourceChanged)
        ComponentDelegate (FlushLastFrame)
        ComponentDelegate (GetSettingsAsText)
        ComponentDelegate (GetParameterListHandle)
        ComponentDelegate (GetParameterList)
        ComponentDelegate (CreateStandardParameterDialog)
        ComponentDelegate (IsStandardParameterDialogEvent)
        ComponentDelegate (DismissStandardParameterDialog)
        ComponentDelegate (StandardParameterDialogDoAction)
        ComponentDelegate (NewImageGWorld)
        ComponentDelegate (DisposeImageGWorld)
        ComponentDelegate (HitTestDataWithFlags)
        ComponentDelegate (ValidateParameters)
        ComponentDelegate (GetBaseMPWorkFunction)
        ComponentDelegate (0x0026)
        ComponentDelegate (0x0027)
        ComponentDelegate (RequestGammaLevel)
        ComponentDelegate (GetSourceDataGammaLevel)
        ComponentDelegate (0x002A)
        ComponentDelegate (GetDecompressLatency)
        ComponentDelegate (MergeFloatingImageOntoWindow)
        ComponentDelegate (RemoveFloatingImage)
        ComponentDelegate (GetDITLForSize)
        ComponentDelegate (DITLInstall)
        ComponentDelegate (DITLEvent)
        ComponentDelegate (DITLItem)
        ComponentDelegate (DITLRemove)
        ComponentDelegate (DITLValidateInput)
        ComponentDelegate (0x0034)
        ComponentDelegate (0x0035)
        ComponentDelegate (GetPreferredChunkSizeAndAlignment)
        ComponentDelegate (PrepareToCompressFrames)
        ComponentDelegate (EncodeFrame)
        ComponentDelegate (CompleteFrame)
        ComponentDelegate (BeginPass)
        ComponentDelegate (EndPass)
        ComponentDelegate (ProcessBetweenPasses)
    ComponentRangeEnd (1)
 
    ComponentRangeUnused (2)
 
    ComponentRangeBegin (3)
        ComponentDelegate (Preflight)
        ComponentDelegate (Initialize)
        ComponentDelegate (BeginBand)
        ComponentDelegate (DrawBand)
        ComponentDelegate (EndBand)
        ComponentDelegate (QueueStarting)
        ComponentDelegate (QueueStopping)
        ComponentDelegate (DroppingFrame)
        ComponentDelegate (ScheduleFrame)
        ComponentDelegate (CancelTrigger)
        ComponentDelegate (DecodeBand)
    ComponentRangeEnd (3)