# Mobiclip Library API Functions

##

### Types

Mobiclip Types

### Code and data relocation

MO_GetOptimalITCMSize | Retrieve the quantity in bytes of ITCM needed by Mobiclip to achieve optimal playback performance.
MO_GetOptimalDTCMSize | Retrieve the quantity in bytes of DTCM needed by Mobiclip to achieve optimal playback performance.
MO_InitITCMArea | Give to Mobiclip the address and size in bytes of the usable ITCM area.
MO_InitDTCMArea | Give to Mobiclip the address and size in bytes of the usable DTCM area.

### Initialization

MO_Malloc and MO_Free | Allocator/Deallocator functions.

### Open/Close

MO_OpenMovie | Open a Mobliclip movie from a file.
MO_CloseMovie | Close a Mobiclip movie.

### Retrieve information about movie

MO_GetVideoWidth | Get the width of the movie in pixels.
MO_GetVideoHeight | Get the height of the movie in pixels.
MO_GetVideoFps | Get the framerate of the movie.
MO_GetNbFrame | Get the number of frames of the movie.
MO_GetNbIFrame | Get the number of I-Frames (keyframe) in the movie.
MO_GetNbAudioTrack | Get the number of audio tracks in the movie.
MO_GetNbSamplePerAudioPacket | Get the number of samples of each audio packet stored in the movie.
MO_GetAudioFrequency | Get the frequency of the movie audio in Hertz.

### Playback

MO_ReadFrame | Read a movie frame.
MO_UnpackFrameImage | Unpack the image of a frame and puts it in the internal image frame FIFO.
MO_BlitFrameImage | Blit the oldest unpacked image from the internal FIFO into a user buffer and removes it from the FIFO.
MO_SkipFrameImage | Skip the oldest unpacked image, which means removes the oldest unpacked image from the internal FIFO without blitting it.
MO_BlitFrameSoundOnePacket | Blit a packet of the current unpacked sound to a user buffer.
MO_SkipFrameSoundOnePacket | Skip a packet of the current unpacked sound.
MO_GetCurrentFrameNumber | Get the current read frame number of the movie.
MO_GetFrameNbAudioPacket | Get the number of audio packets per track for the current frame.
MO_GetIFrameInfo | Get the frame number of an indexed I-frame (keyframe).
MO_JumpBeginning | Go to the beginning of the movie.
MO_JumpNextIframe | Go to the next movie I-frame (keyframe).
MO_JumpPreviousIframe | Go to the previous movie I-frame (keyframe).
MO_JumpToIframe | Go to an indexed I-frame (keyframe).