Chris@1519: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@1519: 
Chris@1519: /*
Chris@1519:     Sonic Visualiser
Chris@1519:     An audio file viewer and annotation editor.
Chris@1519:     Centre for Digital Music, Queen Mary, University of London.
Chris@1519:     
Chris@1519:     This program is free software; you can redistribute it and/or
Chris@1519:     modify it under the terms of the GNU General Public License as
Chris@1519:     published by the Free Software Foundation; either version 2 of the
Chris@1519:     License, or (at your option) any later version.  See the file
Chris@1519:     COPYING included with this distribution for more information.
Chris@1519: */
Chris@1519: 
Chris@1519: #ifndef SV_RECORD_DIRECTORY_H
Chris@1519: #define SV_RECORD_DIRECTORY_H
Chris@1519: 
Chris@1519: #include <QString>
Chris@1519: 
Chris@1519: /**
Chris@1519:  * Report the intended target location for recorded audio files.
Chris@1519:  */
Chris@1519: class RecordDirectory
Chris@1519: {
Chris@1519: public:
Chris@1519:     /**
Chris@1519:      * Return the directory in which a recorded file should be saved.
Chris@1519:      * This may vary depending on the current date and time, and so
Chris@1519:      * should be queried afresh for each recording. The directory will
Chris@1519:      * also be created if it does not yet exist.
Chris@1519:      *
Chris@1519:      * Returns an empty string if the record directory did not exist
Chris@1519:      * and could not be created.
Chris@1519:      */
Chris@1519:     static QString getRecordDirectory();
Chris@1519: 
Chris@1519:     /**
Chris@1519:      * Return the root "recorded files" directory. If
Chris@1519:      * getRecordDirectory() is returning a datestamped directory, then
Chris@1519:      * this will be its parent. The directory will also be created if
Chris@1519:      * it does not yet exist.
Chris@1519:      *
Chris@1519:      * Returns an empty string if the record directory did not exist
Chris@1519:      * and could not be created.
Chris@1519:      */
Chris@1519:     static QString getRecordContainerDirectory();
Chris@1519: 
Chris@1519:     /**
Chris@1519:      * Return the directory in which an audio file converted from a
Chris@1519:      * data file should be saved. The directory will also be created if
Chris@1519:      * it does not yet exist.
Chris@1519:      *
Chris@1519:      * Returns an empty string if the directory did not exist and
Chris@1519:      * could not be created.
Chris@1519:      */
Chris@1519:     static QString getConvertedAudioDirectory();
Chris@1519: };
Chris@1519: 
Chris@1519: #endif