include/alp/media_session.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright (c) 2006 Palmsource, Inc. (an Access company). All rights reserved.
 *******************************************************************************/  

#ifndef MEDIA_SESSION_H
#define MEDIA_SESSION_H 

#include "media_defs.h"

#ifdef __cplusplus
extern "C" {
#endif
        

/****************************************************************************
* Structures 
*****************************************************************************/

typedef struct _AlpMMSessionEvent {
        AlpMMSessionID  session_ref;    
        AlpMMEvent      event_code;     
        int32_t event_cause;    
        int64_t position;       
        int64_t duration;       
        int64_t total_estimated_time;   
        int64_t total_recorded_size;    
} AlpMMSessionEvent;


typedef struct _AlpMMSessionGrabEvent {
    void * buffer;      
    size_t buffersize;  
    int64_t timestamp;  
    int32_t   width;    
    int32_t   height;   
} AlpMMSessionGrabEvent;

/****************************************************************************
* Typedefs 
*****************************************************************************/

typedef void (* AlpMMSessionCallbackFn) (const AlpMMSessionEvent *event, void * userdata);


typedef void (*AlpMMSessionGrabCallbackFn) (const AlpMMSessionGrabEvent *grabevent, void *userdata);


/****************************************************************************
* Enums
*****************************************************************************/


typedef enum
{
    ALP_MM_TYPE_FILE = (ALP_MM_FILE | 0x000001) ,
    
    ALP_MM_TYPE_FILELIST,
    
    ALP_MM_TYPE_NETSTREAM,
    
    ALP_MM_TYPE_MEMSTREAM,
    
    ALP_MM_TYPE_AUDIO_RENDER,
    
    ALP_MM_TYPE_VIDEO_RENDER,    
} AlpMMSourceType;



typedef enum
{
        ALP_MM_FLASH_MODE_OFF           = (ALP_MM_SOURCE_CAMERA | 0x000001), 

        ALP_MM_FLASH_MODE_AUTO,

        ALP_MM_FLASH_MODE_FRONT, 

        ALP_MM_FLASH_MODE_SLOW,
        
        ALP_MM_FLASH_MODE_REAR,

} AlpCameraFlashMode;


typedef enum
{
        ALP_MM_FOCUS_AUTO               = (ALP_MM_SOURCE_CAMERA | 0x000010), 

        ALP_MM_FOCUS_ONE,
        
        ALP_MM_FOCUS_TWO,
        
        ALP_MM_FOCUS_FOUR,
        
        ALP_MM_FOCUS_EIGHT,
        
        ALP_MM_FOCUS_INFINITY = 0xffffff,
                
} AlpCameraFocusMode;


typedef enum 
{
        ALP_MM_WHITE_BALANCE_AUTO = (ALP_MM_SOURCE_CAMERA | 0x000020),

        ALP_MM_WHITE_BALANCE_INCANDESCENT,
        
        ALP_MM_WHITE_BALANCE_FLUORESCENT,
        
        ALP_MM_WHITE_BALANCE_SUNSHINE,
        
        ALP_MM_WHITE_BALANCE_CLOUDS
                
} AlpCameraWhiteBalanceMode;


typedef enum
{
        ALP_MM_COLOR_EFFECT_OFF = (ALP_MM_SOURCE_CAMERA | 0x000030),
        
        ALP_MM_COLOR_EFFECT_NATURAL,

        ALP_MM_COLOR_EFFECT_VIVID,

        ALP_MM_COLOR_EFFECT_SEPIA,

        ALP_MM_COLOR_EFFECT_REVERSAL,

        ALP_MM_COLOR_EFFECT_COLD,

        ALP_MM_COLOR_EFFECT_BLACK_AND_WHITE
                
}AlpCameraColorEffect;


typedef enum 
{
        ALP_MM_SOURCE_CAMERA_APERTURE = (ALP_MM_SOURCE_CAMERA | 0x000040L),

        ALP_MM_SOURCE_CAMERA_EXPOSURE,

        ALP_MM_SOURCE_CAMERA_SCALE,

        ALP_MM_SOURCE_CAMERA_FLASH_MODE,

        ALP_MM_SOURCE_CAMERA_FOCUS,

        ALP_MM_SOURCE_CAMERA_RED_EYE_REDUCTION,

        ALP_MM_SOURCE_CAMERA_ISO_SENSITIVITY,

        ALP_MM_SOURCE_CAMERA_WHITE_BALANCER,

        ALP_MM_SOURCE_CAMERA_BRIGHTNESS,

        ALP_MM_SOURCE_CAMERA_ZOOM,

        ALP_MM_SOURCE_CAMERA_FRAME_RATE,

        ALP_MM_SOURCE_CAMERA_RESOLUTION,

        ALP_MM_SOURCE_CAMERA_COLOR_EFFECT,

        ALP_MM_SOURCE_CAMERA_WIDTH,

        ALP_MM_SOURCE_CAMERA_HEIGHT

}AlpCameraPropertyKey;

typedef enum 
{
        ALP_MM_FORMATKEY_RAW_AUDIO_TYPE = (ALP_MM_FORMATKEY_RAW_AUDIO | 0x000001L),

        ALP_MM_FORMATKEY_RAW_AUDIO_BYTE_ORDER,
        
        ALP_MM_FORMATKEY_RAW_AUDIO_BITS,

        ALP_MM_FORMATKEY_RAW_AUDIO_CHANNELS,

        ALP_MM_FORMATKEY_RAW_AUDIO_SAMPLERATE,

        ALP_MM_FORMATKEY_RAW_AUDIO_BIT_RATE
}AlpRawAudioPropertyKey;

typedef enum 
{
        ALP_MM_AUDIO_AMR_BITRATE_MR475 = 4750,

        ALP_MM_AUDIO_AMR_BITRATE_MR515 = 5150,

        ALP_MM_AUDIO_AMR_BITRATE_MR59 = 5900,

        ALP_MM_AUDIO_AMR_BITRATE_MR67 = 6700,

        ALP_MM_AUDIO_AMR_BITRATE_MR74 = 7400,

        ALP_MM_AUDIO_AMR_BITRATE_MR795 = 7950,

        ALP_MM_AUDIO_AMR_BITRATE_MR102 = 10200,

        ALP_MM_AUDIO_AMR_BITRATE_MR122 = 12200
}AlpAmrBitRate;

typedef enum 
{
        ALP_MM_RAW_AUDIO_INT8 = 0x01,

        ALP_MM_RAW_AUDIO_UINT8,

        ALP_MM_RAW_AUDIO_INT16,

        ALP_MM_RAW_AUDIO_INT32,
        
        ALP_MM_RAW_AUDIO_FLOAT,

        ALP_MM_RAW_AUDIO_SIZE_MASK = 0x0f
}AlpRawAudioTypes;

typedef enum 
{
        ALP_MM_RAW_AUDIO_STEREO = 0x02,

        ALP_MM_RAW_AUDIO_MONO = 0x01,

        ALP_MM_RAW_AUDIO_DOLBY_PRO_LOGIC_STEREO = 0x12,

        ALP_MM_RAW_AUDIO_DOLBY_5_1_SURROUND = 0x26,

        ALP_MM_RAW_AUDIO_DTS_SURROUND = 0x36,

        ALP_MM_RAW_AUDIO_CHANNEL_COUNT_MASK = 0x0f
}AlpRawAudioChannel;

typedef enum 
{
        ALP_MM_FORMATKEY_RAW_VIDEO_COLOR_SPACE = (ALP_MM_FORMATKEY_RAW_VIDEO | 0x000001),
        
        ALP_MM_FORMATKEY_RAW_VIDEO_FRAME_RATE,

        ALP_MM_FORMATKEY_RAW_VIDEO_BIT_RATE,
        
        ALP_MM_FORMATKEY_RAW_VIDEO_RECT
}AlpRawVideoPropertyKey;

typedef enum 
{
        ALP_MM_RAW_VIDEO_YCBCR420_PLANAR = 0x000010,

        ALP_MM_RAW_VIDEO_YCBCR422_PLANAR,

        ALP_MM_RAW_VIDEO_YCBCR420_PACKET,

        ALP_MM_RAW_VIDEO_YCBCR422_PACKET,

        ALP_MM_RAW_VIDEO_YCBCR444,
        
        ALP_MM_RAW_VIDEO_RGB888,

        ALP_MM_RAW_VIDEO_RGB565,

        ALP_MM_RAW_VIDEO_RGB555,

        ALP_MM_RAW_VIDEO_BGR888,

        ALP_MM_RAW_VIDEO_BGR565,

        ALP_MM_RAW_VIDEO_BGR555,

        ALP_MM_RAW_VIDEO_RAWRGB,

        ALP_MM_RAW_VIDEO_OTHER_FMT
}AlpRawVideoColorSpace;

typedef enum 
{
        ALP_MM_VIDEO_RSL_SXGA = 0x000040,

        ALP_MM_VIDEO_RSL_VGA,

        ALP_MM_VIDEO_RSL_QVGA,

        ALP_MM_VIDEO_RSL_QQVGA,

        ALP_MM_VIDEO_RSL_CIF,

        ALP_MM_VIDEO_RSL_QCIF,

        ALP_MM_VIDEO_RSL_QQCIF
}AlpVideoResolution;

typedef enum  
{
        ALP_MM_FILE_FORMAT_MP3 = (ALP_MM_FILE_FORMAT | 0x000001),

        ALP_MM_FILE_FORMAT_MP4,

        ALP_MM_FILE_FORMAT_3GPP,

        ALP_MM_FILE_FORMAT_AVI,

        ALP_MM_FILE_FORMAT_RM,

        ALP_MM_FILE_FORMAT_AMR,

        ALP_MM_FILE_FORMAT_ASF,

        ALP_MM_FILE_FORMAT_WAV,

        ALP_MM_FILE_FORMAT_MIDI_MTHd,
        
        ALP_MM_FILE_FORMAT_MIDI_XMF,
        
        ALP_MM_FILE_FORMAT_MIDI_IMY,

        ALP_MM_FILE_FORMAT_OGG,

        ALP_MM_FILE_FORMAT_JPEG,

        ALP_MM_FILE_FORMAT_BMP,

        ALP_MM_FILE_FORMAT_WBMP,

        ALP_MM_FILE_FORMAT_PNG,

        ALP_MM_FILE_FORMAT_GIF,

        ALP_MM_FILE_FORMAT_TIFF,

        ALP_MM_FILE_FORMAT_WMA,

        ALP_MM_FILE_FORMAT_WMV,

        ALP_MM_FILE_FORMAT_H263,

        ALP_MM_FILE_FORMAT_H264,

        ALP_MM_FILE_FORMAT_RAW_AUDIO,

        ALP_MM_FILE_FORMAT_RAW_VIDEO
}AlpMediaFileFormatType;


typedef enum 
{
        ALP_MM_FILE_CONTENT_ALBUM = (ALP_MM_FILE_CONTENT | 0x000001),

        ALP_MM_FILE_CONTENT_ARTIST,

        ALP_MM_FILE_CONTENT_DURATION,
                
        ALP_MM_FILE_CONTENT_GENRE,

        ALP_MM_FILE_CONTENT_TITLE,

        ALP_MM_FILE_CONTENT_TRACK_NUMBER,

        ALP_MM_FILE_CONTENT_REVISION,

        ALP_MM_FILE_CONTENT_REMARK
}AlpMediaFileContentKeys;

typedef enum {
        ALP_MM_AUDIO_CODEC_RAW = (ALP_MM_AUDIO_CODEC | 0x000001),

        ALP_MM_AUDIO_CODEC_MSADPCM,
        
        ALP_MM_AUDIO_CODEC_DVIADPCM,
        
        ALP_MM_AUDIO_CODEC_OGG_VORBIS,

        ALP_MM_AUDIO_CODEC_AMR_NB,

        ALP_MM_AUDIO_CODEC_AMR_WB,

        ALP_MM_AUDIO_CODEC_G711,

        ALP_MM_AUDIO_CODEC_G722,

        ALP_MM_AUDIO_CODEC_G723,

        ALP_MM_AUDIO_CODEC_G723_1,

        ALP_MM_AUDIO_CODEC_G726,

        ALP_MM_AUDIO_CODEC_G728,

        ALP_MM_AUDIO_CODEC_G729,

        ALP_MM_AUDIO_CODEC_AAC,

        ALP_MM_AUDIO_CODEC_MP3,

        ALP_MM_AUDIO_CODEC_MIDI 
}AlpAudioCodecs;

typedef enum {
        ALP_MM_VIDEO_CODEC_RAW = (ALP_MM_VIDEO_CODEC | 0x000001),
        
        ALP_MM_VIDEO_CODEC_MPEG4,

        ALP_MM_VIDEO_CODEC_3GPP,
  
        ALP_MM_VIDEO_CODEC_H263,
        
        //theora video format
        ALP_MM_VIDEO_CODEC_OGG_THEORA,
        
        ALP_MM_VIDEO_CODEC_REAL8,

        ALP_MM_VIDEO_CODEC_REAL9,

        ALP_MM_VIDEO_CODEC_REAL10,

        ALP_MM_VIDEO_CODEC_DIVX5,
        
        ALP_MM_VIDEO_CODEC_XVID
}AlpVideoCodecs;

typedef enum 
{
        ALP_MM_STILL_CODEC_JPEG = (ALP_MM_STILL_CODEC | 0x000001),

        ALP_MM_STILL_CODEC_BMP,

        ALP_MM_STILL_CODEC_PNG,

        ALP_MM_STILL_CODEC_GIF
}AlpStillImageCodecs;

typedef enum 
{
        ALP_MM_VIDEO_CODEC_TYPE = (ALP_MM_VIDEO_CODEC | 0x000040),

        ALP_MM_AUDIO_CODEC_TYPE,

        ALP_MM_STILL_CODEC_TYPE
}AlpCodecProperyKey;


typedef enum 
{
        ALP_MM_SESSION_CLASS_RECORD = (ALP_MM_SESSION_CLASS | 0x000001),

        ALP_MM_SESSION_CLASS_PLAYBACK,
}AlpMMSessionClassID;



typedef enum
{
        ALP_MM_SESSION_CTL_RUN = (ALP_MM_SESSION_CTL | 0x000001),

        ALP_MM_SESSION_CTL_PAUSE,

        ALP_MM_SESSION_CTL_STOP,

        ALP_MM_SESSION_CTL_PREFETCH,

        ALP_MM_SESSION_CTL_GRAB,

        ALP_MM_SESSION_CTL_REFRESH,
        
        ALP_MM_SESSION_CTL_NEXT,

        ALP_MM_SESSION_CTL_PRV,
        
        ALP_MM_SESSION_CTL_PREVIEW,
                
        ALP_MM_SESSION_CTL_RECORD,

        ALP_MM_SESSION_CTL_CUSTOM_BASE = 0x1000
} AlpMMSessionControlOpcode;

typedef enum
{
        ALP_MM_SESSION_NOT_INITIALIZED = 0x01,

        ALP_MM_SESSION_READY,

        ALP_MM_SESSION_PREFETCHING,

        ALP_MM_SESSION_PAUSED,

        ALP_MM_SESSION_STOPPED,

        ALP_MM_SESSION_FINISHED,

        ALP_MM_SESSION_RUNNING
                
} AlpMMSessionState;

typedef enum 
{
        ALP_MM_SOURCE_FILE_FORMAT = (ALP_MM_SOURCE_FILE | 0x000001),

        ALP_MM_SOURCE_FILE_HAS_AUDIO,

        ALP_MM_SOURCE_FILE_HAS_VIDEO,
        
        ALP_MM_SOURCE_URL,

        ALP_MM_SOURCE_SIZE          
}AlpMMSourcePropertyKey;

typedef enum 
{
        ALP_MM_DESTINATION_FILE_FORMAT = (ALP_MM_DESTINATION_FILE | 0x000001),

        ALP_MM_DESTINATION_FILE_HAS_AUDIO,

        ALP_MM_DESTINATION_FILE_HAS_VIDEO,
        
        ALP_MM_DESTINATION_URL,

        ALP_MM_DISPLAY_ID,

        ALP_MM_DESTINATION_ROTATE 
}AlpMMDestinationPropertyKey;

typedef enum  
{
        ALP_MM_DESTINATION_ROTATE_NONE = 0,

        ALP_MM_DESTINATION_ROTATE_90L = 1,
        
        ALP_MM_DESTINATION_ROTATE_90R = 2,      

        ALP_MM_DESTINATION_ROTATE_180 = 3               
}AlpMMDestinationRotateType;

typedef enum {
        ALP_MM_SESSION_MEDIAIN_TYPE      = 0,           
        ALP_MM_SESSION_MEDIAOUT_TYPE     = 1,           
        ALP_MM_SESSION_VOICEIN_TYPE      = 2,           
        ALP_MM_SESSION_VOICEOUT_TYPE     = 3,           
        ALP_MM_SESSION_RING_TYPE         = 4,           
        ALP_MM_SESSION_SYSSOUND_TYPE     = 5,           
        ALP_MM_SESSION_ALARM_TYPE        = 6            
} AlpMMAudioAppType;

typedef enum 
{
        ALP_MM_SESSION_AUDIO_ENABLE = (ALP_MM_SESSION | 0x000001),

        ALP_MM_SESSION_AUDIO_VOLUME,

        ALP_MM_SESSION_AUDIO_APP_TYPE,
        
        ALP_MM_SESSION_VIDEO_ENABLE, 
        

        ALP_MM_SESSION_DEST_RECT, 

        ALP_MM_SESSION_DEST_ROTATE,
        
        ALP_MM_SESSION_SOURCE_RECT,
        
        ALP_MM_SESSION_CURRENT_TIME,

        ALP_MM_SESSION_END_TIME,

        ALP_MM_SESSION_PLAYBACK_RATE,

        ALP_MM_SESSION_PREFETCH_TIME,

        ALP_MM_SESSION_REPEAT_ENABLE,

        ALP_MM_SESSION_START_TIME,

        ALP_MM_SESSION_SESSION_CLASS,

        ALP_MM_SESSION_VIDEO_IS_BLANK,

        ALP_MM_SESSION_IS_PREVIEW,

        ALP_MM_SESSION_HANDLE_AUDIO_CONFLIC,

        ALP_MM_SESSION_VIDEO_SOURCE_ROTATE
        
}AlpMMSessionPropertyKey;

typedef enum 
{
        ALP_MM_SESSION_SEEK_ORIGIN_BEGIN = 0x01,

        ALP_MM_SESSION_SEEK_ORIGIN_CURRENT,

        ALP_MM_SESSION_SEEK_ORIGIN_END
}AlpMMSessionSeekOrigin;

typedef enum 
{
        ALP_MM_SESSION_EVENT_CAUSE_UNKNOWN = (ALP_MM_SESSION_EVENT | 0x000001),

        ALP_MM_SESSION_EVENT_CAUSE_REQUESTED_BY_APP,

        ALP_MM_SESSION_EVENT_CAUSE_INVALID_AUDIO_STREAM,
        
        ALP_MM_SESSION_EVENT_CAUSE_INVALID_VIDEO_STREAM,

        ALP_MM_SESSION_EVENT_CAUSE_END_OF_STREAM,

        ALP_MM_SESSION_EVENT_CAUSE_INVALID_STREAM,

        ALP_MM_SESSION_EVENT_CAUSE_STORAGE_FULL,

        ALP_MM_SESSION_EVENT_CAUSE_CUSTOM_BASE = 0x1000
}AlpMMSessionEventCauses;

typedef enum 
{
        ALP_MM_SESSION_EVENT_STATE_CHANGED = (ALP_MM_SESSION_EVENT | 0x000020),

        ALP_MM_SESSION_EVENT_WARNING,

        ALP_MM_SESSION_EVENT_ERROR,

        ALP_MM_SESSION_EVENT_CURRENT_TIME,

        ALP_MM_SESSION_EVENT_DELETING,

        ALP_MM_SESSION_EVENT_AUDIO_CONFLICT_OCCUR,

        ALP_MM_SESSION_EVENT_AUDIO_CONFLICT_CANCEL,
        
        ALP_MM_SESSION_EVENT_CUSTOM_BASE
}AlpMMSessionEventCode;

typedef enum
{
        ALP_MM_PROPERTY_TYPE_DEFAULT    =       (ALP_MM_PROPERTY_TYPE | 0x000010),    
        
        ALP_MM_PROPERTY_TYPE_MINIMUM,

        ALP_MM_PROPERTY_TYPE_MAXIMUM,

        // !return whether the value is readbable
        ALP_MM_PROPERTY_TYPE_READABLE,

        // !return whether the value is writable,
        ALP_MM_PROPERTY_TYPE_WRITABLE

}AlpMMPropertyType;

typedef enum
{
        ALP_MM_PROPERTY_CODE_UNDEFINED = (ALP_MM_PROPERTY_CODE | 0x000020),

        ALP_MM_PROPERTY_CODE_RAW,

        ALP_MM_PROPERTY_CODE_INT8,

        ALP_MM_PROPERTY_CODE_INT16,

        ALP_MM_PROPERTY_CODE_INT32,

        ALP_MM_PROPERTY_CODE_INT64,

        ALP_MM_PROPERTY_CODE_BOOL,

        ALP_MM_PROPERTY_CODE_STRING             
                
}AlpMMPropertyCode;

/****************************************************************************
* Macros  (defined in header)
*****************************************************************************/


/****************************************************************************
* Functions and Grouping Objects
*****************************************************************************/


alp_status_t    alp_media_session_create (AlpMMSessionClassID sessionClass, AlpMMSessionID * outSession);



alp_status_t alp_media_session_add_source(AlpMMSessionID session, AlpMMSourceType type, const void *sourceURL, AlpMMSourceID *outSource);


alp_status_t alp_media_session_add_dest(AlpMMSessionID session, const char *destURL, AlpMMDestID *outDest);



alp_status_t alp_media_session_control(AlpMMSessionID session, AlpMMSessionControlOpcode sessionCtl);

alp_status_t alp_media_session_finalize(AlpMMSessionID session);

 

alp_status_t alp_media_session_seek(AlpMMSessionID session, AlpMMSessionSeekOrigin origin, int64_t position);

alp_status_t alp_media_session_seek_full(AlpMMSessionID session, AlpMMSessionSeekOrigin origin, int64_t position, int64_t play_duration, double rate, int is_Accurate);

alp_status_t alp_media_session_get_state(AlpMMSessionID session, AlpMMSessionState *outState);



alp_status_t alp_media_session_register_callback(AlpMMSessionID session, AlpMMSessionCallbackFn callback, void * userdata);

alp_status_t alp_media_session_register_grab_callback(AlpMMSessionID session, AlpMMSessionGrabCallbackFn callback, void * userdata);

alp_status_t alp_media_session_remove_all(AlpMMSessionID session);


alp_status_t alp_media_session_destroy(AlpMMSessionID session);





alp_status_t alp_media_property_get(int32_t  id, AlpMMPropertyType  propertyType, int32_t  propertyKey, AlpMMPropertyCode  properytyCode, void  *outValue, int32_t  *ioLength);


alp_status_t alp_media_property_set(int32_t id, int32_t propertyKey, AlpMMPropertyCode propertyCode, void *value, int32_t *length);

alp_status_t alp_media_session_gst_init();

alp_status_t alp_media_session_syssnd_init();

alp_status_t alp_media_session_syssnd_play(const char * sound, const char * streamtype, int volume);

alp_status_t alp_media_session_syssnd_play_file(char * filename, const char * streamtype, int volume);

alp_status_t alp_media_session_play_tone(unsigned short amplitude, unsigned short duration, unsigned short freq, const char* streamtype);

/****************************************************************************
* Constants 
*****************************************************************************/
 
#define ALP_LONG_MAX 0xffffff

#define ALP_MM_ISO_SENSITIVITY_AUTO     0

#define ALP_MM_EXPOSURE_AUTO    0

#define CAMERADEV "dev://camera"

#define MICDEV          "dev://mic"

#define LCDDEV          "dev://lcd"

#define FILENAME        "dev://filename"


#define DSPDEV  "dev://dsp"


#define FAKEDEV "dev://null"


#define VIDEOFAKEDEV    "dev://video"


#define XWINDOWDEV      "dev://xwindow"


#define AUDIOFAKEDEV    "dev://audio"

#ifdef __cplusplus
}
#endif

#endif

---

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.