The following constants indicate handle status.

For compatibility, Old definitions are remained.

MWE_PLY_STAT_STOP

MWE_PLY_STAT_PREP

MWE_PLY_STAT_PLAYING

MWE_PLY_STAT_PLAYEND

MWE_PLY_STAT_ERROR

The following constants indicate vertical sync (Vsync) frequency for decoder.

The following constants indicate the type of decode server.

The following constants indicate frame composition mode.

The following constants indicate the type of file to play for Sofdec.

For compatibility, Old definitions are remained.

MWE_PLY_FTYPE_SFD

MWE_PLY_FTYPE_MPV

The following constants indicate the data format of decoder's outpu buffer.

For compatibility, Old definitions are remained.

MWE_PLY_BUFFMT type

MWE_PLY_BUFFMT_MB_YCC420

MWE_PLY_BUFFMT_MB_ARGB8888

MWE_PLY_BUFFMT_PLN_YCC420

The following constants indicate output audio volume.

The following constants indicate output audio channel.

For compatibility, Old definitions are remained.

MWD_CH_L

MWD_CH_R

The following constants indicate output audio pan.

In the MWSFD_PAN_AUTO, pan would be set automatically according to data.

For compatibility, Old definitions are remained.

MWD_PAN_LEFT

MWD_PAN_CENTER

MWD_PAN_RIGHT

MWD_PAN_AUTO

The following constants indicate horizontal pitch of output frame buffer.

MWSFD_DFL_OUTBUFSIZE

Unspecified horizontal pitch of output frame buffer.

Frame conversion may be done with width of input frame.

The following constants indicate luminance alpha's transparence key.

The following constants indicate frame type of progressive or interlace.

The following constants indicate picture type.

For compatibility, Old definitions are remained.

MWE_PLY_PTYPE type

MWE_PLY_PTYPE_I

MWE_PLY_PTYPE_P

MWE_PLY_PTYPE_B

MWE_PLY_PTYPE_D

The following constants indicate picture type.

The following constants indicate video synchronization mode.

For compatibility, Old definitions are remained.

MWD_PLY_SYNC_NONE

MWD_PLY_SYNC_VSYNC

MWD_PLY_SYNC_AUDIO

The following constants indicate frame obtain synchronization mode.

The following constants indicate minimum/maximum Z value and Z range for Z movie.

The following constants indicate video codec type.

ncount: playback time in sample units (number of samples)

tscale: sampling frequency (Hz)

None

playback time in real time (sec)

converts the return value of mwPlyGetTime to sec.

For compatibility, Old definitions are remained.

MWD_PLY_TIME2SEC(ncount, tscale)

ncount: playback time in sample units (number of samples)

tscale: sampling frequency (Hz)

None

playback time in real time (msec)

converts the return value of mwPlyGetTime to msec.

For compatibility, Old definitions are remained.

MWD_PLY_TIME2MSEC(ncount, tscale)

npool: the number of frame pool which is set in handle creation parameter

size1pic: maximum user data size per 1 picture

None

Buffer size of user data in picture layer (byte)

calculates buffer size of setting paramteter for mwPlyAttachPicUsrBuf().

picnum : the number of picture whitch holding information of time

None

The size of buffer for video PTS (byte)

calc size for setting by mwPlySetVideoPts function.

Normally, please set the number of picture is 90. 90 pictures is about 3 seconds.

Handle to control playback sofdec data.

Parameter structure for setting the initialization function of Sofdec library.

For compatibility, Old definitions are remained.

MWS_PLY_INIT_SFD type

Parameter structure to set when creating a Middleware playback handle for Sofdec library.

Maximum number of frame pools is 14.

For compatibility, Old definitions are remained.

MWS_PLY_CPRM_SFD type

This is the movie surface information that is to be obtained when playing a texture movie.

For compatibility, Old definitions are remained.

MWS_PLY_FRM type

This is subtitle parameter structure that is obtained by mwPlyGetSubtile function.

This is the playback information structure for getting playback information function.

This is File header information structure that is obtained by mwPlyGetHdrInf function.

This is malloc function type that is set to MWSFD library.

obj : user's object

size : size of allocation

None

None

This is free function type that is set to MWSFD library.

obj : user's object

ptr : allocated pointer

None

None

This is the YcbCr plane information.

For compatibility, Old definitions are remained.

MWS_PLY_YCC_PLANE type

This is make z conversion table function type that is set to MWSFD library.

orgtbl : the pointer of table whitch convert from output decoding to Z-value (0x00000000~0x7FFFFFFF). the table buffer exist in MWPLY handle's work buffer.

znear : near value of Z.

zfar : far value of Z.

ztbl : the pointer of table whitch convert from Z-value (0x00000000~0x7FFFFFFF) to content in Z-Buffer. the table buffer exist in MWPLY handle's work buffer.

None

This is the counter of supply data and consume data.

This is the data flow informatin of each decode unit.

This is external clock function type that is set to MWSFD library.

This function is used on MWSFD_SYNCMODE_EXTCLOCK mode.

mwply :Middleware playback handle

time :time counter

tunit :time unit

None

This is frame information for video codec-specific.

This structure is recorded directly information in MPEG-2 bit stream.

This information is available in the case of MPEG-1 and Sofdec Video.

iprm : Initialization parameter

None

None

This function initializes the library.

If this function called repeatedly, function runs only first time.

If you will change initialize parameter, calls mwPlyFinishSfdFx function, and after call mwPlyInitSfdFx function.

memset(&iprm, 0, sizeof(MwsfdInitPrm));         // zero clear
iprm.vhz            = MWSFD_VHZ_59_94;          // NTSC
iprm.dec_svr        = MWSFD_DEC_SVR_IDLE;       // Idle Thread Decode
mwPlyInitSfdFx(&iprm);

None

None

None

This function performs the library end processing.

cprm : Handle creation parameter

None

Work area size (unit: bytes)

Calculates the work area size.

refer mwPlyCreateSofdec function.

cprm : Handle creation parameter

None

Middleware playback handle

This function creates a handle.

memset(&cprm, 0, sizeof(MwsfdCrePrm));      // For zero setting for reserved area
cprm.compo_mode     = MWSFD_COMPO_AUTO;     // Composition mode 
cprm.ftype          = MWSFD_FTYPE_SFD;      // Playback file type 
cprm.max_bps        = 6 * 1000 * 1000;      // Bit rate:6Mbit/sec 
cprm.max_width      = 640;                  // Image size:640x448
cprm.max_height     = 480; 
cprm.nfrm_pool_wk   = 2;                    // Number of frame buffers 
cprm.max_stm        = 1;                    // Max number of parallel reading
cprm.buffmt         = MWSFD_BUFFMT_DEFAULT
cprm.wksize = mwPlyCalcWorkCprmSfd(&cprm);  // Work area size calculation 
cprm.work           = malloc(cprm.wksize);  // Work area allocation
ply = mwPlyCreateSofdec(&cprm);

mwply : Middleware playback handle

None

None

Destroys the handle.

mwply : Middleware playback handle

fname : file name of sofdec data to play

None

None

Starts playback sofdec data with specified file name.

mwply : Middleware playback handle

None

None

Stops playback sofdec data.

After calling this function, the handle status transits to STOP.

It might take time to execute mwPlyStop function when the handle status is PREP/PLAYING.

mwply : Middleware playback handle

None

None

This is a non-blocking function that just requests command and returns immediately.

The handle status can not be changed after this function but after completion of internal stop process.

It required for status transition to keep calling ADXM_ExecMain function and wait Vsync function in main loop.

This function can avoid having to wait for late function return.

The period of time from calling mwPlyRequestStop function till changed to STOP status is indefinite because of dependency on movie decoding and file reading process.

mwply : Middleware playback handle

None

Internal handle status

Gets the internal status of the Middleware playback handle.

mwply : Middleware playback handle

frm : frame information

None

This function gets the frame to be displayed.

(a) If failed to get frame, then frm.bufadr is set to NULL.

(b) Release any unused frames by mwPlyRelCurFrm promptly.

(c) This function can not use with mwPlyGetFrm/mwPlyRelFrm.

for (;;) {
    MwsfdFrmObj frm;
    /* Main Loop */
    ADXM_ExecMain();
    mwPlyGetCurFrm(mwply, &frm);
    if (frm.bufadr != NULL) {
        /* Conversion of frame */
        /* Transfer texture to VRAM */
        UsrLoadMvFrmFx(mwply, &frm);
        mwPlyRelCurFrm(mwply);
    }
    UsrDrawMv();
}

mwply : Middleware playback handle

None

None

Release the frame reserved by mwPlyGetCurFrm.

(a) This function can not use with mwPlyGetFrm/mwPlyRelFrm.

refer mwPlyGetCurFrm function.

mwply : Middleware playback handle

ncount : time

tscale : unit of time (Hz)

None

This function gets the playback time.

Actual time (second or millisecond) can be calculated by:

sec = MWSFD_TIME2SEC(ncount , tscale);

msec = MWSFD_TIME2MSEC(ncount , tscale);

mwply : Middleware playback handle

sw : Pause / Resume switch (ON=Pause, OFF=Resume)

None

None

Pause and resume playback.

In the case of playback Video only, Pause in a pause means single step playback.

mwply : Middleware playback handle

None

TRUE : in pause (= pause ON)

FALSE : not in pause (= pause OFF)

Get pause status whether pause ON/OFF.

Return value is independent from middleware playback handle status, but result of calling mwPlyPause function.

mwply : Middleware playback handle

frmid :frame identifier ID

frm :frame information

TRUE : successed getting frame.

FALSE : failed getting frame.

This function gets the frame to be displayed.

To get next frame, application don't need to release previous frame.

Application can get each frame only one.

The data of frame is hold until releasing the frame or calling mwPlyStop function.

This function is need to execute on same thread of

mwPlyGetFrm and mwPlyRelFrm need to be called on same thread.

This function can not use with mwPlyGetCurFrm/mwPlyRelCurFrm.

mwply : Middleware playback handle

frmid : frame identifier ID

None

None

This function release the frame indicated by frame ID.

Application can release each frame only one. If you repeatedly released, error callback occured.

mwPlyGetFrm and mwPlyRelFrm need to be called on same thread.

This function can not use with mwPlyGetCurFrm/mwPlyRelCurFrm.

mwply : Middleware playback handle

patid : partition ID

fid : faile ID

None

None

Starts playback by file ID in AFS file.

static char ptinfo[ADXF_CALC_PTINFO_FMGL_SIZE(MAX_INSIDE)];
    ADXF_LoadPartitionFmgLongNw(ptid, "movie.afs", NULL, ptinfo);
    for(;;) {
        if (ADXF_GetPtStat(ptid) == ADXF_STAT_READEND) {
            break;
        }
    }
    fid = 0;
    mwPlyStartAfs(mwply, ptid, fid);

mwply : Middleware playback handle

fname : File name that includes Sofdec data.

offset_sct : Offset of Sofdec data in file [sector]

range_sct : Size of Sofdec data [sector]

None

None

Start playing Sofdec data by range in file.

Please use your original packing file including Sofdec data.

mwply : Middleware playback handle

sji : Input SJ handle

None

None

Starts playback by SJ handle.

mwply : Middleware playback handle

None

None

Notify the end of data supply to MWPLY handle whitch start by mwPlyStartSj function.

Please call this function after you supply all of data to to SJ.

After mwPlyTermSupply function was called and all of data was decoded, MWPLY handle's status transit to PLAYEND.

mwply : Middleware playback handle

addr : memory address

len : data size

None

None

Starts playback on memory movie file.

This function can not play seamless loop/continuous playback.

This function can play only SFD format, can not play MWSFD_FTYPE_MPV data.

ADX library has "memory file system(MFS)" for reading data on memory.

By MFS, mwPlyStartFname/mwPlyStartFnameLp/mwPlyEntryFname functions can play data on memory.

About MFS, please refer sample program "adxmfs" of ADX.

mwply : Middleware playback handle

fname : file name of sofdec data to play

None

None

Starts seamless loop playback sofdec data with specified file name.

(a) mwPlyGetTime() function's return-value means total playback time.

(b) The playback is terminated in limit time, even if the playback is in mid-flow. About limit time, please refer to mwPlySetLimitTime, mwPlyGetLimitTime functions.

(c) By mwPlyReleaseLp() function, the playback is terminated at end of stream.

(d) If movie's total time is vely short (ex. below 2 second), the playback could be not smoothly because reading file is not ready in time.

(e) You can play infinite loop by mwPlySetInfiniteSingleLoop function.

mwply : Middleware playback handle

None

None

Release seamless loop playback.

The playback is terminated at end of stream.

If call function timing is near at end of stream, The playback is terminated at end of next stream.

mwply : Middleware playback handle

patid : partition ID

fid : faile ID

None

None

Starts seamless loop playback by file ID in AFS file.

Refer to mwPlyStartFnameLp() function's Remarks.

mwply : Middleware playback handle

fname : File name that includes Sofdec data.

offset_sct : Offset of Sofdec data in file [sector]

range_sct : Size of Sofdec data [sector]

None

None

Start seamless loop playback of Sofdec data by range in file.

Please use your original packing file including Sofdec data.

mwply : Middleware playback handle

sw : mode switch (ON = use infinite loop playback, OFF = not use infinite loop playback)

None

None

Set infinite single loop playback.

The default setting is OFF.

The playback is terminated in limit time, even if the playback is in mid-flow.

Infinite single movie loop playback function is a kind of automatic restart, finished by reaching playback limit time.

Restart process runs inside ADXM_ExecMain function.

Restarting movie, playback looks breaking up but handle status is kept as PLAYING.

Also playback time, frame ID and other information related to plyaback will be reset by restart process.

Strictly, restart process will wake up at not just playback limit time but a certain time before it, that is based on length of the movie. Therefore movie would not stop halfway.

Restart process will wake up starting by follow functions exclusively.

  - mwPlyStartFnameLp

  - mwPlyStartAfsLp

  - mwPlyStartFnameRangeLp

  - mwPlyStartLsnLp

For example, this sample code can't use infinite loop playback.

 mwPlyEntryFname(ply, loopmovie.sfd);

 mwPlyStartSeamless(ply);

 mwPlySetSeamlessLp(ply, ON);

The number of restart can be got by mwPlyGetInfiniteLoopCount function.

mwply : Middleware playback handle

None

The count of internal restart for infinite loop playback

Get the count of internal restart for infinite loop playback.

mwply : Middleware playback handle

fname : file name of sofdec data to enter play list

None

None

Add filename to continuous play list.

(a) Assigned file name is deleted from file list after the file was played.

(b) Before start playback, can add some files. If the playback is in mid-flow, can add filename.

(c) If file is added to file list, the playback could be not smoothly because reading file is not ready in time.

/* Playback 4 files seamless continuously. */
mwPlyEntryFname(mwply, "movie1.sfd");
mwPlyEntryFname(mwply, "movie2.sfd");
mwPlyEntryFname(mwply, "movie3.sfd");
mwPlyEntryFname(mwply, "movie4.sfd");
mwPlyStartSeamless(mwply);                   /* Start */
mwPlyReleaseSeamless(mwply);                 /* Notify end entry */

mwply : Middleware playback handle

None

None

Starts seamless continuous playback by file list.

(a) mwPlyGetTime() function's return-value means total playback time.

(b) The playback is terminated in limit time, even if the playback is in mid-flow. About limit time, please refer to mwPlySetLimitTime, mwPlyGetLimitTime functions.

(c) By mwPlyReleaseLp() function, the playback is terminated at end of stream.

(d) If movie's total time is vely short (ex. below 2 second), the playback could be not smoothly because reading file is not ready in time.

(e) This function can't use infinite single loop playback.

refer mwPlyEntryFname function.

mwply : Middleware playback handle

None

None

Terminate filelist for continuous playback.

After all file listed was played, the playback is termination.

refer mwPlyEntryFname function.

mwply : Middleware playback handle

flg : flag (1: loop ON, 0: loop OFF)

None

None

Set a loop playback of files witch is registered on continuous playback.

mwPlyEntryFname(mwply, "file01.sfd");
mwPlyEntryFname(mwply, "file02.sfd");
mwPlyEntryFname(mwply, "file03.sfd");
mwPlySetSeamlessLp(mwply, ON);
mwPlyStartSeamless(mwply);

mwply : Middleware playback handle

None

The number of file listed

Get The number of file listed for continuous playback at now.

/* Get num entry files and file name */
num_entry = mwPlyGetNumSlFiles(mwply);
for (i = 0; i < num_entry; i++) {
    printf("%s\n", mwPlyGetSlFname(mwply, i));
}

mwply : Middleware playback handle

stm_no : Ordinal number which is relative from reading file now

None

File name

Get the file name in file list. "stm_no" of now reading file is zero.

refer mwPlyGetNumSlFiles function.

mwply : Middleware playback handle

patid : partition ID

fid : faile ID

None

None

Add file to continuous play list by file ID in AFS file.

Refer to mwPlyEntryFname() function's Remarks.

mwply : Middleware playback handle

fname : File name that includes Sofdec data.

offset_sct : Offset of Sofdec data in file [sector]

range_sct : Size of Sofdec data [sector]

None

None

Add filename to continuous play list by range in file.

(a) Assigned file name is deleted from file list after the file was played.

(b) Before start playback, can add some files. If the playback is in mid-flow, can add filename.

(c) If file is added to file list, the playback could be not smoothly because reading file is not ready in time.

mwply : Middleware playback handle

vol : Output volume (Minimun value is ?796, Maximum value is 0)

None

None

Set audio channel number in the multiple audio stream.

mwply : Middleware playback handle

None

Output volume (Minimun value is ?796, Maximum value is 0)

Get current audio volume.

mwply : Middleware playback handle

chno : Channel number (MWSFD_CH_L / MWSFD_CH_R)

pan : Output pan value (-15 to 15)

None

None

Set output pan in each channel.

mwply : Middleware playback handle

chno : Channel number (MWSFD_CH_L / MWSFD_CH_R)

None

Output pan value (-15 to 15)

Get current audio pan in each channel.

mwply : Middleware playback handle

None

The number of audio channel streams.

Get the number of audio channel streams in SFD file.

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

mwply : Middleware playback handle

ch : Channel number (Minimun value is 0)

None

None

Set audio channel number in the multiple audio stream.

mwply : Middleware playback handle

None

Channel number

Get audio channel number playing now.

None

None

size of work buffer for AHX

Get size of work buffer for AHX

mwply : Middleware playback handle

wkptr : pointer of work buffer

wksize : size of work buffer

ch : channel number of AHX stream

None

None

Attach AHX.

mwply : Middleware playback handle

None

None

Detach AHX.

mwply : Middleware playback handle

ch : channel number of AHX

None

None

Set channel number of AHX.

mwply : Middleware playback handle

bufptr : pointer of user's buffer

bufsize : size of user's buffer [byte]

sbtprm : Subtitle parameter

1 : Got subtitle data on time

other : Didn't get subtitle data

This function copies subtitle to user's buffer and get subtitle parameter.

While subtitle's duration time of display, this function get same data repeatedly.

For use, please set MWSFD_COMPO_AUTO to composition mode of MWPLY handle.

mwply : Middleware playback handle

chno : channel number of subtitle data

None

None

Set channel of subtitle data

mwply : Middleware playback handle

None

The number of subtitle channel.

Get the number of subtitle channel in SFD file.

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

mwply : Middleware playback handle

scount : shift time count (sec = scount / tunit)

None

None

Set shift time of subtitle data

mwply : Middleware playback handle

pitch : width of output buffer (Byte)

height : height of output buffer (Byte)

None

None

Set size of output buffer.

mwply : Middleware playback handle

pitch : width of output buffer (Byte)

height : height of output buffer (Byte)

None

Get size of output buffer.

If unset condition, this function's return-value is "MWSFD_DFL_OUTBUFSIZE".

mwply : Middleware playback handle

mode : composition mode

None

None

Set composition mode.

mwply : Middleware playback handle

None

Composition mode

Get composition mode.

mwply : Middleware playback handle

in_th : transparence in-threshold (min: 0 max: 255)

out_th : transparence out-threshold (min: 0 max: 255)

key : transparence key

None

None

Set luminance key alpha parameter.

mwply : Middleware playback handle

in_th : transparence in-threshold (min: 0 max: 255)

out_th : transparence out-threshold (min: 0 max: 255)

key : transparence key

None

Get luminance key alpha parameter.

mwply : Middleware playback handle

zero : alpha value (0~255) for transparence pixels

half : alpha value (0~255) for translucence pixels

full : alpha value (0~255) for opaque pixels

None

None

Set alpha 3-value parameter.

Please use to adjust translucence pixels.

Alpha 3-value movie was encoded based on transparence/translucence/opaque pixcels.

If you change alpha vlue of transparence/opaque pixels extremely, NOISE may be occured.

mwply : Middleware playback handle

zero : alpha value (0~255) for transparence pixels

half : alpha value (0~255) for translucence pixels

full : alpha value (0~255) for opaque pixels

None

Get alpha 3-value parameter.

mwply : Middleware playback handle

frm : Frame Information

zout : Z-buffer pointer

None

Convert to 16bit-Z format from decoded frame.

mwply : Middleware playback handle

frm : Frame Information

zout : Z-buffer pointer

None

Convert to 32bit-Z format from decoded frame.

mwply : Middleware playback handle

znear : Z-near value

zfar : Z-far value

None

None

Set Z-clip to MWPLY handle.

mwply : Middleware playback handle

znear : Z-near value

zfar : Z-far value

None

Get Z-clip assigned in MWPLY handle.

mwply : Middleware playback handle

func : function to make Z conversion table

None

None

Normally do not call this function.

Set callback function for making z table.

mwply : Middleware playback handle

F/X type

Get F/X type in Sofdec data.

This function can get following F/X type.

- MWSFD_COMPO_OPAQ : Opaque

- MWSFD_COMPO_ALPHFULL : Full-Alpha

- MWSFD_COMPO_ALPH3 : 3value-Alpha

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

buf : Address of data

bsize : Size of data

hdrinf : file header information structure

None

Analyze the SFD file.

Please input the top 20 Kbyte of SFD file on memory.

mwply : Middleware playback handle

None

The number of movie frame

Get the number of movie frame

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

for (;;) {
    MwsfdFrmObj frm;
    /* Main Loop */
    ADXM_ExecMain();
    if (mwPlyGetStat(mwply) == MWSFD_STAT_PLAYING) {
        numfrm = mwPlyGetTotalFrmNum(mwply);
    }
    mwPlyGetCurFrm(mwply, &frm);
    if (frm.bufadr != NULL) {
        /* Conversion of frame */
        /* Transfer texture to VRAM */
        UsrLoadMvFrmFx(mwply, &frm);
        mwPlyRelCurFrm(mwply);
    }
    UsrDrawMv();
}

mwply : Middleware playback handle

hdrinf : file header information structure

None

Get movie header info from playing movie file.

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

This function can get only information from SFD file.

mwply : Middleware playback handle

mallocfn : malloc function

freefun : free function

obj : argument of malloc / free function

None

None

The work buffer of a MWPLY handle is securable using registered Malloc / free function. A work buffer is secured by two or more times of Malloc.

The memory secured at the time of handle creation is released at the time of handle destruction.

When you use the registered function, it is a parameter at the time of handle creation, and please make a buffer address of creation parameter into NULL.

The registered function is used only within mwPlyCreateSofdec() and mwPlyDestroy().

mwply : Middleware playback handle

speed : Playback speed (1000 = x1 speed)

None

None

Set speed of playback.

Playback speed depends on load average of decoding movie. Therefore actual playback speed is not necessarily correspond to setting speed.

mwply : Middleware playback handle

mode : synchronization mode

None

None

Set synchronization mode.

If you change the syncmode, please call this function before start playback.

Default mode is the following.

In the case of MWSFD_FTYPE_VONLYSFD, default mode is MWSFD_SYNCMODE_VSYNC, even if SFD file contained audio.

mwply : Middleware playback handle

None

MWSFD_SYNCMODE_~ : synchronization mode macro

Get synchronization mode.

chno : timer channel

None

None

Set timer channel.

If you don't use timer, please set -1 as channel number.

None

None

The number of timer channel.

-1 : No use timer

Get the number of timer channel

mwply : Middleware playback handle

bufptr : Pointer to user data in picture layer

bufsize : Data size of user data in picture layer

size1pic : Maximum user data size per 1 picture

None

None

buffer setting function to get user data in each frame.

After setting, some value would be set to member usrdatptr, usrdatsize of structure MwsfdFrmObj which is acquired by mwPlyGetCurFrm().

If size of user data exceeds size1pic, you can not refer to user data exceeded size1pic.

Sofdec CRAFT does not have function to fill in user data.

mwply : Middleware playback handle

frmsync : frame obtain synchronization mode

None

None

Set frame obtain synchronization mode.

Default mode is no synchronization.

mwply : Middleware playback handle

None

MWSFD_FRMSYNC_~ : frame obtain synchronization mode macro

Get frame obtain synchronization mode.

mwply :Middleware playback handle

extclock_fn :External clock function

extclock_max :The maximum namber of clock value (In the case fo 8bit: 0x000000FF, 32bit:0xFFFFFFFF)

extclock_usrobj :User object (first argument of external clock function)

None

None

Set external clock callback function for MWSFD_SYNCMODE_EXTCLOCK mode.

The external clock callback need satisfy the following conditions.

- Return the value that always increases monotonously by the same pace.

- The overflow of the clock value must be larger more enough than the update time cycle. (The update time cycle is generaly Vsync.)

The external clock callback function is called at the following timing.

- If using ADX thread and auto update Sofdec time mode, then the callback function is called from Vsync thread.

- If not using ADX thread and auto update Sofdec time mode, then the callback function is called from ADXM_ExecMain function.

- If not auto update Sofdec time mode, then the callback function is called from mwPlyUpdateTime function.

If latest clock value is less than previous one, Sofdec library assume overflow of clock value.

When the overflow occurred, Sofdec library compensates the clock value : clock value = latest value - previous value + clock_max + 1.

mwply :Middleware playback handle

sw : mode switch (ON = use auto update time, OFF = not use auto update time)

None

None

Set auto update time mode.

The default mode is ON (use auto update time).

If you change the mode, please call this function before start playback.

When not use auto update time mode, the application need to call mwPlyUpdateTime function for update time.

For example, this function is used when Vsync thread of ADX can't synchronize with main loop.

When use auto update time mode , updating time is executed at the following timing.

- If using ADX thread, updating is executed in Vsync thread of ADX.

- If not using ADX thread, updating is executed in ADXM_ExecMain function.

You can use ADX thread when you call ADXM_SetupThread or ADXM_SetupFramework function before initialization of ADX/Sofdec.

mwply:Middleware playback handle. If you use NULL, it is for all handles.

None

None

Update Sofdec time.

If you use not auto update time mode by mwPlySetUpdateTimeAuto function, please call this function once per main loop.

Please call this function at the same timing in vsync (ex. after wait vsync).

If you use auto update time mode, this function don't update time.

None

None

Pointer of version string

Get Sofdec library version number string.

mwply : Middleware playback handle

sec : playback's time limit[second]

None

None

Set limit time of playback.

The playback(simple, seamless loop, seamless concatenation) is terminated in limit time, even if the playback is in mid-flow.

playback limit time depends on following condition.

- Vsync frequency (one of handle creation parameter)

- with or without audio

- frame rate of the movie

You can't set limit time over the default limit.

Typical playback limit time is follows.

- 29.97fps frame rate movie without audio

   59.94Hz :  99hrs 31min 11sec

   50.00Hz : 119hrs 18min 15sec

   60.00Hz :  99hrs 25min 12sec

- movie with audio

   59.94Hz :   9hrs 57min 06sec

   50.00Hz :  11hrs 55min 48sec

   60.00Hz :   9hrs 56min 30sec

Generally playback limit time without audio is about 10 times longer than with audio except 23.976fps that is about 4 times longer.

Playback limit time can be got by mwPlyGetLimitTime function after changing to PLAYING state.

mwply : Middleware playback handle

None

The limit time [msec].

Get limit time of playback.

Please call this function after the handle status transit to PLAYING.

About limit time, please refer to mwPlySetLimitTime function.

mwply : Middleware playback handle

plyinf : playback information structure

None

Get statistic playback information.

Each information as below is obtainable.

(a) Count of drop frame ; mwPlyGetNumDropFrm

(b) Count of decode frame skip ; mwPlyGetNumSkipDec

(c) Count of display frame skip ; mwPlyGetNumSkipDisp

(d) Count of empty-B picture skip ; mwPlyGetNumSkipEmptyB

Difference of return value of above function are as follows.

(yes = obtainable, no = is not obtainable)

mwply : Middleware playback handle

None

The total number of frames decoded.

Get the total number of frames docoded in the playback.

mwply : Middleware playback handle

None

The number of frames pooled.

Get the number of frames pooled which is docoded.

After last frame was released, this function return -1.

mwply : Middleware playback handle

None

The number of dropped frames.

Get the number of decoding skip.

In setting skip empty-B picture, this function's return-value doesn't contain the count of empty-B picture.

mwply : Middleware playback handle

None

The number of skipped frame to decode.

Get the total number of decoding skip.

This counter is increased by a frame that does not finish decoding till it's time to display.

mwply : Middleware playback handle

None

The number of skipped frame to decode.

Get the total number of skipped frame to display.

This counter is increased by a frame that is not obtained till it's time to display.

mwply : Middleware playback handle

None

The number of skipped empty-B picture.

Get the number of skipped empty-B picture.

In setting skip empty-B picture, this function return 0.

mwply : Middleware playback handle

flowinf : data flow information

None

Get data flow information of system stream.

mwply : Middleware playback handle

sw : setting switch (ON: skip B-picture, OFF: don't skip B-picture)

None

None

Set switch skip B-picture decode.

mwply : Middleware playback handle

sw : setting switch (ON: skip empty-B, OFF: don't skip empty-B)

None

None

Set switch skip empty-B-picture decode.

mwply : Middleware playback handle

sw : setting switch (ON: skip P-picture, OFF: don't skip P-picture)

None

None

Set switch skip P-picture decode.

mwply : Middleware playback handle

None

ADXT handle

Get ADXT handle in MWPLY handle.

mwply : Middleware playback handle

None

SJ handle

Get input SJ handle in MWPLY handle.

mwply : Middleware playback handle

None

Video decoder handle

Get video decoder handle in MWPLY handle.

mwply : Middleware playback handle

None

the number of gettable new frames

This function get the number of gettable new frames. This number don't include frames which already application got.

If this function return 0, applicatin can not get next frame.

None

None

None

Change into idle thread, that is, Main thread is falling a sleep until next VSync.

If you use MWSFD Ver.3.30 or later, mwPlySwitchToIdle function is same ADXM_WaitVsync function.

Please substitute ADXM_WaitVsync function for user function that waits for Vsync.

None

None

TRUE : in server border

FALSE : not in server border

Determine whether process is in server border.

bufptr : decoder's output buffer address

width : width by number of pixels

height : height by number of pixels

ycc : YCbCr plane information

None

Calculate each of Y, Cb, Cr buffer pointer and width from decoder's output buffer address.

mwply : Middleware playback handle

sw : Audio output switch (ON=decode audio, OFF=skip to decode audio)

None

None

Set audio output switch in decoder level.

If you change the sudio switch, please call this function before start playback.

Mute OFF is realised by volume 0, mwPlySetOutVol(mwply, 0).

mwply : Middleware playback handle

None

The number of video channel streams.

Get the number of video channel streams in SFD file.

This function is enabled after that handle's status is MWSFD_STAT_PLAYING.

mwply : Middleware playback handle

ch : Channel number (Minimun value is 0)

None

None

Set audio channel number in the multiple video stream.

mwply : Middleware playback handle

None

Channel number

Get video channel number playing now.

mwply : Middleware playback handle

sw : Video output switch (ON=decode video, OFF=skip to decode video)

None

None

Set video output switch in decoder level.

mwply : Middleware playback handle

None

None

Execute MWSFD library's vsync process about only one MWPLY handle.

This function is not available.

mwply : Middleware playback handle

None

TRUE : server process request more execution.

FALSE : server process don't request more execution now.

Execute MWSFD library's server process about only one MWPLY handle.

Normally, Calling this funcition by application is prohibited.

None

None

TRUE : process for time update that should be done remains.

FALSE : process for time update has finished.

Appilication that does not use ADX thread function must call this function instead.

Normally do not call this function.

None

None

TRUE : process for decode that should be done remains.

FALSE : process for decode has finished.

Appilication that does not use ADX thread function must call this function instead.

Normally do not call this function.