// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

/**

 @file

 @publishedPartner

 @deprecated

*/

#ifndef _MP4LIB_H

#define _MP4LIB_H

#define MP4Handle mp4_i32*

#include <f32file.h>

#include <caf/caf.h>

#include <3gplibrary/mp4config.h>

/**

Provides async parse read observer.

*/

class M3GPMP4LibAsyncObserver

{

   public:

        /**

        Informs the client about asyncronous parse audio frames operation completion.

        @param aError     		Error code.

        @param aAudioSize		Size of the returned audio frames (in bytes).

        @param aTimeStamp 		Audio frame presentation time in milliseconds from the

                   				beginning of the audio sequence.

        @param aReturnedFrames	Number of frames returned, or 0 if not known.

        @param aTimestamp2		Audio frame presentation time in timescale from the

                   				beginning of the audio sequence

        */

        virtual void M3GPMP4LibAudioFramesAvailable(MP4Err aError,

        											mp4_u32 aAudioSize, 

        											mp4_u32 aTimeStamp, 

        											mp4_u32 aReturnedFrames,

 					                              	mp4_u32 aTimestamp2) = 0;    

        /**

        Informs the client about asyncronous parse video frame operation completion.

        @param aError     	Error code.

        @param aFrameSize   Size of the returned frame (in bytes).

        @param aTimeStamp   Video frame presentation time in milliseconds from the 

        					beginning of the video sequence

        @param aKeyFrame	Returns MP4TRUE if the current frame is a key frame (intra), 

        					otherwise the value is MP4FALSE

        @param aTimestamp2	Video frame presentation time in timescale from the beginning 

        					of the video sequence

        */

        virtual void M3GPMP4LibVideoFrameAvailable(MP4Err aError,

        										   mp4_u32 aFrameSize, 

        										   mp4_u32 aTimeStamp, 

        										   mp4_bool aKeyFrame, 

        										   mp4_u32 aTimestamp2) = 0;    

};

/**  

This class provides async temporary file deleting observer.

*/

class M3GPMP4LibAsyncTempFileRemoverObserver

{

   public:

        /**

        Informs the client about unused temporary file that can be deleted.

        @param tempFileName		Name of the temporary file that can be deleted.

                     			Ownership of the file name memory buffer is transferred.

        */

        virtual void M3GPMP4LibDeleteTempFileName( MP4FileName tempFileName ) = 0;    

};

#ifdef __cplusplus

extern "C" {

#endif

/**

Error codes returned by the library

*/

enum

	{

	/** Success */

  	MP4_OK,   

  	/** Generic error */                 

	MP4_ERROR,   

	/** Library can't allocate memory */              

	MP4_OUT_OF_MEMORY,   

	/** MP4 library needs more data before the

       requested information can be returned */      

	MP4_NOT_AVAILABLE,  

	/** The library has been opened with the input in a file */       

	MP4_FILE_MODE, 

	/** The input is not streamable */            

	MP4_NOT_STREAMABLE,

	/** Frame of requested type is not available */        

	MP4_NO_REQUESTED_FRAME, 

	/** Requested frame doesn't fit into the given buffer */   

	MP4_BUFFER_TOO_SMALL,

	/** No more video frames left */      

	MP4_END_OF_VIDEO,

	/** Can't seek to requested position */          

	MP4_CANT_SEEK,  

	/** Error in file handling */           

	MP4_FILE_ERROR,        

	/** Input stream is invalid */    

	MP4_INVALID_INPUT_STREAM, 

	/** Frame doesn't exist (previous frame was last) */ 

	MP4_NO_FRAME,   

	/** Illegal type */           

	MP4_INVALID_TYPE, 

	/** Timescale has not been set */         

	MP4_TIMESCALE_NOT_SET,

	/** Error writing metadata */     

	MP4_METADATA_ERROR,

	/** No video in input stream */        

	MP4_NO_VIDEO, 

	/** No audio in input stream */             

	MP4_NO_AUDIO,  

	/** Output buffer has not been initialized for buffer writing */             

	MP4_NO_OUTPUT_BUFFER, 

	/** Not enough space in output buffer to write to */      

	MP4_OUTPUT_BUFFER_TOO_SMALL,

	/** No UDTA data found */	

	MP4_UDTA_NOT_FOUND		 

	};

/** 

Possible data source types

*/

enum

	{

	/** Data is read from an RFile64 handle */

	MP4_SOURCE_RFILE,   

	/** Data is read via the CAF */        

	MP4_SOURCE_CAF,             

	};

/** 

Possible input/output values for audio/video type

*/

/** No audio or video */

#define MP4_TYPE_NONE              0x0000

/** Video Type. MPEG-4 video (MPEG-4 Part 2) - Simple and Advance Simple Profiles */

#define MP4_TYPE_MPEG4_VIDEO       0x0001

/** Audio Type.  MPEG-4 audio (MPEG-4 Part 3) */

#define MP4_TYPE_MPEG4_AUDIO       0x0002

/** Video Type. H263 Profile 0  */

#define MP4_TYPE_H263_PROFILE_0    0x0004

/** Video Type. H263 Profile 3  */

#define MP4_TYPE_H263_PROFILE_3    0x0008

/** Audio Type. AMR NB */

#define MP4_TYPE_AMR_NB            0x0010

/** Audio Type. AMR WB */

#define MP4_TYPE_AMR_WB            0x0020

/** Type not supported */

#define MP4_TYPE_UNSUPPORTED       0x0040

/** AVC baseline (MPEG-4 Part 10) */

#define MP4_TYPE_AVC_PROFILE_BASELINE      0x0080

/** AVC main (MPEG-4 Part 10) */

#define MP4_TYPE_AVC_PROFILE_MAIN          0x0100

/** AVC extended (MPEG-4 Part 10) */

#define MP4_TYPE_AVC_PROFILE_EXTENDED      0x0200

/** QCELP 13K additions */

#define MP4_TYPE_QCELP_13K         0x0400

/** AVC high (MPEG-4 Part 10) */

#define MP4_TYPE_AVC_PROFILE_HIGH      0x0800

/**

Flags used by composer

*/

/** No special setup */

#define MP4_FLAG_NONE              0x0000

/** Meta data is placed at end of file */

#define MP4_FLAG_METADATALAST      0x0001

/** Collect metadata in files instead of storing it in memory */

#define MP4_FLAG_LONGCLIP          0x0002

/** Generate a 3G2 File instead of a 3GP File */

#define MP4_FLAG_GENERATE_3G2      0x0004

/** Generate a MP4 File instead of a 3GP File */

#define MP4_FLAG_GENERATE_MP4      0x0008

/** Use large output buffers for writing */

#define MP4_FLAG_LARGEFILEBUFFER   0x0010

/** Size of buf in MP4HandleStruct must be at least 128 bytes */

#define TMPBUFSIZE 128  

/** Duration of one AMR frame is 20 ms */         

#define AUDIO_FRAME_DURATION 20  

#define MP4FALSE (mp4_bool)0

#define MP4TRUE  (mp4_bool)1

/** 

Possible locations for user data atom (UDTA)

*/

/** No user data */

#define MP4_UDTA_NONE         0x0000

/** User data resides within the Movie Box */

#define MP4_UDTA_MOOV         0x0001

/** User data resides within the Track Box for video */

#define MP4_UDTA_VIDEOTRAK    0x0002

/** User data resides within the Track Box for audio */

#define MP4_UDTA_AUDIOTRAK    0x0004

/**

Initializes the MP4 composing operation. The instance handle of the library is 

set by the function.

The possible values of type parameter are

     MP4_TYPE_H263_PROFILE_0

     MP4_TYPE_H263_PROFILE_3

     MP4_TYPE_MPEG4_VIDEO

     MP4_TYPE_AMR_NB

     MP4_TYPE_AMR_WB

     MP4_TYPE_MPEG4_AUDIO

     MP4_TYPE_NONE

     MP4_TYPE_AVC_PROFILE_BASELINE 

     MP4_TYPE_AVC_PROFILE_MAIN

     MP4_TYPE_AVC_PROFILE_EXTENDED

	 MP4_TYPE_AVC_PROFILE_HIGH

     MP4_TYPE_QCELP_13K

In addition, any combination of one video and one audio type are

possible. For example

     MP4_TYPE_H263_PROFILE_0 | MP4_TYPE_AMR_NB

The output file is placed in the current working directory if no path is

specified. The type of filename is dependent on the architecture. When

compiling in Symbian OS, this is a unicode string.

@param handle		MP4 library handle

@param filename	Name of the output MP4 file

@param type		Type of the output file

@return	MP4_OK             Success

 			MP4_ERROR          Generic error

 			MP4_FILE_ERROR     Error opening file

 			MP4_OUT_OF_MEMORY  Out of memory

*/

extern IMPORT_C MP4Err MP4ComposeOpen(MP4Handle *handle, MP4FileName filename, mp4_u32 type);

/**

This function initializes the MP4 composing operation. The instance

handle of the library is set by the function.

The possible values of type parameter are

 	 MP4_TYPE_H263_PROFILE_0

     MP4_TYPE_H263_PROFILE_3

     MP4_TYPE_MPEG4_VIDEO

     MP4_TYPE_AMR_NB

     MP4_TYPE_AMR_WB

     MP4_TYPE_MPEG4_AUDIO

     MP4_TYPE_NONE

     MP4_TYPE_AVC_PROFILE_BASELINE 

     MP4_TYPE_AVC_PROFILE_MAIN

     MP4_TYPE_AVC_PROFILE_EXTENDED

	 MP4_TYPE_AVC_PROFILE_HIGH

     MP4_TYPE_QCELP_13K

In addition, any combination of one video and one audio type are possible. For example

     MP4_TYPE_H263_PROFILE_0 | MP4_TYPE_AMR_NB

The output is placed in the buffer given as argument. 

Size of composed data is in composedSize variable.

@param handle	       MP4 library handle

@param type           Type of the output file

@param composeBuffer  Buffer to write to.

@param composedSize   Size of composed data.

@return 

   MP4_OK                 Success

   MP4_ERROR              Generic error

   MP4_FILE_ERROR         Error opening file

   MP4_OUT_OF_MEMORY      Out of memory

   MP4_NO_OUTPUT_BUFFER   No composed buffer 

*/

extern IMPORT_C MP4Err MP4ComposeOpenToBuffer(MP4Handle *handle, mp4_u32 type, mp4_u8* composeBuffer, mp4_u32 *composedSize);

/** 

This function initializes the MP4 composing operation to existing file handle. The instance

handle of the library is set by the function.

NOTE: MP4_FLAG_METADATALAST must be defined in MP4ComposeSetFlags if MP4ComposeOpenFileHandle is used!

The possible values of type parameter are

     MP4_TYPE_H263_PROFILE_0

     MP4_TYPE_H263_PROFILE_3

     MP4_TYPE_MPEG4_VIDEO

     MP4_TYPE_AMR_NB

     MP4_TYPE_AMR_WB

     MP4_TYPE_MPEG4_AUDIO

     MP4_TYPE_NONE

     MP4_TYPE_AVC_PROFILE_BASELINE 

     MP4_TYPE_AVC_PROFILE_MAIN

     MP4_TYPE_AVC_PROFILE_EXTENDED

	 MP4_TYPE_AVC_PROFILE_HIGH

     MP4_TYPE_QCELP_13K

In addition, any combination of one video and one audio type are possible. For example

      MP4_TYPE_H263_PROFILE_0 | MP4_TYPE_AMR_NB

The output file is placed in the current working directory if no path is

specified. The type of filename is dependent on the architecture. When

compiling in Symbian OS, this is a unicode string.

@param handle             MP4 library handle

@param composedfile       File handle to output file

@param metadataTempDrive  If MP4ComposeSetFlags() is configured to use temporary files for metadata

                          (MP4_FLAG_LONGCLIP) this is way to tell library which drive to use for 

                          temporary files.

@param type               Type of the output file

@return     MP4_OK             Success

            MP4_ERROR          Generic error

            MP4_FILE_ERROR     Error opening file

            MP4_OUT_OF_MEMORY  Out of memory

*/

extern IMPORT_C MP4Err MP4ComposeOpenFileHandle(MP4Handle *handle, RFile *composedfile, TDriveNumber metadataTempDrive, mp4_u32 type);

/** 

This function initializes the MP4 composing operation to existing file handle. The instance

handle of the library is set by the function.

NOTE: MP4_FLAG_METADATALAST must be defined in MP4ComposeSetFlags if MP4ComposeOpenFileHandle is used!

The possible values of type parameter are

  	 MP4_TYPE_H263_PROFILE_0

     MP4_TYPE_H263_PROFILE_3

     MP4_TYPE_MPEG4_VIDEO

     MP4_TYPE_AMR_NB

     MP4_TYPE_AMR_WB

     MP4_TYPE_MPEG4_AUDIO

     MP4_TYPE_NONE

     MP4_TYPE_AVC_PROFILE_BASELINE 

     MP4_TYPE_AVC_PROFILE_MAIN

     MP4_TYPE_AVC_PROFILE_EXTENDED

	 MP4_TYPE_AVC_PROFILE_HIGH

     MP4_TYPE_QCELP_13K

In addition, any combination of one video and one audio type are possible. For example

      MP4_TYPE_H263_PROFILE_0 | MP4_TYPE_AMR_NB

The output file is placed in the current working directory if no path is

specified. The type of filename is dependent on the architecture. When

compiling in Symbian OS, this is a unicode string.

@param handle             MP4 library handle

@param composedfile       File handle to output file

@param metadataTempDrive  If MP4ComposeSetFlags() is configured to use temporary files for metadata

						  (MP4_FLAG_LONGCLIP) this is way to tell library which drive to use for 

  						  temporary files.

@param type               Type of the output file

@return		MP4_OK             Success

 			MP4_ERROR          Generic error

 			MP4_FILE_ERROR     Error opening file

 			MP4_OUT_OF_MEMORY  Out of memory

*/

extern IMPORT_C MP4Err MP4ComposeOpenFileHandle64(MP4Handle *handle, RFile64 *composedfile, TDriveNumber metadataTempDrive, mp4_u32 type);

/**

This function closes the MP4 composing operation. It frees the memory

allocated by the library instance and closes the output MP4 file.

It is necessary to call this function before the output file is

guaranteed to be a valid MP4 file even though the file may exist prior to

the call.

The library handle is not valid after this call.

@param handle   MP4 library handle

@return		MP4_OK              Success

 			MP4_ERROR           Generic error

 			MP4_METADATA_ERROR  Metadata could not be written

*/

extern IMPORT_C MP4Err MP4ComposeClose(MP4Handle handle);

/**

This function is used to inform the MP4 library about the video data. The

data given to the library is inserted into the MP4 file headers.

The parameter timescale indicates the timescale of the video data

to be inserted. Timescale tells how many units of time pass in one second.

Note: Timescale should be chosen so that the duration of each sample is

an integer. Timescale should also be chosen so that the duration

of the presentation fits into 32 bits.

@param handle   	MP4 library handle

@param timescale    Timescale of video

@param width        Video width

@param height       Video height

@param maxbitrate   Maximum bitrate of video

@param avgbitrate   Average bitrate of video

@return		MP4_OK       Success

 			MP4_ERROR    Generic error

*/

extern IMPORT_C MP4Err MP4ComposeAddVideoDescription(MP4Handle handle, mp4_u32 timescale, mp4_u16 width, mp4_u16 height, mp4_u32 maxbitrate, mp4_u32 avgbitrate);

/**

This function is used to inform the MP4 library about the audio data. The

data given to the library is inserted into the MP4 file headers.

The parameter timescale indicates the timescale of the audio data

to be inserted. Timescale tells how many units of time pass in one second.

Note: timescale must be smaller than 65536.

Note: audioFramesPerSample and modeSet are needed only for AMR audio.

@param handle                MP4 library handle

@param timescale             Timescale of audio

@param audioFramesPerSample  AMR frames per sample

@param modeSet               AMR mode set

@return		MP4_OK     Success

 			MP4_ERROR  Generic error

*/

extern IMPORT_C MP4Err MP4ComposeAddAudioDescription(MP4Handle handle, mp4_u32 timescale, mp4_u8 audioFramesPerSample, mp4_u16 modeSet);

/**

This function writes one video frame to the MP4 composer library.

The frames must be inserted in causal order. Because the library doesn't

analyze the video bitstream, the frames can't be retrieved from the

resulting MP4 file correctly if they are not in proper order.

The data is available in the MP4 output file only after calling

MP4ComposeClose. MP4ComposeClose is called exactly once when all audio

and video data has been inserted into the library.

@param handle       MP4 library handle

@param buffer       Video frame data

@param framesize    Size of the video frame in bytes

@param duration     Duration of video frame (in timescale,

                 	see MP4ComposeAddVideoDescription)

@param keyframe     Flag to indicate whether this frame is a keyframe

@return		MP4_OK					Success

 			MP4_ERROR				Generic error

 			MP4_TIMESCALE_NOT_SET	Timescale has not been set

*/

extern IMPORT_C MP4Err MP4ComposeWriteVideoFrame(MP4Handle handle, mp4_u8 *buffer, mp4_u32 framesize, mp4_u32 duration, mp4_bool keyframe);

/**

This function writes audio frames to the MP4 composer library. The data is 

available in the MP4 output file only after calling

MP4ComposeClose. MP4ComposeClose is called exactly once when all audio

and video data has been insrted into the library.

For MPEG audio:

This function writes one MPEG audio frame to the MP4 composer library.

Note: numberofframes is meaningless with MPEG audio since only one frame

can be added with one call.

For other audio types:

This function writes a number of audio frames to the MP4 composer library. 

All audio frames inserted with one function call will be placed inside

one audio sample in the resulting file.

Note: Once this function is called with a certain numberofframes

parameter, it can't be changed. This is a limitation of the MP4 file

format. Only the last call can have a different number of frames if

their number is less than numberofframes.

@param handle          MP4 library handle

@param buffer          Audio data

@param bytestowrite    Number of bytes of audio data in buffer

@param numberofframes  Number of frames to write

@param duration        Duration of audio frames (in timescale,

	                   see MP4ComposeAddAudioDescription)

@return		MP4_OK             		Success

 			MP4_ERROR				Generic error

 			MP4_TIMESCALE_NOT_SET	Timescale has not been set

*/

extern IMPORT_C MP4Err MP4ComposeWriteAudioFrames(MP4Handle handle, mp4_u8 *buffer, mp4_u32 bytestowrite, mp4_u32 numberofframes, mp4_u32 duration);

/**

This function writes MPEG-4 or AVC video DecoderSpecificInfo data into the appropriate atom.

If the video type is MPEG-4 the DecoderSpecificInfo will be written into the esds atom. If the

video type is AVC (any profile) the DecoderSpecificInfo will be written into the avcC atom.

Note: This function needs to be called only when MPEG-4 or AVC video is used.

@param handle         MP4 library handle

@param info           Buffer containing DecoderSpecificInfo

@param infosize       Size of info in bytes