CuteLogger
Fast and simple logging solution for Qt based applications
shotcut_mlt_properties.h
1/*
2 * Copyright (c) 2013-2025 Meltytech, LLC
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18#ifndef SHOTCUT_MLT_PROPERTIES_H
19#define SHOTCUT_MLT_PROPERTIES_H
20
21/* This file contains all of the Shotcut-specific MLT properties.
22 * See also https://www.shotcut.org/notes/mltxml-annotations/
23 *
24 * A property should be prefaced with an underscore if it will not be saved
25 * in the XML even if it never has a chance of getting into there. This makes
26 * it more clear which is also an XML annotation or purely internal use.
27 */
28
29/* MLT XML annotations */
30
31#define kShotcutXmlProperty "shotcut"
32#define kAudioTrackProperty "shotcut:audio"
33#define kCommentProperty "shotcut:comment"
34#define kShotcutFilterProperty "shotcut:filter"
35#define kShotcutPlaylistProperty "shotcut:playlist"
36#define kShotcutTransitionProperty "shotcut:transition"
37#define kShotcutProducerProperty "shotcut:producer"
38#define kShotcutVirtualClip "shotcut:virtual"
39#define kTimelineScaleProperty "shotcut:scaleFactor"
40#define kTrackHeightProperty "shotcut:trackHeight"
41#define kTrackHeaderWidthProperty "shotcut:trackHeaderWidth"
42#define kTrackNameProperty "shotcut:name"
43#define kTrackLockProperty "shotcut:lock"
44#define kVideoTrackProperty "shotcut:video"
45#define kShotcutCaptionProperty "shotcut:caption"
46#define kShotcutDetailProperty "shotcut:detail"
47#define kShotcutHashProperty "shotcut:hash"
48#define kShotcutHiddenProperty "shotcut:hidden"
49#define kShotcutSkipConvertProperty "shotcut:skipConvert"
50#define kShotcutAnimInProperty "shotcut:animIn"
51#define kShotcutAnimOutProperty "shotcut:animOut"
52#define kShotcutMarkersProperty "shotcut:markers"
53#define kShotcutGroupProperty "shotcut:group"
54// Shotcut's VUI (video user interface) components set this so that glwidget can
55// hide the VUI when the play head is not over the clip with the current filter.
56#define kShotcutVuiMetaProperty "meta.shotcut.vui"
57#define kDefaultAudioIndexProperty "shotcut:defaultAudioIndex"
58#define kOriginalResourceProperty "shotcut:resource"
59#define kOriginalInProperty "shotcut:originalIn"
60#define kOriginalOutProperty "shotcut:originalOut"
61#define kDisableProxyProperty "shotcut:disableProxy"
62#define kBackupProperty "shotcut:backup"
63// "shotcut:proxy" is internal only because older versions do not know to hide it.
64// "shotcut:metaProxy" indicates whether the "meta." properties reflect source or proxy.
65#define kMetaProxyProperty "shotcut:proxy.meta"
66#define kShotcutBinsProperty "shotcut:bins"
67
68/* Project specific properties */
69#define kShotcutProjectAudioChannels "shotcut:projectAudioChannels"
70#define kShotcutProjectFolder "shotcut:projectFolder"
71#define kShotcutProjectNote "shotcut:projectNote"
72
73/* Ideally all shotcut properties should begin with "shotcut:", but these
74 * do not and kept for legacy reasons? */
75
76#define kAspectRatioNumerator "shotcut_aspect_num"
77#define kAspectRatioDenominator "shotcut_aspect_den"
78#define kShotcutSequenceProperty "shotcut_sequence"
79
80/* Special object Ids expected by Shotcut and used in XML */
81
82#define kBackgroundTrackId "background"
83#define kLegacyPlaylistTrackId "main bin"
84#define kPlaylistTrackId "main_bin"
85
86/* Internal only */
87
88#define kAudioLevelsProperty "_shotcut:audio-levels"
89#define kBackgroundCaptureProperty "_shotcut:bgcapture"
90#define kPlaylistIndexProperty "_shotcut:playlistIndex"
91#define kPlaylistStartProperty "_shotcut:playlistStart"
92#define kFilterInProperty "_shotcut:filter_in"
93#define kFilterOutProperty "_shotcut:filter_out"
94#define kThumbnailInProperty "_shotcut:thumbnail-in"
95#define kThumbnailOutProperty "_shotcut:thumbnail-out"
96#define kUuidProperty "_shotcut:uuid"
97#define kMultitrackItemProperty "_shotcut:multitrack-item"
98#define kExportFromProperty "_shotcut:exportFromDefault"
99#define kTrackIndexProperty "_shotcut:trackIndex"
100#define kFilterIndexProperty "_shotcut:filterIndex"
101#define kNewFilterProperty "_shotcut:newFilter"
102#define kShotcutFiltersClipboard "shotcut:filtersClipboard"
103#define kIsProxyProperty "shotcut:proxy"
104
105#define kDefaultMltProfile "atsc_1080p_25"
106
107#endif // SHOTCUT_MLT_PROPERTIES_H