VideoScaler.h

Go to the documentation of this file.

// VideoScaler.h - interface of class VideoScaler
//
// Copyright (c) 2003, Roku, LLC.
//

#ifndef _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_VIDEOSCALER_H
#define _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_VIDEOSCALER_H

#include <cascade/graphics/CascadeRect.h>
#include <cascade/graphics/CascadeDims.h>

// class VideoScaler
class VideoScaler
{
public: 
    VideoScaler();
    virtual ~VideoScaler();

public:
    typedef enum ScalerColorFormat
    {
        kColorFormatInvalid     = -1,
        kColorFormatARGB888     = 0,
        kColorFormatARGB4888    = 1,
        kColorFormatARGB4444    = 2,
        kColorFormatARGB1555    = 3,
        kColorFormatRGB565      = 4,
        kColorFormatARGB8888_32 = 6,
        kColorFormatVYUY422     = 11,
        kColorFormatYVYU422     = 12,
        kColorFormatYOverV      = 13,
        kColorFormatVBID_Raw    = 20
    };

    bool Open( ScalerColorFormat format = kColorFormatVYUY422 );
        // scaler is opened disabled
        // only open the scaler when you are about to use it.
        // scaler defaults to VYUY422 color

    bool Close();
        // scaler is closed
        // close the scaler as soon as you are done with it so it can be used 
        // by other clients.

    bool IsOpen();
        // returns true if scaler is open

    bool SetSourceWindow(const CascadeDims & sourceWindowDims, 
                         u32 & outPitch );
        // sets the source window dimensions, returning the scaler's required
        // pitch.  You must allocate video memory whose line width (in pixels)
        // is the pitch, or the scaler won't function correctly.  Allocate
        // that memory by calling AllocateScalerVRAM, then pass the resulting
        // pointer to SetSourceVRAM()

    bool SetSourceVRAM( u8 * pVRAMSourceWindow );
        // sets the memory location from which the scaler is to read.  You
        // should call SetSourceWindow() first to get the pitch, then
        // AllocateScalerVRAM(), then pass the allocated pointer in here.

    bool SetDestWindow(const CascadeRect & destWindowRect, 
                       bool bPreserveAspectRatio);
        // sets the scaler's dest window to destWindowRect

    bool SetCropWindow(const CascadeRect & cropWindowRect);
        // sets the scaler's crop window to cropWindowRect

    typedef enum ScalerColorConversionFormat
    {
        kColorConversionInvalid = 0,
        kColorConversionRGB,
        kColorConversionYCbCr709,
        kColorConversionYCbCr601,
        kColorConversionYCbCr240,
        kColorConversionYCbCr444
    };

    bool SetSourceColorConversionFormat( ScalerColorConversionFormat format );
        // sets the scaler's color converter source format
    
    u8 * AllocateScalerVRAM(u32 nBytes);
        // returns pointer to newly allocated video memory for use in 
        // SetSourceWindow
    
    bool FreeScalerVRAM(u8 * pVRAM);
        // frees previously allocated scaler memory

    typedef enum ScalerBlendMode
    {
        kBlendModeAdd,
        kBlendModeMultiply
    };

    bool Show( ScalerBlendMode mode = kBlendModeMultiply );
        // shows an open scaler, setting the blend mode of the 
        // GUI overlay to the specified blend.  Multiply is recommended
        // when compositing onto video.

    bool Hide();
        // hides an open scaler
    
    bool IsShowing();
        // returns true if open scaler is enabled

private:
    void * m_pScalerInternal;
};

#endif // #ifndef _ROKU_INCLUDE_DESCHUTES_LIBRARIES_HDMACHINEX225_VIDEOSCALER_H

//  LOG
//  29-Jun-03   dwoodward   created
//  02-Jul-03   mjkobb      Modified SetSourceWindow and added SetSourceVRAM,
//                          to take into account the pitch requirements
//                          of the scaler
//  21-Aug-03   mjkobb      Added SetSourceColorFormat
//  11-Dec-03   mjkobb      Rename Enable/Disable as Show/Hide.
//                          Move alpha mode setting to Show/Hide.
//                          Make Open take a parameter for the source format.
//                          Make Show take a blend mode.
//                          Rename source color conversion functions & enum

---