File indexing completed on 2025-01-19 04:24:29

 /****************************************************************************************
  * Copyright (c) 2009 Alejandro Wainzinger <aikawarazuni@gmail.com>                     *
  * Copyright (c) 2011 Matěj Laitl <matej@laitl.cz>                                      *
  *                                                                                      *
  * This program 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.                                                                             *
  *                                                                                      *
  * This program 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/>.                           *
  ****************************************************************************************/
 
 #ifndef MEDIADEVICEHANDLER_READCAPABILITY_H
 #define MEDIADEVICEHANDLER_READCAPABILITY_H
 
 #include "core-impl/collections/mediadevicecollection/MediaDeviceMeta.h"
 #include "core-impl/collections/mediadevicecollection/handler/MediaDeviceHandlerCapability.h"
 #include "core-impl/collections/mediadevicecollection/support/mediadevicecollection_export.h"
 
 #include <QDateTime>
 
 namespace Handler
 {
 
 class MEDIADEVICECOLLECTION_EXPORT ReadCapability : public Handler::Capability
 {
     Q_OBJECT
 
     public:
         explicit ReadCapability( QObject *parent ) : Capability( parent ) {}
         ~ReadCapability() override;
 
         static Type capabilityInterfaceType() { return Handler::Capability::Readable; }
 
         /* Parsing of Tracks on Device */
 
         /**
          * Initializes iteration over some list of track structs
          * e.g. with libgpod, this initializes a GList to the beginning of
          * the list of tracks
          */
         virtual void prepareToParseTracks() = 0;
 
         /**
          * Runs a test to see if we have reached the end of
          * the list of tracks to be parsed on the device, e.g. in libgpod
          * this tests if cur != NULL, i.e. if(cur)
          */
         virtual bool isEndOfParseTracksList() = 0;
 
         /**
          * Moves the iterator to the next track on the list of
          *  track structs, e.g. with libgpod, cur = cur->next where cur
          *  is a GList*
          */
         virtual void prepareToParseNextTrack() = 0;
 
         /**
          * This method attempts to access the special struct of the
          * next track, so that information can then be parsed from it.
          * For libgpod, this is m_currtrack = (Itdb_Track*) cur->data
          */
         virtual void nextTrackToParse() = 0;
 
         /**
          * This method must create a two-way association of the current Meta::Track
          * to the special struct provided by the library to read/write information.
          * For example, for libgpod one would associate Itdb_Track*.  It makes
          * the most sense to use a QHash since it is fastest lookup and order
          * does not matter.
          * @param track The track to two-way associate with a library track struct
          */
         virtual void setAssociateTrack( const Meta::MediaDeviceTrackPtr track ) = 0;
 
         /*
          * Methods that wrap get/set of information using given library (e.g. libgpod)
          * Subclasses of MediaDeviceHandler must keep a pointer to the track struct
          * associated to the track parameter to get the information from the struct in libGet*,
          * and to set the struct's information to the passed metadata in libSet*
          */
 
         virtual QString libGetAlbum( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QString libGetArtist( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QString libGetAlbumArtist( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QString libGetComposer( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QString libGetGenre( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetYear( const Meta::MediaDeviceTrackPtr &track ) = 0;
 
         virtual QString libGetTitle( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual qint64  libGetLength( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetTrackNumber( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QString libGetComment( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetDiscNumber( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetBitrate( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetSamplerate( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual qreal   libGetBpm( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetFileSize( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetPlayCount( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QDateTime libGetLastPlayed( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual int     libGetRating( const Meta::MediaDeviceTrackPtr &track )  = 0;
         virtual QString libGetType( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual QUrl    libGetPlayableUrl( const Meta::MediaDeviceTrackPtr &track ) = 0;
         virtual bool    libIsCompilation( const Meta::MediaDeviceTrackPtr &track );
         virtual qreal   libGetReplayGain( const Meta::MediaDeviceTrackPtr &track );
 
         /**
          * Get used capacity on the device, in bytes. Returns 0.0 if capacity information
          * is not appropriate or not available.
          */
         virtual float usedCapacity() const { return 0.0; }
 
         /**
          * Get total (used + free) capacity on the device, in bytes. Returns 0.0 if
          * capacity information is not appropriate or not available.
          */
         virtual float totalCapacity() const { return 0.0; }
 
 };
 }
 
 #endif