encodingoptions.h

Go to the documentation of this file.

/*
 * Sailfin: a Jellyfin client written using Qt
 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
/*
 * WARNING: THIS IS AN AUTOMATICALLY GENERATED FILE! PLEASE DO NOT EDIT THIS, AS YOUR EDITS WILL GET
 * OVERWRITTEN AT SOME POINT! 
 *
 * If there is a bug in this file, please fix the code generator used to generate this file found in
 * core/openapigenerator.d. 
 *
 * This file is generated based on Jellyfin's OpenAPI description, "openapi.json". Please update that
 * file with a newer file if needed instead of manually updating the files.
 */
 
#ifndef JELLYFIN_DTO_ENCODINGOPTIONS_H
#define JELLYFIN_DTO_ENCODINGOPTIONS_H
 
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/dto/deinterlacemethod.h"
#include "JellyfinQt/dto/downmixstereoalgorithms.h"
#include "JellyfinQt/dto/encoderpreset.h"
#include "JellyfinQt/dto/hardwareaccelerationtype.h"
#include "JellyfinQt/dto/tonemappingalgorithm.h"
#include "JellyfinQt/dto/tonemappingmode.h"
#include "JellyfinQt/dto/tonemappingrange.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class EncodingOptions {
public:
    EncodingOptions(    
        qint32 encodingThreadCount,                         
        bool enableFallbackFont,            
        bool enableAudioVbr,            
        double downMixAudioBoost,           
        DownMixStereoAlgorithms downMixStereoAlgorithm,         
        qint32 maxMuxingQueueSize,          
        bool enableThrottling,          
        qint32 throttleDelaySeconds,            
        bool enableSegmentDeletion,         
        qint32 segmentKeepSeconds,          
        HardwareAccelerationType hardwareAccelerationType,                                          
        bool enableTonemapping,         
        bool enableVppTonemapping,          
        bool enableVideoToolboxTonemapping,         
        TonemappingAlgorithm tonemappingAlgorithm,          
        TonemappingMode tonemappingMode,            
        TonemappingRange tonemappingRange,          
        double tonemappingDesat,            
        double tonemappingPeak,         
        double tonemappingParam,            
        double vppTonemappingBrightness,            
        double vppTonemappingContrast,          
        qint32 h264Crf,         
        qint32 h265Crf,         
        EncoderPreset encoderPreset,            
        bool deinterlaceDoubleRate,         
        DeinterlaceMethod deinterlaceMethod,            
        bool enableDecodingColorDepth10Hevc,            
        bool enableDecodingColorDepth10Vp9,         
        bool enableDecodingColorDepth10HevcRext,            
        bool enableDecodingColorDepth12HevcRext,            
        bool enableEnhancedNvdecDecoder,            
        bool preferSystemNativeHwDecoder,           
        bool enableIntelLowPowerH264HwEncoder,          
        bool enableIntelLowPowerHevcHwEncoder,          
        bool enableHardwareEncoding,            
        bool allowHevcEncoding,         
        bool allowAv1Encoding,          
        bool enableSubtitleExtraction                       
    );
 
    EncodingOptions(const EncodingOptions &other);
    
    void replaceData(EncodingOptions &other);
    
    static EncodingOptions fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    qint32 encodingThreadCount() const;
    void setEncodingThreadCount(qint32 newEncodingThreadCount);

    QString transcodingTempPath() const;
    void setTranscodingTempPath(QString newTranscodingTempPath);
    bool transcodingTempPathNull() const;
    void setTranscodingTempPathNull();

    QString fallbackFontPath() const;
    void setFallbackFontPath(QString newFallbackFontPath);
    bool fallbackFontPathNull() const;
    void setFallbackFontPathNull();

    bool enableFallbackFont() const;
    void setEnableFallbackFont(bool newEnableFallbackFont);

    bool enableAudioVbr() const;
    void setEnableAudioVbr(bool newEnableAudioVbr);

    double downMixAudioBoost() const;
    void setDownMixAudioBoost(double newDownMixAudioBoost);
 
 
    DownMixStereoAlgorithms downMixStereoAlgorithm() const;
 
    void setDownMixStereoAlgorithm(DownMixStereoAlgorithms newDownMixStereoAlgorithm);

    qint32 maxMuxingQueueSize() const;
    void setMaxMuxingQueueSize(qint32 newMaxMuxingQueueSize);

    bool enableThrottling() const;
    void setEnableThrottling(bool newEnableThrottling);

    qint32 throttleDelaySeconds() const;
    void setThrottleDelaySeconds(qint32 newThrottleDelaySeconds);

    bool enableSegmentDeletion() const;
    void setEnableSegmentDeletion(bool newEnableSegmentDeletion);

    qint32 segmentKeepSeconds() const;
    void setSegmentKeepSeconds(qint32 newSegmentKeepSeconds);
 
 
    HardwareAccelerationType hardwareAccelerationType() const;
 
    void setHardwareAccelerationType(HardwareAccelerationType newHardwareAccelerationType);

    QString encoderAppPath() const;
    void setEncoderAppPath(QString newEncoderAppPath);
    bool encoderAppPathNull() const;
    void setEncoderAppPathNull();

    QString encoderAppPathDisplay() const;
    void setEncoderAppPathDisplay(QString newEncoderAppPathDisplay);
    bool encoderAppPathDisplayNull() const;
    void setEncoderAppPathDisplayNull();

    QString vaapiDevice() const;
    void setVaapiDevice(QString newVaapiDevice);
    bool vaapiDeviceNull() const;
    void setVaapiDeviceNull();

    QString qsvDevice() const;
    void setQsvDevice(QString newQsvDevice);
    bool qsvDeviceNull() const;
    void setQsvDeviceNull();

    bool enableTonemapping() const;
    void setEnableTonemapping(bool newEnableTonemapping);

    bool enableVppTonemapping() const;
    void setEnableVppTonemapping(bool newEnableVppTonemapping);

    bool enableVideoToolboxTonemapping() const;
    void setEnableVideoToolboxTonemapping(bool newEnableVideoToolboxTonemapping);
 
 
    TonemappingAlgorithm tonemappingAlgorithm() const;
 
    void setTonemappingAlgorithm(TonemappingAlgorithm newTonemappingAlgorithm);
 
 
    TonemappingMode tonemappingMode() const;
 
    void setTonemappingMode(TonemappingMode newTonemappingMode);
 
 
    TonemappingRange tonemappingRange() const;
 
    void setTonemappingRange(TonemappingRange newTonemappingRange);

    double tonemappingDesat() const;
    void setTonemappingDesat(double newTonemappingDesat);

    double tonemappingPeak() const;
    void setTonemappingPeak(double newTonemappingPeak);

    double tonemappingParam() const;
    void setTonemappingParam(double newTonemappingParam);

    double vppTonemappingBrightness() const;
    void setVppTonemappingBrightness(double newVppTonemappingBrightness);

    double vppTonemappingContrast() const;
    void setVppTonemappingContrast(double newVppTonemappingContrast);

    qint32 h264Crf() const;
    void setH264Crf(qint32 newH264Crf);

    qint32 h265Crf() const;
    void setH265Crf(qint32 newH265Crf);
 
 
    EncoderPreset encoderPreset() const;
 
    void setEncoderPreset(EncoderPreset newEncoderPreset);

    bool deinterlaceDoubleRate() const;
    void setDeinterlaceDoubleRate(bool newDeinterlaceDoubleRate);
 
 
    DeinterlaceMethod deinterlaceMethod() const;
 
    void setDeinterlaceMethod(DeinterlaceMethod newDeinterlaceMethod);

    bool enableDecodingColorDepth10Hevc() const;
    void setEnableDecodingColorDepth10Hevc(bool newEnableDecodingColorDepth10Hevc);

    bool enableDecodingColorDepth10Vp9() const;
    void setEnableDecodingColorDepth10Vp9(bool newEnableDecodingColorDepth10Vp9);

    bool enableDecodingColorDepth10HevcRext() const;
    void setEnableDecodingColorDepth10HevcRext(bool newEnableDecodingColorDepth10HevcRext);

    bool enableDecodingColorDepth12HevcRext() const;
    void setEnableDecodingColorDepth12HevcRext(bool newEnableDecodingColorDepth12HevcRext);

    bool enableEnhancedNvdecDecoder() const;
    void setEnableEnhancedNvdecDecoder(bool newEnableEnhancedNvdecDecoder);

    bool preferSystemNativeHwDecoder() const;
    void setPreferSystemNativeHwDecoder(bool newPreferSystemNativeHwDecoder);

    bool enableIntelLowPowerH264HwEncoder() const;
    void setEnableIntelLowPowerH264HwEncoder(bool newEnableIntelLowPowerH264HwEncoder);

    bool enableIntelLowPowerHevcHwEncoder() const;
    void setEnableIntelLowPowerHevcHwEncoder(bool newEnableIntelLowPowerHevcHwEncoder);

    bool enableHardwareEncoding() const;
    void setEnableHardwareEncoding(bool newEnableHardwareEncoding);

    bool allowHevcEncoding() const;
    void setAllowHevcEncoding(bool newAllowHevcEncoding);

    bool allowAv1Encoding() const;
    void setAllowAv1Encoding(bool newAllowAv1Encoding);

    bool enableSubtitleExtraction() const;
    void setEnableSubtitleExtraction(bool newEnableSubtitleExtraction);

    QStringList hardwareDecodingCodecs() const;
    void setHardwareDecodingCodecs(QStringList newHardwareDecodingCodecs);
    bool hardwareDecodingCodecsNull() const;
    void setHardwareDecodingCodecsNull();

    QStringList allowOnDemandMetadataBasedKeyframeExtractionForExtensions() const;
    void setAllowOnDemandMetadataBasedKeyframeExtractionForExtensions(QStringList newAllowOnDemandMetadataBasedKeyframeExtractionForExtensions);
    bool allowOnDemandMetadataBasedKeyframeExtractionForExtensionsNull() const;
    void setAllowOnDemandMetadataBasedKeyframeExtractionForExtensionsNull();
 
 
protected:
    qint32 m_encodingThreadCount;
    QString m_transcodingTempPath;
    QString m_fallbackFontPath;
    bool m_enableFallbackFont;
    bool m_enableAudioVbr;
    double m_downMixAudioBoost;
    DownMixStereoAlgorithms m_downMixStereoAlgorithm;
    qint32 m_maxMuxingQueueSize;
    bool m_enableThrottling;
    qint32 m_throttleDelaySeconds;
    bool m_enableSegmentDeletion;
    qint32 m_segmentKeepSeconds;
    HardwareAccelerationType m_hardwareAccelerationType;
    QString m_encoderAppPath;
    QString m_encoderAppPathDisplay;
    QString m_vaapiDevice;
    QString m_qsvDevice;
    bool m_enableTonemapping;
    bool m_enableVppTonemapping;
    bool m_enableVideoToolboxTonemapping;
    TonemappingAlgorithm m_tonemappingAlgorithm;
    TonemappingMode m_tonemappingMode;
    TonemappingRange m_tonemappingRange;
    double m_tonemappingDesat;
    double m_tonemappingPeak;
    double m_tonemappingParam;
    double m_vppTonemappingBrightness;
    double m_vppTonemappingContrast;
    qint32 m_h264Crf;
    qint32 m_h265Crf;
    EncoderPreset m_encoderPreset;
    bool m_deinterlaceDoubleRate;
    DeinterlaceMethod m_deinterlaceMethod;
    bool m_enableDecodingColorDepth10Hevc;
    bool m_enableDecodingColorDepth10Vp9;
    bool m_enableDecodingColorDepth10HevcRext;
    bool m_enableDecodingColorDepth12HevcRext;
    bool m_enableEnhancedNvdecDecoder;
    bool m_preferSystemNativeHwDecoder;
    bool m_enableIntelLowPowerH264HwEncoder;
    bool m_enableIntelLowPowerHevcHwEncoder;
    bool m_enableHardwareEncoding;
    bool m_allowHevcEncoding;
    bool m_allowAv1Encoding;
    bool m_enableSubtitleExtraction;
    QStringList m_hardwareDecodingCodecs;
    QStringList m_allowOnDemandMetadataBasedKeyframeExtractionForExtensions;
 
private:
    // Private constructor which generates an invalid object, for use withing EncodingOptions::fromJson();
    EncodingOptions();
};
 
 
} // NS DTO
 
namespace Support {
 
using EncodingOptions = Jellyfin::DTO::EncodingOptions;
 
template <>
EncodingOptions fromJsonValue(const QJsonValue &source, convertType<EncodingOptions>);
 
template<>
QJsonValue toJsonValue(const EncodingOptions &source, convertType<EncodingOptions>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_ENCODINGOPTIONS_H