digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::VidSlideSettings Class Reference

Public Types

enum  Selection { IMAGES = 0 , ALBUMS }
 Images selection mode.
 
enum  VidBitRate {
  VBR04 = 0 , VBR05 , VBR10 , VBR12 ,
  VBR15 , VBR20 , VBR25 , VBR30 ,
  VBR40 , VBR45 , VBR50 , VBR60 ,
  VBR80
}
 Video rates in bits per seconds. More...
 
enum  VidCodec {
  X264 = 0 , MPEG4 , MPEG2 , MJPEG ,
  FLASH , WEBMVP8 , THEORA , WMV7 ,
  WMV8 , WMV9
}
 Video Codecs. More...
 
enum  VidFormat { AVI = 0 , MKV , MP4 , MPG }
 Video Container Formats. More...
 
enum  VidPlayer { NOPLAYER = 0 , INTERNAL , DESKTOP }
 Video player to use.
 
enum  VidStd { PAL = 0 , NTSC }
 Video Standards. More...
 
enum  VidType {
  QVGA = 0 , VCD1 , VCD2 , CVD1 ,
  CVD2 , HVGA , SVCD1 , SDTV1 ,
  SDTV2 , EDTV1 , SVCD2 , EGA ,
  VGA , SDTV3 , EDTV2 , DVD1 ,
  DVD2 , WVGA , SVGA , DVGA ,
  XVGA , HDTV , WXGA1 , WXGA2 ,
  SXGA , SXGAPLUS , WSXGA , HDPLUS ,
  UXGA , WSXGAPLUS , BLUERAY , WUXGA ,
  TXGA , QXGA , UWFHD , WQHD ,
  WQXGA , QSXGA , QSXGAPLUS , WQXGAPLUS ,
  WQSXGA , QUXGA , UHD4K , WQUXGA ,
  HXGA , UHD5K , WHXGA , HSXGA ,
  UHD6K , WHSXGA , HUXGA , UHD8K ,
  WHUXGA , UW10K , UW16K
}
 Video types (size of target screen) See https://en.wikipedia.org/wiki/List_of_common_resolutions#Digital_TV_standards https://en.wikipedia.org/wiki/Aspect_ratio_(image) More...
 

Public Member Functions

QStringList defaultFFmpegSearchPaths () const
 
void readSettings (const KConfigGroup &group)
 Read and write settings in config file between sessions.
 
int videoBitRate () const
 Return the current video bit rate.
 
QString videoCodec () const
 Return the current video ffmpeg codec name.
 
QString videoFormat () const
 Return the current video format extension.
 
qreal videoFrameRate () const
 Return the current video frame rate.
 
QSize videoSize () const
 Return the current video size.
 
void writeSettings (KConfigGroup &group)
 

Static Public Member Functions

static bool isVideoTVFormat (VidType type)
 Return true if type is a video TV format. If false is returned type is computer graphics screen format.
 
static QMap< VidBitRate, QString > videoBitRateNames ()
 
static QMap< VidCodec, QString > videoCodecNames ()
 
static QMap< VidFormat, QString > videoFormatNames ()
 
static QMap< VidPlayer, QString > videoPlayerNames ()
 
static QSize videoSizeFromType (VidType type)
 Return the current size from a type of video.
 
static QMap< VidStd, QString > videoStdNames ()
 
static QMap< VidType, QString > videoTypeNames ()
 Helper methods to fill combobox from GUI.
 

Public Attributes

int abitRate = 64000
 Encoded Audio stream bit rate in bit/s.
 
QString audioTrack
 Soundtrack stream.
 
FileSaveConflictBox::ConflictRule conflictRule = FileSaveConflictBox::OVERWRITE
 Rule to follow if video file already exists.
 
bool equalize = false
 Equalize filter to applying while encoding video from frames.
 
QMap< QString, QString > ffmpegCodecs
 Map of FFmpeg codec names and features.
 
QMap< QString, QString > ffmpegFormats
 Map of FFmpeg format names and features.
 
QString ffmpegPath
 Path to FFmpeg binary.
 
QString filesList
 Path to list of frame files to encode.
 
DInfoInterfaceiface = nullptr
 Plugin host interface to handle item properties.
 
int imgFrames = 125
 Amount of frames by image to encode in video (ex: 125 frames = 5 s at 25 img/s).
 
QList< QUrl > inputImages
 Images stream.
 
FrameOsdSettings osdSettings
 On Screen Display parameters.
 
QString outputDir = QStandardPaths::writableLocation(QStandardPaths::MoviesLocation)
 Encoded video stream directory.
 
QString outputFile
 Path to encoded video.
 
VidPlayer outputPlayer = INTERNAL
 Open video stream in player at end.
 
QString outputVideo
 Target video file encoded at end.
 
Selection selMode = IMAGES
 Items selection mode.
 
QTime soundtrackLength
 Duration of the soundtrack.
 
int strength = 5
 Equalization strength factor.
 
QString tempDir
 To store temporary frames.
 
TransitionMngr::TransType transition = TransitionMngr::None
 Transition type between images.
 
VidBitRate vbitRate = VBR12
 Encoded Video stream bit rate in bit/s.
 
VidCodec vCodec = X264
 Encoded video codec.
 
EffectMngr::EffectType vEffect = EffectMngr::None
 Encoded video effect while displaying images.
 
VidFormat vFormat = MP4
 Encoded video container format.
 
VidStd vStandard = PAL
 Encoded Video standard => frame rate in img/s.
 
VidType vType = BLUERAY
 Encoded video type.
 

Member Enumeration Documentation

◆ VidBitRate

Enumerator
VBR04 

400000

VBR05 

500000

VBR10 

1000000

VBR12 

1200000

VBR15 

1500000

VBR20 

2000000

VBR25 

2500000

VBR30 

3000000

VBR40 

4000000

VBR45 

4500000

VBR50 

5000000

VBR60 

6000000

VBR80 

8000000

◆ VidCodec

◆ VidFormat

◆ VidStd

Enumerator
PAL 

25 FPS

NTSC 

29.97 FPS

◆ VidType

Enumerator
QVGA 

320 x 180 - 16:9 - Computer Graphics

VCD1 

352 x 240 - 7:5 - Digital TV

VCD2 

352 x 288 - 6:5 - Digital TV

CVD1 

352 x 480 - 11:15 - Digital TV

CVD2 

352 x 576 - 11:18 - Digital TV

HVGA 

480 x 270 - 16:9 - Computer Graphics

SVCD1 

480 x 480 - 1:1 - Digital TV

SDTV1 

528 x 480 - 11:10 - Digital TV

SDTV2 

544 x 480 - 17:15 - Digital TV

EDTV1 

544 x 576 - 17;18 - Digital TV

SVCD2 

480 x 576 - 5:6 - Digital TV

EGA 

640 x 350 - 16:9 - Computer Graphics

VGA 

640 x 480 - 4:3 - Computer Graphics

SDTV3 

704 x 480 - 22:15 - Digital TV

EDTV2 

704 x 576 - 11;9 - Digital TV

DVD1 

720 x 480 - 3:2 - Digital TV

DVD2 

720 x 576 - 5:4 - Digital TV

WVGA 

800 x 450 - 16:9 - Computer Graphics

SVGA 

800 x 600 - 4:3 - Computer Graphics

DVGA 

960 x 640 - 3:2 - Computer Graphics

XVGA 

1024 x 576 - 16:9 - Computer Graphics

HDTV 

1280 x 720 - 16:9 - Digital TV

WXGA1 

1280 x 768 - 5:3 - Computer Graphics

WXGA2 

1280 x 800 - 8:5 - Computer Graphics

SXGA 

1280 x 1024 - 5:4 - Computer Graphics

SXGAPLUS 

1400 x 1050 - 4:3 - Computer Graphics

WSXGA 

1440 x 900 - 8:5 - Computer Graphics

HDPLUS 

1600 x 900 - 16:9 - Digital TV

UXGA 

1600 x 1200 - 4:3 - Computer Graphics

WSXGAPLUS 

1680 x 1050 - 8:5 - Computer Graphics

BLUERAY 

1920 x 1080 - 19:9 - Digital TV

WUXGA 

1920 x 1200 - 8:5 - Computer Graphics

TXGA 

1920 x 1440 - 7:5 - Computer Graphics

QXGA 

2048 x 1536 - 4:3 - Computer Graphics

UWFHD 

2560 < 1080 - 21:9 - Computer Graphics

WQHD 

2560 x 1440 - 16:9 - Computer Graphics

WQXGA 

2560 x 1600 - 8:5 - Computer Graphics

QSXGA 

2560 x 2048 - 5:4 - Computer Graphics

QSXGAPLUS 

2800 x 2100 - 4:3 - Computer Graphics

WQXGAPLUS 

3200 x 1800 - 16:9 - Computer Graphics

WQSXGA 

3200 x 2048 - 25:16 - Computer Graphics

QUXGA 

3200 x 2400 - 4:3 - Computer Graphics

UHD4K 

3840 x 2160 - 19:9 - Digital TV

WQUXGA 

3840 x 2400 - 8:5 - Computer Graphics

HXGA 

4096 x 3072 - 4:3 - Computer Graphics

UHD5K 

5120 x 2880 - 16:9 - Computer Graphics

WHXGA 

5120 x 3200 - 8:5 - Computer Graphics

HSXGA 

5120 x 4096 - 5:4 - Computer Graphics

UHD6K 

6016 x 3384 - 16:9 - Computer Graphics

WHSXGA 

6400 x 4096 - 25:16 - Computer Graphics

HUXGA 

6400 x 4800 - 4:3 - Computer Graphics

UHD8K 

7680 x 4320 - 16:9 - Digital TV

WHUXGA 

7680 x 4800 - 8:5 - Computer Graphics

UW10K 

10240 x 4320 - 21:9 - Computer Graphics

UW16K 

15360 x 8640 - 16:9 - Computer Graphics