Warning, file /multimedia/kid3/src/core/tags/trackdata.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

 /**
  * \file trackdata.h
  * Track data, frames with association to tagged file.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 7 Jul 2005
  *
  * Copyright (C) 2005-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 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 of the License, or
  * (at your option) any later version.
  *
  * Kid3 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.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <QVector>
 #include <QString>
 #include <QSet>
 #include <QUrl>
 #include "frame.h"
 #include "taggedfile.h"
 #include "kid3api.h"
 
 /**
  * Track data, frames with association to tagged file.
  */
 class KID3_CORE_EXPORT TrackData : public FrameCollection {
 public:
   /**
    * Constructor.
    */
   TrackData();
 
   /**
    * Constructor.
    * All fields are set from the tagged file,
    * which should be read using readTags() before.
    *
    * @param taggedFile tagged file providing track data
    * @param tagVersion source of frames
    */
   TrackData(TaggedFile& taggedFile, Frame::TagVersion tagVersion);
 
   /**
    * Get duration of file.
    * @return duration of file.
    */
   int getFileDuration() const;
 
   /**
    * Get absolute filename.
    *
    * @return absolute file path.
    */
   QString getAbsFilename() const;
 
   /**
    * Get filename.
    *
    * @return filename.
    */
   QString getFilename() const;
 
   /**
    * Get directory name.
    *
    * @return directory name.
    */
   QString getDirname() const;
 
   /**
    * Get file extension including the dot.
    *
    * @param preferFromFilename true to prefer extension from current filename
    *                           over default extension for file type
    *
    * @return file extension, e.g. ".mp3".
    */
   QString getFileExtension(bool preferFromFilename = false) const;
 
   /**
    * Get the total number of tracks in the directory.
    *
    * @return total number of tracks, -1 if unavailable.
    */
   int getTotalNumberOfTracksInDir() const;
 
   /**
    * Get the tag format.
    *
    * @param tagNr tag number
    * @return string describing format of tag,
    *         e.g. "ID3v1.1", "ID3v2.3", "Vorbis", "APE",
    *         QString::null if unknown.
    */
   QString getTagFormat(Frame::TagNumber tagNr) const;
 
   /**
    * Get detail info.
    * @param info the detail information is returned here
    */
   void getDetailInfo(TaggedFile::DetailInfo& info) const;
 
   /**
    * Format a string from track data.
    * Supported format fields:
    * Those supported by TrackDataFormatReplacer::getReplacement()
    *
    * @param format    format specification
    *
    * @return formatted string.
    */
   QString formatString(const QString& format) const;
 
   /**
    * Create filename from tags according to format string.
    *
    * @param str       format string containing codes supported by
    *                  TrackDataFormatReplacer::getReplacement()
    * @param isDirname true to generate a directory name
    *
    * @return format string with format codes replaced by tags.
    */
   QString formatFilenameFromTags(QString str, bool isDirname = false) const;
 
   /**
    * Transform string to file name.
    * The directory part is removed and a file extension added.
    * @param str string to transform
    */
   void transformToFilename(QString& str) const;
 
   /**
    * Get frames.
    * @return frames.
    */
   FrameCollection& getFrameCollection() {
     return *this;
   }
 
   /**
    * Set frames.
    * @param frames frames
    */
   void setFrameCollection(const FrameCollection& frames) {
     *(static_cast<FrameCollection*>(this)) = frames; // clazy:exclude=unneeded-cast
   }
 
   /**
    * Get tagged file associated with this track data.
    * @return tagged file, 0 if none assigned.
    */
   TaggedFile* getTaggedFile() const;
 
   /**
    * Get help text for format codes supported by formatString().
    *
    * @param onlyRows if true only the tr elements are returned,
    *                 not the surrounding table
    *
    * @return help text.
    */
   static QString getFormatToolTip(bool onlyRows = false);
 
 private:
   QPersistentModelIndex m_taggedFileIndex;
 };
 
 /**
  * Track data used for import.
  */
 class ImportTrackData : public TrackData {
 public:
   /**
    * Constructor.
    */
   ImportTrackData() : m_importDuration(0), m_enabled(true) {}
 
   /**
    * Constructor.
    * All fields except the import duration are set from the tagged file,
    * which should be read using readTags() before.
    *
    * @param taggedFile tagged file providing track data
    * @param tagVersion source of frames
    */
   ImportTrackData(TaggedFile& taggedFile, Frame::TagVersion tagVersion)
     : TrackData(taggedFile, tagVersion), m_importDuration(0), m_enabled(true) {}
 
   /**
    * Get duration of import.
    * @return duration of import.
    */
   int getImportDuration() const { return m_importDuration; }
 
   /**
    * Set duration of import.
    * @param duration duration of import
    */
   void setImportDuration(int duration) { m_importDuration = duration; }
 
   /**
    * Check if track is enabled.
    * @return true if enabled (true is default).
    */
   bool isEnabled() const { return m_enabled; }
 
   /**
    * Enable or disable track.
    * @param enabled true to enable
    */
   void setEnabled(bool enabled) { m_enabled = enabled; }
 
   /**
    * Get the difference between the imported duration and the track's duration.
    * @return absolute value of time difference in seconds, -1 if not available.
    */
   int getTimeDifference() const;
 
   /**
    * Get words of file name.
    * @return lower case words found in file name.
    */
   QSet<QString> getFilenameWords() const;
 
   /**
    * Get words of title.
    * @return lower case words found in title.
    */
   QSet<QString> getTitleWords() const;
 
 private:
   int m_importDuration;
   bool m_enabled;
 };
 
 /**
  * Vector containing tracks to import and artist, album names.
  */
 class KID3_CORE_EXPORT ImportTrackDataVector : public QVector<ImportTrackData> {
 public:
   /**
    * Clear vector and associated data.
    */
   void clearData();
 
   /**
    * Get album artist.
    * @return album artist.
    */
   QString getArtist() const;
 
   /**
    * Get album title.
    * @return album title.
    */
   QString getAlbum() const;
 
   /**
    * Check if tag is supported in the first track.
    * @param tagNr tag number
    * @return true if tag is supported.
    */
   bool isTagSupported(Frame::TagNumber tagNr) const;
 
   /**
    * Get cover art URL.
    * @return cover art URL.
    */
   QUrl getCoverArtUrl() const { return m_coverArtUrl; }
 
   /**
    * Set cover art URL.
    * @param coverArtUrl cover art URL
    */
   void setCoverArtUrl(const QUrl& coverArtUrl) { m_coverArtUrl = coverArtUrl; }
 
   /**
    * Read the tags from the files.
    * This can be used to fill the track data with another tag version.
    *
    * @param tagVersion tag version to read
    */
   void readTags(Frame::TagVersion tagVersion);
 
 #ifndef QT_NO_DEBUG
   /**
    * Dump contents of tracks to debug console.
    */
   void dump() const;
 #endif
 
 private:
   /**
    * Get frame from first track.
    * @param type frame type
    * @return value of frame.
    */
   QString getFrame(Frame::Type type) const;
 
   QUrl m_coverArtUrl;
 };
 
 
 /**
  * Replaces track data format codes in a string.
  */
 class KID3_CORE_EXPORT TrackDataFormatReplacer : public FrameFormatReplacer {
 public:
   /**
    * Constructor.
    *
    * @param trackData track data
    * @param str       string with format codes
    */
   explicit TrackDataFormatReplacer(
     const TrackData& trackData,
     const QString& str = QString());
 
   /**
    * Destructor.
    */
   ~TrackDataFormatReplacer() override = default;
 
   TrackDataFormatReplacer(const TrackDataFormatReplacer& other) = delete;
   TrackDataFormatReplacer &operator=(const TrackDataFormatReplacer& other) = delete;
 
   /**
    * Get help text for supported format codes.
    *
    * @param onlyRows if true only the tr elements are returned,
    *                 not the surrounding table
    *
    * @return help text.
    */
   static QString getToolTip(bool onlyRows = false);
 
 protected:
   /**
    * Replace a format code (one character %c or multiple characters %{chars}).
    * Supported format fields:
    * Those supported by FrameFormatReplacer::getReplacement()
    * %f filename
    * %p path to file
    * %u URL of file
    * %d duration in minutes:seconds
    * %D duration in seconds
    * %n number of tracks
    *
    * @param code format code
    *
    * @return replacement string,
    *         QString::null if code not found.
    */
   QString getReplacement(const QString& code) const override;
 
 private:
   const TrackData& m_trackData;
 };