k3b/libk3bdevice/k3bmsf.h

/* 
 *
 * $Id: k3bmsf.h 619556 2007-01-03 17:38:12Z trueg $
 * Copyright (C) 2003-2007 Sebastian Trueg <trueg@k3b.org>
 *
 * This file is part of the K3b project.
 * Copyright (C) 1998-2007 Sebastian Trueg <trueg@k3b.org>
 *
 * 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.
 * See the file "COPYING" for the exact licensing terms.
 */


#ifndef _K3B_MSF_H_
#define _K3B_MSF_H_

#include <tqstring.h>
#include <tqregexp.h>

#include <kdebug.h>
#include <kio/global.h>
#include "k3bdevice_export.h"

namespace K3b
{
  /**
   * int values are always treated as frames
   * except in the set methods
   * A MSF is never < 0.
   */
  class LIBK3BDEVICE_EXPORT Msf
    {
    public:
      Msf();
      Msf( const Msf& );
      Msf( int, int, int );
      Msf( int );

      Msf& operator=( const Msf& );
      Msf& operator=( int );
      Msf& operator+=( const Msf& );
      Msf& operator+=( int );
      Msf& operator-=( const Msf& );
      Msf& operator-=( int );
      const Msf operator++( int );
      Msf& operator++();
      const Msf operator--( int );
      Msf& operator--();

      int minutes() const { return m_minutes; }
      int seconds() const { return m_seconds; }
      int frames() const { return m_frames; }

      int totalFrames() const { return ( m_minutes*60 + m_seconds )*75 + m_frames; }
      int lba() const { return totalFrames(); }

      //      operator int () const { return lba(); }

      void setValue( int m, int s, int f );

      void addMinutes( int m );
      void addSeconds( int s );
      void addFrames( int f );

      TQString toString( bool showFrames = true ) const;

      TDEIO::filesize_t mode1Bytes() const;
      TDEIO::filesize_t mode2Form1Bytes() const;
      TDEIO::filesize_t mode2Form2Bytes() const;
      TDEIO::filesize_t audioBytes() const;
      TDEIO::filesize_t rawBytes() const;
      unsigned long long pcmSamples() const { return lba()*588; }

      /**
       * Convert a string representation into an Msf object.
       *
       * Valid strings include:
       * \li 100       - treated as 100 frames
       * \li 100:23    - treated as 100 minutes and 23 seconds
       * \li 100:23:57 - treated as 100 minutes, 23 seconds, and 57 frames
       * \li 100:23.57 - treated as 100 minutes, 23 seconds, and 57 frames
       */
      static Msf fromString( const TQString&, bool* ok = 0 );

      /**
       * @param ms seconds
       * frames will be rounded up
       */
      static Msf fromSeconds( double ms );

      static TQRegExp regExp();

    private:
      void makeValid();
      int m_minutes;
      int m_seconds;
      int m_frames;
    };

  LIBK3BDEVICE_EXPORT Msf operator+( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT Msf operator+( const Msf&, int );
  LIBK3BDEVICE_EXPORT Msf operator-( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT Msf operator-( const Msf&, int );
  LIBK3BDEVICE_EXPORT bool operator==( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT bool operator!=( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT bool operator<( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT bool operator>( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT bool operator<=( const Msf&, const Msf& );
  LIBK3BDEVICE_EXPORT bool operator>=( const Msf&, const Msf& );

  LIBK3BDEVICE_EXPORT kdbgstream& operator<<( kdbgstream&, const Msf& );
  LIBK3BDEVICE_EXPORT inline kndbgstream& operator<<( kndbgstream &stream, const Msf& ) { return stream; }
}

#endif