os/mm/mmlibs/mmfw/inc/mmf/common/MmfPanicCodes.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#ifndef __MMF_COMMON_PANICCODES_H__
sl@0
    17
#define __MMF_COMMON_PANICCODES_H__
sl@0
    18
sl@0
    19
//Multimedia Framework Panic Codes
sl@0
    20
sl@0
    21
/**
sl@0
    22
@publishedAll
sl@0
    23
@released
sl@0
    24
sl@0
    25
Panic codes for CMMFAudioInput.
sl@0
    26
*/
sl@0
    27
enum TMMFAudioInputPanicCode
sl@0
    28
	{
sl@0
    29
	/**
sl@0
    30
	Panic in MMMFAudioInput::NewAudioInputL() if ImplementationUid!=KUidMmfAudioInput.
sl@0
    31
	*/
sl@0
    32
	EMMFAudioInputPanicBadUID = 1,
sl@0
    33
	/**
sl@0
    34
	MDevSoundObserver::ToneFinished() was called but not implemented.
sl@0
    35
	*/
sl@0
    36
	EMMFAudioInputPanicToneFinishedNotSupported,
sl@0
    37
	/**
sl@0
    38
	MDevSoundObserver::BufferToBeFilled() was called but not implemented.
sl@0
    39
	*/
sl@0
    40
	EMMFAudioInputPanicPlayerDataUsedNotSupported,
sl@0
    41
	/**
sl@0
    42
	MDevSoundObserver::PlayError() was called but not implemented.
sl@0
    43
	*/
sl@0
    44
	EMMFAudioInputPanicPlayErrorNotSupported,
sl@0
    45
	/**
sl@0
    46
	Panic if CMMFAudioInput::DevSound not loaded.
sl@0
    47
	*/
sl@0
    48
	EMMFAudioInputDevSoundNotLoaded
sl@0
    49
	};
sl@0
    50
sl@0
    51
/**
sl@0
    52
@publishedAll
sl@0
    53
@released
sl@0
    54
sl@0
    55
Panic codes for CMMFAudioOutput
sl@0
    56
*/
sl@0
    57
enum TMMFAudioOutputPanicCode
sl@0
    58
	{
sl@0
    59
	/**	Panic in MMMFAudioOutput::NewAudioInputL() if ImplementationUid!=KUidMmfAudioInput
sl@0
    60
	*/
sl@0
    61
	EMMFAudioOutputPanicBadUID = 1,
sl@0
    62
sl@0
    63
	/**	MMMFAudioOutput::BufferFilledL() was called but not implemented
sl@0
    64
	*/
sl@0
    65
	EMMFAudioOutputPanicBufferFilledLNotSupported,
sl@0
    66
sl@0
    67
	/**	MMMFAudioOutput::ToneFinished() was called but not implemented
sl@0
    68
	*/
sl@0
    69
	EMMFAudioOutputPanicToneFinishedNotSupported,
sl@0
    70
sl@0
    71
	/** Unimplemented panic code.
sl@0
    72
	*/
sl@0
    73
	EMMFAudioOutputPanicRecordDataFilledNotSupported,
sl@0
    74
sl@0
    75
	/**	MMMFAudioOutput::RecordError() was called but not implemented
sl@0
    76
	*/
sl@0
    77
	EMMFAudioOutputPanicRecordErrorNotSupported,
sl@0
    78
sl@0
    79
	/**	Panic if CMMFAudioOutput::iMMFDevSound is NULL
sl@0
    80
	*/
sl@0
    81
	EMMFAudioOutputDevSoundNotLoaded, 
sl@0
    82
sl@0
    83
	/**	Panic if trying to resume when resume is not supported by DevSound
sl@0
    84
	*/
sl@0
    85
	EMMFAudioOutputDevSoundResumingWhenNotSupported
sl@0
    86
	};
sl@0
    87
sl@0
    88
/**
sl@0
    89
@publishedAll
sl@0
    90
@released
sl@0
    91
sl@0
    92
Panic codes for CMMFDescriptor
sl@0
    93
*/
sl@0
    94
enum TMMFDescriptorPanicCode
sl@0
    95
	{
sl@0
    96
	/** MDataSource::BufferEmptiedL() was called but not implemented
sl@0
    97
	*/
sl@0
    98
	EMMFDescriptorPanicBufferEmptiedLNotSupported = 1,
sl@0
    99
	/** MDataSink::BufferFilledL() was called but not implemented
sl@0
   100
	*/
sl@0
   101
	EMMFDescriptorPanicBufferFilledLNotSupported
sl@0
   102
	};
sl@0
   103
sl@0
   104
/**
sl@0
   105
@publishedAll
sl@0
   106
@released
sl@0
   107
sl@0
   108
Panic codes for CMMFFile
sl@0
   109
*/
sl@0
   110
enum TMMFFilePanicCode
sl@0
   111
	{
sl@0
   112
	/** MDataSource::BufferEmptiedL() called but not implemented
sl@0
   113
	*/
sl@0
   114
	EMMFFilePanicBufferEmptiedLNotSupported = 1,
sl@0
   115
	/** MDataSink::BufferFilledL() called but not implemented
sl@0
   116
	*/
sl@0
   117
	EMMFFilePanicBufferFilledLNotSupported,
sl@0
   118
	/** Panic code raised if the file is already open.
sl@0
   119
	*/
sl@0
   120
	EMMFFileAlreadyOpen,
sl@0
   121
    /** Panic code raised if the file Handle is NULL.
sl@0
   122
    */  
sl@0
   123
  EMMFFileHandleNULL
sl@0
   124
	};
sl@0
   125
sl@0
   126
/** 
sl@0
   127
@publishedAll
sl@0
   128
@deprecated
sl@0
   129
sl@0
   130
Panic codes for CMMFDataPath
sl@0
   131
*/
sl@0
   132
enum TMMFDataPathPanicCode
sl@0
   133
	{
sl@0
   134
	/**
sl@0
   135
	The iState value is not the expected value (normally EPlaying). For example, when it is asked to initialise
sl@0
   136
	the sink or source whilst it is already playing some audio data.
sl@0
   137
	*/
sl@0
   138
	EMMFDataPathPanicBadState = 1000000,
sl@0
   139
sl@0
   140
	/**
sl@0
   141
	The code has detected a condition that cannot occur - must be programming error
sl@0
   142
	*/
sl@0
   143
	EMMFDataPathPanicProgrammingError = 2000000,
sl@0
   144
sl@0
   145
	/**
sl@0
   146
	A panic in CMMFDataPath::EmptySinkBufferL() if sink status
sl@0
   147
	is not EFull or EBeingFilled.
sl@0
   148
	*/
sl@0
   149
	EMMFDataPathPanicSinkError = 3000000
sl@0
   150
	};
sl@0
   151
sl@0
   152
/**
sl@0
   153
@publishedAll
sl@0
   154
@released
sl@0
   155
sl@0
   156
Panic codes for RMMFSubThread.
sl@0
   157
*/
sl@0
   158
enum TMMFSubThreadPanicCode
sl@0
   159
	{
sl@0
   160
	/** An attempt to close the subthread using RMMFSubThreadBase::Shutdown() has failed. The shutdown command
sl@0
   161
	waits for both the death of the thread and the time-out of a timer to minimise the risk of deadlock.
sl@0
   162
	If the timer times-out and the sub-thread is not dead then this thread is panicked in debug mode or,
sl@0
   163
	in release mode the sub-thread is killed.
sl@0
   164
	*/
sl@0
   165
	EMMFSubThreadPanicTimedOut = 1
sl@0
   166
	};
sl@0
   167
sl@0
   168
/**
sl@0
   169
@publishedAll
sl@0
   170
@released
sl@0
   171
sl@0
   172
Panic codes for MMFCodecBaseDefinitions
sl@0
   173
*/
sl@0
   174
enum TMMFCodecBaseDefinitionsPanicCode
sl@0
   175
	{
sl@0
   176
	/**
sl@0
   177
	Panic code raised when the codec TMMFTableAudioCodec::ConvertFast() method is not supported for this codec.
sl@0
   178
	*/
sl@0
   179
	EMMFCodecBaseDefinitionsPanicConvertFastNotSupported = 1	
sl@0
   180
	};
sl@0
   181
sl@0
   182
/**
sl@0
   183
@publishedAll
sl@0
   184
@released
sl@0
   185
sl@0
   186
Panic codes for CMMFAudioController.
sl@0
   187
*/
sl@0
   188
enum TMMFAudioControllerPanicCode
sl@0
   189
	{
sl@0
   190
sl@0
   191
	/** Panic code for a bad Unique Identifier. This is reserved.
sl@0
   192
	*/
sl@0
   193
	EMMFAudioControllerPanicBadUID = 1,
sl@0
   194
sl@0
   195
	/** AddDataSourceL() failed to add a data source. This could be caused by an 
sl@0
   196
	audio source that has been loaded but now does not exist.
sl@0
   197
	*/
sl@0
   198
	EMMFAudioControllerPanicDataSourceDoesNotExist,
sl@0
   199
sl@0
   200
	/** AddDataSinkL() failed to add a sink. This could be caused by an audio sink 
sl@0
   201
	that has been loaded but now does not exist.
sl@0
   202
	*/
sl@0
   203
	EMMFAudioControllerPanicDataSinkDoesNotExist
sl@0
   204
	};
sl@0
   205
sl@0
   206
/**
sl@0
   207
@publishedAll
sl@0
   208
@deprecated
sl@0
   209
sl@0
   210
Panic codes for MMFDisplay
sl@0
   211
*/
sl@0
   212
enum TMMFDisplayPanicCode
sl@0
   213
	{
sl@0
   214
  	/** Panic code raised when this CMMFDisplay is in the wrong thread.
sl@0
   215
	*/
sl@0
   216
	EMMFDisplayPanicWrongThread = 1,
sl@0
   217
  	/** Panic code raised when the CMMFDisplay has been asked to do something before it is ready.
sl@0
   218
	*/
sl@0
   219
	EMMFDisplayPanicNotReady,
sl@0
   220
  	/** Panic code raised when the CMMFDisplay::CreateSinkBufferL() method is not supported.
sl@0
   221
	*/
sl@0
   222
	EMMFDisplayPanicCreateSinkBufferLNotSupported,
sl@0
   223
  	/** Panic code raised when the CMMFDisplay::BufferFilledL() method is not supported.
sl@0
   224
	*/
sl@0
   225
	EMMFDisplayPanicBufferFilledLNotSupported,
sl@0
   226
  	/** Panic code raised when the calling supplier does not exist.
sl@0
   227
	*/
sl@0
   228
	EMMFDisplayPanicCallingSupplierDoesNotExist,
sl@0
   229
  	/** Panic code raised when the CMMFDisplay method has an internal error.
sl@0
   230
	*/
sl@0
   231
	EMMFDisplayPanicRequestStatusError
sl@0
   232
	};
sl@0
   233
sl@0
   234
/**
sl@0
   235
@publishedAll
sl@0
   236
@deprecated
sl@0
   237
sl@0
   238
Panic codes for MMFToneController.
sl@0
   239
*/
sl@0
   240
enum TMMFToneControllerPanicCode 
sl@0
   241
	{
sl@0
   242
	/** Panic code raised when the tone controller encounters a bad Unique Identifier.
sl@0
   243
	*/
sl@0
   244
	EMMFToneControllerPanicBadUID = 1,
sl@0
   245
	/** Panic code raised when the mixin class API encounters an unexpected call, for example
sl@0
   246
	when the hardware has full buffer or when playback is stopped due to error or EOF.
sl@0
   247
	*/
sl@0
   248
	EMMFToneControllerPanicUnexpectedMixinApiCall,
sl@0
   249
	/** Panic code raised when there is an error with the cancel command. Not used at present.
sl@0
   250
	*/
sl@0
   251
	EMMFToneControllerPanicBadCancelCustomCommand
sl@0
   252
	};
sl@0
   253
sl@0
   254
sl@0
   255
/**
sl@0
   256
@publishedAll
sl@0
   257
@released
sl@0
   258
sl@0
   259
Panic codes for the audio media client
sl@0
   260
*/
sl@0
   261
enum TMMFMediaClientPanicCode
sl@0
   262
	{
sl@0
   263
  	/** The specified audio device mode is not supported.
sl@0
   264
	*/
sl@0
   265
	EMMFMediaClientPanicSetAudioDeviceModeNotSupported = 1,
sl@0
   266
sl@0
   267
	/** An error occurred communicating with the audio device.
sl@0
   268
	*/
sl@0
   269
	EMMFMediaClientPanicServerCommunicationProblem,
sl@0
   270
sl@0
   271
	/** The functions CMMFMdaAudioConvertUtility::OpenL() or CMMFMdaAudioRecorderUtility::DoPlay()
sl@0
   272
	detected an invalid internal state
sl@0
   273
	*/
sl@0
   274
	EMMFMediaClientBadState,
sl@0
   275
sl@0
   276
	/** The audio media client received a bad argument.
sl@0
   277
	*/
sl@0
   278
	EMMFMediaClientBadArgument,
sl@0
   279
sl@0
   280
	/** Reserved function should not be called
sl@0
   281
	*/
sl@0
   282
	EMMFReservedCall
sl@0
   283
	};
sl@0
   284
sl@0
   285
/**
sl@0
   286
@publishedAll
sl@0
   287
sl@0
   288
Panic codes for the sw codec wrapper
sl@0
   289
*/
sl@0
   290
enum TMMFSwCodecWrapperPanicCode
sl@0
   291
	{
sl@0
   292
	/** Codec wrapper did not create an internal datapath
sl@0
   293
	*/
sl@0
   294
	EMMFSwCodecWrapperNoDataPath,
sl@0
   295
sl@0
   296
	/** Codec wrapper does not have a device handle
sl@0
   297
	*/
sl@0
   298
	EMMFSwCodecWrapperNoDevice,
sl@0
   299
sl@0
   300
	/** Codec wrapper codec returns non existant process result
sl@0
   301
	*/
sl@0
   302
	EMMFSwCodecWrapperBadCodec,
sl@0
   303
sl@0
   304
	/** Sound driver returns unexpected buffer
sl@0
   305
	*/
sl@0
   306
	EMMFSwCodecWrapperBadBuffer
sl@0
   307
	};
sl@0
   308
sl@0
   309
sl@0
   310
/**
sl@0
   311
@publishedAll
sl@0
   312
@released
sl@0
   313
sl@0
   314
Panic codes for the media client utility
sl@0
   315
*/
sl@0
   316
enum TMMFMediaClientUtilityPanicCode 
sl@0
   317
	{
sl@0
   318
	/** Client utility is in a bad state
sl@0
   319
	*/
sl@0
   320
	EMMFMediaClientUtilityBadState = 1,
sl@0
   321
	
sl@0
   322
	/** Client utility is passed a bad argument
sl@0
   323
	*/
sl@0
   324
	EMMFMediaClientUtilityBadArgument
sl@0
   325
	};
sl@0
   326
sl@0
   327
#ifdef SYMBIAN_MULTIMEDIA_SUBTITLE_SUPPORT
sl@0
   328
/**
sl@0
   329
@publishedAll
sl@0
   330
@released
sl@0
   331
sl@0
   332
Panic codes for the video player utility
sl@0
   333
*/
sl@0
   334
enum TMMFVideoPlayerUtilityPanicCode 
sl@0
   335
	{
sl@0
   336
	/** File not opened
sl@0
   337
	*/
sl@0
   338
	EMMFVideoPlayerUtilityFileNotOpened = 1,
sl@0
   339
sl@0
   340
	/** Subtitle not supported
sl@0
   341
	*/
sl@0
   342
	EMMFVideoPlayerUtilitySubtitleNotSupported = 2,
sl@0
   343
sl@0
   344
	/** No display window available
sl@0
   345
	*/
sl@0
   346
	EMMFVideoPlayerUtilityNoWindowAdded = 3,
sl@0
   347
sl@0
   348
	/** Subtitle not enabled
sl@0
   349
	*/
sl@0
   350
	EMMFVideoPlayerUtilitySubtitleNotEnabled = 4,
sl@0
   351
sl@0
   352
	/** Subtitle language not supported
sl@0
   353
	*/
sl@0
   354
	EMMFVideoPlayerUtilitySubtitleLanguageNotSupported = 5
sl@0
   355
	};
sl@0
   356
#endif //SYMBIAN_MULTIMEDIA_SUBTITLE_SUPPORT
sl@0
   357
sl@0
   358
#endif