/*

* Copyright (c) 2008 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:

*

*/

#ifndef __NGAPOSTPROCHWDEVICE_H__

#define __NGAPOSTPROCHWDEVICE_H__

#include <e32std.h> 

#include <w32std.h>

#include <e32base.h>

#include <e32def.h>

#include <e32cmn.h>

#include <string.h>

#include <stdarg.h>

#include <mmf/devvideo/videoplayhwdevice.h>

#include <mmf/devvideo/devvideostandardcustominterfaces.h>

#include <mmf/devvideo/devvideovideosurfacecustominterface.h>

#include <graphics/surfacemanager.h> //RSurfaceManager

#include <graphics/surface.h> //TSurfaceId

#include <mmf/common/mmfvideo.h> //TVideoAspectRatio

#include <mmf/devvideo/devvideosurfacehandlecustominterface.h>

#include <mmf/devvideo/devvideoplayratecustominterface.h>  

#include <surface_hints.h>

#include <secureoutputci.h>

#include <advancedsecureoutputci.h>

#include <graphics/suerror.h>

#include "MdfRDebug.h"

#include "NGAPostProcHwDevice_UID.hrh"

#include "NGAPostProcSessionManagerObserver.h"

class CNGAPostProcSessionManager;

class CNGAPostProcSurfaceHandler;

class CNGAPostProcTimer;

class RWsSession;

class CNGAPostProcHwDevice: public CMMFVideoPostProcHwDevice,

							public MMmfVideoBufferManagement,

							public MNGAPostProcSessionManagerObserver,

							public MMMFVideoSurfaceSupport,

							public MMmfVideoPropertiesObserver,

							public MMmfVideoResourceObserver,

							public MMmfVideoSurfaceHandleControl,

							public MMmfVideoPropertiesNotifier,

							public MMmfVideoPlayRateControl,

							public MMmfVideoSecureOutput,

							public MMmfAdvancedVideoSecureOutput

{

public: 

    //  === Constructors and destructor ===

    /**

    * Two-phased constructor.   

    * @return pointer to an instance of CMMFVideoPostProcHwDevice

    */

    static CMMFVideoPostProcHwDevice* NewL();

    /**

    * Destructor.

    */

    ~CNGAPostProcHwDevice();

public: 

    // === CMMFVideoPostProcHwDevice ===

    /**

    Sets the device input format to an uncompressed video format.

    @param  "aFormat"   "The input format to use."

    @leave  "The method will leave if an error occurs. Typical error codes used:

            * KErrNotSupported - The input format is not supported."    

    @pre    "This method can only be called before the hwdevice has been initialized with Initialize()."

    */

    void SetInputFormatL(const TUncompressedVideoFormat& aFormat);

    /**

    Sets the decoder device that will write data to this post-processor. Decoded pictures will be 

    written with WritePictureL() or through a custom interface. After pictures have been processed, 

    they must be returned to the decoder using ReturnPicture().

    @param  "aDevice"   "The decoder source plug-in to use."

    @pre    "This method can only be called before the hwdevice has been initialized with Initialize()."

    */

    void SetInputDevice(CMMFVideoDecodeHwDevice* aDevice);

    /**

    Writes an uncompressed video picture to the post-processor. The picture must be returned to the 

    client or source plug-in after it has been used.

    @param  "aPicture"  "The picture to write."

    @leave  "This method may leave with one of the system-wide error codes."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void WritePictureL(TVideoPicture* aPicture);    

    /**

    Retrieves post-processing information about this hardware device. 

    The device creates a CPostProcessorInfo structure, fills it with correct data, pushes it 

    to the cleanup stack and returns it. The client will delete the object when it is no 

    longer needed.

    @return "Post-processor information as a CPostProcessorInfo object. 

            The object is pushed to the cleanup stack, and must be deallocated by the caller."

    @leave  "This method may leave with one of the system-wide error codes.

    */

    CPostProcessorInfo* PostProcessorInfoLC();

    /**

    Retrieves the list of the output formats that the device supports. The list is ordered in 

    plug-in preference order, with the preferred formats at the beginning of the list. The list 

    can depend on the device source format, and therefore SetSourceFormatL() must be called before 

    calling this method.

    @param "aFormats" "An array for the result format list. The array must be created and destroyed by the caller."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method may only be called before the hwdevice has been initialized using Initialize()."

    */

    void GetOutputFormatListL(RArray<TUncompressedVideoFormat>& aFormats);

    /**

    Sets the device output format.

    @param  "aFormat" "The format to use."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method may only be called before the hwdevice has been initialized using Initialize()."

    */

    void SetOutputFormatL(const TUncompressedVideoFormat &aFormat);

    /**

    Sets the clock source to use for video timing. If no clock source is set. video playback 

    will not be synchronized, but will proceed as fast as possible, depending on input data 

    and output buffer availability. 

    @param  "aClock" "The clock source to be used."

    @pre    "This method can only be called before the hwdevice has been initialized with Initialize()."

    */

    void SetClockSource(MMMFClockSource* aClock);

    /**

    Sets the device video output destination. The destination can be the screen (using direct 

    screen access) or memory buffers. By default memory buffers are used. If data is written 

    to another device, this method is ignored, and suitable memory buffers are always used.

    @param  "aScreen" "True if video output destination is the screen, false if memory buffers."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can only be called before the hwdevice has been initialized with Initialize()."

    */

    void SetVideoDestScreenL(TBool aScreen);

    /**

    Sets the post-processing types to be used.

    @param  "aPostProcCombination" "The post-processing steps to perform, a bitwise OR of values from TPostProcessType."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetPostProcessTypesL(TUint32 aPostProcCombination);

    /**

    Sets post-processing options for input (pan-scan) cropping.

    @param  "aRect" "The cropping rectangle to use."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetInputCropOptionsL(const TRect& aRect);

    /**

    Sets post-processing options for YUV to RGB color space conversion. 

    Specifies the input YUV and output RGB formats to use explicitly. SetSourceFormatL(), 

    SetOutputFormatL(), and SetPostProcessTypesL() must be called before this method is used.

    @param  "aOptions"      "The conversion options to use."

    @param  "aYuvFormat"    "Conversion source YUV format"

    @param  "aRgbFormat"    "Conversion target RGB format"

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetYuvToRgbOptionsL(const TYuvToRgbOptions& aOptions, const TYuvFormat& aYuvFormat, 

                                TRgbFormat aRgbFormat);

    /**

    Sets post-processing options for YUV to RGB color space conversion.

    Uses the device input and output formats. For decoder devices the default YUV format used is 

    the format specified in the input bitstream. SetSourceFormatL(), SetOutputFormatL(), and 

    SetPostProcessTypesL() must be called before this method is used.

    @param  "aOptions"      "The conversion options to use."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetYuvToRgbOptionsL(const TYuvToRgbOptions& aOptions);

    /**

    Sets post-processing options for rotation. SetPostProcessTypesL() must be called before 

    this method is used.

    @param  "aRotationType" "The rotation to perform."  

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetRotateOptionsL(TRotationType aRotationType);

    /**

    Sets post-processing options for scaling. SetPostProcessTypesL() must be called before 

    this method is used.

    @param  "aTargetSize"           "Scaling target size. If a fixed scale factor size is used, 

                                    the new dimensions must be set to width=floor(factor*width), 

                                    height=floor(factor*height). For example, scaling a 

                                    QCIF (176x144) picture up by a factor of 4/3 yields a size 

                                    of 234x192."

    @param  "aAntiAliasFiltering"   "True if anti-aliasing filtering should be used. 

                                    If the post-processor does not support anti-aliased scaling, 

                                    or supports anti-aliased scaling only, this argument is ignored."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetScaleOptionsL(const TSize& aTargetSize, TBool aAntiAliasFiltering);

    /**

    Sets post-processing options for output cropping. SetPostProcessTypesL() must be called before 

    this method is used.

    @param  "aRect" "Output cropping area."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetOutputCropOptionsL(const TRect& aRect);

    /**

    Sets post-processing plug-in specific options. SetPostProcessTypesL() must be called before 

    this method is used.

    @param  "aOptions" "The options. The format is plug-in specific."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can be called either before or after the hwdevice has been initialized with Initialize().

            If called after initialization, the change must only be committed when CommitL() is called."

    */

    void SetPostProcSpecificOptionsL(const TDesC8& aOptions);

    /**

    Initializes the device. This method is asynchronous, the device will call 

    MMFVideoPlayProxy::MdvppInitializeComplete() after initialization has completed. After this 

    method has successfully completed, further configuration changes are not possible except where 

    separately noted.

    */

    void Initialize();

    /**

    Commit all changes since the last CommitL(), Revert() or Initialize()

    to the hardware device.  This only applies to methods which can be called both

    before AND after DevVideoPlay has been initialized.

    @see    SetPostProcessTypesL

    @see    SetInputCropOptionsL

    @see    SetYuvToRgbOptionsL

    @see    SetRotateOptionsL

    @see    SetScaleOptionsL

    @see    SetOutputCropOptionsL

    @see    SetPostProcSpecificOptionsL

    @leave  "The method will leave if an error occurs."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void CommitL();

    /**

    Revert all changes since the last CommitL(), Revert() or Initialize()

    back to their previous settings.  This only applies to methods which can 

    be called both before AND after DevVideoPlay has been initialized.

    @see    SetPostProcessTypesL

    @see    SetInputCropOptionsL

    @see    SetYuvToRgbOptionsL

    @see    SetRotateOptionsL

    @see    SetScaleOptionsL

    @see    SetOutputCropOptionsL

    @see    SetPostProcSpecificOptionsL

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Revert();

    /**

    Starts writing output directly to the display frame buffer using Direct Screen Access.

    @param  "aVideoRect"    "The video output rectangle on screen."

    @param  "aScreenDevice" "The screen device to use. The screen device object must be valid in the current thread."

    @param  "aClipRegion"   "Initial clipping region to use."

    @leave  "This method may leave with one of the system-wide error codes.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void StartDirectScreenAccessL(const TRect& aVideoRect, 

        CFbsScreenDevice& aScreenDevice, const TRegion& aClipRegion);

    /**

    Sets a new clipping region for Direct Screen Access. After the method returns, no video will 

    be drawn outside of the region. If clipping is not supported, or the clipping region is too 

    complex, either playback will pause or will resume without video display, depending on the 

    current setting of SetPauseOnClipFail(), and the result can be verified with IsPlaying(). 

    Clipping can be disabled by setting a new clipping region that includes the whole video window.

    @param  "aRegion" "The new clipping region. After the method returns, no video will be drawn outside the region."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void SetScreenClipRegion(const TRegion& aRegion);

    /**

    Sets whether the system should pause playback when it gets a clipping region it cannot handle, 

    or Direct Screen Access is aborted completely. If not, processing will proceed normally, but no 

    video will be drawn. By default, playback is paused.

    @param "aPause" "True if playback should be paused when clipping fails, false if not. 

                    If playback is not paused, it will be continued without video display."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void SetPauseOnClipFail(TBool aPause);

    /**

    Aborts Direct Screen Access completely, to be called from MAbortDirectScreenAccess::AbortNow() 

    and similar methods. DSA can be resumed by calling StartDirectScreenAccessL().

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void AbortDirectScreenAccess();

    /**

    Indicates whether playback is proceeding. This method can be used to check whether playback was 

    paused or not in response to a new clipping region or DSA abort.

    @return "ETrue if video is still being played (even if not necessarily displayed)."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    TBool IsPlaying();

    /**

    Re-draws the latest video picture. Only available when DSA is being used. If DSA is aborted or a 

    non-supported clipping region has been set, the request may be ignored.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Redraw();

    /**

    Starts video playback, including decoding, post-processing, and rendering. Playback will proceed 

    until it has been stopped or paused, or the end of the bitstream is reached.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Start();

    /**

    Stops video playback. No new pictures will be decoded, post-processed, or rendered.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Stop();

    /**

    Pauses video playback, including decoding, post-processing, and rendering. No pictures will be 

    decoded, post-processed, or rendered until playback has been resumed.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Pause();

    /**

    Resumes video playback after a pause.

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void Resume();

    /**

    Changes to a new decoding and playback position, used for randomly accessing (seeking) the 

    input stream. The position change flushes all input and output buffers. Pre-decoder and 

    post-decoder buffering are handled as if a new bitstream was being decoded. If the device still

    has buffered pictures that precede the new playback position, they will be discarded. If playback

    is synchronized to a clock source, the client is responsible for setting the clock source to the 

    new position.

    @param "aPlaybackPosition" "The new playback position in the video stream."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void SetPosition(const TTimeIntervalMicroSeconds& aPlaybackPosition);

    /**

    Freezes a picture on the screen. After the picture has been frozen, no new pictures are 

    displayed until the freeze is released with ReleaseFreeze(). If the device output is being 

    written to memory buffers or to another plug-in, instead of the screen, no decoded pictures 

    will be delivered while the freeze is active, and they are simply discarded.

    @param "aTimestamp" "The presentation timestamp of the picture to freeze. The frozen picture 

                        will be the first picture with a timestamp greater than or equal to this 

                        parameter."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void FreezePicture(const TTimeIntervalMicroSeconds& aTimestamp);

    /**

    Releases a picture frozen with FreezePicture().

    @param "aTimestamp" "The presentation timestamp of the picture to release. The first picture 

                        displayed after the release will be the first picture with a timestamp 

                        greater than or equal to this parameter. To release the freeze immediately, 

                        set the timestamp to zero."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void ReleaseFreeze(const TTimeIntervalMicroSeconds& aTimestamp);

    /**

    Returns the current playback position, i.e. the timestamp for the most recently displayed or 

    virtually displayed picture. If the device output is written to another device, the most recent 

    output picture is used.

    @return "Current playback position."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    TTimeIntervalMicroSeconds PlaybackPosition();

    /**

    Returns the total amount of memory allocated for uncompressed pictures. This figure only 

    includes the pictures actually allocated by the plug-in itself, so that the total number of 

    bytes allocated in the system can be calculated by taking the sum of the values from all plug-ins.

    @return "Total number of bytes of memory allocated for uncompressed pictures."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    TUint PictureBufferBytes();

    /**

    Reads various counters related to decoded pictures. The counters are reset when Initialize() 

    or this method is called, and thus they only include pictures processed since the last call.

    Post-processor devices return the number of input pictures in iPicturesDecoded and 

    iTotalPictures. If the decoded pictures are written to another plug-in, they are considered 

    to be "virtually displayed".

    @param "aCounters" "The counter structure to fill."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void GetPictureCounters(CMMFDevVideoPlay::TPictureCounters& aCounters);

    /**

    Sets the computational complexity level to use. If separate complexity levels are not available, 

    the method call is ignored. If the level specified is not available, the results are undefined. 

    Typically the device will either ignore the request or use the nearest suitable level.

    The complexity level can be changed at any point during playback.

    @param "aLevel" "The computational complexity level to use. Level zero (0) is the most complex 

                    one, with the highest quality. Higher level numbers require less processing 

                    and may have lower quality."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void SetComplexityLevel(TUint aLevel);

    /**

    Gets the number of complexity levels available.

    @return "The number of complexity control levels available, or zero if the information is not 

            available yet. The information may not be available if the number of levels depends on 

            the input data, and enough input data has not been read yet. In that case, using level 

            zero is safe."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    TUint NumComplexityLevels();

    /**

    Gets information about a computational complexity level. This method can be called after 

    NumComplexityLevels() has returned a non-zero value - at that point the information is guaranteed 

    to be available. Some hardware device implementations may not be able to provide all values, 

    in that case the values will be approximated.

    @param "aLevel" "The computational complexity level to query. The level numbers range from zero 

                    (the most complex) to NumComplexityLevels()-1."

    @param "aInfo"  "The information structure to fill."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void GetComplexityLevelInfo(TUint aLevel, CMMFDevVideoPlay::TComplexityLevelInfo& aInfo);

    /**

    Returns a picture back to the device. This method is called by CMMFDevVideoPlay to return pictures 

    from the client (after they have been written with NewPicture()), or by the output device when 

    it has finished using a picture.

    @param "aPicture" "The picture to return. The device can re-use the memory for the picture."

    @pre    "This method can only be called after the hwdevice has been initialized with Initialize()."

    */

    void ReturnPicture(TVideoPicture* aPicture);

    /**

    Gets a copy of the latest picture sent to output.

    @param "aPictureData"   "Target picture. The memory for the picture must be allocated by the 

                            caller, and initialized properly. The data formats must match the snapshot 

                            format requested."

    @param "aFormat"        "The picture format to use for the snapshot."

    @return "ETrue if the snapshot was taken, EFalse if a picture is not available. The picture may not 

            be available if decoding has not progressed far enough yet."

    @leave  "The method will leave if an error occurs. Typical error codes used:

            * KErrNotSupported - The requested data format or picture size is not supported, or the 

            plug-in does not support snapshots."