Handle TRACKTOTAL/DISCTOTAL/PARTTOTAL fields in Vorbis Comments

See the corresponding tagparser commit

application/main.cpp

@@ -85,6 +85,9 @@ SetTagInfoArgs::SetTagInfoArgs(Argument &filesArg, Argument &verboseArg, Argumen
     , preserveModificationTimeArg("preserve-modification-time", '\0', "preserves the file's modification time")
     , preserveMuxingAppArg("preserve-muxing-app", '\0', "preserves the file's muxing app meta-data value")
     , preserveWritingAppArg("preserve-writing-app", '\0', "preserves the file's writing app meta-data value")
+    , preserveTotalFieldsArg("preserve-total-fields", '\0',
+          "preserves the TRACKTOTAL/DISCTOTAL/PARTTOTAL fields in Vorbis Comments (which are otherwise automatically included into the "
+          "TRACKNUMBER/DISCNUMBER/PARTNUMBER fields)")
     , jsArg("script", 'j', "modifies tag fields via the specified JavaScript", { "path" })
     , jsSettingsArg("script-settings", '\0', "passes settings to the JavaScript specified via --script", { "key=value" })
     , setTagInfoArg("set", 's', "sets the specified tag information and attachments")
@@ -142,7 +145,8 @@ SetTagInfoArgs::SetTagInfoArgs(Argument &filesArg, Argument &verboseArg, Argumen
         &id3v2UsageArg, &id3InitOnCreateArg, &id3TransferOnRemovalArg, &mergeMultipleSuccessiveTagsArg, &id3v2VersionArg, &encodingArg,
         &removeTargetArg, &addAttachmentArg, &updateAttachmentArg, &removeAttachmentArg, &removeExistingAttachmentsArg, &minPaddingArg,
         &maxPaddingArg, &prefPaddingArg, &tagPosArg, &indexPosArg, &forceRewriteArg, &backupDirArg, &layoutOnlyArg, &preserveModificationTimeArg,
-        &preserveMuxingAppArg, &preserveWritingAppArg, &jsArg, &jsSettingsArg, &verboseArg, &pedanticArg, &quietArg, &outputFilesArg });
+        &preserveMuxingAppArg, &preserveWritingAppArg, &preserveTotalFieldsArg, &jsArg, &jsSettingsArg, &verboseArg, &pedanticArg, &quietArg,
+        &outputFilesArg });
 }
 
 } // namespace Cli

application/settings.cpp

@@ -131,6 +131,7 @@ void restore()
         = settings.value(QStringLiteral("preservemodificationtime"), v.tagPocessing.preserveModificationTime).toBool();
     v.tagPocessing.preserveMuxingApp = settings.value(QStringLiteral("preservemuxingapp"), v.tagPocessing.preserveMuxingApp).toBool();
     v.tagPocessing.preserveWritingApp = settings.value(QStringLiteral("preservewritingapp"), v.tagPocessing.preserveWritingApp).toBool();
+    v.tagPocessing.convertTotalFields = settings.value(QStringLiteral("converttotalfields"), v.tagPocessing.convertTotalFields).toBool();
     settings.beginGroup(QStringLiteral("id3v1"));
     switch (settings.value(QStringLiteral("usage"), 0).toInt()) {
     case 1:
@@ -270,6 +271,7 @@ void save()
     settings.setValue(QStringLiteral("preservemodificationtime"), v.tagPocessing.preserveModificationTime);
     settings.setValue(QStringLiteral("preservemuxingapp"), v.tagPocessing.preserveMuxingApp);
     settings.setValue(QStringLiteral("preservewritingapp"), v.tagPocessing.preserveWritingApp);
+    settings.setValue(QStringLiteral("converttotalfields"), v.tagPocessing.convertTotalFields);
     settings.beginGroup(QStringLiteral("id3v1"));
     settings.setValue(QStringLiteral("usage"), static_cast<int>(v.tagPocessing.creationSettings.id3v1usage));
     settings.endGroup();

application/settings.h

@@ -82,6 +82,7 @@ struct TagProcessing {
     bool preserveModificationTime = false;
     bool preserveMuxingApp = false;
     bool preserveWritingApp = false;
+    bool convertTotalFields = true;
     TagParser::TagCreationSettings creationSettings;
     FileLayout fileLayout;
 };

cli/mainfeatures.cpp

@@ -391,7 +391,8 @@ void displayTagInfo(
     // parse specified fields
     const auto fields = parseFieldDenotations(fieldsArg, true);
 
-    MediaFileInfo fileInfo;
+    auto fileInfo = MediaFileInfo();
+    fileInfo.setFileHandlingFlags(fileInfo.fileHandlingFlags() | MediaFileHandlingFlags::ConvertTotalFields);
     for (const char *file : filesArg.values()) {
         Diagnostics diag;
         AbortableProgressFeedback progress; // FIXME: actually use the progress object
@@ -709,6 +710,9 @@ void setTagInfo(const SetTagInfoArgs &args)
     if (args.preserveWritingAppArg.isPresent()) {
         fileInfo.setFileHandlingFlags(fileInfo.fileHandlingFlags() | MediaFileHandlingFlags::PreserveWritingApplication);
     }
+    if (!args.preserveTotalFieldsArg.isPresent()) {
+        fileInfo.setFileHandlingFlags(fileInfo.fileHandlingFlags() | MediaFileHandlingFlags::ConvertTotalFields);
+    }
 
     // set backup path
     if (args.backupDirArg.isPresent()) {

cli/mainfeatures.h

@@ -50,6 +50,7 @@ struct SetTagInfoArgs {
     CppUtilities::ConfigValueArgument preserveModificationTimeArg;
     CppUtilities::ConfigValueArgument preserveMuxingAppArg;
     CppUtilities::ConfigValueArgument preserveWritingAppArg;
+    CppUtilities::ConfigValueArgument preserveTotalFieldsArg;
     CppUtilities::ConfigValueArgument jsArg;
     CppUtilities::ConfigValueArgument jsSettingsArg;
     CppUtilities::OperationArgument setTagInfoArg;

gui/settingsdialog.cpp

@@ -360,6 +360,7 @@ bool TagProcessingGeneralOptionPage::apply()
         settings.preserveModificationTime = ui()->preserveModificationTimeCheckBox->isChecked();
         settings.preserveMuxingApp = ui()->preserveMuxingAppCheckBox->isChecked();
         settings.preserveWritingApp = ui()->preserveWritingAppCheckBox->isChecked();
+        settings.convertTotalFields = ui()->convertTotalFieldsCheckBox->isChecked();
     }
     return true;
 }
@@ -397,6 +398,7 @@ void TagProcessingGeneralOptionPage::reset()
         ui()->preserveModificationTimeCheckBox->setChecked(settings.preserveModificationTime);
         ui()->preserveMuxingAppCheckBox->setChecked(settings.preserveMuxingApp);
         ui()->preserveWritingAppCheckBox->setChecked(settings.preserveWritingApp);
+        ui()->convertTotalFieldsCheckBox->setChecked(settings.convertTotalFields);
     }
 }
 

gui/tageditorwidget.cpp

@@ -835,6 +835,11 @@ bool TagEditorWidget::startParsing(const QString &path, bool forceRefresh)
         m_currentDir = fileInfo.absolutePath();
         m_fileName = fileInfo.fileName();
     }
+    // set flags that are also important when parsing
+    auto &generalSettings = Settings::values().tagPocessing;
+    auto flags = m_fileInfo.fileHandlingFlags();
+    CppUtilities::modFlagEnum(flags, MediaFileHandlingFlags::ConvertTotalFields, generalSettings.convertTotalFields);
+    m_fileInfo.setFileHandlingFlags(flags);
     // write diagnostics to m_diagReparsing if making results are available
     m_makingResultsAvailable &= sameFile;
     Diagnostics &diag = m_makingResultsAvailable ? m_diagReparsing : m_diag;
@@ -1166,12 +1171,11 @@ bool TagEditorWidget::startSaving()
     m_fileInfo.setMaxPadding(fileLayoutSettings.maxPadding);
     m_fileInfo.setPreferredPadding(fileLayoutSettings.preferredPadding);
     m_fileInfo.setBackupDirectory(settings.editor.backupDirectory);
-    if (generalSettings.preserveMuxingApp) {
-        m_fileInfo.setFileHandlingFlags(m_fileInfo.fileHandlingFlags() | MediaFileHandlingFlags::PreserveMuxingApplication);
-    }
-    if (generalSettings.preserveWritingApp) {
-        m_fileInfo.setFileHandlingFlags(m_fileInfo.fileHandlingFlags() | MediaFileHandlingFlags::PreserveWritingApplication);
-    }
+    auto flags = m_fileInfo.fileHandlingFlags();
+    CppUtilities::modFlagEnum(flags, MediaFileHandlingFlags::PreserveMuxingApplication, generalSettings.preserveMuxingApp);
+    CppUtilities::modFlagEnum(flags, MediaFileHandlingFlags::PreserveWritingApplication, generalSettings.preserveWritingApp);
+    CppUtilities::modFlagEnum(flags, MediaFileHandlingFlags::ConvertTotalFields, generalSettings.convertTotalFields);
+    m_fileInfo.setFileHandlingFlags(flags);
     const auto startThread = [this, preserveModificationTime = settings.tagPocessing.preserveModificationTime] {
         // define functions to show the saving progress and to actually applying the changes
         auto showPercentage([this](AbortableProgressFeedback &progress) {

gui/tagprocessinggeneraloptionpage.ui

@@ -159,6 +159,16 @@
         </property>
        </widget>
       </item>
+      <item>
+       <widget class="QCheckBox" name="convertTotalFieldsCheckBox">
+        <property name="toolTip">
+         <string>Ensures fields usually holding values like &quot;3/15&quot; such as the track position are actually stored as such (and &lt;i&gt;not&lt;/i&gt; as two separate fields for the position and total values). This is required for the tag editor to support handling such separately stored total values at all. So far this only affects Vorbis Comments where it will convert the fields TRACKTOTAL/DISCTOTAL/PARTTOTAL to be included in the TRACKNUMBER/DISCNUMBER/PARTNUMBER fields.</string>
+        </property>
+        <property name="text">
+         <string>Convert total fields (see tooltip for details)</string>
+        </property>
+       </widget>
+      </item>
      </layout>
     </widget>
    </item>