AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_Errors.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2010-2017, 2020-2021 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
26 #ifndef AAX_ERRORS_H
27 #define AAX_ERRORS_H
29 
30 #include "AAX_Enums.h"
31 
38 {
40 
69  AAX_ERROR_PLUGIN_NOT_AUTHORIZED = -20029, //return this from EffectInit() if the plug-in doesn't have proper license.
92 
93 
95  AAX_ERROR_PLUGIN_END = -21000
97 
98 
99 
100 
101 
102 
103 
104 
105 
108 // AAE and other known AAX host error codes //
109 // Listed here as a reference //
112 
113 // FicErrors.h
114 /*
115 
116 //
117 // NOTE: (Undefined) comments for an error code mean that it's
118 // either no longer supported or returned from another source
119 // other than DAE.
120 //
121 
122 //----------------------------------------------------------------------------
123 // Error codes for all of Fic
124 //----------------------------------------------------------------------------
125 
126 enum {
127  kFicHostTimeoutErr = -9003, // Host Timeout Error. DSP is not responding.
128  kFicHostBusyErr = -9004, // (Undefined)
129  kFicLowMemoryErr = -9006, // DAE was unable to allocate memory. Memory is low.
130  kFicUnimplementedErr = -9007, // An unimplemented method was called.
131  kFicAllocatedErr = -9008, // (Undefined)
132  kFicNILObjectErr = -9013, // Standard error return when an object is NULL.
133  kFicNoDriverDSPErr = -9014, // Missing DSPPtr from the SADriver.
134  kFicBadIndexErr = -9015, // Index to an array or list is invalid.
135  kFicAlreadyDeferredErr = -9017, // Tried to install a deferred task when the task was already deferred.
136  kFicFileSystemBusyErr = -9019, // PB chain for an audio file returned an error for a disk task.
137  kFicRunningErr = -9020, // Tried to execute code when the deck was started.
138  kFicTooManyItemsErr = -9022, // Number of needed items goes beyond a lists max size.
139  kFicItemNotFoundErr = -9023, // Unable to find an object in a list of objects.
140  kFicWrongTypeErr = -9024, // Type value not found or not supported.
141  kFicNoDeckErr = -9025, // Standard error returned from other objects that require a deck object.
142  kFicNoDSPErr = -9028, // Required DSP object is NULL.
143  kFicNoFeederErr = -9029, // (Undefined)
144  kFicNoOwnerErr = -9030, // Play or record track not owned by a channel.
145  kFicPrimedErr = -9031, // Tried to execute code when the deck was primed.
146  kFicAlreadyAttached = -9032, // DAE object already attached to another DAE object.
147  kFicTooManyDSPTracksErr = -9033, // The user has run out of virtual tracks for a given card or dsp.
148  kFicParseErr = -9035, // While trying to parse a data structure ran into an error.
149  kFicNotAcquiredErr = -9041, // Tried to execute code when an object needs to be acquired first.
150  kFicNoSSIClockErr = -9045, // DSP does not recieve peripheral clock interrupts.
151  kFicNotFound = -9048, // Missing DAE resource or timeout occured while waiting for DAE to launch.
152  kFicCantRecordErr = -9050, // Error returned when CanRecord() returns false. Exp: Recording on scrub channel.
153  kFicWrongObjectErr = -9054, // Object size or pointers do not match.
154  kFicLowVersionErr = -9055, // Errors with version number too low.
155  kFicNotStartedErr = -9057, // Tried to execute code when the deck was not started yet.
156  kFicOnly1PunchInErr = -9059, // Error when deck can only support a single punch in.
157  kFicAssertErr = -9060, // Generic error when a format does not match.
158  kFicScrubOnlyErr = -9061, // Tried to scrub in a non-scrub mode or on a sys axe channel.
159  kFicNoSADriverErr = -9062, // InitSADriver failed. Possible missing DigiSystem INIT.
160  kFicCantFindDAEFolder = -9064, // Unable to find "DAE Folder" in the system folder.
161  kFicCantFindDAEApp = -9065, // Unable to find DAE app in the DAE Folder.
162  kFicNeeds32BitModeErr = -9066, // DAE runs only in 32 bit mode.
163  kFicHatesVirtualMemErr = -9068, // DAE will not run if virtual memory is turned on.
164  kFicSCIConnectErr = -9070, // Unable to get SCI ports between two dsp's to communicate.
165  kFicSADriverVersionErr = -9071, // Unable to get DigiSystem INIT version or it's version is too low.
166  kFicUserCancelledErr = -9072, // User chose to cancel or quit operation from DAE dialog.
167  kFicDiskTooSlowErr = -9073, // Disk action did not complete in time for next command.
168  kFicAudioTrackTooDense1 = -9074, // Audio playlist is too dense.
169  kFicAudioTrackTooDense2 = -9075, // Audio playlist is too dense for silience play list.
170  kFicCantDescribeZone = -9076, // Zone description is NULL.
171  kFicCantApplyPlayLimits = -9077, // Ran out of time regions for a zone.
172  kFicCantApplySkipMode = -9078, // Ran out of time regions for a zone in skip mode.
173  kFicCantApplyLoop = -9079, // Ran out of time regions for a zone in loop mode.
174  kFicAutoSortErr = -9084, // DSP event elements are not sorted in relation to time.
175  kFicNoAutoEvent = -9085, // No event list for an auto parser.
176  kFicAutoTrackTooDense1 = -9086, // Automation event scripts are too dense.
177  kFicAutoTrackTooDense2 = -9087, // Ran out of free events for the automation parser.
178  kFicNothingAllowedErr = -9088, // Missing allowed decks for the hw setup dialog.
179  kFicHardwareNotFreeErr = -9089, // Unable to select a deck because the hardware is allocated or not available.
180  kFicUnderrunErr9093 = -9093, // Under run error from the DSP.
181  kFicBadVRefNumErr = -9095, // Audio file is not on the propper disk SCSI chain.
182  kFicNoPeripheralSelected = -9096, // Deck can not be aquired without a peripheral being selected.
183  kFicLaunchMemoryErr = -9097, // Unable to launch DAE because of a memory error. DAE does NOT launch.
184  kFicGestaltBadSelector = -9099, // Gestalt selector not supported.
185  kDuplicateWriteFiles = -9118, // Writing to the same file multiple times during processing.
186  kFicCantGetTempBuffer = -9121, // Disk scheduler ran out of temporary buffers. Playlist is too complex.
187  kFicPendingRequestsFull = -9122, // (Undefined)
188  kFicRequestHandlesFull = -9123, // (Undefined)
189  kFicAnonymousDrive = -9124, // (Win32) Disk scheduler can't use a drive that doesn't have a drive signature.
190  kFicComputerNeedsRestart = -9127, // DAE state has changed such that the computer needs to restart
191  kFicCPUOverload = -9128, // Host processing has exceeded its CPU allocation.
192  kFicHostInterruptTooLong = -9129, // Host processing held off other system interrupts for too long.
193  kFicBounceHandlerTooSlow = -9132,
194  kFicBounceHandlerTooSlowToConvertWhileBouncing = -9133,
195  kFicMBoxLostConnection = -9134, // MBox was disconnected during playback
196  kFicMBoxNotConnected = -9135, // MBox is not connected
197  kFicUSBIsochronousUnderrun = -9136, // USB audio streaming underrun
198  kFicAlreadyAcquired = -9137, // tried to change coarse sample rate on already acquired deck
199  kFicTDM2BusTopologyErr = -9138, // eDsiTDM2BusTopologyErr was returned from DSI.
200  kFicDirectIODHSAlreadyOpen = -9142, // can't run if a DirectIO client is running DHS right now
201  kFicAcquiredButChangedBuffers = -9143, // DAE was able to acquire the device but had to change the disk buffers size to do it.
202  kFicStreamManagerUnderrun = -9144, // received error from StreamManager
203  kDirectMidiError = -9145, // an error occurred in the DirectMidi subsytem
204  kFicResourceForkNotFound = -9146, // Could not find the DAE resource fork (i.e. fnfErr)
205  kFicInputDelayNotSupported = -9147,
206  kFicInsufficientBounceStreams = -9148,
207  kFicAutoTotalTooDenseForDSP = -9155, // (Undefined)
208  kBadPlugInSpec = -9156, // Default error returned when there's no component object attatched to a spec.
209  kFicFarmRequiredErr = -9157, // Error returned by objects that require a DSP farm in the system.
210  kFicPlugInDidSetCursor = -9163, // When returned by FicPlugInEvent, the plug-in DID change the cursor.
211  kFicMaxFileCountReached = -9168, // Max number of files open has been reached
212  kFicCantIncreaseAIOLimits = -9169, // Can't increase the AIO kernel limits on OSX. DigiShoeTool is probably not installed correctly.
213  kFicGreenOverrunWhileVSOIsOn = -9170, // A PIO underrun/overrun occurred while varispeed is on; should probably warn the user this can happen.
214  kFicBerlinGreenStreamingError = -9171,
215  kFicHardwareDeadlineMissedErr = -9172,
216  kFicStatePacketUnderrun = -9173, // Low-latency engine ran out of state packets sent from high-latency engine
217  kFicCannotCompleteRequestError = -9174,
218  kFicNILParameterError = -9175, // Method called with one or more required parameters set to NULL
219  kFicMissingOrInvalidAllowedPlugInsListFile = -9176, // PT First-specific: could not parse the "Allowed" plug-ins file
220  kFicBufferNotLargeEnoughError = -9177, // Method called with a data buffer that is too small for the requested data
221  kFicInitializationFailed = -9178, // Error caught during FicInit
222  kFicPostPacketFailed = -9179, // Error triggered by AAXH_CPlugIn::PostPacket
223 
224 };
225 
226 // Weird errors preserved here for backwards compatibility (i.e., older DAE's returned these errors, so we should also):
227 
228 enum {
229  kFicBeyondPlayableRange = -9735 // Session playback passed the signed 32 bit sample number limit ( = kFicParseErr - 700).
230 };
231 
232 
233 //----------------------------------------------------------------------------
234 // Error codes returned from the SADriver/DigiSystem INIT via DAE
235 //----------------------------------------------------------------------------
236 
237 enum {
238  kFicSADriverErrOffset = -9200, // Offset only, should never be returned as a result.
239  kSADUnsupported = -9201, // Unsupported feature being set from a piece of hardware.
240  kSADNoStandardShell = -9202, // Unable to load standard shell code resource.
241  kSADTooManyPeripherals = -9203, // Went beyond the max number of peripherals allowed in the code.
242  kSADHostTimeoutErr = -9204, // Timeout occured while trying to communicate with the DSP's host port.
243  kSADInvalidValue = -9205, // Invalid value being set to a hardware feature.
244  kSADInvalidObject = -9206, // NULL object found when a valid object is required.
245 
246  kSADNILClient = -9210, // Trying to opperate on a NULL client.
247  kSADClientRegistered = -9211, // Client already registered.
248  kSADClientUnregistered = -9212, // Trying to remove a client when it's not registered.
249  kSADNoListener = -9213, // No client to respond to a message from another client.
250 
251  kSADCardOwned = -9220, // A card is owned by a client.
252  kSADDSPOwned = -9230, // A DSP is owned by a client.
253 
254  kSADNILShell = -9240, // Trying to opperate on a NULL shell.
255  kSADShellRegistered = -9241, // Shell already registered.
256  kSADShellUnregistered = -9242, // Trying to remove a shell when it's not registered.
257  kSADShellTooSmall = -9243, // (Undefined)
258  kSADShellTooLarge = -9244, // DSP code runs into standard shell or runs out of P memory.
259  kSADStandardShell = -9245, // Trying to unregister the standard shell.
260 
261  kSADNoDriverFile = -9250, // Unable to open or create the DigiSetup file.
262  kSADDriverFileUnused = -9251, // Trying to free the DigiSetup file when it hasn't been openned.
263  kSADNILResource = -9252, // Resource not found in the DigiSetup file.
264  kSADBadSize = -9253, // Resource size does not match pointer size requested.
265  kSADBadSlot = -9254, // NuBus slot value is out of range for the system.
266  kSADBadIndex = -9255 // DSP index is out of range for the system.
267 };
268 
269 
270 //----------------------------------------------------------------------------
271 // Error codes for Elastic audio
272 //----------------------------------------------------------------------------
273 enum {
274  kFicElasticGeneralErr = -9400, // don't know what else to do
275  kFicElasticUnsupported = -9401, // requested op unsupported
276  kFicElasticCPUOverload = -9403, // Like kFicCPUOverload but for Fela
277  kFicElasticOutOfMemory = -9404, // you're not going to last long...
278  kFicElasticTrackTooDense = -9405, // like kFicAudioTrackTooDense1; feeder list too big
279  kFicElasticInadequateBuffering = -9406, // reserved buffers for Fela data too small
280  kFicElasticConnectionErr = -9408, // Problem with a plugin connection
281  kFicElasticDriftBackwardsErr = -9411, // disconnect between DAE (app?) and plugin data consumption rates
282  kFicElasticDriftForwardsErr = -9412, // disconnect between DAE (app?) and plugin data consumption rates
283  kFicElasticPlugInLimitsErr = -9413, // problem with plugin drift/lookAhead; too much requested?
284  kFicElasticInvalidParameter = -9415, // Elastic function was passed a bad parameter
285  kFicElasticInvalidState = -9416, // Elastic track's internal state is in error.
286  kFicElasticPlugInConnected = -9417, // Can't change stem format once an elastic plugin is already connected to a track
287  kFicElasticEphemeralAllocErr = -9419, // ephemeral buffer alloc failure
288  kFicElasticDiskTooSlowErr = -9473, // Like -9073, but caught in a new way (Elastic needs disk data sooner)
289 };
290 
291 //----------------------------------------------------------------------------
292 // Error codes for Clip Gain RT Fades
293 //----------------------------------------------------------------------------
294 enum {
295  kFicClipGainRTFadesFadeOutofBounds = 9480,
296 };
297 
298 //----------------------------------------------------------------------------
299 // Error codes for Disk Cache
300 //----------------------------------------------------------------------------
301 enum {
302  kFicDiskCachePageOverflow = -9500, // not enough pages in the cache to fulfill page request.
303  kFicDiskCacheWriteErr = -9502, // problem writing to the disk cache.
304  kFicDiskCacheDiskWriteErr = -9503, // problem writing to disk from the cache.
305  kFicDiskCacheInvalidNull = -9504, // invalid NULL variable. NULL and 0 have special meaning in the cache.
306  kFicDiskCacheMissingDataErr = -9506, // data that's supposed to be in the cache is not.
307  kFicDiskCacheGeneralErr = -9507, // general error.
308  kFicDiskCacheDoubleLRUPageErr = -9508, // duplicate page in the LRU.
309  kFicDiskCacheDoubleOwnerPageErr = -9509, // two pages with the same owner.
310  kFicDiskCachePageLeakErr = -9510, // page leak in the allocator.
311  kFicDiskCacheMappingErr = -9511, // corruption in mapping of disk cache objects to the page allocator
312  kFicDiskCacheUnityFileErr = -9513, // Unity and ISIS are incompatible with the disk cache's temporary buffers
313  kFicDiskCacheOutOfMemory = -9514, // Couldn't allocate the disk cache! 32bits will suffocate us all.
314  kFicNativeDiskCacheOutOfMemory = -9515, // Couldn't allocate the disk cache on a Native system!
315 };
316 
317 //----------------------------------------------------------------------------
318 // Error codes for FPGA DMA Device(Green and Berlin cards)
319 //----------------------------------------------------------------------------
320 enum {
321  kFicFpgaDmaDevicePIOOverflow = -9600, // PIO ring buffer overflowed
322  kFicFpgaDmaDevicePIOUnderflow = -9601, // PIO ring buffer underflow
323  kFicFpgaDmaDevicePIOSyncErr = -9602, // PIO sync error
324  kFicFpgaDmaDevicePIOClockChange = -9603, // PIO clock change error
325  kFicFpgaDmaDevicePIOUnknownErr = -9604, // PIO unknown error
326  kFicFpgaDmaDeviceTDMRcvOverflow = -9605, // TDM receive overflow
327  kFicFpgaDmaDeviceTDMXmtUnderflow = -9606, // TDM transmit underflow
328  kFicFpgaDmaDeviceTDMSyncErr = -9607, // TDM sync error
329  kFicFpgaDmaDeviceTDMCRCErr = -9608, // TDM CRC error
330  kFicFpgaDmaDeviceTDM_NO_Xbar_Txdata_error = -9609, // TDM NO_Xbar_Txdata_error
331  kFicFpgaDmaDeviceTDMUnknownErr = -9610, // TDM unknown error
332  kFicFpgaDmaDeviceRegRdTimeoutErr = -9611, // RegRdTimeoutErr
333  kFicFpgaDmaDeviceTemperatureErr = -9612, // Temperature error
334 };
335 
336 //----------------------------------------------------------------------------
337 // Various Widget Error Codes
338 //----------------------------------------------------------------------------
339 
340 enum {
341 
342  // External Callback Proc Errors -7000..-7024
343  kSelectorNotSupported = -7000, // This selector ID is unknown currently.
344  kWidgetNotFound = -7001, // Refnum did not specify a known widget.
345 
346  // Plug-In Manager Errors -7025..-7049
347  kPlugInNotInstantiated = -7026, // A non-instantiated plug-in was asked to do something.
348  kNilComponentObject = -7027, // A component-referencing object was NIL.
349  kWidgetNotOpen = -7028, // A non-instantiated widget was asked to do something.
350  //TIMILEONE ADD
351  kDspMgrError = -7030, // An error originating in DspMgr returned
352  kEffectInstantiateError = -7032, // Problem occurred attempting to instantiate a plug-in.
353 
354  // Plug-In Manager Errors -7050..-7075
355  kNotEnoughHardware = -7050, // Not enough hardware available to instantiate a plug-in.
356  kNotEnoughTDMSlots = -7052, // Not enough TDM slots available to instantiate a plug-in.
357  kCantInstantiatePlugIn = -7054, // Unable to instantiate a plug-in (generic error).
358  kCantFindPlugIn = -7055, // Unable to find the specified plug-in.
359  kNoPlugInsExist = -7056, // No plug-ins at all exist.
360  kPlugInUnauthorized = -7058, // To catch uncopyprotected plugins
361  kInvalidHostSignalNet = -7062, // The signalNet ptr does not correspond to a CHostSignalNet instance
362  // The RTAS/TDM plug-in would be disabled because the corresponding AAX plug-in exists.
363  //
364  // The following lower-level errors can also be converted to kPlugInDisabled:
365  // kAAXH_Result_FailedToRegisterEffectPackageWrongArchitecture
366  // kAAXH_Result_PluginBuiltAgainstIncompatibleSDKVersion
367  kPlugInDisabled = -7063,
368  kPlugInNotAllowed = -7064, // The plug-in not allowed to load
369 
370  // Widget errors (returned by calls to widget functions): -7075..-7099.
371  kWidgetUnsupportedSampleRate = -7081, // Widget cannot instantiate at the current sample rate
372 
373  // Connection errors: -7100..-7124
374  kInputPortInUse = -7100, // Tried to connect to an input that is already connected.
375  kOutputPortCannotConnect = -7101, // Specified output port has reached its limit of output connections.
376  kInvalidConnection = -7103, // Invalid or freed connection reference passed.
377  kBadConnectionInfo = -7104, // TDM talker & listener data not consistent on disconnect.
378  kFreeConnectionErr = -7105, // Could not delete connection info.
379  kInvalidPortNum = -7106, // Out-of-range or nonexistent port number specified.
380  kPortIsDisconnected = -7107, // Tried to disconnect a disconnected port.
381 
382  kBadStemFormat = -7110,
383  kBadInputStemFormat = -7111,
384  kBadOutputStemFormat = -7112,
385  kBadSideChainStemFormat = -7113,
386  kBadGenericStemFormat = -7114,
387  kBadUnknownStemFormat = -7115,
388 
389  kNoFirstRTASDuringPlayback = -7117, // can't instantiate the first RTAS plug-in on the fly (TDM decks)
390  kNoBridgeConnectionDuringPlayback = -7118, // can't create or free a bridge connection during playback
391 
392  // Subwidget errs: -7125..-7149
393  kInstanceIndexRangeErr = -7126, // Specified instance index doesn't correspond with an instance.
394  kEmptySubWidgetList = -7129, // List isn't NULL, but has no elements.
395 
396  // Instance errs: -7150..-7174
397  kNumInstancesWentNegative = -7150, // Somehow a count of instances (in widget or DSP) went < 0.
398  kCantChangeNumInputs = -7152, // Plugin does not have variable number of inputs.
399  kCantChangeNumOutputs = -7153, // Plugin does not have variable number of outputs.
400  kSetNumInputsOutOfRange = -7154, // Number of inputs being set is out of range.
401  kSetNumOutputsOutOfRange = -7155, // Number of outputs being set is out of range.
402  kChunkRangeErr = -7157, // Handle of plugin settings will not work on a plugin.
403 
404  // driver call errs: -7200..-7249
405  kBadDriverRefNum = -7200, // Plugin does not have a valid driver object.
406  kBadHardwareRefNum = -7201, // Plugin does not have a valid pointer to a hardware object. DSPPtr = NULL.
407  kBadWidgetRef = -7202, // Widget object is NULL.
408  kLoggedExceptionInConnMgr = -7224, // Logged exception caught in Connection Manager
409  kUnknownExceptionInConnMgr = -7225, // Unknown exception caught in Connection Manager
410 
411  // Widget control errors: -7300..-7324
412  kControlIndexRangeErr = -7300, // Passed control index was out of range (couldn't find control).
413  kNotOurControl = -7301, // Passed in control that didn't belong to widget.
414  kNullControl = -7302, // Passed in control ref was NULL.
415  kControlNumStepsErr = -7303, // Control provided an invalid number of steps
416 
417  // Builtin plugin errors: -7350..-7374
418  kUnsupportedBuiltinPlugin = -7350, // Invalid built-in plugin spec.
419  kAssertErr = -7400,
420 
421  // ASP Processing errors: - 7450..-7499
422  kFicProcessStuckInLoop = -7450, // Plugin is stuck in a loop for an process pass.
423  kFicOutputBoundsNotInited = -7452, // Plugin needs to set output connections to valid range within InitOutputBounds.
424  kFicConnectionBufferOverwrite = -7453, // Plugin overwrote the end of the connection buffer.
425  kFicNoASPBounds = -7454, // Start and end bounds for an ASP process or analysis were equal.
426  kFicASPDoneProcessing = -7456, // The ASP terminated processing with no errors.
427  kFicASPErrorWritingToDisk = -7457, // ASP encountered error while writing audio data to disk.
428  kFicASPOutputFileTooLarge = -7458, // ASP tried to write a file larger than the 2^31 bytes in size.
429  kFicASPOverwriteOnUnity = -7459, // ASP tried to write destructively to Unity
430 
431  // Errors called from Failure Handler routines.
432  kUnknownErr = -7401 // Plugin caught an unknown exception
433 };
434 
435 //----------------------------------------------------------------------------
436 // Digi Serial Port Errors
437 //----------------------------------------------------------------------------
438 
439 enum {
440  kFicSerBadParameterPointer = -7500,
441  kFicSerBadRoutineSelector = -7501,
442  kFicSerPortDoesNotExist = -7502,
443  kFicSerPortAlreadyInUse = -7503,
444  kFicSerPortNotOpen = -7504,
445  kFicSerBadPortRefereceNumber = -7505
446 };
447 
448 // Play nice with emacs
449 // Local variables:
450 // mode:c++
451 // End:
452 
453 */
454 
455 
456 // AAXH.h
457 /*
458 enum
459 {
460  kAAXH_Result_NoErr = 0,
461  kAAXH_Result_Error_Base = -14000, // ePSError_Base_AAXHost
462  // kAAXH_Result_Error = kAAXH_Result_Error_Base - 0,
463  kAAXH_Result_Warning = kAAXH_Result_Error_Base - 1,
464  kAAXH_Result_UnsupportedPlatform = kAAXH_Result_Error_Base - 3,
465  kAAXH_Result_EffectNotRegistered = kAAXH_Result_Error_Base - 4,
466  kAAXH_Result_IncompleteInstantiationRequest = kAAXH_Result_Error_Base - 5,
467  kAAXH_Result_NoShellMgrLoaded = kAAXH_Result_Error_Base - 6,
468  kAAXH_Result_UnknownExceptionLoadingTIPlugIn = kAAXH_Result_Error_Base - 7,
469  kAAXH_Result_EffectComponentsMissing = kAAXH_Result_Error_Base - 8,
470  kAAXH_Result_BadLegacyPlugInIDIndex = kAAXH_Result_Error_Base - 9,
471  kAAXH_Result_EffectFactoryInitedTooManyTimes = kAAXH_Result_Error_Base - 10,
472  kAAXH_Result_InstanceNotFoundWhenDeinstantiating = kAAXH_Result_Error_Base - 11,
473  kAAXH_Result_FailedToRegisterEffectPackage = kAAXH_Result_Error_Base - 12,
474  kAAXH_Result_PlugInSignatureNotValid = kAAXH_Result_Error_Base - 13,
475  kAAXH_Result_ExceptionDuringInstantiation = kAAXH_Result_Error_Base - 14,
476  kAAXH_Result_ShuffleCancelled = kAAXH_Result_Error_Base - 15,
477  kAAXH_Result_NoPacketTargetRegistered = kAAXH_Result_Error_Base - 16,
478  kAAXH_Result_ExceptionReconnectingAfterShuffle = kAAXH_Result_Error_Base - 17,
479  kAAXH_Result_EffectModuleCreationFailed = kAAXH_Result_Error_Base - 18,
480  kAAXH_Result_AccessingUninitializedComponent = kAAXH_Result_Error_Base - 19,
481  kAAXH_Result_TIComponentInstantiationPostponed = kAAXH_Result_Error_Base - 20,
482  kAAXH_Result_FailedToRegisterEffectPackageNotAuthorized = kAAXH_Result_Error_Base - 21,
483  kAAXH_Result_FailedToRegisterEffectPackageWrongArchitecture = kAAXH_Result_Error_Base - 22,
484  kAAXH_Result_PluginBuiltAgainstIncompatibleSDKVersion = kAAXH_Result_Error_Base - 23,
485  kAAXH_Result_RequiredProperyMissing = kAAXH_Result_Error_Base - 24,
486  kAAXH_Result_ObjectCopyFailed = kAAXH_Result_Error_Base - 25,
487  kAAXH_Result_CouldNotGetPlugInBundleLoc = kAAXH_Result_Error_Base - 26,
488  kAAXH_Result_CouldNotFindExecutableInBundle = kAAXH_Result_Error_Base - 27,
489  kAAXH_Result_CouldNotGetExecutableLoc = kAAXH_Result_Error_Base - 28,
490 
491  kAAXH_Result_InvalidArgumentValue = kAAXH_Result_Error_Base - 100, // WARNING: Overlaps with eTISysErrorBase
492  kAAXH_Result_NameNotFoundInPageTable = kAAXH_Result_Error_Base - 101 // WARNING: Overlaps with eTISysErrorNotImpl
493 };
494 
495 */
496 
497 
498 // PlatformSupport_Error.h
499 /*
500 enum
501 {
502  ePSError_None = 0,
503  ePSError_Base_DSI = -1000, // DaeStatus.h
504  ePSError_Base_DirectIO = -6000, // DirectIODefs.h
505  ePSError_Base_DirectMIDI = -6500, // DirectIODefs.h
506 
507  ePSError_Base_DAE_Plugins = -7000, // FicErrors.h
508  ePSError_Base_DAE_Disk = -8000, // FicErrors.h
509  ePSError_Base_DAE_General = -9000, // FicErrors.h
510  ePSError_Base_DAE_DCM = -11000, // FicErrors.h
511  ePSError_General_PLEASESTOPUSINGTHIS = -12000,
512  ePSError_Generic_PLEASESTOPUSINGTHIS = -12001,
513  ePSError_OutOfMemory = -12002,
514  ePSError_OutOfHardwareMemory = -12003,
515  ePSError_FixedListTooSmall = -12004,
516  ePSError_FileNotFound = -12005,
517  ePSError_Timeout = -12006,
518  ePSError_FileReadError = -12007,
519  ePSError_InvalidArgs = -12008,
520 
521  ePSError_DEXBase_Interrupts = -12100,
522  ePSError_DEXBase_PCI = -12200,
523  ePSError_DEXBase_Task = -12300,
524  ePSError_DEXBase_Console = -12400,
525  ePSError_Base_PalmerEngine = -12500,
526  ePSError_Base_IP = -12600,
527  ePSError_Base_DEXLoader = -12700,
528  ePSError_Base_DEXDebugger = -12800,
529  ePSError_Base_DEXDLLLoader = -12900,
530  ePSError_Base_Thread = -13000,
531  ePSError_Base_Hardware = -13100,
532  ePSError_Base_TMS = -13400, // TMSErrors.h
533  ePSError_Base_Harpo = -13500, // Dhm_HarpoInterface.h
534  ePSError_Base_FlashProgram = -13600, // Hampton_HostFPGAProgramming.h
535  ePSError_Base_Balance = -13700, // Dhm_Balance.h
536  ePSError_Base_CTIDSP = -13800, // Dhm_Core_TIDSP.h
537  ePSError_Base_ONFPGASerial = -13900, // Dhm_COnFPGASerialController.h
538  ePSError_Base_AAXHost = -14000, // AAXH.h
539  ePSError_Base_TISys = -14100, // TISysError.h
540  ePSError_Base_DIDL = -14200, // DIDL.h
541  ePSError_Base_TIDSPMgr = -14300, // TIDspMgrAllocationReturnCodes.h
542  ePSError_Base_Berlin = -14400, // Dhm_Berlin.h
543  ePSError_Base_Isoch = -14500, // Dhm_IsochEngine.h
544  ePSError_SuppHW_NotSupported = -14600, // Dhm_SuppHW.h
545 
546  // Add new ranges here...
547 
548  ePSError_Base_AAXPlugIns = -20000, // AAX_Errors.h
549 
550  ePSError_Base_DynamicErrors = -30000, // Dynamically Generated error tokens
551 
552 
553 
554  ePSError_Base_GenericErrorTranslations = -21000, // these errors used to be ePSError_Generic_PLEASESTOPUSINGTHIS - splitting into unique error codes
555  // putting this out in space in case anyone's using other numbers on another branch
556  ePSError_CEthDCMDeviceInterface_CreatePort_UncaughtException = -21001,
557  ePSError_CEthDCMDeviceInterface_DestroyPort_UncaughtException = -21002,
558  ePSError_CEEPro1000Imp_InitializeAndAllocateBuffers_NullE1000State = -21003,
559  ePSError_CIODeviceOverviewsManager_OvwDataThreadNull = -21004,
560  ePSError_CIODeviceOverviewsManager_ThreadAlreadyRunning = -21005,
561  ePSError_CPalmerEngineKernelImp_CreateIsochronousStream_PalmerEngineIsCurrentlyShuttingDown = -21006,
562  ePSError_CPalmerEngineKernelImp_SetStreamEnabledState_PalmerEngineIsCurrentlyShuttingDown = -21007,
563  ePSError_CPalmerEngineImplementation_StartOperating_DidNotFindPartnerInTime = -21008,
564  ePSError_CPalmerEngineImplementation_TransmitAsyncMessage_PalmerEngineIsCurrentlyShuttingDown = -21009,
565  ePSError_CPalmerEngineImplementation_TransmitAsyncMessageAndWaitForReply_PalmerEngineIsCurrentlyShuttingDown = -21010,
566  ePSError_CPalmerEngineImplementation_TransmitAsyncMessageAndWaitForReply_PalmerEngineIsShuttingDownAfterReply = -21011,
567  ePSError_CPalmerEngineImplementation_TransmitGeneralAsyncPacket_PalmerEngineIsShuttingDown = -21012,
568  ePSError_CEthernetDeviceSimpleImp_InitializeAndAllocateBuffers_FailedToGetBufferInfo = -21013,
569  ePSError_CPEInterface_Imp_GetFeatureSetList_FailedWinGetResourceOfModuleByName = -21014,
570  ePSError_CPEInterface_Imp_GetFourPartVersion_FailedWinGetVersionOfModuleByName = -21015,
571  ePSError_CHamptonHostDEXLifeLine_Common_TransmitMessageAndGetReply_TransmitAndWaitForReplyFailed = -21016,
572  ePSError_CHamptonHostDEXLifeLine_Common_TransmitMessageAndGetReply_ConnectionClosedOrNotEstablished = -21017,
573  ePSError_CHamptonHostDEXLifeLine_Common_TransmitMessageAndGetReply_GotUnexpectedReply = -21018,
574  ePSError_PerformLoadNotSupportedOnMac = -21019,
575  ePSError_PerformLoad_FailedGetUnusedUDPPort = -21020,
576  ePSError_PerformLoad_FailedCreateLocalUDPEndPoint = -21021,
577  ePSError_PerformLoad_FailedCreateRemoteUDPEndPoint = -21022,
578  ePSError_PerformLoad_FailedToGetPacketFromEndpoint = -21023,
579  ePSError_PerformLoad_FirstPacketContainsUnexpectedData = -21024,
580  ePSError_PerformLoad_SecondPacketContainsUnexpectedData = -21025,
581  ePSError_PerformLoad_FailedToGetCorrectPacketFromEndpoint = -21026,
582  ePSError_HamptonDEXLoader_LoadOverUDP_UpdateImageBootInterfaceHeaderFailed = -21027,
583  ePSError_HamptonDEXLoader_ResetOverUDP_FailedGetUnusedUDPPort = -21028,
584  ePSError_HamptonDEXLoader_ResetOverUDP_FailedCreateLocalUDPEndPoint = -21029,
585  ePSError_CTask_Imp_SetSchedulingParameters_FailedThreadSpecificDataInit = -21030,
586  ePSError_CTask_Imp_SetSchedulingParameters_FailedToSetFirstThreadPriority = -21031,
587  ePSError_CTask_Imp_SetSchedulingParameters_FailedToSetSecondThreadPriority = -21032,
588  ePSError_CTask_Imp_SetSchedulingParameters_FailedToVerifyNewPolicy = -21033,
589  ePSError_CTask_Imp_SetSchedulingParameters_FailedToSetTimeshareToFalse = -21034,
590  ePSError_CTask_Imp_SetSchedulingParameters_FailedToGetThreadPolicy = -21035,
591  ePSError_CTask_Imp_SetSchedulingParameters_FailedToSetThirdThreadPriority = -21036,
592  ePSError_CTask_Imp_SetSchedulingParameters_FailedToGetThreadPolicyAgain = -21037,
593  ePSError_CModule_Hardware_Imp_GetHardwareMemoryAvailable_WinError = -21038,
594  ePSError_CModule_Hardware_Imp_SetHardwareMemoryRequired_WinError = -21039,
595  ePSError_Win_CModule_Hardware_Imp_MapAndGetDALDevices_MapIOCTLFailed = -21040,
596  ePSError_CModule_Hardware_Imp_ThreadMethod_CreateDALHandleFailed = -21041,
597  ePSError_CSyncPrim_Semaphore_Imp_CSyncPrim_Semaphore_Imp_CreateSemaphoreFailed = -21042,
598  ePSError_CSyncPrim_Event_Imp_CSyncPrim_Event_Imp_CreateEventFailed = -21043,
599  ePSError_CTask_Imp_SetSchedulingParameters_gSetInfoThreadProcNotSet = -21044,
600  ePSError_CTask_Imp_SetSchedulingParameters_SetThreadPriorityFailed = -21045,
601  ePSError_CTask_Imp_SetProcessorAffinityMask_SetThreadAffinityMaskFailed = -21046,
602  ePSError_PSThreadTable_VerifyTableEntryExists_NotFound = -21047,
603  ePSError_PSM_SimpleThread_ThreadMethod_RunThrewException = -21048,
604  ePSError_Hampton_DEXImage_MakeROM_BadFilename = -21049,
605  ePSError_MakeDllIntoHex_BadFilename = -21050,
606  ePSError_MakeDllIntoHex_BadPayloadObject = -21051,
607  ePSError_MakeDllIntoHex_FailedCreatePEInterface = -21052,
608  ePSError_MakeDllIntoHex_FailedResolvedAllSymbols = -21053,
609  ePSError_MakeDllIntoHexWithStdCLib_BadFilename = -21054,
610  ePSError_MakeDllIntoHexWithStdCLib_NULLDEXImages = -21055,
611  ePSError_CDEXWin32Kernel_ExceptionsModule_Initialize_FailedToCreateTLSContext = -21056,
612  ePSError_CDEXIP_ARP_Imp_GetMACForGivenIP_IPAddressMaskBad = -21057,
613  ePSError_CDEXIP_ARP_Imp_GetMACForGivenIP_IPAddressInvalid = -21058,
614  ePSError_DEXIntegrityCheck_VerifySection_FailureCheckingSectionCookies = -21059,
615  ePSError_DEXIntegrityCheck_VerifySection_FailureCheckingSectionBufferCookie = -21060,
616  ePSError_DEXIntegrityCheck_VerifyTextSection_FailedChecksum = -21061,
617  ePSError_Mac_CModule_Hardware_Imp_MapAndGetDALDevices_MapIOCTLFailed = -21062,
618  ePSError_CModule_Hardware_Imp_ThreadMethod_mach_port_allocate_failed = -21063,
619  ePSError_DEXTool_main_ExceptionThrown = -21064,
620  ePSError_Hampton_DEXImage_MakeHexIntoBin_HEXFileNameVersion_StandardExceptionThrown = -21065,
621  ePSError_Hampton_DEXImage_MakeHexIntoBin_HEXFileNameVersion_UnknownExceptionThrown = -21066,
622  ePSError_Hampton_DEXImage_MakeHexIntoBin_HEXDataVersion_StandardExceptionThrown = -21067,
623  ePSError_Hampton_DEXImage_MakeHexIntoBin_HEXDataVersion_UnknownExceptionThrown = -21068
624 };
625 */
626 
627 // TISysError.h
628 /*
633 enum
634 {
635  eTISysErrorSuccess = 0, ///< success code
636  eTISysErrorBase = ePSError_Base_TISys, ///< -14100 see PlatformSupport_Error.h
637  eTISysErrorNotImpl = eTISysErrorBase - 1, ///< not implemented
638  eTISysErrorMemory = eTISysErrorBase - 2, ///< out of memory
639  eTISysErrorParam = eTISysErrorBase - 3, ///< invalid parameter
640  eTISysErrorNull = eTISysErrorBase - 4, ///< NULL value
641  eTISysErrorCommunication = eTISysErrorBase - 5, ///< Communication problem with Shell
642  eTISysErrorIllegalAccess = eTISysErrorBase - 6,
643  eTISysErrorDirectAccessOfFifoBlocksUnsupported = eTISysErrorBase - 7,
644  eTISysErrorPortIdOutOfBounds = eTISysErrorBase - 8,
645  eTISysErrorPortTypeDoesNotSupportDirectAccess = eTISysErrorBase - 9,
646  eTISysErrorFIFOFull = eTISysErrorBase - 10, ///< FIFO doesn't have capacity
647  eTISysErrorRPCTimeOutOnDSP = eTISysErrorBase - 11,
648  eTISysErrorShellMgrChip_SegsDontMatchAddrs = eTISysErrorBase - 12,
649  eTISysErrorOnChipRPCNotRegistered = eTISysErrorBase - 13,
650  eTISysErrorUnexpectedBufferLength = eTISysErrorBase - 14,
651  eTISysErrorUnexpectedEntryPointName = eTISysErrorBase - 15,
652  eTISysErrorPortIDTooLargeForContextBlock = eTISysErrorBase - 16,
653  eTISysErrorMixerDelayNotSupportedForPlugIns = eTISysErrorBase - 17,
654  eTISysErrorShellFailedToStartUp = eTISysErrorBase - 18,
655  eTISysErrorUnexpectedCondition = eTISysErrorBase - 19,
656  eTISysErrorShellNotRunningWhenExpected = eTISysErrorBase - 20,
657  eTISysErrorFailedToCreateNewPIInstance = eTISysErrorBase - 21,
658  eTISysErrorUnknownPIInstance = eTISysErrorBase - 22,
659  eTISysErrorTooManyInstancesForSingleBufferProcessing = eTISysErrorBase - 23,
660  eTISysErrorNoDSPs = eTISysErrorBase - 24,
661  eTISysBadDSPID = eTISysErrorBase - 25,
662  eTISysBadPIContextWriteBlockSize = eTISysErrorBase - 26,
663  eTISysInstanceInitFailed = eTISysErrorBase - 28,
664  eTISysSameModuleLoadedTwiceOnSameChip = eTISysErrorBase - 29,
665  eTISysCouldNotOpenPlugInModule = eTISysErrorBase - 30,
666  eTISysPlugInModuleMissingDependcies = eTISysErrorBase - 31,
667  eTISysPlugInModuleLoadableSegmentCountMismatch = eTISysErrorBase - 32,
668  eTISysPlugInModuleLoadFailure = eTISysErrorBase - 33,
669  eTISysOutOfOnChipDebuggingSpace = eTISysErrorBase - 34,
670  eTISysMissingAlgEntryPoint = eTISysErrorBase - 35,
671  eTISysInvalidRunningStatus = eTISysErrorBase - 36,
672  eTISysExceptionRunningInstantiation = eTISysErrorBase - 37,
673  eTISysTIShellBinaryNotFound = eTISysErrorBase - 38,
674  eTISysTimeoutWaitingForTIShell = eTISysErrorBase - 39,
675  eTISysSwapScriptTimeout = eTISysErrorBase - 40,
676  eTISysTIDSPModuleNotFound = eTISysErrorBase - 41,
677  eTISysTIDSPReadError = eTISysErrorBase - 42,
678 
679 };
680 
681 */
682 
684 #endif // AAX_ERRORS_H
Utility functions for byte-swapping. Used by AAX_CChunkDataParser.
AAX_EError
Definition: AAX_Errors.h:38
@ AAX_RESULT_NEW_PACKET_POSTED
Definition: AAX_Errors.h:68
@ AAX_ERROR_CONTEXT_ALREADY_HAS_METERS
Definition: AAX_Errors.h:54
@ AAX_ERROR_INVALID_PARAMETER_ID
Definition: AAX_Errors.h:41
@ AAX_ERROR_NOTIFICATION_FAILED
Definition: AAX_Errors.h:71
@ AAX_ERROR_UNSUPPORTED_ENCODING
Unsupported input argument text encoding.
Definition: AAX_Errors.h:87
@ AAX_ERROR_PORT_ID_OUT_OF_RANGE
Definition: AAX_Errors.h:56
@ AAX_ERROR_INVALID_CHUNK_ID
Definition: AAX_Errors.h:47
@ AAX_ERROR_PLUGIN_END
Custom plug-in error codes may be placed in the range ( AAX_ERROR_PLUGIN_END, AAX_ERROR_PLUGIN_BEGIN ...
Definition: AAX_Errors.h:95
@ AAX_RESULT_ADD_FIELD_UNSUPPORTED_FIELD_TYPE
Definition: AAX_Errors.h:63
@ AAX_ERROR_UNIMPLEMENTED
Definition: AAX_Errors.h:49
@ AAX_ERROR_PLUGIN_NULL_PARAMETER
Definition: AAX_Errors.h:70
@ AAX_RESULT_PACKET_STREAM_NOT_EMPTY
Definition: AAX_Errors.h:62
@ AAX_ERROR_UNKNOWN_EXCEPTION
An AAX plug-in should return this to the host if an unknown exception is caught. Exceptions should ne...
Definition: AAX_Errors.h:82
@ AAX_ERROR_MALFORMED_CHUNK
Definition: AAX_Errors.h:66
@ AAX_ERROR_EMPTY_EFFECT_NAME
Definition: AAX_Errors.h:77
@ AAX_ERROR_MIXER_THREAD_FALLING_BEHIND
Definition: AAX_Errors.h:64
@ AAX_ERROR_DIRECT_ACCESS_OUT_OF_BOUNDS
Definition: AAX_Errors.h:58
@ AAX_ERROR_INVALID_PATH
Definition: AAX_Errors.h:80
@ AAX_ERROR_SIGNED_INT_OVERFLOW
Definition: AAX_Errors.h:73
@ AAX_ERROR_FIFO_FULL
Definition: AAX_Errors.h:59
@ AAX_ERROR_NULL_OBJECT
Definition: AAX_Errors.h:44
@ AAX_ERROR_NULL_COMPONENT
Definition: AAX_Errors.h:55
@ AAX_ERROR_PRINT_FAILURE
A failure occurred in a "print" library call such as printf.
Definition: AAX_Errors.h:91
@ AAX_ERROR_PLUGIN_BEGIN
Custom plug-in error codes may be placed in the range ( AAX_ERROR_PLUGIN_END, AAX_ERROR_PLUGIN_BEGIN ...
Definition: AAX_Errors.h:94
@ AAX_ERROR_INVALID_ARGUMENT
One or more input parameters are invalid; all output parameters are left unchanged.
Definition: AAX_Errors.h:83
@ AAX_ERROR_INVALID_METER_INDEX
Definition: AAX_Errors.h:43
@ AAX_ERROR_UNEXPECTED_EFFECT_ID
Encountered an effect ID with a different value from what was expected.
Definition: AAX_Errors.h:88
@ AAX_ERROR_PLUGIN_NOT_AUTHORIZED
Definition: AAX_Errors.h:69
@ AAX_ERROR_UNKNOWN_PLUGIN
Definition: AAX_Errors.h:78
@ AAX_ERROR_INVALID_STRING_CONVERSION
Definition: AAX_Errors.h:42
@ AAX_ERROR_ACF_ERROR
Definition: AAX_Errors.h:52
@ AAX_ERROR_OLDER_VERSION
Definition: AAX_Errors.h:45
@ AAX_ERROR_ARGUMENT_OUT_OF_RANGE
One or more input parameters are out of the expected range, e.g. an index argument that is negative o...
Definition: AAX_Errors.h:90
@ AAX_ERROR_INVALID_FIELD_INDEX
Definition: AAX_Errors.h:65
@ AAX_ERROR_NO_COMPONENTS
Definition: AAX_Errors.h:74
@ AAX_ERROR_POST_PACKET_FAILED
Definition: AAX_Errors.h:61
@ AAX_ERROR_INCORRECT_CHUNK_SIZE
Definition: AAX_Errors.h:48
@ AAX_ERROR_FIELD_TYPE_DOES_NOT_SUPPORT_DIRECT_ACCESS
Definition: AAX_Errors.h:57
@ AAX_ERROR_NULL_ARGUMENT
One or more required pointer arguments are null.
Definition: AAX_Errors.h:84
@ AAX_ERROR_PROPERTY_UNDEFINED
Definition: AAX_Errors.h:79
@ AAX_ERROR_DUPLICATE_TYPE_ID
Definition: AAX_Errors.h:76
@ AAX_ERROR_NO_ABBREVIATED_PARAMETER_NAME
No parameter name abbreviation with the requested properties has been defined.
Definition: AAX_Errors.h:89
@ AAX_ERROR_INVALID_VIEW_SIZE
Definition: AAX_Errors.h:72
@ AAX_ERROR_INVALID_PARAMETER_INDEX
Definition: AAX_Errors.h:50
@ AAX_ERROR_INITIALIZING_PACKET_STREAM_THREAD
Definition: AAX_Errors.h:60
@ AAX_ERROR_INVALID_METER_TYPE
Definition: AAX_Errors.h:53
@ AAX_ERROR_INVALID_CHUNK_INDEX
Definition: AAX_Errors.h:46
@ AAX_ERROR_UNKNOWN_ID
Definition: AAX_Errors.h:81
@ AAX_SUCCESS
Definition: AAX_Errors.h:39
@ AAX_ERROR_INVALID_INTERNAL_DATA
Some part of the internal data required by the method is invalid.
Definition: AAX_Errors.h:85
@ AAX_ERROR_NOT_INITIALIZED
Definition: AAX_Errors.h:51
@ AAX_ERROR_TOD_BEHIND
Definition: AAX_Errors.h:67
@ AAX_ERROR_ARGUMENT_BUFFER_OVERFLOW
A buffer argument was not large enough to hold the data which must be placed within it.
Definition: AAX_Errors.h:86
@ AAX_ERROR_DUPLICATE_EFFECT_ID
Definition: AAX_Errors.h:75
AAX_ENUM_SIZE_CHECK(AAX_EError)