K3BExportPlugin.h

Go to the documentation of this file.

/*************************************************************************
 *      K3BExportPlugin.h  -  export of K3b project files
 *                             -------------------
 *    begin                : Thu Apr 13 2017
 *    copyright            : (C) 2017 by Thomas Eschenbacher
 *    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef K3B_EXPORT_PLUGIN_H
#define K3B_EXPORT_PLUGIN_H

#include "config.h"

#include <QObject>
#include <QStringList>
#include <QUrl>
#include <QVariantList>
#include <QVector>

#include "libkwave/Plugin.h"

class QDomElement;

namespace Kwave
{

    class K3BExportPlugin: public Kwave::Plugin
    {
        Q_OBJECT
    public:

        typedef enum {
            EXPORT_TO_SAME_DIR = 0,
            EXPORT_TO_SUB_DIR  = 1
        } export_location_t ;

        typedef enum {
            OVERWRITE_EXISTING_FILES = 0,
            USE_NEW_FILE_NAMES       = 1
        } overwrite_policy_t;

        K3BExportPlugin(QObject *parent, const QVariantList &args);

        virtual ~K3BExportPlugin() Q_DECL_OVERRIDE;

        virtual void load(QStringList &params) Q_DECL_OVERRIDE;

        virtual QStringList *setup(QStringList &params) Q_DECL_OVERRIDE;

        virtual int start(QStringList &params) Q_DECL_OVERRIDE;

        static QStringList knownPatterns();

    protected:

        typedef struct {
            unsigned int   m_index;    
            QString        m_filename; 
            sample_index_t m_start;    
            sample_index_t m_length;   
            QString        m_title;    
            QString        m_artist;   
        } BlockInfo;

        int interpreteParameters(QStringList &params);

        void scanBlocksToSave(const QString &base,
                              sample_index_t selection_left,
                              sample_index_t selection_right);

        QString createFileName(const QString &pattern, unsigned int index);

        bool detectBlockMetaData(const QString &text,
                                 const QString &pattern,
                                 BlockInfo &block);

        void saveGeneralDocumentData(QDomElement *part);

        void saveDocumentData(QDomElement *docElem);

        int saveBlocks(bool selection_only,
                       const QString &out_dir,
                       const QString &out_pattern);

        int saveK3BFile(const QString &k3b_filename);

    private:

        QUrl m_url;

        QString m_pattern;

        bool m_selection_only;

        export_location_t m_export_location;

        overwrite_policy_t m_overwrite_policy;

        QVector<BlockInfo> m_block_info;
    };
}

#endif /* K3B_EXPORT_PLUGIN_H */

//***************************************************************************
//***************************************************************************