include/alp/mediaselector_api.h

Go to the documentation of this file.

/*********************************************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
        *Copyright © 2006-2007, ACCESS Systems Americas, Inc. a member of the ACCESS Co., Ltd group of companies.
        *ACCESS, ACCESS Linux Platform, ACCESS Powered, ACCESS Desktop, Palm Desktop, Palm OS, Garnet, Graffiti,
        *Hiker, HotSync, iMessenger, HandMail, MultiMail Deluxe, Netfront and certain other trade names, trademarks
        *and logos are trademarks which may be registered in the United States, France, Germany, Japan, the
        *United Kingdom, and other countries and are either owned by ACCESS Systems Americas, Inc. or its affiliates,
        *or are licensed on an exclusive basis by ACCESS Systems Americas, Inc. (“ACCESS”) from Palm Trademark Holding
        *Company, LLC.    These marks may not be used in connection with any product or service that does not belong
        *to ACCESS (except as expressly permitted by a license with ACCESS), in any manner that is likely to cause
        *confusion among customers, or in any manner that disparages or discredits ACCESS or its affiliates or licensor.
 ********************************************************************************************************/
/*      Sections:
        Section 1   Definitions used across the whole media selector subsystem.
        Section 2   mediacatd public API. (Primarily) methods that communicate with mediacatd.
        Section 3   mediaselector_dml public API. Methods for reading and writing metadata.
        Section 4   mediafile public API. Methods for manipulating mount-point-independent filenames.
*/        
        
#ifndef __ALP_MEDIA_SELECTOR_API_H
#define __ALP_MEDIA_SELECTOR_API_H

#include <errno.h>

#include <sqlite3.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>

#include <glib/gtypes.h>

#include <alp/sal.h>
#include <alp/types.h>
#include <alp/sysclass.h>
#include <alp/volumesvcs_types.h>

#if (__GNUC__ >= 3)
#define DEPRECATED  __attribute__((__deprecated__))
#else
#define DEPRECATED
#endif /* __GNUC__ */
                
G_BEGIN_DECLS
        
/* @addtogroup ALP_MEDIA_SELECTOR Media Selector infrastructure
 *  @ingroup ALP_MULTIMEDIA
 * This is the public API for the ALP Media Selector infrastructure: 
 *      1) the cataloger daemon (mediacatd);
 *      2) the (user-process) data access library (mediaselector_dml); and
 *      3) the (user-process) media utilities library (mediafile).
 *  @{
*/

//
//  Section 1:   Definitions used across the whole media selector subsystem
//

// 1.1: error messages

#define ALP_STATUS_MS_MISC  0x00000000 
#define ALP_STATUS_MS_CAT   0x00010000 
#define ALP_STATUS_MS_IPC   0x00020000 
#define ALP_STATUS_MS_DML   0x00030000 
#define ALP_STATUS_MS_FILE  0x00040000 
#define ALP_STATUS_MS_UI    0x00050000 
        
#define ALP_STATUS_MS_MISC_ERROR (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_MISC) 
#define ALP_STATUS_MS_CAT_ERROR  (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_CAT)  
#define ALP_STATUS_MS_DML_ERROR  (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_DML)  
#define ALP_STATUS_MS_IPC_ERROR  (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_IPC)  
#define ALP_STATUS_MS_FILE_ERROR (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_FILE) 
#define ALP_STATUS_MS_UI_ERROR   (ALP_CLASS_MEDIASELECTOR | ALP_STATUS_MS_UI)   
        
// Cataloger and IPC errors
//
// NOTE: If you change any of these error codes, be sure to change the error_strings library under platform/servers/mediacatd
        
enum
{
    ALP_STATUS_MS_CAT_OK = ALP_STATUS_OK,                           
    ALP_STATUS_MS_CAT_NO_COMM = ALP_STATUS_MS_CAT_ERROR + 1,        
    ALP_STATUS_MS_CAT_DB_DONE,                                      
    ALP_STATUS_MS_CAT_INVALID_PATH,                                 
    ALP_STATUS_MS_CAT_NOT_SUPPORTED,                                
    ALP_STATUS_MS_CAT_DB_ERROR,                                     
    ALP_STATUS_MS_CAT_NOTIFICATION_ERROR,                           
    ALP_STATUS_MS_CAT_FILE_NOT_FOUND,                               
    ALP_STATUS_MS_CAT_FILE_IO_ERROR,                                
    ALP_STATUS_MS_CAT_INTERNAL_ERROR,                               
    ALP_STATUS_MS_CAT_NO_MEMORY,                                    
    ALP_STATUS_MS_CAT_BAD_PARAMETER,                                
    ALP_STATUS_MS_CAT_USER_ABORT,                                   
    ALP_STATUS_MS_CAT_TARGET_FILE_EXISTS,                           
    ALP_STATUS_MS_CAT_UNKNOWN_SOURCE_FILE,                          
    ALP_STATUS_MS_CAT_TARGET_NAME_COLLISION,                        
};

enum
{
    ALP_STATUS_MS_IPC_NOT_MOUNTED = ALP_STATUS_MS_IPC_ERROR + 1,    
    ALP_STATUS_MS_IPC_INVALID_OPERATION                             
};

// DML errors

enum
{
    ALP_STATUS_MS_OK = ALP_STATUS_OK,                              
    ALP_STATUS_MS_DML_UNIMPLEMENTED = ALP_STATUS_MS_DML_ERROR + 1, 
    ALP_STATUS_MS_DML_NO_RECORDS,                                  
    ALP_STATUS_MS_DML_NO_MORE_RECORDS,                             
    ALP_STATUS_MS_DML_NO_MEM,                                      
    ALP_STATUS_MS_DML_INTERNAL_ERR,                                
    ALP_STATUS_MS_DML_DATABASE_ERR,                                
    ALP_STATUS_MS_DML_BAD_PARAM,                                   
    ALP_STATUS_MS_DML_COLUMN_INVALID,                              
    ALP_STATUS_MS_DML_COLUMN_MISMATCH,                             
    ALP_STATUS_MS_DML_NOT_A_NUMBER,                                
    ALP_STATUS_MS_DML_OUT_OF_RANGE,                                
    ALP_STATUS_MS_DML_NOT_INDEXED,                                 
    ALP_STATUS_MS_DML_SYSTEM_COLUMN,                               
    ALP_STATUS_MS_DML_FILE_DOES_NOT_EXIST                          
};

// MediaFile errors

enum
{
    ALP_STATUS_MF_UNAVAILABLE = ALP_STATUS_MS_FILE_ERROR + 1,       
    ALP_STATUS_MF_INVALID_PARAM,                                    
    ALP_STATUS_MF_PENDING                                           
};

enum AlpMsStatus
{
    ALP_MS_STATUS_OK = 0,                                           
    ALP_MS_STATUS_BAD_PARAMETER = ALP_STATUS_MS_UI_ERROR + 1        
};
        
                                
// 1.2: Media selector widget

// MediaSelector widget properties
#define ALP_MS_PROP_CATEGORY            "category"          
#define ALP_MS_PROP_FILTER                      "filter"            
#define ALP_MS_PROP_VIEW_MODE           "view_mode"         
#define ALP_MS_PROP_SORTBY                      "sortby"            
#define ALP_MS_PROP_MATCH                       "match"             
#define ALP_MS_PROP_MATCH_FIELD         "match_field"       
#define ALP_MS_PROP_SORT_ASCENDING      "sort_ascending"    
#define ALP_MS_PROP_ICON_SPACING        "icon_spacing"          
#define ALP_MS_PROP_ICON_MARGIN         "icon_margin"           
#define ALP_MS_PROP_POPUP_MENU      "ms_popup_menu"     

// MediaSelector signals
#define ALP_MS_SIGNAL_SELECTION_CHANGED   "selection_changed"   
#define ALP_MS_SIGNAL_SELECTION_ACTIVATED "selection_activated" 

// Common category selections
#define ALP_MS_CATEGORY_AUDIO           "audio"       
#define ALP_MS_CATEGORY_AUDIO_PIC   "audio_pic"   
#define ALP_MS_CATEGORY_VIDEO           "video"       
#define ALP_MS_CATEGORY_IMAGE           "image"       
#define ALP_MS_CATEGORY_ALL             "all"         
#define ALP_MS_CATEGORY_RINGTONE        "ringtone"    
#define ALP_MS_CATEGORY_DOCUMENT        "application" 
#define ALP_MS_CATEGORY_APPLICATION "application" 
#define ALP_MS_CATEGORY_VOICE           "voice"       
#define ALP_MS_CATEGORY_OTHER           "other"       
#define ALP_MS_CATEGORY_COLLECTION      "collection"  
        
// Common sortby selections 
#define ALP_MS_SORTBY_SIZE                      "size"       
#define ALP_MS_SORTBY_NAME                      "name"       
#define ALP_MS_SORTBY_LOCATION          "location"   
#define ALP_MS_SORTBY_TYPE                      "type"       
#define ALP_MS_SORTBY_TIME                      "mtime"      


enum AlpMediaSelectorViewModeType
{
    ALP_MS_SINGLE_VIEW = 0,                     
    ALP_MS_MULTI_VIEW,                          
    ALP_MS_GALLERY_VIEW                         
};

enum AlpMsSorts
{
    ALP_MS_SORT_DESCENDING = 0,                 
    ALP_MS_SORT_ASCENDING,                      
};

                
//        
//  Section 2:   mediacatd public API
//
                
// 2.1: macros and constants

// Standard registered directories


#define ALP_MEDIASELECTOR_REGISTERED_DIRECTORY_HOME               "/var/home"

#define ALP_MEDIASELECTOR_REGISTERED_DIRECTORY_RINGTONES          "/usr/share/sounds/ringtones"

#define ALP_MEDIASELECTOR_REGISTERED_DIRECTORY_STANDARD_IMAGES    "/usr/share/images"

#define ALP_MEDIASELECTOR_REGISTERED_DIRECTORY_STANDARD_VIDEO     "/usr/share/video"
        
        
// Messages sent BY the media cataloger daemon

#define ALP_MEDIASELECTOR_APP_ID "mediacatd"

#define ALP_MS_EVENT_PREFIX "/alp/" ALP_MEDIASELECTOR_APP_ID "/"

#define ALP_MS_REFRESH_CONTENT      ALP_MS_EVENT_PREFIX "refresh"

#define ALP_NOTIFY_EVENT_MS_REFRESH ALP_MS_REFRESH_CONTENT

#define ALP_NOTIFY_EVENT_MS_SCANNING_DIRECTORY ALP_MS_EVENT_PREFIX "scanning_directory"

#define ALP_NOTIFY_EVENT_MS_METADATA_READ_PROGRESS ALP_MS_EVENT_PREFIX "reading_metadata"

#define MS_READ_PROGRESS_PARTS 10000

#define ALP_NOTIFY_EVENT_MS_INDEX_FILE ALP_MS_EVENT_PREFIX "index_file"

#define ALP_NOTIFY_EVENT_MS_UNINDEX_FILE ALP_MS_EVENT_PREFIX "unindex_file"

#define ALP_NOTIFY_EVENT_MS_FILE_DELETED ALP_MS_EVENT_PREFIX "file_deleted"


// Messages sent TO the media cataloger daemon

#define ALP_NOTIFY_EVENT_DIRECTORY_UPDATED              ALP_MS_EVENT_PREFIX "update_dir"


// 2.2: types

typedef void* AlpMSRegDirH;

// single file indexing

// At least one app loads a heaader that #defines Status ....
#ifdef Status
#ifdef  Copy__of__Status__define Status
#warning woop! woop!
#endif
#define Copy__of__Status__define Status
#undef Status
#endif

#define ALP_MS_CAT_INDEX_FILE_RESULTS_VERSION_1PT0 0x00010000

enum AlpMsCatIndexFileStatus
{
    ALP_MS_CAT_IFS_SUCCESS,                     
    ALP_MS_CAT_IFS_FILE_DOES_NOT_EXIST,         
    ALP_MS_CAT_IFS_NOT_IN_REGISTERED_DIRECTORY, 
    ALP_MS_CAT_IFS_INDEXING_ERROR,              
    ALP_MS_CAT_IFS_DATABASE_ERROR,              
};

typedef struct _AlpNotifyEventIndexFileResultsHeader AlpNotifyEventIndexFileResultsHeader;
struct _AlpNotifyEventIndexFileResultsHeader
{
    int                             Version;   
    enum AlpMsCatIndexFileStatus    Status;    
};

typedef struct _AlpNotifyEventIndexFileResults AlpNotifyEventIndexFileResults;
struct _AlpNotifyEventIndexFileResults
{
    AlpNotifyEventIndexFileResultsHeader
           Header;      
    char   Filename[0]; 
};

#define ALP_MS_CAT_UNINDEX_FILE_RESULTS_VERSION_1PT0 0x00010000
        
enum AlpMsCatUnindexFileStatus
{
    ALP_MS_CAT_UFS_SUCCESS,             
    ALP_MS_CAT_UFS_NOT_INDEXED,         
    ALP_MS_CAT_UFS_UNINDEXING_ERROR,    
    ALP_MS_CAT_UFS_FILE_DOES_NOT_EXIST  
};

typedef struct _AlpNotifyEventUnindexFileResultsHeader AlpNotifyEventUnindexFileResultsHeader;
struct _AlpNotifyEventUnindexFileResultsHeader
{
    int                             Version; 
    enum AlpMsCatUnindexFileStatus  Status;  
};

typedef struct _AlpNotifyEventUnindexFileResults AlpNotifyEventUnindexFileResults;
struct _AlpNotifyEventUnindexFileResults
{
    AlpNotifyEventUnindexFileResultsHeader
            Header;      
    char    Filename[0]; 
};

// rename file

#define FILE_RENAMED_NOTIFICATION_VERSION_1PT0 0x00010000

#define ALP_NOTIFY_EVENT_MS_RENAME_FILE ALP_MS_EVENT_PREFIX "rename_file"

typedef struct _AlpNotifyEventFileRenamed AlpNotifyEventFileRenamed;
struct _AlpNotifyEventFileRenamed
{
    int Version;    
    int UrlOffset;  
    int NameOffset; 
};

// file copy callback

typedef int (*alp_ms_cat_file_copy_callback)
        (const char* destination_filename, const char* source_filename, int64_t bytes_copied, int64_t total_bytes, void* data);

// 2.3: entry points

    alp_status_t alp_ms_cat_register_directory(const char* path);

    alp_status_t alp_ms_cat_unregister_directory(const char* path);

    alp_status_t alp_ms_cat_get_registered_begin(AlpMSRegDirH* handle);

    alp_status_t alp_ms_cat_get_registered_next_dir(AlpMSRegDirH handle, char** directory);

    alp_status_t alp_ms_cat_get_registered_end(AlpMSRegDirH handle);
 
    alp_status_t alp_ms_cat_update(const char* path);
                                   
    bool alp_ms_cat_extension_supported(const char* extension);

    alp_status_t alp_ms_cat_copy_file(const char* new_filename, const char* existing_filename,
        alp_ms_cat_file_copy_callback callback, void* data);

    alp_status_t alp_ms_cat_index_file(const char* filename);

    alp_status_t alp_ms_cat_unindex_file(const char* filename);

    alp_status_t alp_ms_cat_rename_file(const char* new_filename, const char* existing_url, const char* notification_app);
    

 
//
//  Section 3:   mediaselector_dml public API
//
                
// 3.1: macros and constants
        
// Common to all item types
#define ALP_MS_DML_COL_ANY_FILEID                       "file_id"               

// Audio
#define ALP_MS_DML_COL_AUDIO_TITLE                      "title"                 
#define ALP_MS_DML_COL_AUDIO_ARTIST                     "artist"                
#define ALP_MS_DML_COL_AUDIO_ALBUM                      "album"                 
#define ALP_MS_DML_COL_AUDIO_GENRE                      "genre"                 
#define ALP_MS_DML_COL_AUDIO_YEAR                       "year"                  
#define ALP_MS_DML_COL_AUDIO_DURATION           "duration"              
#define ALP_MS_DML_COL_AUDIO_CTIME                      "ctime"                 
#define ALP_MS_DML_COL_AUDIO_COUNT                      "play_count"    
#define ALP_MS_DML_COL_AUDIO_NOTES                      "notes"                 
                
#define ALP_MS_DML_COL_AUDIO_COMPOSER           "composer"              
#define ALP_MS_DML_COL_AUDIO_BITRATE            "bitrate"       
#define ALP_MS_DML_COL_AUDIO_SAMPLERATE         "samplerate"    
#define ALP_MS_DML_COL_AUDIO_TRACKNUM           "tracknum"              
#define ALP_MS_DML_COL_AUDIO_TOTAL_TRACKS       "totaltracks"   
        
// Audio Pic
#define ALP_MS_DML_COL_AUDIO_PIC_PATH           "pic_file_location"   
        
// Collection
#define ALP_MS_DML_COL_COLLECTION_TITLE         "title"                 
#define ALP_MS_DML_COL_COLLECTION_COUNT         "count"                 

// Document
#define ALP_MS_DML_COL_DOCUMENT_TYPE            "mimetype"              
#define ALP_MS_DML_COL_DOCUMENT_NOTES           "notes"                 
#define ALP_MS_DML_COL_DOCUMENT_DESCRIPTION     "title"         
#define ALP_MS_DML_COL_DOCUMENT_TITLE       "title"         
        
// Video
#define ALP_MS_DML_COL_VIDEO_TITLE                      "title"                 
#define ALP_MS_DML_COL_VIDEO_GENRE                      "genre"                 
#define ALP_MS_DML_COL_VIDEO_DURATION           "duration"              
#define ALP_MS_DML_COL_VIDEO_CREATION_TIME      "ctime"                 
#define ALP_MS_DML_COL_VIDEO_PLAY_COUNT         "play_count"    
#define ALP_MS_DML_COL_VIDEO_NOTES                      "notes"                 
#define ALP_MS_DML_COL_VIDEO_WIDTH                      "width"                 
#define ALP_MS_DML_COL_VIDEO_HEIGHT                     "height"                

#define ALP_MS_DML_COL_VIDEO_CTIME                      "ctime"                 
        
// Image
#define ALP_MS_DML_COL_IMAGE_TITLE                      "title"                 
#define ALP_MS_DML_COL_IMAGE_WIDTH                      "width"                 
#define ALP_MS_DML_COL_IMAGE_HEIGHT                     "height"                
#define ALP_MS_DML_COL_IMAGE_NOTES                      "notes"                 

// Ringtone
#define ALP_MS_DML_COL_RINGTONE_DURATION        "duration"              
#define ALP_MS_DML_COL_RINGTONE_TITLE           "title"                 
        
// Voice
#define ALP_MS_DML_COL_VOICE_DURATION           "duration"              
#define ALP_MS_DML_COL_VOICE_TITLE              "title"                 
#define ALP_MS_DML_COL_VOICE_BITRATE            "bitrate"               
#define ALP_MS_DML_COL_VOICE_SAMPLERATE         "samplerate"            
    

// Constants for values to be used with alp_ms_dml_item*() api for the item_type parameter.
#define ALP_MS_ITEM_TYPE_AUDIO                  ALP_MS_CATEGORY_AUDIO        
#define ALP_MS_ITEM_TYPE_AUDIO_PIC              ALP_MS_CATEGORY_AUDIO_PIC    
#define ALP_MS_ITEM_TYPE_DOCUMENT               ALP_MS_CATEGORY_APPLICATION  
#define ALP_MS_ITEM_TYPE_APPLICATION    ALP_MS_CATEGORY_APPLICATION  
#define ALP_MS_ITEM_TYPE_VIDEO                  ALP_MS_CATEGORY_VIDEO        
#define ALP_MS_ITEM_TYPE_IMAGE                  ALP_MS_CATEGORY_IMAGE        
#define ALP_MS_ITEM_TYPE_RINGTONE               ALP_MS_CATEGORY_RINGTONE     
#define ALP_MS_ITEM_TYPE_VOICE                  ALP_MS_CATEGORY_VOICE        

// 3.2: types
        
// 3.3: entry points
    
// Open and Close

    alp_status_t     alp_ms_dml_open(AlpDmlH *dmlH);

    alp_status_t     alp_ms_dml_flush(AlpDmlH dmlH);

    alp_status_t     alp_ms_dml_close(AlpDmlH dmlH);

// Write Item
  
    alp_status_t      alp_ms_dml_item_create(const char* item_type, AlpDmlItemH* itemH, const char* path);

    alp_status_t      alp_ms_dml_item_destroy(AlpDmlItemH itemH);

    alp_status_t      alp_ms_dml_item_set_int32(AlpDmlItemH itemH, const char* dml_column, int32_t* value);

    alp_status_t      alp_ms_dml_item_set_int64(AlpDmlItemH itemH, const char* dml_column, int64_t* value);

    alp_status_t      alp_ms_dml_item_set_string(AlpDmlItemH itemH, const char* dml_column, const char* value);
     
    alp_status_t     alp_ms_dml_commit_item(AlpDmlH dmlH, AlpDmlItemH itemH);

// Read Item
        
    typedef int (*AlpMsCallbackFunction)(void *user_data, int argc, char **argv, char **azColName);

    typedef struct
    {
        const char *category;      
        const char *fields;        
    
        const char *filter;        
    
        const char *matchField;    
        const char *match;                 

    
        const char *regexField;    
        const char *regex;                 

        const char *includedCategories;  
        const char *excludedCategories;  
        const char *sortby;                
        bool ascending;                    
    
        int start;                                 
        int limit;                                 
    } alp_ms_dml_statement_parameters;
    
    alp_status_t alp_ms_dml_statement_parameters_clear(alp_ms_dml_statement_parameters* parameters);
        
    alp_status_t alp_ms_dml_statement_parameters_set_fields(alp_ms_dml_statement_parameters* parameters,
            const char *category, const char *fields);

    alp_status_t alp_ms_dml_statement_parameters_set_match(alp_ms_dml_statement_parameters* parameters,
            const char *matchField, const char *match);
        
    alp_status_t alp_ms_dml_statement_parameters_set_regex(alp_ms_dml_statement_parameters* parameters,
            const char *regexField, const char *regex);
        
    alp_status_t alp_ms_dml_statement_parameters_set_select_by_category(alp_ms_dml_statement_parameters* parameters,
            const char *includedCategories, const char *excludedCategories);
    
    alp_status_t alp_ms_dml_statement_parameters_set_sort(alp_ms_dml_statement_parameters* parameters,
            const char *sortby, bool ascending);
        
    alp_status_t alp_ms_dml_statement_parameters_set_skip(alp_ms_dml_statement_parameters* parameters,
            int start, int limit);
        
    alp_status_t alp_ms_dml_statement_build_single_file_filter(const char* filename, char** filter);

    enum alp_ms_dml_statement_exec_offsets
    {
        alp_ms_dml_statement_exec_location_offset = -2, 
        alp_ms_dml_statement_exec_file_id_offset = -1   
    };
    
    alp_status_t alp_ms_dml_statement_exec(AlpDmlH dmlH, 
        AlpMsCallbackFunction callback, void* data, alp_ms_dml_statement_parameters* params,
        int* numResults                          
    );

    //TODO: Reorder the params so all OUT params are last? (Would have to change app code.)
    alp_status_t alp_ms_dml_statement_begin(AlpDmlH dmlH, AlpDmlStatementH *stmtH,                 
        alp_ms_dml_statement_parameters* params, int* numResults                                
    );
          
    alp_status_t alp_ms_dml_statement_next(AlpDmlStatementH stmtH);
    
    alp_status_t alp_ms_dml_statement_end(AlpDmlStatementH stmtH);

    alp_status_t alp_ms_dml_statement_get_columns(AlpDmlStatementH stmtH,
        int* columnCount, gchar*** columnNames
    );

    alp_status_t alp_ms_dml_statement_get_int32(AlpDmlStatementH stmtH, const char* dml_column, int32_t *value);
    
    alp_status_t alp_ms_dml_statement_get_int64(AlpDmlStatementH stmtH, const char* dml_column, int64_t *value);
    
    alp_status_t alp_ms_dml_statement_get_string(AlpDmlStatementH stmtH, const char* dml_column, const char **value);

    alp_status_t alp_ms_dml_statement_get_file_url(AlpDmlStatementH stmtH, const char** url);

    
//
// Section 4:   mediafile public API
//        
        
// 4.1: macros and constants
        

#define ALP_MF_URL_CARD_PREFIX   "card://"

#define ALP_MF_URL_DEVICE_PREFIX "file://"

#define ALP_MF_THUMBNAILER_PSEUDOAPP "background.thumbnailer"
    
// 4.2: types
    
typedef void* AlpFileMime;

// 4.3: entry points
        
    alp_status_t alp_mf_get_media_path(const char* udi, const char* filename, char** outpath);
        
    alp_status_t alp_mf_get_media_file_type_id(const char* desc, int32_t* ftid);

    alp_status_t alp_mf_get_file_url(const char* full_path, char** urlout);
        
    alp_status_t alp_mf_get_url_path(const char* url, char** pathout);
        
    alp_status_t alp_mf_get_path_udi(const char* path, char** udi);
        
    alp_status_t alp_mf_get_url_udi(const char* url, char** udi);
        
    alp_status_t alp_mf_get_file_thumbnail_path(const char* path, char** pathout) DEPRECATED;

    alp_status_t alp_mf_get_file_thumbnail_path_extended(const char* path, const char* notification, char** pathout, int* token);

    alp_status_t alp_mf_get_file_icon_path(const char* path, char** pathout);

    alp_status_t alp_mf_get_mime_icon_path(const char* mime, char** pathout);

// Mime determination for media files.
        
    alp_status_t alp_mf_mime_init(const char* file, AlpFileMime* handle);

    alp_status_t alp_mf_mime_fini(AlpFileMime handle);
        
    alp_status_t alp_mf_mime_set_to(AlpFileMime handle, const char* file);
        
    char* alp_mf_mime_get_supertype(AlpFileMime handle);

    char* alp_mf_mime_get_subtype(AlpFileMime handle);

    char* alp_mf_mime_get_mime_string(AlpFileMime handle);
        
    bool alp_mf_mime_is_supported(AlpFileMime handle);
        
    alp_status_t alp_mf_get_mime_for_file(const char* file, char** outmime);
        
    
G_END_DECLS
        
#ifdef Copy__of__Status__define 
#define Status Copy__of__Status__define 
#undef Copy__of__Status__define 
#endif
        
#endif        

// @}   /* ALP_MULTIMEDIA */

---

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.