include/mmp.h

   1 /*
   2  * mmp.h - class for reading and writing multimedia-project-files
   3  *
   4  * Copyright (c) 2004-2009 Tobias Doerffel <tobydox/at/users.sourceforge.net>
   5  *
   6  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program (see COPYING); if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301 USA.
  22  *
  23  */
  24
  25
  26 #ifndef _MMP_H
  27 #define _MMP_H
  28
  29 #include <QtXml/QDomDocument>
  30
  31 #include "export.h"
  32 #include "lmms_basics.h"
  33
  34
  35 class EXPORT multimediaProject : public QDomDocument
  36 {
  37 public:
  38         enum ProjectTypes
  39         {
  40                 UnknownType,
  41                 SongProject,
  42                 SongProjectTemplate,
  43                 InstrumentTrackSettings,
  44                 DragNDropData,
  45                 ClipboardData,
  46                 JournalData,
  47                 EffectSettings,
  48                 VideoProject,           // might come later...
  49                 BurnProject,            // might come later...
  50                 Playlist,               // might come later...
  51                 NumProjectTypes
  52         } ;
  53
  54
  55         multimediaProject( const QString & _fileName );
  56         multimediaProject( const QByteArray & _data );
  57         multimediaProject( ProjectTypes _project_type );
  58         virtual ~multimediaProject();
  59
  60         QString nameWithExtension( const QString & _fn ) const;
  61
  62         bool writeFile( const QString & _fn );
  63
  64         inline QDomElement & content()
  65         {
  66                 return( m_content );
  67         }
  68         inline QDomElement & head()
  69         {
  70                 return( m_head );
  71         }
  72
  73         inline ProjectTypes type() const
  74         {
  75                 return( m_type );
  76         }
  77
  78
  79 private:
  80         static ProjectTypes type( const QString & _type_name );
  81         static QString typeName( ProjectTypes _project_type );
  82
  83         void cleanMetaNodes( QDomElement _de );
  84
  85         void upgrade();
  86
  87         void loadData( const QByteArray & _data, const QString & _sourceFile );
  88
  89
  90         struct EXPORT typeDescStruct
  91         {
  92                 ProjectTypes m_type;
  93                 QString m_name;
  94         } ;
  95         static typeDescStruct s_types[NumProjectTypes];
  96
  97         QDomElement m_content;
  98         QDomElement m_head;
  99         ProjectTypes m_type;
 100
 101 } ;
 102
 103
 104 const Uint8 MMP_MAJOR_VERSION = 1;
 105 const Uint8 MMP_MINOR_VERSION = 0;
 106 const QString MMP_VERSION_STRING = QString::number( MMP_MAJOR_VERSION ) + "." +
 107                                         QString::number( MMP_MINOR_VERSION );
 108
 109
 110 #endif
 111