SaveBlocksPlugin.h

Go to the documentation of this file.

/***************************************************************************
     SaveBlocksPlugin.h  -  Plugin for saving blocks between labels
                             -------------------
    begin                : Thu Mar 01 2007
    copyright            : (C) 2007 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 SAVE_BLOCKS_PLUGIN_H
#define SAVE_BLOCKS_PLUGIN_H

#include "config.h"

#include <QObject>
#include <QString>
#include <QUrl>

#include "libkwave/Plugin.h"

class QStringList;

namespace Kwave
{
    class SaveBlocksPlugin: public Kwave::Plugin
    {
        Q_OBJECT

    public:

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

        virtual ~SaveBlocksPlugin() Q_DECL_OVERRIDE;

        virtual QStringList *setup(QStringList &previous_params)
            Q_DECL_OVERRIDE;

        virtual int start(QStringList &params) Q_DECL_OVERRIDE;

        typedef enum {
            CONTINUE      = 0,
            START_AT_ONE  = 1
        } numbering_mode_t;

    protected:

        int interpreteParameters(QStringList &params);

        void scanBlocksToSave(const QString &base, bool selection_only);

        QString createFileName(const QString &base, const QString &ext,
                               const QString &pattern,
                               unsigned int index, int count, int total);

        unsigned int firstIndex(const QString &path, const QString &base,
                                const QString &ext, const QString &pattern,
                                Kwave::SaveBlocksPlugin::numbering_mode_t mode,
                                unsigned int count);

        QString findBase(const QString &filename, const QString &pattern);

        QString firstFileName(const QString &filename, const QString &pattern,
            numbering_mode_t mode, bool selection_only);

    signals:

        void sigNewExample(const QString &example);

    private slots:

        void updateExample(
            const QString &filename,
            const QString &pattern,
            Kwave::SaveBlocksPlugin::numbering_mode_t mode,
            bool selection_only);

    private:

        typedef struct {
            sample_index_t m_start;  
            sample_index_t m_length; 
            QString        m_title;  
        } BlockInfo;

    private:

        QString createDisplayList(const QStringList &list,
                                  unsigned int max_entries) const;

    private:

        QUrl m_url;

        QString m_pattern;

        numbering_mode_t m_numbering_mode;

        bool m_selection_only;

        QList<BlockInfo> m_block_info;

    };
}

#endif /* SAVE_BLOCKS_PLUGIN_H */

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