mediafiles.h 3.49 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/**
 * Copyright (C) 2002-2004 Scott Wheeler <wheeler@kde.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.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
16

17 18
#ifndef JUK_MEDIAFILES_H
#define JUK_MEDIAFILES_H
19

Michael Pyne's avatar
Michael Pyne committed
20
#include <QList>
Michael Pyne's avatar
Michael Pyne committed
21
#include <QUrl>
Michael Pyne's avatar
Michael Pyne committed
22

23 24 25
class QWidget;
class QString;
class QStringList;
26

27 28 29 30 31
namespace TagLib {
    class File;
}

#include <taglib_config.h>
32

33 34 35 36 37 38 39
/**
 * A namespace for file JuK's file related functions.  The goal is to hide
 * all specific knowledge of mimetypes and file extensions here.
 */
namespace MediaFiles
{
    /**
40 41
     * Returns a list of selected music files to open, or an empty list if
     * canceled.
42
     */
43
    QStringList openDialog(QWidget *parent = nullptr);
44 45

    /**
46 47
     * Returns the file name to use to save the playlist with the given name,
     * or an empty string if canceled.
48
     */
49
    QString savePlaylistDialog(const QString &playlistName, QWidget *parent = nullptr);
50

51 52 53 54 55 56 57
    /**
     * Returns a pointer to a new appropriate subclass of TagLib::File, or
     * a null pointer if there is no appropriate subclass for the given
     * file.
     */
    TagLib::File *fileFactoryByType(const QString &fileName);

58 59 60 61 62 63 64 65 66 67
    /**
     * Returns true if fileName is a supported media file.
     */
    bool isMediaFile(const QString &fileName);

    /**
     * Returns true if fileName is a supported playlist file.
     */
    bool isPlaylistFile(const QString &fileName);

68 69 70 71 72
    /**
     * Returns a list of all supported mimetypes.
     */
    QStringList mimeTypes();

73
    /**
74
     * Returns true if fileName is a mp3 file.
75 76 77
     */
    bool isMP3(const QString &fileName);

78 79 80 81 82
    /**
     * Returns true if fileName is a mpc (aka musepack) file.
     */
    bool isMPC(const QString &fileName);

83 84 85 86
    /**
     * Returns true if fileName is an Ogg file.
     */
    bool isOgg(const QString &fileName);
87 88

    /**
89
     * Returns true if fileName is a FLAC file.
90 91
     */
    bool isFLAC(const QString &fileName);
92 93 94 95 96 97

    /**
     * Returns true if fileName is an Ogg/Vorbis file.
     */
    bool isVorbis(const QString &fileName);

98 99 100 101 102 103 104 105 106 107 108 109 110 111
#ifdef TAGLIB_WITH_ASF
    /**
     * Returns true if fileName is an ASF file.
     */
    bool isASF(const QString &fileName);
#endif

#ifdef TAGLIB_WITH_MP4
    /**
     * Returns true if fileName is a MP4 file.
     */
    bool isMP4(const QString &fileName);
#endif

112 113 114 115
    /**
     * Returns true if fileName is an Ogg/FLAC file.
     */
    bool isOggFLAC(const QString &fileName);
116 117 118 119 120 121 122 123 124 125

    /**
     * Returns a list of absolute local filenames, mapped from \p urlList.
     * Any URLs in urlList that aren't really local files will be stripped
     * from the result (so result.size() may be < urlList.size()).
     *
     * @param urlList list of file names or URLs to convert.
     * @param w KIO may need the widget to handle user interaction.
     * @return list of all local files in urlList, converted to absolute paths.
     */
Michael Pyne's avatar
Michael Pyne committed
126
    QStringList convertURLsToLocal(const QList<QUrl> &urlList, QWidget *w = nullptr);
Dirk Mueller's avatar
Dirk Mueller committed
127
}
128 129

#endif
130 131

// vim: set et sw=4 tw=0 sta: