1.1 --- a/epoc32/include/mmf/common/mmfpaniccodes.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mmf/common/mmfpaniccodes.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,326 @@
1.4 -mmfpaniccodes.h
1.5 +/*
1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description:
1.19 +*
1.20 +*/
1.21 +
1.22 +#ifndef __MMF_COMMON_PANICCODES_H__
1.23 +#define __MMF_COMMON_PANICCODES_H__
1.24 +
1.25 +//Multimedia Framework Panic Codes
1.26 +
1.27 +/**
1.28 +@publishedAll
1.29 +@released
1.30 +
1.31 +Panic codes for CMMFAudioInput.
1.32 +*/
1.33 +enum TMMFAudioInputPanicCode
1.34 + {
1.35 + /**
1.36 + Panic in MMMFAudioInput::NewAudioInputL() if ImplementationUid!=KUidMmfAudioInput.
1.37 + */
1.38 + EMMFAudioInputPanicBadUID = 1,
1.39 + /**
1.40 + MDevSoundObserver::ToneFinished() was called but not implemented.
1.41 + */
1.42 + EMMFAudioInputPanicToneFinishedNotSupported,
1.43 + /**
1.44 + MDevSoundObserver::BufferToBeFilled() was called but not implemented.
1.45 + */
1.46 + EMMFAudioInputPanicPlayerDataUsedNotSupported,
1.47 + /**
1.48 + MDevSoundObserver::PlayError() was called but not implemented.
1.49 + */
1.50 + EMMFAudioInputPanicPlayErrorNotSupported,
1.51 + /**
1.52 + Panic if CMMFAudioInput::DevSound not loaded.
1.53 + */
1.54 + EMMFAudioInputDevSoundNotLoaded
1.55 + };
1.56 +
1.57 +/**
1.58 +@publishedAll
1.59 +@released
1.60 +
1.61 +Panic codes for CMMFAudioOutput
1.62 +*/
1.63 +enum TMMFAudioOutputPanicCode
1.64 + {
1.65 + /** Panic in MMMFAudioOutput::NewAudioInputL() if ImplementationUid!=KUidMmfAudioInput
1.66 + */
1.67 + EMMFAudioOutputPanicBadUID = 1,
1.68 +
1.69 + /** MMMFAudioOutput::BufferFilledL() was called but not implemented
1.70 + */
1.71 + EMMFAudioOutputPanicBufferFilledLNotSupported,
1.72 +
1.73 + /** MMMFAudioOutput::ToneFinished() was called but not implemented
1.74 + */
1.75 + EMMFAudioOutputPanicToneFinishedNotSupported,
1.76 +
1.77 + /** Unimplemented panic code.
1.78 + */
1.79 + EMMFAudioOutputPanicRecordDataFilledNotSupported,
1.80 +
1.81 + /** MMMFAudioOutput::RecordError() was called but not implemented
1.82 + */
1.83 + EMMFAudioOutputPanicRecordErrorNotSupported,
1.84 +
1.85 + /** Panic if CMMFAudioOutput::iMMFDevSound is NULL
1.86 + */
1.87 + EMMFAudioOutputDevSoundNotLoaded,
1.88 +
1.89 + /** Panic if trying to resume when resume is not supported by DevSound
1.90 + */
1.91 + EMMFAudioOutputDevSoundResumingWhenNotSupported
1.92 + };
1.93 +
1.94 +/**
1.95 +@publishedAll
1.96 +@released
1.97 +
1.98 +Panic codes for CMMFDescriptor
1.99 +*/
1.100 +enum TMMFDescriptorPanicCode
1.101 + {
1.102 + /** MDataSource::BufferEmptiedL() was called but not implemented
1.103 + */
1.104 + EMMFDescriptorPanicBufferEmptiedLNotSupported = 1,
1.105 + /** MDataSink::BufferFilledL() was called but not implemented
1.106 + */
1.107 + EMMFDescriptorPanicBufferFilledLNotSupported
1.108 + };
1.109 +
1.110 +/**
1.111 +@publishedAll
1.112 +@released
1.113 +
1.114 +Panic codes for CMMFFile
1.115 +*/
1.116 +enum TMMFFilePanicCode
1.117 + {
1.118 + /** MDataSource::BufferEmptiedL() called but not implemented
1.119 + */
1.120 + EMMFFilePanicBufferEmptiedLNotSupported = 1,
1.121 + /** MDataSink::BufferFilledL() called but not implemented
1.122 + */
1.123 + EMMFFilePanicBufferFilledLNotSupported,
1.124 + /** Panic code raised if the file is already open.
1.125 + */
1.126 + EMMFFileAlreadyOpen
1.127 + };
1.128 +
1.129 +/**
1.130 +@publishedAll
1.131 +@deprecated
1.132 +
1.133 +Panic codes for CMMFDataPath
1.134 +*/
1.135 +enum TMMFDataPathPanicCode
1.136 + {
1.137 + /**
1.138 + The iState value is not the expected value (normally EPlaying). For example, when it is asked to initialise
1.139 + the sink or source whilst it is already playing some audio data.
1.140 + */
1.141 + EMMFDataPathPanicBadState = 1000000,
1.142 +
1.143 + /**
1.144 + The code has detected a condition that cannot occur - must be programming error
1.145 + */
1.146 + EMMFDataPathPanicProgrammingError = 2000000,
1.147 +
1.148 + /**
1.149 + A panic in CMMFDataPath::EmptySinkBufferL() if sink status
1.150 + is not EFull or EBeingFilled.
1.151 + */
1.152 + EMMFDataPathPanicSinkError = 3000000
1.153 + };
1.154 +
1.155 +/**
1.156 +@publishedAll
1.157 +@released
1.158 +
1.159 +Panic codes for RMMFSubThread.
1.160 +*/
1.161 +enum TMMFSubThreadPanicCode
1.162 + {
1.163 + /** An attempt to close the subthread using RMMFSubThreadBase::Shutdown() has failed. The shutdown command
1.164 + waits for both the death of the thread and the time-out of a timer to minimise the risk of deadlock.
1.165 + If the timer times-out and the sub-thread is not dead then this thread is panicked in debug mode or,
1.166 + in release mode the sub-thread is killed.
1.167 + */
1.168 + EMMFSubThreadPanicTimedOut = 1
1.169 + };
1.170 +
1.171 +/**
1.172 +@publishedAll
1.173 +@released
1.174 +
1.175 +Panic codes for MMFCodecBaseDefinitions
1.176 +*/
1.177 +enum TMMFCodecBaseDefinitionsPanicCode
1.178 + {
1.179 + /**
1.180 + Panic code raised when the codec TMMFTableAudioCodec::ConvertFast() method is not supported for this codec.
1.181 + */
1.182 + EMMFCodecBaseDefinitionsPanicConvertFastNotSupported = 1
1.183 + };
1.184 +
1.185 +/**
1.186 +@publishedAll
1.187 +@released
1.188 +
1.189 +Panic codes for CMMFAudioController.
1.190 +*/
1.191 +enum TMMFAudioControllerPanicCode
1.192 + {
1.193 +
1.194 + /** Panic code for a bad Unique Identifier. This is reserved.
1.195 + */
1.196 + EMMFAudioControllerPanicBadUID = 1,
1.197 +
1.198 + /** AddDataSourceL() failed to add a data source. This could be caused by an
1.199 + audio source that has been loaded but now does not exist.
1.200 + */
1.201 + EMMFAudioControllerPanicDataSourceDoesNotExist,
1.202 +
1.203 + /** AddDataSinkL() failed to add a sink. This could be caused by an audio sink
1.204 + that has been loaded but now does not exist.
1.205 + */
1.206 + EMMFAudioControllerPanicDataSinkDoesNotExist
1.207 + };
1.208 +
1.209 +/**
1.210 +@publishedAll
1.211 +@deprecated
1.212 +
1.213 +Panic codes for MMFDisplay
1.214 +*/
1.215 +enum TMMFDisplayPanicCode
1.216 + {
1.217 + /** Panic code raised when this CMMFDisplay is in the wrong thread.
1.218 + */
1.219 + EMMFDisplayPanicWrongThread = 1,
1.220 + /** Panic code raised when the CMMFDisplay has been asked to do something before it is ready.
1.221 + */
1.222 + EMMFDisplayPanicNotReady,
1.223 + /** Panic code raised when the CMMFDisplay::CreateSinkBufferL() method is not supported.
1.224 + */
1.225 + EMMFDisplayPanicCreateSinkBufferLNotSupported,
1.226 + /** Panic code raised when the CMMFDisplay::BufferFilledL() method is not supported.
1.227 + */
1.228 + EMMFDisplayPanicBufferFilledLNotSupported,
1.229 + /** Panic code raised when the calling supplier does not exist.
1.230 + */
1.231 + EMMFDisplayPanicCallingSupplierDoesNotExist,
1.232 + /** Panic code raised when the CMMFDisplay method has an internal error.
1.233 + */
1.234 + EMMFDisplayPanicRequestStatusError
1.235 + };
1.236 +
1.237 +/**
1.238 +@publishedAll
1.239 +@deprecated
1.240 +
1.241 +Panic codes for MMFToneController.
1.242 +*/
1.243 +enum TMMFToneControllerPanicCode
1.244 + {
1.245 + /** Panic code raised when the tone controller encounters a bad Unique Identifier.
1.246 + */
1.247 + EMMFToneControllerPanicBadUID = 1,
1.248 + /** Panic code raised when the mixin class API encounters an unexpected call, for example
1.249 + when the hardware has full buffer or when playback is stopped due to error or EOF.
1.250 + */
1.251 + EMMFToneControllerPanicUnexpectedMixinApiCall,
1.252 + /** Panic code raised when there is an error with the cancel command. Not used at present.
1.253 + */
1.254 + EMMFToneControllerPanicBadCancelCustomCommand
1.255 + };
1.256 +
1.257 +
1.258 +/**
1.259 +@publishedAll
1.260 +@released
1.261 +
1.262 +Panic codes for the audio media client
1.263 +*/
1.264 +enum TMMFMediaClientPanicCode
1.265 + {
1.266 + /** The specified audio device mode is not supported.
1.267 + */
1.268 + EMMFMediaClientPanicSetAudioDeviceModeNotSupported = 1,
1.269 +
1.270 + /** An error occurred communicating with the audio device.
1.271 + */
1.272 + EMMFMediaClientPanicServerCommunicationProblem,
1.273 +
1.274 + /** The functions CMMFMdaAudioConvertUtility::OpenL() or CMMFMdaAudioRecorderUtility::DoPlay()
1.275 + detected an invalid internal state
1.276 + */
1.277 + EMMFMediaClientBadState,
1.278 +
1.279 + /** The audio media client received a bad argument.
1.280 + */
1.281 + EMMFMediaClientBadArgument,
1.282 +
1.283 + /** Reserved function should not be called
1.284 + */
1.285 + EMMFReservedCall
1.286 + };
1.287 +
1.288 +/**
1.289 +@internalTechnology
1.290 +
1.291 +Panic codes for the sw codec wrapper
1.292 +*/
1.293 +enum TMMFSwCodecWrapperPanicCode
1.294 + {
1.295 + /** Codec wrapper did not create an internal datapath
1.296 + */
1.297 + EMMFSwCodecWrapperNoDataPath,
1.298 +
1.299 + /** Codec wrapper does not have a device handle
1.300 + */
1.301 + EMMFSwCodecWrapperNoDevice,
1.302 +
1.303 + /** Codec wrapper codec returns non existant process result
1.304 + */
1.305 + EMMFSwCodecWrapperBadCodec,
1.306 +
1.307 + /** Sound driver returns unexpected buffer
1.308 + */
1.309 + EMMFSwCodecWrapperBadBuffer
1.310 + };
1.311 +
1.312 +
1.313 +/**
1.314 +@publishedAll
1.315 +@released
1.316 +
1.317 +Panic codes for the media client utility
1.318 +*/
1.319 +enum TMMFMediaClientUtilityPanicCode
1.320 + {
1.321 + /** Client utility is in a bad state
1.322 + */
1.323 + EMMFMediaClientUtilityBadState = 1,
1.324 +
1.325 + /** Client utility is passed a bad argument
1.326 + */
1.327 + EMMFMediaClientUtilityBadArgument
1.328 + };
1.329 +
1.330 +#endif