vidslidesettings.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2017-05-25
 * Description : a tool to generate video slideshow from images.
 *
 * Copyright (C) 2017-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_VIDSLIDE_SETTINGS_H
#define DIGIKAM_VIDSLIDE_SETTINGS_H
 
// Qt includes
 
#include <QString>
#include <QList>
#include <QUrl>
#include <QSize>
#include <QMap>
 
// Local includes
 
#include "filesaveconflictbox.h"
#include "transitionmngr.h"
#include "effectmngr.h"
#include "digikam_export.h"
 
class KConfigGroup;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT VidSlideSettings
{
public:
 
    enum Selection
    {
        IMAGES = 0,
        ALBUMS
    };
 
    enum VidPlayer
    {
        NOPLAYER = 0,
        INTERNAL,
        DESKTOP
    };
 
    enum VidCodec
    {
        X264 = 0,    
        MPEG4,       
        MPEG2,       
        MJPEG,       
        FLASH,       
        WEBMVP8,     
        THEORA,      
        WMV7,        
        WMV8,        
        WMV9         
    };
 
    enum VidStd
    {
        PAL = 0,    
        NTSC        
    };
 
    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       
    };
 
    enum VidBitRate
    {
        VBR04 = 0,  
        VBR05,      
        VBR10,      
        VBR12,      
        VBR15,      
        VBR20,      
        VBR25,      
        VBR30,      
        VBR40,      
        VBR45,      
        VBR50,      
        VBR60,      
        VBR80       
    };
 
    enum VidFormat
    {
        AVI = 0,    
        MKV,        
        MP4,        
        MPG         
    };
 
public:
 
    explicit VidSlideSettings();
    ~VidSlideSettings();
 
    void  readSettings(KConfigGroup& group);
    void  writeSettings(KConfigGroup& group);
 
    QSize   videoSize()             const;              
    int     videoBitRate()          const;              
    qreal   videoFrameRate()        const;              
    QString videoCodec()            const;              
    QString videoFormat()           const;              
 
    static QMap<VidType,    QString> videoTypeNames();
    static QMap<VidBitRate, QString> videoBitRateNames();
    static QMap<VidStd,     QString> videoStdNames();
    static QMap<VidCodec,   QString> videoCodecNames();
    static QMap<VidFormat,  QString> videoFormatNames();
    static QMap<VidPlayer,  QString> videoPlayerNames();
 
    static QSize videoSizeFromType(VidType type);       
    static bool isVideoTVFormat(VidType type);        
 
public:
 
    Selection                         selMode;          
 
    // -- Generator settings ------
 
    QList<QUrl>                       inputImages;      
    QList<QUrl>                       inputAudio;       
 
    TransitionMngr::TransType         transition;       
 
    int                               imgFrames;        
 
    int                               abitRate;         
    VidBitRate                        vbitRate;         
    VidStd                            vStandard;        
    VidType                           vType;            
    VidCodec                          vCodec;           
    VidFormat                         vFormat;          
    EffectMngr::EffectType            vEffect;          
 
    FileSaveConflictBox::ConflictRule conflictRule;     
    QUrl                              outputDir;        
 
    // ---------------------
 
    QString                           outputVideo;      
    VidPlayer                         outputPlayer;     
};
 
} // namespace Digikam
 
#endif // DIGIKAM_VIDSLIDE_SETTINGS_H