programtypes.h File Reference

#include <cstdint>
#include <deque>
#include <QString>
#include <QMap>
#include <QHash>
#include "mythbaseexp.h"
#include "recordingtypes.h"
#include "programtypeflags.h"

Include dependency graph for programtypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DEFINE_FLAGS_ENUM

Typedefs
using	frm_pos_map_t = QMap< long long, long long >
	Frame # -> File offset map. More...
using	stringMarkMap = std::map< QString, MarkTypes >
using	frm_dir_map_t = QMap< uint64_t, MarkTypes >
	Frame # -> Mark map. More...

Enumerations
enum	MarkTypes : std::int16_t {   MARK_INVALID = -9999, MARK_ALL = -100, MARK_UNSET = -10, MARK_TMP_CUT_END = -5,   MARK_TMP_CUT_START = -4, MARK_UPDATED_CUT = -3, MARK_PLACEHOLDER = -2, MARK_CUT_END = 0,   MARK_CUT_START = 1, MARK_BOOKMARK = 2, MARK_BLANK_FRAME = 3, MARK_COMM_START = 4,   MARK_COMM_END = 5, MARK_GOP_START = 6, MARK_KEYFRAME = 7, MARK_SCENE_CHANGE = 8,   MARK_GOP_BYFRAME = 9, MARK_ASPECT_1_1 = 10, MARK_ASPECT_4_3 = 11, MARK_ASPECT_16_9 = 12,   MARK_ASPECT_2_21_1 = 13, MARK_ASPECT_CUSTOM = 14, MARK_SCAN_PROGRESSIVE = 15, MARK_VIDEO_WIDTH = 30,   MARK_VIDEO_HEIGHT = 31, MARK_VIDEO_RATE = 32, MARK_DURATION_MS = 33, MARK_TOTAL_FRAMES = 34,   MARK_UTIL_PROGSTART = 40, MARK_UTIL_LASTPLAYPOS = 41 }
enum	CommFlagStatus : std::uint8_t { COMM_FLAG_NOT_FLAGGED = 0, COMM_FLAG_DONE = 1, COMM_FLAG_PROCESSING = 2, COMM_FLAG_COMMFREE = 3 }
enum	SkipType : std::int16_t {   COMM_DETECT_COMMFREE = -2, COMM_DETECT_UNINIT = -1, COMM_DETECT_OFF = 0x00000000, COMM_DETECT_BLANK = 0x00000001,   COMM_DETECT_BLANKS = COMM_DETECT_BLANK, COMM_DETECT_SCENE = 0x00000002, COMM_DETECT_LOGO = 0x00000004, COMM_DETECT_BLANK_SCENE = (COMM_DETECT_BLANKS | COMM_DETECT_SCENE),   COMM_DETECT_ALL, COMM_DETECT_2 = 0x00000100, COMM_DETECT_2_LOGO = COMM_DETECT_2 | COMM_DETECT_LOGO, COMM_DETECT_2_BLANK = COMM_DETECT_2 | COMM_DETECT_BLANKS,   COMM_DETECT_2_SCENE = COMM_DETECT_2 | COMM_DETECT_SCENE, COMM_DETECT_2_ALL = (COMM_DETECT_2_LOGO | COMM_DETECT_2_BLANK), COMM_DETECT_PREPOSTROLL = 0x00000200, COMM_DETECT_PREPOSTROLL_ALL }
	This is used as a bitmask. More...
enum	TranscodingStatus : std::uint8_t { TRANSCODING_NOT_TRANSCODED = 0, TRANSCODING_COMPLETE = 1, TRANSCODING_RUNNING = 2 }
enum	ProgramInfoType : std::uint8_t {   kProgramInfoTypeRecording = 0, kProgramInfoTypeVideoFile, kProgramInfoTypeVideoDVD, kProgramInfoTypeVideoStreamingHTML,   kProgramInfoTypeVideoStreamingRTSP, kProgramInfoTypeVideoBD }
enum	AvailableStatusType : std::uint8_t {   asAvailable = 0, asNotYetAvailable, asPendingDelete, asFileNotFound,   asZeroByte, asDeleted }
enum	WatchListStatus : std::int8_t { wlDeleted = -4, wlEarlier = -3, wlWatched = -2, wlExpireOff = -1 }
enum	AutoExpireType : std::uint16_t { kDisableAutoExpire = 0, kNormalAutoExpire = 1, kDeletedAutoExpire = 9999, kLiveTVAutoExpire = 10000 }

Functions
MBASE_PUBLIC QString	toString (MarkTypes type)
MBASE_PUBLIC MarkTypes	markTypeFromString (const QString &str)
MBASE_PUBLIC QString	SkipTypeToString (int flags)
MBASE_PUBLIC std::deque< int >	GetPreferredSkipTypeCombinations (void)
MBASE_PUBLIC QString	toString (AvailableStatusType status)

Variables
const MBASE_PUBLIC QString	kPlayerInUseID
const MBASE_PUBLIC QString	kPIPPlayerInUseID
const MBASE_PUBLIC QString	kPBPPlayerInUseID
const MBASE_PUBLIC QString	kImportRecorderInUseID
const MBASE_PUBLIC QString	kRecorderInUseID
const MBASE_PUBLIC QString	kFileTransferInUseID
const MBASE_PUBLIC QString	kTruncatingDeleteInUseID
const MBASE_PUBLIC QString	kFlaggerInUseID
const MBASE_PUBLIC QString	kTranscoderInUseID
const MBASE_PUBLIC QString	kPreviewGeneratorInUseID
const MBASE_PUBLIC QString	kJobQueueInUseID
const MBASE_PUBLIC QString	kCCExtractorInUseID
static stringMarkMap	MarkTypeStrings

Macro Definition Documentation

DEFINE_FLAGS_ENUM

#define DEFINE_FLAGS_ENUM

Definition at line 163 of file programtypes.h.

Typedef Documentation

frm_pos_map_t

using frm_pos_map_t = QMap<long long, long long>

Frame # -> File offset map.

Definition at line 45 of file programtypes.h.

stringMarkMap

using stringMarkMap = std::map<QString, MarkTypes>

Definition at line 82 of file programtypes.h.

frm_dir_map_t

using frm_dir_map_t = QMap<uint64_t, MarkTypes>

Frame # -> Mark map.

Definition at line 118 of file programtypes.h.

Enumeration Type Documentation

MarkTypes

enum MarkTypes : std::int16_t

Enumerator
MARK_INVALID
MARK_ALL
MARK_UNSET
MARK_TMP_CUT_END
MARK_TMP_CUT_START
MARK_UPDATED_CUT
MARK_PLACEHOLDER
MARK_CUT_END
MARK_CUT_START
MARK_BOOKMARK
MARK_BLANK_FRAME
MARK_COMM_START
MARK_COMM_END
MARK_GOP_START
MARK_KEYFRAME
MARK_SCENE_CHANGE
MARK_GOP_BYFRAME
MARK_ASPECT_1_1	deprecated, it is only 1:1 sample aspect ratio
MARK_ASPECT_4_3
MARK_ASPECT_16_9
MARK_ASPECT_2_21_1
MARK_ASPECT_CUSTOM
MARK_SCAN_PROGRESSIVE
MARK_VIDEO_WIDTH
MARK_VIDEO_HEIGHT
MARK_VIDEO_RATE
MARK_DURATION_MS
MARK_TOTAL_FRAMES
MARK_UTIL_PROGSTART
MARK_UTIL_LASTPLAYPOS

Definition at line 47 of file programtypes.h.

CommFlagStatus

enum CommFlagStatus : std::uint8_t

Enumerator
COMM_FLAG_NOT_FLAGGED
COMM_FLAG_DONE
COMM_FLAG_PROCESSING
COMM_FLAG_COMMFREE

Definition at line 120 of file programtypes.h.

SkipType

enum SkipType : std::int16_t

This is used as a bitmask.

Enumerator
COMM_DETECT_COMMFREE
COMM_DETECT_UNINIT
COMM_DETECT_OFF
COMM_DETECT_BLANK
COMM_DETECT_BLANKS
COMM_DETECT_SCENE
COMM_DETECT_LOGO
COMM_DETECT_BLANK_SCENE
COMM_DETECT_ALL
COMM_DETECT_2
COMM_DETECT_2_LOGO
COMM_DETECT_2_BLANK
COMM_DETECT_2_SCENE
COMM_DETECT_2_ALL
COMM_DETECT_PREPOSTROLL
COMM_DETECT_PREPOSTROLL_ALL

Definition at line 128 of file programtypes.h.

TranscodingStatus

enum TranscodingStatus : std::uint8_t

Enumerator
TRANSCODING_NOT_TRANSCODED
TRANSCODING_COMPLETE
TRANSCODING_RUNNING

Definition at line 157 of file programtypes.h.

ProgramInfoType

enum ProgramInfoType : std::uint8_t

Enumerator
kProgramInfoTypeRecording
kProgramInfoTypeVideoFile
kProgramInfoTypeVideoDVD
kProgramInfoTypeVideoStreamingHTML
kProgramInfoTypeVideoStreamingRTSP
kProgramInfoTypeVideoBD

Definition at line 167 of file programtypes.h.

AvailableStatusType

enum AvailableStatusType : std::uint8_t

Enumerator
asAvailable
asNotYetAvailable
asPendingDelete
asFileNotFound
asZeroByte
asDeleted

Definition at line 176 of file programtypes.h.

WatchListStatus

enum WatchListStatus : std::int8_t

Enumerator
wlDeleted
wlEarlier
wlWatched
wlExpireOff

Definition at line 186 of file programtypes.h.

AutoExpireType

enum AutoExpireType : std::uint16_t

Enumerator
kDisableAutoExpire
kNormalAutoExpire
kDeletedAutoExpire
kLiveTVAutoExpire

Definition at line 193 of file programtypes.h.

Function Documentation

toString() [1/2]

MBASE_PUBLIC QString toString

(

MarkTypes

type

)

Definition at line 29 of file programtypes.cpp.

markTypeFromString()

MBASE_PUBLIC MarkTypes markTypeFromString

(

const QString &

str

)

Definition at line 68 of file programtypes.cpp.

Referenced by Dvr::SetRecordedMarkup(), and V2Dvr::SetRecordedMarkup().

SkipTypeToString()

MBASE_PUBLIC QString SkipTypeToString

(

int

flags

)

Definition at line 91 of file programtypes.cpp.

Referenced by CommercialSkipMethod(), CommMethod::CommMethod(), and V2Channel::GetCommMethodList().

GetPreferredSkipTypeCombinations()

MBASE_PUBLIC std::deque<int> GetPreferredSkipTypeCombinations

(

void

)

Definition at line 129 of file programtypes.cpp.

Referenced by CommercialSkipMethod(), CommMethod::CommMethod(), and V2Channel::GetCommMethodList().

toString() [2/2]

MBASE_PUBLIC QString toString

(

AvailableStatusType

status

)

Definition at line 76 of file programtypes.cpp.

Variable Documentation

kPlayerInUseID

const MBASE_PUBLIC QString kPlayerInUseID

Definition at line 16 of file programtypes.cpp.

Referenced by Scheduler::FillRecordingDir(), ProgramInfo::MarkAsInUse(), ProgramInfo::QueryInUseMap(), ProgramInfo::QueryIsDeleteCandidate(), ProgramInfo::QueryIsInUse(), and TV::ShowOSDPromptDeleteRecording().

kPIPPlayerInUseID

const MBASE_PUBLIC QString kPIPPlayerInUseID

Definition at line 17 of file programtypes.cpp.

Referenced by ProgramInfo::QueryIsInUse().

kPBPPlayerInUseID

const MBASE_PUBLIC QString kPBPPlayerInUseID

Definition at line 18 of file programtypes.cpp.

Referenced by ProgramInfo::QueryIsInUse().

kImportRecorderInUseID

const MBASE_PUBLIC QString kImportRecorderInUseID

Definition at line 19 of file programtypes.cpp.

Referenced by ProgramInfo::QueryIsInUse(), and ImportRecorder::run().

kRecorderInUseID

const MBASE_PUBLIC QString kRecorderInUseID

Definition at line 20 of file programtypes.cpp.

Referenced by TVRec::CreateLiveTVRingBuffer(), Scheduler::FillRecordingDir(), ProgramInfo::MarkAsInUse(), ProgramInfo::QueryInUseMap(), ProgramInfo::QueryIsDeleteCandidate(), ProgramInfo::QueryIsInUse(), TVRec::RingBufferChanged(), TV::ShowOSDPromptDeleteRecording(), TVRec::StartRecording(), TVRec::SwitchLiveTVRingBuffer(), TVRec::SwitchRecordingRingBuffer(), TVRec::TeardownRecorder(), TVRec::TuningNewRecorder(), TVRec::TuningRestartRecorder(), and TVRec::TuningShutdowns().

kFileTransferInUseID

const MBASE_PUBLIC QString kFileTransferInUseID

Definition at line 21 of file programtypes.cpp.

Referenced by BEFileTransfer::BEFileTransfer(), FileTransfer::FileTransfer(), ProgramInfo::QueryIsInUse(), BEFileTransfer::~BEFileTransfer(), and FileTransfer::~FileTransfer().

kTruncatingDeleteInUseID

const MBASE_PUBLIC QString kTruncatingDeleteInUseID

Definition at line 22 of file programtypes.cpp.

Referenced by ProgramInfo::QueryIsInUse(), and MainServer::TruncateAndClose().

kFlaggerInUseID

const MBASE_PUBLIC QString kFlaggerInUseID

Definition at line 23 of file programtypes.cpp.

Referenced by Scheduler::FillRecordingDir(), FlagCommercials(), ProgramInfo::QueryIsDeleteCandidate(), ProgramInfo::QueryIsInUse(), and RebuildSeekTable().

kTranscoderInUseID

const MBASE_PUBLIC QString kTranscoderInUseID

Definition at line 24 of file programtypes.cpp.

Referenced by Scheduler::FillRecordingDir(), ProgramInfo::QueryIsDeleteCandidate(), ProgramInfo::QueryIsInUse(), and Transcode::TranscodeFile().

kPreviewGeneratorInUseID

const MBASE_PUBLIC QString kPreviewGeneratorInUseID

Definition at line 25 of file programtypes.cpp.

Referenced by PreviewGenerator::GetScreenGrab(), PreviewGenerator::LocalPreviewRun(), and ProgramInfo::QueryIsInUse().

kJobQueueInUseID

const MBASE_PUBLIC QString kJobQueueInUseID

Definition at line 26 of file programtypes.cpp.

Referenced by JobQueue::ProcessJob(), ProgramInfo::QueryIsDeleteCandidate(), ProgramInfo::QueryIsInUse(), and JobQueue::RemoveRunningJob().

kCCExtractorInUseID

const MBASE_PUBLIC QString kCCExtractorInUseID

Definition at line 27 of file programtypes.cpp.

Referenced by RunCCExtract().

MarkTypeStrings

stringMarkMap MarkTypeStrings

static

Definition at line 83 of file programtypes.h.

Referenced by markTypeFromString().