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

 /**
  * \file flacfile.hpp
  * Handling of FLAC files.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 04 Oct 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 <QScopedPointer>
 #include "oggflacconfig.h"
 #include "oggfile.hpp"
 
 namespace FLAC {
   namespace Metadata {
     class Chain;
     class VorbisComment;
     class StreamInfo;
     class Picture;
   }
 }
 
  /** List box item containing FLAC file */
 class FlacFile : public OggFile {
 public:
   /**
    * Constructor.
    *
    * @param idx index in file proxy model
    */
   explicit FlacFile(const QPersistentModelIndex& idx);
 
   /**
    * Destructor.
    */
   ~FlacFile() override;
 
   /**
    * Get key of tagged file format.
    * @return "FlacMetadata".
    */
   QString taggedFileKey() 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;
 
   /**
    * 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 ".flac".
    */
   QString getFileExtension() const override;
 
 #ifdef HAVE_FLAC_PICTURE
   /**
    * 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;
 
   /**
    * 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
    *
    * @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;
 
   /**
    * Remove frames.
    *
    * @param tagNr tag number
    * @param flt filter specifying which frames to remove
    */
   void deleteFrames(Frame::TagNumber tagNr, const FrameFilter& flt) override;
 
   /**
    * Get all frames in tag.
    *
    * @param tagNr tag number
    * @param frames frame collection to set.
    */
   void getAllFrames(Frame::TagNumber tagNr, FrameCollection& frames) override;
 #endif // HAVE_FLAC_PICTURE
 
 private:
   FlacFile(const FlacFile&);
   FlacFile& operator=(const FlacFile&);
 
   /**
    * Read information about a FLAC file.
    * @param info file info to fill
    * @param si stream info
    * @return true if ok.
    */
   bool readFileInfo(FileInfo& info, const FLAC::Metadata::StreamInfo* si) const;
 
   /**
    * Set the vorbis comment block with the comments.
    *
    * @param vc vorbis comment block to set
    */
   void setVorbisComment(FLAC::Metadata::VorbisComment* vc);
 
 #ifdef HAVE_FLAC_PICTURE
   /** Pictures */
   typedef QList<Frame> PictureList;
   PictureList m_pictures;
 #endif // HAVE_FLAC_PICTURE
 
   /** FLAC metadata chain. */
   QScopedPointer<FLAC::Metadata::Chain> m_chain;
 };