videoouttypes.h

Go to the documentation of this file.

// -*- Mode: c++ -*-

#ifndef _VIDEOOUT_TYPES_H_
#define _VIDEOOUT_TYPES_H_

#include <QString>
#include <QObject>
#include <QSize>

enum PIPState
{
    kPIPOff = 0,
    kPIPonTV,
    kPIPStandAlone,
    kPBPLeft,
    kPBPRight,
};

enum PIPLocation
{
    kPIPTopLeft = 0,
    kPIPBottomLeft,
    kPIPTopRight,
    kPIPBottomRight,
    kPIP_END
};

enum ZoomDirection
{
    kZoomHome = 0,
    kZoomIn,
    kZoomOut,
    kZoomVerticalIn,
    kZoomVerticalOut,
    kZoomHorizontalIn,
    kZoomHorizontalOut,
    kZoomUp,
    kZoomDown,
    kZoomLeft,
    kZoomRight,
    kZoomAspectUp,
    kZoomAspectDown,
    kZoom_END
};

enum AspectOverrideMode
{
    kAspect_Toggle = -1,
    kAspect_Off = 0,
    kAspect_4_3,
    kAspect_16_9,
    kAspect_14_9, // added after 16:9 so as not to upset existing setups.
    kAspect_2_35_1,
    kAspect_END
};

enum AdjustFillMode
{
    kAdjustFill_Toggle = -1,
    kAdjustFill_Off = 0,
    kAdjustFill_Half,
    kAdjustFill_Full,
    kAdjustFill_HorizontalStretch,
    kAdjustFill_VerticalStretch,
    kAdjustFill_HorizontalFill,
    kAdjustFill_VerticalFill,
    kAdjustFill_END,
    kAdjustFill_AutoDetect_DefaultOff,
    kAdjustFill_AutoDetect_DefaultHalf,
};

enum LetterBoxColour
{
    kLetterBoxColour_Toggle = -1,
    kLetterBoxColour_Black = 0,
    kLetterBoxColour_Gray25,
    kLetterBoxColour_END
};

enum FrameScanType
{
    kScan_Ignore       = -1,
    kScan_Detect       =  0,
    kScan_Interlaced   =  1,
    kScan_Intr2ndField =  2,
    kScan_Progressive  =  3,
};

enum PictureAttribute
{
    kPictureAttribute_None = 0,
    kPictureAttribute_MIN = 0,
    kPictureAttribute_Brightness = 1,
    kPictureAttribute_Contrast,
    kPictureAttribute_Colour,
    kPictureAttribute_Hue,
    kPictureAttribute_Range,
    kPictureAttribute_Volume,
    kPictureAttribute_MAX
};

enum PictureAttributeSupported
{
    kPictureAttributeSupported_None       = 0x00,
    kPictureAttributeSupported_Brightness = 0x01,
    kPictureAttributeSupported_Contrast   = 0x02,
    kPictureAttributeSupported_Colour     = 0x04,
    kPictureAttributeSupported_Hue        = 0x08,
    kPictureAttributeSupported_Range      = 0x10,
    kPictureAttributeSupported_Volume     = 0x20,
};

#define ALL_PICTURE_ATTRIBUTES static_cast<PictureAttributeSupported> \
    (kPictureAttributeSupported_Brightness | \
     kPictureAttributeSupported_Contrast | \
     kPictureAttributeSupported_Colour | \
     kPictureAttributeSupported_Hue | \
     kPictureAttributeSupported_Range)

enum StereoscopicMode
{
    kStereoscopicModeNone,
    kStereoscopicModeSideBySide,
    kStereoscopicModeSideBySideDiscard,
    kStereoscopicModeTopAndBottom,
    kStereoscopicModeTopAndBottomDiscard,
};

enum PrimariesMode
{
    PrimariesDisabled = 0,
    PrimariesAuto,
    PrimariesAlways
};

inline QString StereoscopictoString(StereoscopicMode mode)
{
    switch (mode)
    {
        case kStereoscopicModeNone:
            return QObject::tr("No 3D");
        case kStereoscopicModeSideBySide:
            return QObject::tr("3D Side by Side");
        case kStereoscopicModeSideBySideDiscard:
            return QObject::tr("Discard 3D Side by Side");
        case kStereoscopicModeTopAndBottom:
            return QObject::tr("3D Top and Bottom");
        case kStereoscopicModeTopAndBottomDiscard:
            return QObject::tr("Discard 3D Top and Bottom");
    }
    return QObject::tr("Unknown");
}

enum VideoErrorState
{
    kError_None            = 0x00,
    kError_Unknown         = 0x01,
};

inline bool is_interlaced(FrameScanType scan)
{
    return (kScan_Interlaced == scan) || (kScan_Intr2ndField == scan);
}

inline bool is_progressive(FrameScanType scan)
{
    return (kScan_Progressive == scan);
}

inline QString toString(FrameScanType scan, bool brief = false)
{
    QString ret = QObject::tr("Unknown");
    switch (scan)
    {
        case kScan_Ignore:
            ret = QObject::tr("Ignore"); break;
        case kScan_Detect:
            ret = QObject::tr("Detect"); break;
        case kScan_Interlaced:
            if (brief)
                ret = QObject::tr("Interlaced");
            else
                ret = QObject::tr("Interlaced (Normal)");
            break;
        case kScan_Intr2ndField:
            if (brief)
                ret = QObject::tr("Interlaced");
            else
                ret = QObject::tr("Interlaced (Reversed)");
            break;
        case kScan_Progressive:
            ret = QObject::tr("Progressive"); break;
        default:
            break;
    }

    return ret;
}

inline QString toString(PIPState State)
{
    switch (State)
    {
    case kPIPOff: return QString("Pip Off");
    case kPIPonTV: return QString("Pip on TV");
    case kPIPStandAlone: return QString("Pip Standalone");
    case kPBPLeft: return QString("PBP Left");
    case kPBPRight: return QString("PBP Right");
    }
    return QString("Unknown");
}

inline QString toString(PIPLocation location)
{
    QString ret;
    switch (location)
    {
        case kPIPTopLeft:     ret = QObject::tr("Top Left");     break;
        case kPIPBottomLeft:  ret = QObject::tr("Bottom Left");  break;
        case kPIPTopRight:    ret = QObject::tr("Top Right");    break;
        case kPIPBottomRight: ret = QObject::tr("Bottom Right"); break;
        case kPIP_END: break;
    }

    return ret;
}

inline QString toString(AspectOverrideMode aspectmode)
{
    QString ret = QObject::tr("Off");
    switch (aspectmode)
    {
        case kAspect_4_3:    ret = QObject::tr("4:3");    break;
        case kAspect_14_9:   ret = QObject::tr("14:9");   break;
        case kAspect_16_9:   ret = QObject::tr("16:9");   break;
        case kAspect_2_35_1: ret = QObject::tr("2.35:1"); break;
        case kAspect_Toggle:
        case kAspect_Off:
        case kAspect_END: break;
    }

    return ret;
}

inline QString toString(LetterBoxColour letterboxcolour)
{
    QString ret = QObject::tr("Black");
    switch (letterboxcolour)
    {
        case kLetterBoxColour_Gray25: ret = QObject::tr("Gray"); break;
        case kLetterBoxColour_Black:
        case kLetterBoxColour_Toggle:
        case kLetterBoxColour_END: break;
    }

    return ret;
}

inline float get_aspect_override(AspectOverrideMode aspectmode, float orig)
{
    float ret = orig;
    switch (aspectmode)
    {
        case kAspect_4_3:    ret = 4.0F  / 3.0F; break;
        case kAspect_14_9:   ret = 14.0F / 9.0F; break;
        case kAspect_16_9:   ret = 16.0F / 9.0F; break;
        case kAspect_2_35_1: ret = 2.35F       ; break;
        case kAspect_Toggle:
        case kAspect_Off:
        case kAspect_END: break;
    }
    return ret;
}

inline QString toString(AdjustFillMode aspectmode)
{
    QString ret = QObject::tr("Off");
    switch (aspectmode)
    {
        case kAdjustFill_Half:    ret = QObject::tr("Half");    break;
        case kAdjustFill_Full:    ret = QObject::tr("Full");    break;
        case kAdjustFill_HorizontalStretch:
            ret = QObject::tr("H.Stretch"); break;
        case kAdjustFill_VerticalStretch:
            ret = QObject::tr("V.Stretch"); break;
        case kAdjustFill_VerticalFill:
            ret = QObject::tr("V.Fill"); break;
        case kAdjustFill_HorizontalFill:
            ret = QObject::tr("H.Fill"); break;
        case kAdjustFill_Toggle:
        case kAdjustFill_Off:
        case kAdjustFill_END: break;
        case kAdjustFill_AutoDetect_DefaultOff:
            ret = QObject::tr("Auto Detect (Default Off)");
            break;
        case kAdjustFill_AutoDetect_DefaultHalf:
            ret = QObject::tr("Auto Detect (Default Half)");
            break;
    }

    return ret;
}

inline QString toString(PictureAttribute pictureattribute)
{
    QString ret = QObject::tr("None");
    switch (pictureattribute)
    {
      case kPictureAttribute_None:            break;
      case kPictureAttribute_Brightness:
          ret = QObject::tr("Brightness");    break;
      case kPictureAttribute_Contrast:
          ret = QObject::tr("Contrast");      break;
      case kPictureAttribute_Colour:
          ret = QObject::tr("Color");         break;
      case kPictureAttribute_Hue:
          ret = QObject::tr("Hue");           break;
      case kPictureAttribute_Range:
          ret = QObject::tr("Range"); break;
      case kPictureAttribute_Volume:
          ret = QObject::tr("Volume");        break;
      case kPictureAttribute_MAX:
          ret = "MAX";                        break;
    }

    return ret;
}

inline QString toDBString(PictureAttribute pictureattribute)
{
    QString ret;
    switch (pictureattribute)
    {
      case kPictureAttribute_None: break;
      case kPictureAttribute_Brightness:
          ret = "brightness";      break;
      case kPictureAttribute_Contrast:
          ret = "contrast";        break;
      case kPictureAttribute_Colour:
          ret = "colour";          break;
      case kPictureAttribute_Hue:
          ret = "hue";             break;
      case kPictureAttribute_Range:
      case kPictureAttribute_Volume:
      case kPictureAttribute_MAX:  break;
    }

    return ret;
}

inline QString toString(PictureAttributeSupported supported)
{
    QStringList list;

    if (kPictureAttributeSupported_Brightness & supported)
        list += "Brightness";
    if (kPictureAttributeSupported_Contrast & supported)
        list += "Contrast";
    if (kPictureAttributeSupported_Colour & supported)
        list += "Colour";
    if (kPictureAttributeSupported_Hue & supported)
        list += "Hue";
    if (kPictureAttributeSupported_Range & supported)
        list += "Range";
    if (kPictureAttributeSupported_Volume & supported)
        list += "Volume";
    return list.join(",");
}

inline PictureAttributeSupported toMask(PictureAttribute pictureattribute)
{
    PictureAttributeSupported ret = kPictureAttributeSupported_None;
    switch (pictureattribute)
    {
        case kPictureAttribute_None: break;
        case kPictureAttribute_Brightness:
            ret = kPictureAttributeSupported_Brightness; break;
        case kPictureAttribute_Contrast:
            ret = kPictureAttributeSupported_Contrast; break;
        case kPictureAttribute_Colour:
            ret = kPictureAttributeSupported_Colour; break;
        case kPictureAttribute_Hue:
            ret = kPictureAttributeSupported_Hue; break;
        case kPictureAttribute_Range:
            ret = kPictureAttributeSupported_Range; break;
        case kPictureAttribute_Volume:
            ret = kPictureAttributeSupported_Volume; break;
        case kPictureAttribute_MAX: break;
    }
    return ret;
}

inline PictureAttribute next(PictureAttributeSupported supported,
                             PictureAttribute          attribute)
{
    int i = ((int) attribute + 1) % (int) kPictureAttribute_MAX;
    for (int j = 0; j < kPictureAttribute_MAX;
         (i = (i+1) % kPictureAttribute_MAX), j++)
    {
        if (toMask((PictureAttribute) i) & supported)
            return (PictureAttribute) i;
    }
    return kPictureAttribute_None;
}

#endif // _VIDEOOUT_TYPES_H_