File indexing completed on 2024-05-12 04:55:39

 /**
  * \file mp3file.h
  * Handling of tagged MP3 files.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 9 Jan 2003
  *
  * Copyright (C) 2003-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 <QScopedPointer>
 #include "taggedfile.h"
 #include "tagconfig.h"
 
 class ID3_Tag;
 class ID3_Field;
 class ID3_Frame;
 class QTextCodec;
 
 /** List box item containing MP3 file */
 class Mp3File : public TaggedFile {
 public:
   /**
    * Constructor.
    *
    * @param idx index in tagged file system model
    */
   explicit Mp3File(const QPersistentModelIndex& idx);
 
   /**
    * Destructor.
    */
   ~Mp3File() override;
 
   /**
    * Get key of tagged file format.
    * @return "Id3libMetadata".
    */
   QString taggedFileKey() const override;
 
   /**
    * Get features supported.
    * @return bit mask with Feature flags set.
    */
   int taggedFileFeatures() const override;
 
   /**
    * Read tags from file.
    *
    * @param force true to force reading even if tags were already read.
    */
   void readTags(bool force) override;
 
   /**
    * Write tags to file and rename it if necessary.
    *
    * @param force   true to force writing even if file was not changed.
    * @param renamed will be set to true if the file was renamed,
    *                i.e. the file name is no longer valid, else *renamed
    *                is left unchanged
    * @param preserve true to preserve file time stamps
    *
    * @return true if ok, false if the file could not be written or renamed.
    */
   bool writeTags(bool force, bool* renamed, bool preserve) override;
 
   /**
    * Free resources allocated when calling readTags().
    *
    * @param force true to force clearing even if the tags are modified
    */
   void clearTags(bool force) override;
 
   /**
    * Remove frames.
    *
    * @param tagNr tag number
    * @param flt filter specifying which frames to remove
    */
   void deleteFrames(Frame::TagNumber tagNr, const FrameFilter& flt) override;
 
   /**
    * Check if tag information has already been read.
    *
    * @return true if information is available,
    *         false if the tags have not been read yet, in which case
    *         hasTag() does not return meaningful information.
    */
   bool isTagInformationRead() const override;
 
   /**
    * Check if file has a tag.
    *
    * @param tagNr tag number
    * @return true if a tag is available.
    * @see isTagInformationRead()
    */
   bool hasTag(Frame::TagNumber tagNr) const override;
 
   /**
    * Check if tags are supported by the format of this file.
    *
    * @param tagNr tag number
    * @return true.
    */
   bool isTagSupported(Frame::TagNumber tagNr) const override;
 
   /**
    * Get technical detail information.
    *
    * @param info the detail information is returned here
    */
   void getDetailInfo(DetailInfo& info) const override;
 
   /**
    * Get duration of file.
    *
    * @return duration in seconds,
    *         0 if unknown.
    */
   unsigned getDuration() const override;
 
   /**
    * Get file extension including the dot.
    *
    * @return file extension ".mp3".
    */
   QString getFileExtension() const override;
 
   /**
    * Get the format of tag.
    *
    * @param tagNr tag number
    * @return string describing format of tag,
    *         e.g. "ID3v1.1", "ID3v2.3", "ID3v2.4".
    */
   QString getTagFormat(Frame::TagNumber tagNr) const override;
 
   /**
    * Get a specific frame from the tags.
    *
    * @param tagNr tag number
    * @param type  frame type
    * @param frame the frame is returned here
    *
    * @return true if ok.
    */
   bool getFrame(Frame::TagNumber tagNr, Frame::Type type, Frame& frame) const override;
 
   /**
    * Set a frame in the tags.
    *
    * @param tagNr tag number
    * @param frame frame to set
    *
    * @return true if ok.
    */
   bool setFrame(Frame::TagNumber tagNr, const Frame& frame) override;
 
   /**
    * Add a frame in the tags.
    *
    * @param tagNr tag number
    * @param frame frame to add, a field list may be added by this method
    *
    * @return true if ok.
    */
   bool addFrame(Frame::TagNumber tagNr, Frame& frame) override;
 
   /**
    * Delete a frame from the tags.
    *
    * @param tagNr tag number
    * @param frame frame to delete.
    *
    * @return true if ok.
    */
   bool deleteFrame(Frame::TagNumber tagNr, const Frame& frame) override;
 
   /**
    * Get all frames in tag.
    *
    * @param tagNr tag number
    * @param frames frame collection to set.
    */
   void getAllFrames(Frame::TagNumber tagNr, FrameCollection& frames) override;
 
   /**
    * Get a list of frame IDs which can be added.
    * @param tagNr tag number
    * @return list with frame IDs.
    */
   QStringList getFrameIds(Frame::TagNumber tagNr) const override;
 
   /**
    * Add a suitable field list for the frame if missing.
    * If a frame is created, its field list is empty. This method will create
    * a field list appropriate for the frame type and tagged file type if no
    * field list exists.
    * @param tagNr tag number
    * @param frame frame where field list is added
    */
   void addFieldList(Frame::TagNumber tagNr, Frame& frame) const override;
 
   /**
    * Notify about configuration change.
    * This method shall be called when the configuration changes.
    */
   static void notifyConfigurationChange();
 
 private:
   Mp3File(const Mp3File&);
   Mp3File& operator=(const Mp3File&);
 
   /**
    * Set track.
    *
    * @param tag ID3 tag
    * @param num number to set, 0 to remove field.
    * @param numTracks total number of tracks, <=0 to ignore
    *
    * @return true if the field was changed.
    */
   bool setTrackNum(ID3_Tag* tag, int num, int numTracks = 0) const;
 
   /**
    * Set the fields in an id3lib frame from the field in the frame.
    *
    * @param id3Frame id3lib frame
    * @param frame    frame with fields
    */
   void setId3v2Frame(ID3_Frame* id3Frame, const Frame& frame) const;
 
   /**
    * Create an id3lib frame from a frame.
    * @param frame frame
    * @return id3lib frame, 0 if invalid.
    */
   ID3_Frame* createId3FrameFromFrame(Frame& frame) const;
 
   /**
    * Set the encoding to be used for tag 1.
    *
    * @param name of encoding, default is ISO 8859-1
    */
   static void setTextEncodingV1(const QString& name);
 
   /**
    * Set the default text encoding.
    *
    * @param textEnc default text encoding
    */
   static void setDefaultTextEncoding(TagConfig::TextEncoding textEnc);
 
   /** ID3v1 tags */
   QScopedPointer<ID3_Tag> m_tagV1;
 
   /** ID3v2 tags */
   QScopedPointer<ID3_Tag> m_tagV2;
 };