/*

* Copyright (c) 2010 Ixonos Plc.

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the "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:

* Ixonos Plc

*

* Description:  

*

*/

#ifndef __VEDMOVIEIMP_H__

#define __VEDMOVIEIMP_H__

#include <e32base.h>

#include <f32file.h>

#include "VedMovie.h"

#include "VedVideoClip.h"

#include "VedAudioClipInfoImp.h"

#include "AudObservers.h"

#include "AudCommon.h"

#include "Vedqualitysettingsapi.h"

#include "ctrtranscoder.h"

#if ( defined (__WINS__) || defined (__WINSCW__) )

const TInt KVEdMaxFrameRate = 10;

#else 

const TInt KVEdMaxFrameRate = 15;

#endif

/*

 *  Forward declarations.

 */

class CMovieProcessor;

class CVedMovie;

class CVedMovieImp;

class CVedMovieAddClipOperation;

class CVedMovieProcessOperation;

class CAudSong;

class CVedCodecChecker;

/**

 * Video movie, which consists of zero or more video clips and zero or more audio clips.

 *

 * @see  CVedVideoClip

 * @see  CVedAudioClip

 */

class CVedMovieImp : public CVedMovie, MAudSongObserver, MVedAudioClipInfoObserver

    {

public:

    /* Constructors. */

    CVedMovieImp(RFs *aFs);

    void ConstructL();

    /**

     * Destroys the object and releases all resources.

     */

    ~CVedMovieImp();

    /* Property methods. */

    /**

     * Returns the quality setting of this movie.

     *

     * @return  quality setting of this movie

     */

    TVedMovieQuality Quality() const;

    /**

     * Sets the quality setting of this movie.

     *

     * @param aQuality  quality setting

     */

    void SetQuality(TVedMovieQuality aQuality);

    /**

     * Returns the video format of this movie. 

     * 

     * @return  video format of this movie

     */

    TVedVideoFormat Format() const;

    /**

     * Returns the video type of this movie. 

     * 

     * @return  video type of this movie

     */

    TVedVideoType VideoType() const;

    /**

     * Returns the resolution of this movie. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no clips 

     * in the movie.

     * 

     * @return  resolution of the movie

     */

    TSize Resolution() const;

    /**

     * Returns the recommended maximum framerate of this movie..

     * <p>

     * Note that the returned maximum framerate is a recommendation,

     * not a guarantee. For example, the video clip generators inserted

     * in this movie should not generate frames at higher framerates 

     * than the recommendation. The movie may, however, exceed this

     * recommendation. For example, the framerate may be higher if the 

     * framerates of some of the video clips are higher than the 

     * recommendation and it is not possible to transcode them to reduce 

     * the framerate.

     *

     * @return  maximum framerate in frames per second

     */

    TInt MaximumFramerate() const;

    /**

     * Returns the audio type of the movie audio track.

     * 

     * @return  audio type of the movie audio track

     */

    TVedAudioType AudioType() const;

    /**

     * Returns the audio sampling rate of the movie audio track.

     *

     * @return  audio sampling rate of the movie audio track.

     */

    TInt AudioSamplingRate() const;

    /**

     * Sets the output parameters for the movie. Leaves

     * with KErrNotSupported if a parameter is illegal,

     * e.g., target bitrate is too high for the given 

     * codec. This method overrides the SetQuality method

     *

     * Possible leave codes:

     *  - <code>KErrNotSupported</code> if setting is not valid

     *

     * @param Output parameters

     */

    virtual void SetOutputParametersL(TVedOutputParameters& aOutputParams);

    /**

     * Returns the audio channel mode of the movie audio track.

     * 

     * @return  audio channel mode of the movie audio track.

     */

    TVedAudioChannelMode AudioChannelMode() const;

    /**

     * Returns the audio bitrate mode of the movie audio track.

     *

     * @return audio bitrate mode

     */

    TVedBitrateMode AudioBitrateMode() const;

    /**

     * Returns the target bitrate of the movie audio track.

     * 

     * @return  target bitrate of the movie audio track.

     */

    TInt AudioBitrate() const;

    /**

     * Returns the required bitrate of the movie video track.

     * If nonzero, indicates real target bitrate => requires transcoding

     * 

     * @return  Requested bitrate of the movie video track.

     */

    TInt VideoBitrate() const;

    /**

     * Returns the "standard" or default bitrate of the movie video track.

     * If input is something else, no transcoding is needed, but new content 

     * is encoded using this rate. If there is also requested bitrate, the values 

     * should be the same. The "standard" does not necessarily mean the bitrate

     * is from video coding standard, it can be, but it can be also something else,

     * depending on the product variant.

     * 

     * @return  Standard bitrate of the movie video track.

     */

    TInt VideoStandardBitrate() const;

    /**

     * Returns the target framerate of the movie video track.

     * 

     * @return  target framerate of the movie video track.

     */

    TReal VideoFrameRate() const;

    /**

     * Returns the total duration of this movie.

     * 

     * @return  duration in microseconds

     */

    inline TTimeIntervalMicroSeconds Duration() const;

    /**

     * Returns an estimate of the total size of this movie.

     * 

     * @return  size estimate in bytes

     */

    TInt GetSizeEstimateL() const;

    /**

     * Estimates end cutpoint with given target size and start cutpoint for current movie.

     *

     * @param aTargetSize  Target filesize for section indicated by aStartTime and aEndTime.

     * @param aStartTime   Start time for first frame included in cutted section. 

     * @param aEndTime     On return contains estimated end time with given start time and section target filesize.

     */

    void GetDurationEstimateL(TInt aTargetSize, TTimeIntervalMicroSeconds aStartTime, TTimeIntervalMicroSeconds& aEndTime);

    /**

     * Returns whether movie properties meet MMS compatibility

     * 

     * @return  ETrue if MMS compatible, else EFalse

     */

    TBool IsMovieMMSCompatible() const;

    /* Video clip management methods. */

    /**

     * Returns the number of video clips in this movie.

     *

     * @return  number of video clips

     */

    inline TInt VideoClipCount() const;

    /** 

     * Returns the video clip at the specified index. 

     * Used by underlying modules and friend classes. Not part of public API.

     * Panics with code <code>USER-130</code> if the clip index is invalid.

     *

     * @param aIndex  index

     *

     * @return  clip at the specified index.

     */ 

    CVedVideoClip* VideoClip(TInt aIndex) const;

    /** 

     * Inserts the specified video clip to the specified index in this movie. 

     * The observers are notified when the clip has been added or adding clip 

     * has failed. Panics with <code>EMovieAddOperationAlreadyRunning</code> 

     * if another add video or audio clip operation is already running.

     * Panics with code <code>USER-130</code> if the clip index is invalid.

     *

     * Possible leave codes:

     *  - <code>KErrNoMemory</code> if memory allocation fails

     *

     * @param aFileName  file name of the clip to add

     * @param aIndex     index the clip should be inserted at

     */

    void InsertVideoClipL(const TDesC& aFileName, TInt aIndex);

    void InsertVideoClipL(CVedVideoClipGenerator& aGenerator, TBool aIsOwnedByVideoClip,

                          TInt aIndex);

    /** 

     * Removes the video clip at the specified index from this movie.

     * Panics with code <code>USER-130</code> if the clip index is invalid.

     *

     * @param aIndex  index of the clip to be removed

     */

    void RemoveVideoClip(TInt aIndex);

    /* Transition effect management methods. */

    /** 

     * Returns the start transition effect of this movie. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no video clips 

     * in the movie.

     *

     * @return  start transition effect

     */ 

    TVedStartTransitionEffect StartTransitionEffect() const;

    /** 

     * Sets the start transition effect of this movie. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no video clips 

     * in the movie.

     *

     * @param aEffect  start transition effect

     */ 

    void SetStartTransitionEffect(TVedStartTransitionEffect aEffect);

    /**

     * Returns the number of middle transition effects in this movie.

     * Note that this is the same as the number of video clips minus one.

     *

     * @return  number of middle transition effects

     */

    TInt MiddleTransitionEffectCount() const;

    /** 

     * Returns the middle transition effect at the specified index. 

     * Panics with code <code>USER-130</code> if the index is invalid.

     *

     * @param aIndex  index

     *

     * @return  middle transition effect at the specified index

     */ 

    TVedMiddleTransitionEffect MiddleTransitionEffect(TInt aIndex) const;

    /** 

     * Sets the middle transition effect at the specified index. 

     * Panics with code <code>USER-130</code> if the index is invalid.

     *

     * @param aEffect  middle transition effect

     * @param aIndex   index

     */ 

    void SetMiddleTransitionEffect(TVedMiddleTransitionEffect aEffect, TInt aIndex);

    /** 

     * Returns the end transition effect of this movie. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no video clips 

     * in the movie.

     *

     * @return  end transition effect

     */ 

    TVedEndTransitionEffect EndTransitionEffect() const;

    /** 

     * Sets the end transition effect of this movie. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no video clips 

     * in the movie.

     *

     * @param aEffect  end transition effect

     */ 

    void SetEndTransitionEffect(TVedEndTransitionEffect aEffect);

    /* Audio clip management methods. */

    /**

     * Returns the number of audio clips in this movie.

     *

     * @return  number of audio clips

     */

    TInt AudioClipCount() const;    

    /** 

     * Adds the specified audio clip to this movie. The observers are notified

     * when the clip has been added or adding clip has failed. Panics with 

     * <code>EMovieAddOperationAlreadyRunning</code> if another add video or

     * audio clip operation is already running.

     * 

     * Possible leave codes:

     *  - <code>KErrNoMemory</code> if memory allocation fails

     *

     * @param aFileName   file name of the clip to add

     * @param aStartTime  start time of the clip in movie timebase

     * @param aCutInTime  cut in time of the clip

     * @param aCutOutTime cut out time of the clip; or 

     *                    <code>KVedAudioClipOriginalDuration</code> to specify

     *                    that the original duration of the clip should be used

     */

    void AddAudioClipL(const TDesC& aFileName,

            TTimeIntervalMicroSeconds aStartTime,

            TTimeIntervalMicroSeconds aCutInTime,

            TTimeIntervalMicroSeconds aCutOutTime);

    /** 

     * Removes the audio clip at the specified index from this movie.

     * Panics with code <code>USER-130</code> if the clip index is invalid.

     *

     * @param aIndex  index of the clip to be removed

     */

    void RemoveAudioClip(TInt aIndex);

    /* Whole movie management methods. */

    /** 

     * Removes all video and audio clips and clears all transitions.

     */

    void Reset();

    /* Processing methods. */

    /**

     * Starts a video processing operation. This method is asynchronous and 

     * returns immediately. The processing will happen in the background and

     * the observer will be notified about the progress of the operation.

     * Processed data is written into the specified file. Panics with 

     * <code>TVedPanic::EMovieEmpty</code> if there are no clips 

     * in the movie.

     * 

     * Possible leave codes:

     *  - <code>KErrNoMemory</code> if memory allocation fails

     *  - <code>KErrAccessDenied</code> if the file access is denied

     *  - <code>KErrDiskFull</code> if the disk is full

     *  - <code>KErrWrite</code> if not all data could be written

     *  - <code>KErrBadName</code> if the filename is bad

     *  - <code>KErrDirFull</code> if the directory is full

     * 

     * @param aObserver  observer to be notified of the processing status

     * @param aFileName  name of the file to be written

     */

    void ProcessL(const TDesC& aFileName,

                           MVedMovieProcessingObserver& aObserver);

    /**

     * Cancels the current video processing operation. If there is no 

     * operation in progress, the function does nothing.

     */

    void CancelProcessing();

    /* Observer methods. */

    /**

     * Registers a movie observer. Panics with panic code 

     * <code>EMovieObserverAlreadyRegistered</code> if the movie observer is 

     * already registered.

     *

     * @param aObserver  observer that will receive the events

     */

    void RegisterMovieObserverL(MVedMovieObserver* aObserver);

    /**

     * Unregisters a movie observer.

     *

     * @param aObserver  observer to be unregistered

     */

    void UnregisterMovieObserver(MVedMovieObserver* aObserver);

    /* Video Clip Methods */

    /**

     * Returns a video clip info object to get detailed information about

     * the original video clip. Note that the specified editing operations 

     * (for example, cutting or muting audio) do <em>not</em>

     * affect the values returned by the info object.

     * 

     * @param aIndex  index of video clip in movie

     * @return  pointer to a video clip info instance

     */

    CVedVideoClipInfo* VideoClipInfo(TInt aIndex) const;

    /**

     * Returns whether this video clip with the specified editing operations 

     * applied (for example, changing speed or muting) has an audio track or not.

     *

     * @param aIndex  index of video clip in movie

     * @return  <code>ETrue</code> if clip has an audio track;

     *          <code>EFalse</code> otherwise

     */

    TBool VideoClipEditedHasAudio(TInt aIndex) const;

    /**

     * Sets the index of this video clip in the movie. 

     * Panics with code <code>EVideoClipIllegalIndex</code> 

     * if the clip index is invalid.

     *

     * @param aIndex  index of video clip in movie

     * @param aNewIndex  new index of this clip

     */

    void VideoClipSetIndex(TInt aOldIndex, TInt aNewIndex);

    /**

     * Returns the playback speed of this video clip. Playback speed is

     * specified as parts per thousand of the normal playback speed. For example.

     * 1000 means the normal speed, 750 means 75% of the normal speed, and so on.

     *

     * @param aIndex  index of video clip in movie

     * @return  playback speed

     */

    TInt VideoClipSpeed(TInt aIndex) const;

    /**

     * Sets the playback speed of this video clip. Playback speed is

     * specified as parts per thousand of the normal playback speed. For example.

     * 1000 means the normal speed, 750 means 75% of the normal speed, and so on.

     * Panics with <code>EVideoClipIllegalSpeed</code> if playback speed is

     * illegal.

     *

     * @param aIndex  index of video clip in movie

     * @param aSpeed  playback speed; must be between 1 and 1000

     */

    void VideoClipSetSpeed(TInt aIndex, TInt aSpeed);

    /**

     * Returns the color effect of this video clip.

     *

     * @param aIndex  index of video clip in movie

     * @return  color effect

     */

    TVedColorEffect VideoClipColorEffect(TInt aIndex) const;

    /**

     * Sets the color effect of this video clip.

     *

     * @param aIndex  index of video clip in movie

     * @param aColorEffect  color effect

     */

    void VideoClipSetColorEffect(TInt aIndex, TVedColorEffect aColorEffect);

    /**

     * Returns whether this video clip can be muted or not (that is,

     * whether the mute setting has any effect). For example, if

     * this video clip has no audio track, it can never have audio

     * even if the mute setting is false.

     *

     * @param aIndex  index of video clip in movie

     * @return  <code>ETrue</code> if this video clip can be muted;

     *          <code>EFalse</code> otherwise

     */

    TBool VideoClipIsMuteable(TInt aIndex) const;