include/alp/media_defs.h

Go to the documentation of this file.
00001 /*****************************************************************************
00002  * This header file describes the session management API types and macros defination
00003  * in the multimedia Library.
00004  * 
00005  * author: Yuetao.Zhang
00006  * email: Yuetao.Zhang@palmsource.com
00007  *****************************************************************************/
00008 
00009 /******************************************************************************
00010  * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
00011  * Copyright (c) 2006 PalmSource, Inc (an ACCESS company). All rights reserved.
00012  ******************************************************************************/
00026 #ifndef MEDIA_DEFS_H
00027 #define MEDIA_DEFS_H 
00028 #include <sys/types.h>
00029 #include "types.h"
00030 #ifdef __cplusplus
00031 extern "C" {
00032 #endif
00033 
00039   /****************************************************************************
00040    * Structures 
00041    *****************************************************************************/
00042 
00047   typedef struct _AlpMMRectangle {
00048     int32_t x; 
00049     int32_t y; 
00050     int32_t width; 
00051     int32_t height; 
00052   } AlpMMRectangle;
00053 
00056   /****************************************************************************
00057    * Enums
00058    *****************************************************************************/
00059 
00060 
00066   /****************************************************************************
00067    * Typedefs 
00068    *****************************************************************************/
00069 
00071   typedef int32_t AlpMMCodecClassID;
00072 
00074   typedef int32_t AlpMMDestID;
00075 
00077   typedef int32_t AlpMMEvent;
00078 
00080   typedef int32_t AlpMMSessionID;
00081 
00083   typedef int32_t AlpMMSourceID;
00084 
00086   typedef int32_t AlpMMSubtitleID;
00096   /****************************************************************************
00097    * Constants 
00098    *****************************************************************************/
00100 #define ALP_STATUS_OK     0
00101 
00103 #define ALP_STATUS            (1L << 24)
00104 
00106 #define ALP_STATUS_SYS_ERR        (ALP_STATUS | 0x001000)
00107 
00109 #define ALP_STATUS_SYS_ERR_BAD_TYPE        (ALP_STATUS_SYS_ERR | 0x000001)
00110 
00112 #define ALP_STATUS_SYS_ERR_PARAM        (ALP_STATUS_SYS_ERR | 0x000002)
00113 
00115 #define ALP_STATUS_SYS_ERR_NO_RESOURCE        (ALP_STATUS_SYS_ERR | 0x000003)
00116 
00118 #define ALP_STATUS_SYS_ERR_UNSUPPORTED        (ALP_STATUS_SYS_ERR | 0x000004)
00119 
00121 #define ALP_STATUS_SYS_ERR_MISS_OBJECT        (ALP_STATUS_SYS_ERR | 0x000005)
00122 
00124 #define ALP_STATUS_SYS_ERR_NOT_ALLOWED        (ALP_STATUS_SYS_ERR | 0x000006)
00125 
00127 #define ALP_STATUS_SYS_ERR_OUT_OF_RANGE        (ALP_STATUS_SYS_ERR | 0x000007)
00128 
00130 #define ALP_STATUS_SYS_ERR_BAD_STATE        (ALP_STATUS_SYS_ERR | 0x000008)
00131 
00133 #define ALP_STATUS_SYS_ERR_NO_ENOUGH_SPACE    (ALP_STATUS_SYS_ERR | 0x000009)
00134 
00143   /****************************************************************************
00144    * Constants 
00145    *****************************************************************************/
00146 
00148 #define ALP_MM_SOURCE                   (2L << 24)
00149 
00151 #define ALP_MM_SOURCE_CAMERA            (ALP_MM_SOURCE | 0x001000)
00152 
00154 #define ALP_MM_SOURCE_FILE              (ALP_MM_SOURCE | 0x002000)
00155 
00157 #define ALP_MM_SOURCE_AUDIO             (ALP_MM_SOURCE | 0x004000)
00158 
00160 #define ALP_MM_FILE                     (3L << 24)
00161 
00163 #define ALP_MM_FILE_CONTENT             (ALP_MM_FILE | 0x001000)
00164 
00166 #define ALP_MM_FILE_FORMAT              (ALP_MM_FILE | 0x002000)
00167 
00169 #define ALP_MM_AUDIO                    (4L << 24)
00170 
00172 #define ALP_MM_AUDIO_CODEC              (ALP_MM_AUDIO | 0x001000)
00173 
00175 #define ALP_MM_VIDEO                    (5L << 24)
00176 
00178 #define ALP_MM_VIDEO_CODEC              (ALP_MM_VIDEO | 0x001000)
00179 
00181 #define ALP_MM_DESTINATION              (6L << 24)
00182 
00184 #define ALP_MM_DESTINATION_VIDEO        (ALP_MM_DESTINATION | 0x001000)
00185 
00187 #define ALP_MM_DESTINATION_FILE        (ALP_MM_DESTINATION | 0x002000)
00188 
00190 #define ALP_MM_DESTINATION_AUDIO        (ALP_MM_DESTINATION | 0x003000)
00191 
00193 #define ALP_MM_FORMATKEY                (7L << 24)
00194 
00196 #define ALP_MM_FORMATKEY_RAW_AUDIO      (ALP_MM_FORMATKEY | 0x001000)
00197 
00199 #define ALP_MM_FORMATKEY_RAW_VIDEO      (ALP_MM_FORMATKEY | 0x002000)
00200 
00202 #define ALP_MM_STILL                    (8L << 24)
00203 
00205 #define ALP_MM_STILL_CODEC      (ALP_MM_STILL | 0x001000)
00206 
00208 #define ALP_MM_SESSION          (9L << 24)
00209 
00211 #define ALP_MM_SESSION_AUDIO    (ALP_MM_SESSION | 0x001000)
00212 
00214 #define ALP_MM_SESSION_VIDEO    (ALP_MM_SESSION    | 0x002000)
00215 
00217 #define ALP_MM_SESSION_CLASS    (ALP_MM_SESSION | 0x003000)
00218 
00220 #define ALP_MM_SESSION_CTL      (ALP_MM_SESSION | 0x004000)
00221 
00223 #define ALP_MM_SESSION_EVENT    (ALP_MM_SESSION | 0x005000)
00224 
00226 #define ALP_MM_PROPERTY         (10L<<24)
00227 
00229 #define ALP_MM_PROPERTY_TYPE    (ALP_MM_PROPERTY | 0x001000)
00230 
00232 #define ALP_MM_PROPERTY_CODE    (ALP_MM_PROPERTY | 0x002000)
00233 
00236 //#define ALP_CLASS_MM  0x45000000
00237 #define ALP_MM_ERROR_DECLARE(sys_class_id, error_id)  ((alp_status_t)((alp_status_t)(sys_class_id) | (((alp_status_t)(error_id) << 16 ) & 0x00FF0000)))
00238 
00239 
00240 #define ALP_MM_STATUS_OK            ALP_STATUS_OK 
00242 #define ALP_MM_STATUS_GENERIC_ERR                   ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 1) 
00243 #define ALP_MM_STATUS_ERR_PARAM                     ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 2) 
00244 #define ALP_MM_STATUS_ERR_UNSUPPORTED               ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 3) 
00245 #define ALP_MM_STATUS_ERR_MISS_OBJECT               ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 4) 
00246 #define ALP_MM_STATUS_NOT_ALLOWED                   ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 5) 
00247 #define ALP_MM_STATUS_OUT_OF_RANGE                  ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 6) 
00248 #define ALP_MM_STATUS_BAD_STATE                     ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 7) 
00249 #define ALP_MM_STATUS_INTERNAL_ERROR                ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 8) 
00250 #define ALP_MM_STATUS_OBJECT_ID_INVALID             ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 9) 
00251 #define ALP_MM_STATUS_PROPERTY_KEY_INVALID          ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 10)  
00252 #define ALP_MM_STATUS_PROPERTY_VALUE_INVALID        ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 11)  
00253 #define ALP_MM_STATUS_PROPERTY_SET_FAILED           ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 12)  
00254 #define ALP_MM_STATUS_OBJECT_EXIST                  ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 13)  
00255 #define ALP_MM_STATUS_PROPERTY_IS_READONLY          ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 14)  
00256 #define ALP_MM_STATUS_PROPERTY_KEY_OBJ_UNMATCH      ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 15)  
00258 #define ALP_MM_STATUS_NOT_ADD_SRC_OR_DEST           ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 20)  
00259 #define ALP_MM_STATUS_NOT_ADD_FILESINK              ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 21)  
00260 #define ALP_MM_STATUS_NOT_SET_FILENAME              ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 22)  
00261 #define ALP_MM_STATUS_INVALID_SOURCE_TYPE           ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 23)  
00262 #define ALP_MM_STATUS_SESSION_ID_INVALID            ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 24)  
00263 #define ALP_MM_STATUS_INVALID_DEST_URL              ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 25)  
00264 #define ALP_MM_STATUS_INVALID_SESSION_TYPE          ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 26)
00265 #define ALP_MM_STATUS_AUDIO_DEST_NOT_EXIST          ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 27)  
00266 #define ALP_MM_STATUS_VIDEO_DEST_NOT_EXIST          ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 28)  
00267 #define ALP_MM_STATUS_ID_INVALID                    ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 29)  
00269 #define ALP_MM_STATUS_SYSSND_ERROR_NO_SOUND         ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 29)  
00271 #define ALP_MM_STATUS_ERROR_MODULE_NOT_INITED       ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 150) 
00272 #define ALP_MM_STATUS_ERROR_CODE_HAS_NO_INFO        ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 151) 
00273 #define ALP_MM_STATUS_ERROR_CODE_INVALID            ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 152) 
00274 #define ALP_MM_STATUS_ERROR_MODULE_COULDNOT_INITED  ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 153) 
00275 #define ALP_MM_STATUS_UNKNOW_FILE_TYPE              ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 154) 
00277 #define ALP_MM_STATUS_ERR_NO_RESOURCE               ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 200) 
00278 #define ALP_MM_STATUS_NO_ENOUGH_SPACE               ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 201) 
00279 #define ALP_MM_STATUS_NO_ENOUGH_MEMORY              ALP_MM_ERROR_DECLARE(ALP_CLASS_MEDIA_SESSION, 202) 
00281 //Re-define the status of media.
00282 #define ALP_STATUS_MM_OK                            ALP_MM_STATUS_OK       
00284 #define ALP_STATUS_MM_GENERIC_ERR                   ALP_MM_STATUS_GENERIC_ERR  
00285 #define ALP_STATUS_MM_ERR_PARAM                     ALP_MM_STATUS_ERR_PARAM  
00286 #define ALP_STATUS_MM_ERR_UNSUPPORTED               ALP_MM_STATUS_ERR_UNSUPPORTED 
00287 #define ALP_STATUS_MM_ERR_MISS_OBJECT               ALP_MM_STATUS_ERR_MISS_OBJECT  
00288 #define ALP_STATUS_MM_NOT_ALLOWED                   ALP_MM_STATUS_NOT_ALLOWED 
00289 #define ALP_STATUS_MM_OUT_OF_RANGE                  ALP_MM_STATUS_OUT_OF_RANGE 
00290 #define ALP_STATUS_MM_BAD_STATE                                         ALP_MM_STATUS_BAD_STATE  
00291 #define ALP_STATUS_MM_INTERNAL_ERROR                ALP_MM_STATUS_INTERNAL_ERROR 
00292 #define ALP_STATUS_MM_OBJECT_ID_INVALID             ALP_MM_STATUS_OBJECT_ID_INVALID 
00293 #define ALP_STATUS_MM_PROPERTY_KEY_INVALID          ALP_MM_STATUS_PROPERTY_KEY_INVALID   
00295 #define ALP_STATUS_MM_PROPERTY_VALUE_INVALID        ALP_MM_STATUS_PROPERTY_VALUE_INVALID  
00297 #define ALP_STATUS_MM_PROPERTY_SET_FAILED           ALP_MM_STATUS_PROPERTY_SET_FAILED  
00299 #define ALP_STATUS_MM_OBJECT_EXIST                  ALP_MM_STATUS_OBJECT_EXIST  
00300 #define ALP_STATUS_MM_PROPERTY_IS_READONLY          ALP_MM_STATUS_PROPERTY_IS_READONLY 
00302 #define ALP_STATUS_MM_PROPERTY_KEY_OBJ_UNMATCH      ALP_MM_STATUS_PROPERTY_KEY_OBJ_UNMATCH 
00305 #define ALP_STATUS_MM_NOT_ADD_SRC_OR_DEST           ALP_MM_STATUS_NOT_ADD_SRC_OR_DEST  
00306 #define ALP_STATUS_MM_NOT_ADD_FILESINK              ALP_MM_STATUS_NOT_ADD_FILESINK  
00307 #define ALP_STATUS_MM_NOT_SET_FILENAME              ALP_MM_STATUS_NOT_SET_FILENAME  
00308 #define ALP_STATUS_MM_INVALID_SOURCE_TYPE           ALP_MM_STATUS_INVALID_SOURCE_TYPE 
00309 #define ALP_STATUS_MM_SESSION_ID_INVALID            ALP_MM_STATUS_SESSION_ID_INVALID  
00310 #define ALP_STATUS_MM_INVALID_DEST_URL              ALP_MM_STATUS_INVALID_DEST_URL   
00311 #define ALP_STATUS_MM_INVALID_SESSION_TYPE          ALP_MM_STATUS_INVALID_SESSION_TYPE
00312 #define ALP_STATUS_MM_AUDIO_DEST_NOT_EXIST          ALP_MM_STATUS_AUDIO_DEST_NOT_EXIST 
00313 #define ALP_STATUS_MM_VIDEO_DEST_NOT_EXIST          ALP_MM_STATUS_VIDEO_DEST_NOT_EXIST  
00314 #define ALP_STATUS_MM_ID_INVALID                    ALP_MM_STATUS_ID_INVALID  
00316 #define ALP_STATUS_MM_SYSSND_ERROR_NO_SOUND         ALP_MM_STATUS_SYSSND_ERROR_NO_SOUND  
00318 #define ALP_STATUS_MM_ERROR_MODULE_NOT_INITED       ALP_MM_STATUS_ERROR_MODULE_NOT_INITED 
00320 #define ALP_STATUS_MM_ERROR_CODE_HAS_NO_INFO        ALP_MM_STATUS_ERROR_CODE_HAS_NO_INFO 
00322 #define ALP_STATUS_MM_ERROR_CODE_INVALID            ALP_MM_STATUS_ERROR_CODE_INVALID  
00324 #define ALP_STATUS_MM_ERROR_MODULE_COULDNOT_INITED  ALP_MM_STATUS_ERROR_MODULE_COULDNOT_INITED 
00326 #define ALP_STATUS_MM_UNKNOW_FILE_TYPE              ALP_MM_STATUS_UNKNOW_FILE_TYPE 
00329 #define ALP_STATUS_MM_ERR_NO_RESOURCE               ALP_MM_STATUS_ERR_NO_RESOURCE 
00330 #define ALP_STATUS_MM_NO_ENOUGH_SPACE               ALP_MM_STATUS_NO_ENOUGH_SPACE 
00331 #define ALP_STATUS_MM_NO_ENOUGH_MEMORY              ALP_MM_STATUS_NO_ENOUGH_MEMORY 
00334 #define ALP_SYS_STOCK_SOUND_PREFIX    "stock:sound/"
00335 #define ALP_SYS_SOUND_SOFTKEY_CLICK   ALP_SYS_STOCK_SOUND_PREFIX "soft-keyboard"   
00336 #define ALP_SYS_SOUND_DEFAULT_RING    ALP_SYS_STOCK_SOUND_PREFIX "default-ring"    
00337 #define ALP_SYS_SOUND_USER_ATTENTION  ALP_SYS_STOCK_SOUND_PREFIX "attention"       
00338 #define ALP_SYS_SOUND_LOW_BATTERY     ALP_SYS_STOCK_SOUND_PREFIX "low-battery"     
00339 #define ALP_SYS_SOUND_CAMERA_SHUTTER  ALP_SYS_STOCK_SOUND_PREFIX "camera-shutter"  
00340 #define ALP_SYS_SOUND_CAMERA_ZOOM     ALP_SYS_STOCK_SOUND_PREFIX "camera-zoom"     
00341 #define ALP_SYS_SOUND_ALARM           ALP_SYS_STOCK_SOUND_PREFIX "alarm"           
00342 #define ALP_SYS_SOUND_CALL_DISCONNECT ALP_SYS_STOCK_SOUND_PREFIX "call-disconnect" 
00343 #define ALP_SYS_SOUND_CALL_CONNECT    ALP_SYS_STOCK_SOUND_PREFIX "call-connect"    
00344 #define ALP_SYS_SOUND_IRDA_CONNECT    ALP_SYS_STOCK_SOUND_PREFIX "irda-connect"    
00345 #define ALP_SYS_SOUND_IRDA_DISCONNECT ALP_SYS_STOCK_SOUND_PREFIX "irda-disconnect" 
00346 #define ALP_SYS_SOUND_USB_CONNECT     ALP_SYS_STOCK_SOUND_PREFIX "usb-connect"     
00347 #define ALP_SYS_SOUND_USB_DISCONNECT  ALP_SYS_STOCK_SOUND_PREFIX "usb-disconnect"  
00348 #define ALP_SYS_SOUND_BT_CONNECT      ALP_SYS_STOCK_SOUND_PREFIX "bt-connect"      
00349 #define ALP_SYS_SOUND_WIFI_CONNECT      ALP_SYS_STOCK_SOUND_PREFIX "wifi-connect"      
00350 #define ALP_SYS_SOUND_CONNECTION_DISCONNECT      ALP_SYS_STOCK_SOUND_PREFIX "cnc-disconnect"      
00351 #define ALP_SYS_SOUND_NEW_SMS         ALP_SYS_STOCK_SOUND_PREFIX "new-sms"         
00352 #define ALP_SYS_SOUND_NEW_MMS         ALP_SYS_STOCK_SOUND_PREFIX "new-mms"         
00353 #define ALP_SYS_SOUND_NEW_AMMS        ALP_SYS_STOCK_SOUND_PREFIX "new-amms"        
00354 #define ALP_SYS_SOUND_NEW_EMAIL       ALP_SYS_STOCK_SOUND_PREFIX "new-email"       
00355 #define ALP_SYS_SOUND_SAVED           ALP_SYS_STOCK_SOUND_PREFIX "saved"           
00356 #define ALP_SYS_SOUND_MESSAGE_SENT    ALP_SYS_STOCK_SOUND_PREFIX "message-sent"    
00357 #define ALP_SYS_SOUND_DELETED         ALP_SYS_STOCK_SOUND_PREFIX "deleted"         
00358 #define ALP_SYS_SOUND_CONFIRMATION    ALP_SYS_STOCK_SOUND_PREFIX "confirmation"    
00359 #define ALP_SYS_SOUND_CAL_REMINDER    ALP_SYS_STOCK_SOUND_PREFIX "cal-reminder"    
00360 #define ALP_SYS_SOUND_ERROR           ALP_SYS_STOCK_SOUND_PREFIX "error"           
00361 #define ALP_SYS_SOUND_WARNING         ALP_SYS_STOCK_SOUND_PREFIX "warning"         
00362 #define ALP_SYS_SOUND_NET_FAIL        ALP_SYS_STOCK_SOUND_PREFIX "net-fail"        
00364 #ifdef __cplusplus
00365 }
00366 #endif
00367 
00368 #endif
00369 
00370 

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.