src/cuefile.cpp

   1 // (c) 2005 Martin Ehmke <ehmke@gmx.de>
   2 // License: GNU General Public License V2
   3
   4 #define DEBUG_PREFIX "CueFile"
   5
   6 #include "cuefile.h"
   7
   8 #include "debug.h"
   9 #include "enginecontroller.h"
  10 #include "metabundle.h"
  11
  12 #include <KGlobal>
  13
  14 #include <QFile>
  15 #include <QMap>
  16 #include <QStringList>
  17 #include <QTextStream>
  18
  19
  20 CueFile *CueFile::instance()
  21 {
  22     static CueFile *s_instance = 0;
  23
  24     if(!s_instance)
  25     {
  26         s_instance = new CueFile(EngineController::instance()); // FIXME berkus: le grand borkage (if engine is changed, e.g.)?
  27     }
  28
  29     return s_instance;
  30 }
  31
  32 CueFile::~CueFile()
  33 {
  34     debug() << "shmack! destructed";
  35 }
  36
  37
  38 /*
  39 + - set and continue in the same state
  40 x - cannot happen
  41 track - switch to new state
  42
  43 state/next token >
  44  v         PERFORMER               TITLE           FILE            TRACK            INDEX          PREGAP
  45 begin         +                      +             file              x                x              x
  46 file          x                      x             file            track              x              x
  47 track         +                      +             file              x                +              +
  48 index         x                      x             file            track              +              x
  49
  50 1. Ignore FILE completely.
  51 2. INDEX 00 is gap abs position in cue formats we care about (use it to calc length of prev track and then drop on the floor).
  52 3. Ignore subsequent INDEX entries (INDEX 02, INDEX 03 etc). - FIXME? this behavior is different from state chart above.
  53 4. For a valid cuefile at least TRACK and INDEX are required.
  54 */
  55 enum {
  56     BEGIN = 0,
  57     TRACK_FOUND, // track found, index not yet found
  58     INDEX_FOUND
  59 };
  60
  61
  62 /**
  63 * @return true if the cuefile could be successfully loaded
  64 */
  65 bool CueFile::load(int mediaLength)
  66 {
  67     clear();
  68     m_lastSeekPos = -1;
  69
  70     if( QFile::exists( m_cueFileName ) )
  71     {
  72         QFile file( m_cueFileName );
  73         int track = 0;
  74         QString defaultArtist = QString();
  75         QString defaultAlbum = QString();
  76         QString artist = QString();
  77         QString title = QString();
  78         long length = 0;
  79         long prevIndex = -1;
  80         bool index00Present = false;
  81         long index = -1;
  82
  83         int mode = BEGIN;
  84         if( file.open( QIODevice::ReadOnly ) )
  85         {
  86             QTextStream stream( &file );
  87             QString line;
  88
  89             while ( !stream.atEnd() )
  90             {
  91                 line = stream.readLine().simplified();
  92
  93                 if( line.startsWith( "title", Qt::CaseInsensitive ) )
  94                 {
  95                     title = line.mid( 6 ).remove( '"' );
  96                     if( mode == BEGIN )
  97                     {
  98                         defaultAlbum = title;
  99                         title.clear();
 100                         debug() << "Album: " << defaultAlbum;
 101                     }
 102                     else
 103                         debug() << "Title: " << title;
 104                 }
 105
 106                 else if( line.startsWith( "performer", Qt::CaseInsensitive ))
 107                 {
 108                     artist = line.mid( 10 ).remove( '"' );
 109                     if( mode == BEGIN )
 110                     {
 111                         defaultArtist = artist;
 112                         artist.clear();
 113                         debug() << "Album Artist: " << defaultArtist;
 114                     }
 115                     else
 116                         debug() << "Artist: " << artist;
 117                 }
 118
 119                 else if( line.startsWith( "track", Qt::CaseInsensitive ) )
 120                 {
 121                     if( mode == TRACK_FOUND )
 122                     {
 123                         // not valid, because we have to have an index for the previous track
 124                         file.close();
 125                         debug() << "Mode is TRACK_FOUND, abort.";
 126                         return false;
 127                     }
 128                     if( mode == INDEX_FOUND )
 129                     {
 130                         if(artist.isNull())
 131                             artist = defaultArtist;
 132
 133                         debug() << "Inserting item: " << title << " - " << artist << " on " << defaultAlbum << " (" << track << ")";
 134                         // add previous entry to map
 135                         insert( index, CueFileItem( title, artist, defaultAlbum, track, index ) );
 136                         prevIndex = index;
 137                         title.clear();
 138                         artist.clear();
 139                         track  = 0;
 140                     }
 141                     track = line.section (' ',1,1).toInt();
 142                     debug() << "Track: " << track;
 143                     mode = TRACK_FOUND;
 144                 }
 145                 else if( line.startsWith( "index", Qt::CaseInsensitive ) )
 146                 {
 147                     if( mode == TRACK_FOUND)
 148                     {
 149                         int indexNo = line.section(' ',1,1).toInt();
 150
 151                         if( indexNo == 1 )
 152                         {
 153                             QString splitMe = line.section( ' ', -1, -1 );
 154                             QStringList time = splitMe.split( ":", QString::SkipEmptyParts );
 155
 156                             index = time[0].toLong()*60*1000 + time[1].toLong()*1000 + time[2].toLong()*1000/75; //75 frames per second
 157
 158                              if( prevIndex != -1 && !index00Present ) // set the prev track's length if there is INDEX01 present, but no INDEX00
 159                             {
 160                                 length = index - prevIndex;
 161                                 debug() << "Setting length of track " << (*this)[prevIndex].getTitle() << " to " << length << " msecs.";
 162                                 (*this)[prevIndex].setLength(length);
 163                             }
 164
 165                             index00Present = false;
 166                             mode = INDEX_FOUND;
 167                             length = 0;
 168                         }
 169
 170                         else if( indexNo == 0 ) // gap, use to calc prev track length
 171                         {
 172                             QString splitMe = line.section( ' ', -1, -1 );
 173                             QStringList time = splitMe.split( ":", QString::SkipEmptyParts );
 174
 175                             length = time[0].toLong()*60*1000 + time[1].toLong()*1000 + time[2].toLong()*1000/75; //75 frames per second
 176
 177                             if( prevIndex != -1 )
 178                             {
 179                                 length -= prevIndex; //this[prevIndex].getIndex();
 180                                 debug() << "Setting length of track " << (*this)[prevIndex].getTitle() << " to " << length << " msecs.";
 181                                 (*this)[prevIndex].setLength(length);
 182                                 index00Present = true;
 183                             }
 184                             else
 185                                 length =  0;
 186                         }
 187                         else
 188                         {
 189                             debug() << "Skipping unsupported INDEX " << indexNo;
 190                         }
 191                     }
 192                     else
 193                     {
 194                         // not valid, because we don't have an associated track
 195                         file.close();
 196                         debug() << "Mode is not TRACK_FOUND but encountered INDEX, abort.";
 197                         return false;
 198                     }
 199                     debug() << "index: " << index;
 200                 }
 201             }
 202
 203             if(artist.isNull())
 204                 artist = defaultArtist;
 205
 206             debug() << "Inserting item: " << title << " - " << artist << " on " << defaultAlbum << " (" << track << ")";
 207             // add previous entry to map
 208             insert( index, CueFileItem( title, artist, defaultAlbum, track, index ) );
 209             file.close();
 210         }
 211
 212         /**
 213             *  Because there is no way to set the length for the last track in a normal way,
 214             *  we have to do some magic here. Having the total length of the media file given
 215             *  we can set the lenth for the last track after all the cue file was loaded into array.
 216             */
 217
 218         (*this)[index].setLength(mediaLength*1000 - index);
 219         debug() << "Setting length of track " << (*this)[index].getTitle() << " to " << mediaLength*1000 - index << " msecs.";
 220
 221         return true;
 222     }
 223
 224     else
 225         return false;
 226 }
 227
 228 void CueFile::engineTrackPositionChanged( long position, bool userSeek )
 229 {
 230     Q_UNUSED( position ); Q_UNUSED( userSeek );
 231     //TODO: port 2.0 reimplement this
 232     /*position /= 1000;
 233     if(userSeek || position > m_lastSeekPos)
 234     {
 235         CueFile::Iterator it = end();
 236         while( it != begin() )
 237         {
 238             --it;
 239 //            debug() << "Checking " << position << " against pos " << it.key()/1000 << " title " << it.data().getTitle();
 240             if(it.key()/1000 <= position)
 241             {
 242                 MetaBundle bundle = EngineController::instance()->bundle(); // take current one and modify it
 243                 if(it.data().getTitle() != bundle.title()
 244                    || it.data().getArtist() != bundle.artist()
 245                    || it.data().getAlbum() != bundle.album()
 246                    || it.data().getTrackNumber() != bundle.track())
 247                 {
 248                     bundle.setTitle(it.data().getTitle());
 249                     bundle.setArtist(it.data().getArtist());
 250                     bundle.setAlbum(it.data().getAlbum());
 251                     bundle.setTrack(it.data().getTrackNumber());
 252                     emit metaData(bundle);
 253
 254                     long length = it.data().getLength();
 255                     if ( length == -1 ) // need to calculate
 256                     {
 257                         ++it;
 258                         long nextKey = it == end() ? bundle.length() * 1000 : it.key();
 259                         --it;
 260                         length = qMax( nextKey - it.key(), 0L );
 261                     }
 262                     emit newCuePoint( position, it.key() / 1000, ( it.key() + length ) / 1000 );
 263                 }
 264                 break;
 265             }
 266         }
 267     }
 268
 269     m_lastSeekPos = position;*/
 270 }
 271
 272
 273 #include "cuefile.moc"
 274
 275
 276