IMediaLibrary.h 3.63 KB
Newer Older
1 2 3 4 5 6
#ifndef IMEDIALIBRARY_H
#define IMEDIALIBRARY_H

#include <vector>
#include <string>

7
#include "Types.h"
8
#include "factory/IFileSystem.h"
9
#include "IDiscoverer.h"
10

11 12 13
class IParserCb
{
    public:
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
14
        virtual ~IParserCb() = default;
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

        /**
         * @brief onServiceDone will be called after each MetadataService completes
         * @param file      The file being parsed
         * @param status    A flag describing the parsing outcome
         */
        virtual void onServiceDone( FilePtr file, ServiceStatus status ) = 0;
        /**
         * @brief onFileDone will be called when all parsing operations on a given file have been completed
         *
         * This doesn't imply all modules have succeeded
         */
        //FIXME: We should probably expose some way of telling if the user should retry later in
        // case of tmeporary failure
        virtual void onFileDone( FilePtr file ) = 0;
};

32
class IMediaLibrary
33 34
{
    public:
35
        virtual ~IMediaLibrary() {}
36
        ///
37 38 39
        /// \brief  initialize Initializes the media library.
        ///         This will use the provided discoverer to search for new media asynchronously.
        ///
40 41 42
        /// \param dbPath       Path to the database
        /// \return true in case of success, false otherwise
        ///
43
        virtual bool initialize( const std::string& dbPath, const std::string& snapshotPath, std::shared_ptr<factory::IFileSystem> fsFactory ) = 0;
44
        /// Adds a stand alone file
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
45 46
        virtual FilePtr addFile( const std::string& path ) = 0;
        virtual FilePtr file( const std::string& path ) = 0;
47 48
        virtual bool deleteFile( const std::string& mrl ) = 0;
        virtual bool deleteFile( FilePtr file ) = 0;
49 50 51

        /// Adds a folder and all the files it contains
        virtual FolderPtr folder( const std::string& path ) = 0;
52
        virtual bool deleteFolder( FolderPtr folder ) = 0;
53

54
        virtual LabelPtr createLabel( const std::string& label ) = 0;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
55 56
        virtual bool deleteLabel( const std::string& label ) = 0;
        virtual bool deleteLabel( LabelPtr label ) = 0;
57
        virtual std::vector<FilePtr> files() = 0;
58 59
        virtual AlbumPtr album( const std::string& title ) = 0;
        virtual AlbumPtr createAlbum( const std::string& title ) = 0;
60 61
        virtual ShowPtr show( const std::string& name ) = 0;
        virtual ShowPtr createShow( const std::string& name ) = 0;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
62 63
        virtual MoviePtr movie( const std::string& title ) = 0;
        virtual MoviePtr createMovie( const std::string& title ) = 0;
64

65 66 67
        /**
         * @brief addMetadataService Adds a service to parse media
         *
68 69 70 71
         * User is expected to add all services before calling parse for the first time.
         * Once parse has been called, adding another service is an undefined behavior.
         * This method will call service->initialize(), therefor the passed ServiceStatus
         * is expected to be uninitialized.
72
         */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
73
        virtual void addMetadataService( std::unique_ptr<IMetadataService> service ) = 0;
74
        virtual void parse( FilePtr file, IParserCb* cb ) = 0;
75 76 77 78 79 80 81 82

        /**
         * @brief discover Launch a discovery on the provided entry point.
         * There no garanty on how this will be processed, or if it will be processed synchronously or not.
         * Depending on which discoverer modules where provided, this might or might not work
         * @param entryPoint What to discover.
         */
        virtual void discover( const std::string& entryPoint ) = 0;
83
        virtual const std::string& snapshotPath() const = 0;
84 85
};

86 87 88 89 90 91
class MediaLibraryFactory
{
    public:
        static IMediaLibrary* create();
};

92
#endif // IMEDIALIBRARY_H