ci/gitlab-ci.yml

@@ -214,7 +214,7 @@ gen-test-db:
   script:
     - meson --buildtype=release build
     - cd build && ninja
-    - ../ci/generate-samples.sh -o $CI_PROJECT_DIR/dummysamples -n 10
+    - ../ci/generate-samples.sh -o $CI_PROJECT_DIR/dummysamples -n 2
     - test/discoverer/discoverer $CI_PROJECT_DIR/dummysamples -q
     - echo "BEGIN;" > $CI_PROJECT_DIR/test_db.sql
     - >

include/medialibrary/IChapter.h

@@ -23,6 +23,7 @@
 #pragma once
 
 #include <string>
+#include <cstdint>
 
 namespace medialibrary
 {

include/medialibrary/IDeviceLister.h

@@ -34,7 +34,7 @@ namespace medialibrary
  *
  * An external device lister shall only be used when the medialibrary can't list
  * the devices itself.
- * The device/folder/file management will still be the medialibrary's responsability
+ * The device/folder/file management will still be the medialibrary's responsibility
  */
 class IDeviceListerCb
 {

include/medialibrary/IFolder.h

@@ -54,7 +54,7 @@ public:
     virtual bool isPresent() const = 0;
     virtual bool isRemovable() const = 0;
     /**
-     * @brief isBanned Will return true if the folder was explicitely banned
+     * @brief isBanned Will return true if the folder was explicitly banned
      * from being discovered.
      */
     virtual bool isBanned() const = 0;

include/medialibrary/IGenre.h

@@ -87,7 +87,7 @@ public:
      * @param sizeType The thumbnail size type
      * @param takeOwnership If true, the medialibrary will copy the thumbnail in
      *                      its thumbnail directory and will manage its lifetime
-     * @return true if the thumbnail was successfully overriden, false otherwise.
+     * @return true if the thumbnail was successfully overridden, false otherwise.
      */
     virtual bool setThumbnail( const std::string& mrl, ThumbnailSizeType sizeType,
                                bool takeOwnership ) = 0;

include/medialibrary/IMedia.h

@@ -111,10 +111,10 @@ public:
      */
     enum class ProgressResult : uint8_t
     {
-        /// An error occured and the progress wasn't changed
+        /// An error occurred and the progress wasn't changed
         Error,
         /// The provided position/time was interpreted as the beginning of the
-        /// media and has been reset to -1. This nedia playback is now not
+        /// media and has been reset to -1. This media playback is now not
         /// considered started.
         Begin,
         /// The provided position/time was not interpreted as a special position
@@ -170,11 +170,11 @@ public:
      * @brief setLastPosition updates the last playback position
      *
      * @param lastPosition The current playback position expressed by a number in the range [0;1]
-     * @return a ProgressResult value indicating how the value was intepreted and
+     * @return a ProgressResult value indicating how the value was interpreted and
      *         if the operation succeeded
      *
      * The media library will interpret the value to determine if the playback
-     * is completed and the media should be marked as watched (therefor increasing
+     * is completed and the media should be marked as watched (therefore increasing
      * the playcount). If the progress isn't large enough, the media library will
      * ignore the new progress.
      * The base value for the beginning/end of a media is 5%, meaning that the
@@ -207,7 +207,7 @@ public:
     /**
      * @brief setLastTime Sets the last playback time.
      * @param lastTime A time in millisecond
-     * @return a ProgressResult value indicating how the value was intepreted and
+     * @return a ProgressResult value indicating how the value was interpreted and
      *         if the operation succeeded
      *
      * This is similar to setLastPosition but works with a time in
@@ -308,7 +308,7 @@ public:
     /// Upon completion (successful or not) IMediaLibraryCb::onMediaThumbnailReady
     /// will be called.
     /// In case a thumbnail was already generated for the media, a new thumbnail
-    /// will be generated, and the previous one will be overriden.
+    /// will be generated, and the previous one will be overridden.
     /// \param sizeType The size type of the thumbnail to generate
     /// \param desiredWidth The desired thumbnail width
     /// \param desiredHeight The desired thumbnail height
@@ -348,7 +348,7 @@ public:
     ///
     virtual std::unordered_map<MetadataType, std::string> metadata() const = 0;
     ///
-    /// \brief setMetadata Immediatly saves a metadata in database
+    /// \brief setMetadata Immediately saves a metadata in database
     ///
     virtual bool setMetadata( MetadataType type, const std::string& value ) = 0;
     virtual bool setMetadata( MetadataType type, int64_t value ) = 0;
@@ -412,12 +412,12 @@ public:
     ///
     /// \brief isDiscoveredMedia Returns true if this media was discovered
     ///                          during a scan.
-    /// false means that the media has been explicitely added by the user
+    /// false means that the media has been explicitly added by the user
     /// as a stream, or an external media
     ///
     virtual bool isDiscoveredMedia() const = 0;
     ///
-    /// \brief isExternalMedia Returns true if the media was explicitely added
+    /// \brief isExternalMedia Returns true if the media was explicitly added
     ///                        by the application.
     /// This is the opposite counterpart of isDiscoveredMedia
     ///
@@ -468,7 +468,7 @@ public:
     /// The media is considered present if the device containing its main file
     /// is present (ie. if a removable drive is mounted, or a network drive
     /// connected)
-    /// This is only relevent when the media is not external
+    /// This is only relevant when the media is not external
     ///
     virtual bool isPresent() const = 0;
 

include/medialibrary/IMediaGroup.h

@@ -114,7 +114,7 @@ public:
     /**
      * @brief userInteracted Returns true if the group has had user interactions
      *
-     * This includes being renamed, or being explicitely created with some specific
+     * This includes being renamed, or being explicitly created with some specific
      * media or an explicit title.
      * It doesn't include groups that were automatically created by the media library
      * Removing a media from an automatically created group won't be interpreted
@@ -178,7 +178,7 @@ public:
     /**
      * @brief rename Rename a group
      * @param name The new name
-     * @return true if the rename was successfull, false otherwise
+     * @return true if the rename was successful, false otherwise
      *
      * This will not change the group content, however, it will prevent further
      * media that matched the previous name to be automatically added to this

include/medialibrary/IMediaLibrary.h

@@ -222,7 +222,7 @@ struct SetupConfig
 
     /**
      * @brief logLevel The default log level to initialize the medialibrary with.
-     * This can be overwriten at a later point using IMediaLibrary::setVerbosity
+     * This can be overwritten at a later point using IMediaLibrary::setVerbosity
      */
     LogLevel logLevel = LogLevel::Error;
 
@@ -290,10 +290,10 @@ public:
 
     /**
      * @brief onDiscoveryStarted This callback will be invoked when the discoverer
-     * starts to crawl an entrypoint that was scheduled for discovery or reload.
+     * starts to crawl a root folder that was scheduled for discovery or reload.
      *
      * This callback will be invoked when the discoverer thread gets woken up
-     * regardless of how many entry points need to be discovered.
+     * regardless of how many roots need to be discovered.
      */
     virtual void onDiscoveryStarted() = 0;
     /**
@@ -301,7 +301,7 @@ public:
      * discoverer enters a new folder.
      * @param currentFolder The folder being discovered
      *
-     * This callback can be invoked multiple times even though a single entry point was asked to be
+     * This callback can be invoked multiple times even though a single root was asked to be
      * discovered. ie. In the case of a file system discovery, discovering a folder would make this
      * callback being invoked for all subfolders
      */
@@ -310,58 +310,57 @@ public:
      * @brief onDiscoveryCompleted Will be invoked when the discoverer finishes
      * all its queued operations and goes back to idle.
      *
-     * This callback will be invoked once for each invocation fo onDiscoveryStarted
+     * This callback will be invoked once for each invocation of onDiscoveryStarted
      */
     virtual void onDiscoveryCompleted() = 0;
 
     /**
      * @brief onDiscoveryFailed Will be invoked when a discovery operation fails
-     * @param entryPoint The entry point for which the discovery failed.
+     * @param root The root folder for which the discovery failed.
      */
-    virtual void onDiscoveryFailed( const std::string& entryPoint ) = 0;
+    virtual void onDiscoveryFailed( const std::string& root ) = 0;
 
     /**
-     * @brief onEntryPointAdded will be invoked when an entrypoint gets added
-     * @param entryPoint The entry point which was scheduled for discovery
+     * @brief onRootAdded will be invoked when an root folder is added
+     * @param root The root folder which was scheduled for discovery
      * @param success A boolean to represent the operation's success
      *
-     * This callback will only be emitted the first time the entry point gets
+     * This callback will only be emitted the first time the root folder is
      * processed, after it has been inserted to the database.
-     * In case of failure, it might be emited every time the request is sent, since
-     * the provided entry point would most likely be invalid, and couldn't be inserted.
-     * Later processing of that entry point will still cause \sa{onDiscoveryStarted}
+     * In case of failure, it might be emitted every time the request is sent, since
+     * the provided folder would most likely be invalid, and couldn't be inserted.
+     * Later processing of the folder will still cause \sa{onDiscoveryStarted}
      * \sa{onDiscoveryProgress} and \sa{onDiscoveryCompleted} events to be fired
      * \warning This event will be fired after \sa{onDiscoveryStarted} since we
-     * don't know if an entry point is known before starting its processing
+     * don't know if a root folder is known before starting its processing
      */
-    virtual void onEntryPointAdded( const std::string& entryPoint, bool success ) = 0;
+    virtual void onRootAdded( const std::string& root, bool success ) = 0;
 
     /**
-     * @brief onEntryPointRemoved will be invoked when an entrypoint removal
-     *                            request gets processsed
-     * by the appropriate worker thread.
-     * @param entryPoint The entry point which removal was required
+     * @brief onRootRemoved will be invoked when a root removal request is
+     *                              processsed by the appropriate worker thread.
+     * @param root The root folder which removal was required
      * @param success A boolean representing the operation's success
      */
-    virtual void onEntryPointRemoved( const std::string& entryPoint, bool success ) = 0;
+    virtual void onRootRemoved( const std::string& root, bool success ) = 0;
     /**
-     * @brief onEntryPointBanned will be called when an entrypoint ban request
-     *                           is done being processed.
-     * @param entryPoint The banned entrypoint
+     * @brief onRootBanned will be called when a root ban request
+     *                     has been processed.
+     * @param root The banned root folder
      * @param success A boolean representing the operation's success
      */
-    virtual void onEntryPointBanned( const std::string& entryPoint, bool success ) = 0;
+    virtual void onRootBanned( const std::string& root, bool success ) = 0;
     /**
-     * @brief onEntryPointUnbanned will be called when an entrypoint unban request
-     *                             is done being processed.
-     * @param entryPoint The unbanned entrypoint
+     * @brief onRootUnbanned will be called when a root unban request
+     *                       is done being processed.
+     * @param root The unbanned root folder
      * @param success A boolean representing the operation's success
      */
-    virtual void onEntryPointUnbanned( const std::string& entryPoint, bool success ) = 0;
+    virtual void onRootUnbanned( const std::string& root, bool success ) = 0;
     /**
      * @brief onParsingStatsUpdated Called when the parser statistics are updated
      *
-     * There is no waranty about how often this will be called.
+     * There is no warranty about how often this will be called.
      * @param opsDone The number of operation the parser completed
      * @param opsScheduled The number of operations currently scheduled by the parser
      *
@@ -405,7 +404,7 @@ public:
      * IMediaLibrary::clearDatabase. After doing so, the medialibrary can still
      * be used without any further calls (but will need to rescan the entire user
      * collection). If clearDatabase isn't called, the database should be
-     * considered as corrupted, and therefor the medialibrary considered unusable.
+     * considered as corrupted, and therefore the medialibrary considered unusable.
      *
      * If clearSuggested is false, there are no certain way of knowing if the
      * database is still usable or not.
@@ -416,7 +415,7 @@ public:
     /**
      * @brief onRescanStarted will be invoked when a rescan is started.
      *
-     * This won't be emited when the media library issues a rescan itself, due
+     * This won't be emitted when the media library issues a rescan itself, due
      * to a migration.
      */
     virtual void onRescanStarted() = 0;
@@ -539,7 +538,7 @@ public:
     virtual bool removeExternalMedia( MediaPtr media ) = 0;
 
     /**
-     * @brief audioFiles Returns the media classified as Audio
+     * @brief mediaFiles Returns the media unclassified
      * @param params Some query parameters.
      * @return A query representing the results set
      *
@@ -554,13 +553,21 @@ public:
      *   - FileSize
      * Default sorting parameter uses the media's title, in ascending order
      */
+    virtual Query<IMedia> mediaFiles( const QueryParameters* params = nullptr ) const = 0;
+    /**
+     * @brief audioFiles Returns the media classified as Audio
+     * @param params Some query parameters.
+     * @return A query representing the results set
+     *
+     * \see{IMediaLibrary::mediaFiles} for the supported sorting criteria
+     */
     virtual Query<IMedia> audioFiles( const QueryParameters* params = nullptr ) const = 0;
     /**
      * @brief videoFiles Returns the media classified as Video
      * @param params Some query parameters.
      * @return A query representing the results set
      *
-     * \see{IMediaLibrary::audioFile} for the supported sorting criteria
+     * \see{IMediaLibrary::mediaFiles} for the supported sorting criteria
      */
     virtual Query<IMedia> videoFiles( const QueryParameters* params = nullptr ) const = 0;
 
@@ -639,7 +646,7 @@ public:
     virtual Query<IMediaGroup> searchMediaGroups( const std::string& pattern,
                                                   const QueryParameters* params = nullptr ) const = 0;
     /**
-     * @brief regroupAll Attemps to regroup all media that belong to a forced singleton group
+     * @brief regroupAll Attempts to regroup all media that belong to a forced singleton group
      *
      * This will try to regroup all media that were manually removed from their
      * group, and now belong to a forced singleton group.
@@ -763,7 +770,7 @@ public:
      * @param params Some query parameters.
      *
      * Only media that were discovered by the medialibrary will be included.
-     * For instance, media that are added explicitely, playlist items that
+     * For instance, media that are added explicitly, playlist items that
      * point to remote content, will *not* be included
      *
      * \see{IMediaLibrary::audioFile} for the supported sorting criteria
@@ -799,15 +806,15 @@ public:
                                     const QueryParameters* params = nullptr ) const = 0;
 
     /**
-     * @brief discover Launch a discovery on the provided entry point.
+     * @brief discover Launch a discovery on the provided root folder.
      * This will start the discoverer thread, device listers, and file system
      * factories if needed
-     * The actuall discovery will run asynchronously, meaning this method will immediatly return.
+     * The actual discovery will run asynchronously, meaning this method will immediately return.
      * Depending on which discoverer modules where provided, this might or might not work
      * @note This must be called after initialize()
-     * @param entryPoint The MRL of the entrypoint to discover.
+     * @param root The MRL of the root folder to discover.
      */
-    virtual void discover( const std::string& entryPoint ) = 0;
+    virtual void discover( const std::string& root ) = 0;
     /**
      * @brief setDiscoverNetworkEnabled Enable discovery of network shares
      * @return true In case of success, false otherwise.
@@ -836,14 +843,15 @@ public:
      *
      * This is essentially a way of knowing what has been passed to discover()
      * throughout the database life.
-     * The resulting list includes entry points on device that are currently unmounted.
+     * The resulting list includes root folders on device that are currently
+     * unmounted.
      * If the passed params field publicOnly is true, this function will list
      * top level public folders instead of the folders provided to discover()
      */
     virtual Query<IFolder> roots( const QueryParameters* params ) const = 0;
     /**
-     * @brief isIndexed Returns true if the mrl point to a file of folder in an
-     *                  indexed entrypoint
+     * @brief isIndexed Returns true if the mrl point to a file or folder in an
+     *                  indexed root.
      * @param mrl The MRL to probe
      * @return true if the mrl is indexed, false otherwise
      */
@@ -876,7 +884,7 @@ public:
      * would return a query containing 'z' and 'c' as the other folders are
      * not containing any media.
      * In case a non flattened list is desired, the
-     * entryPoints() & IFolder::subFolders() functions should be used.
+     * roots() & IFolder::subFolders() functions should be used.
      */
     virtual Query<IFolder> folders( IMedia::Type type,
                                     const QueryParameters* params = nullptr ) const = 0;
@@ -886,10 +894,10 @@ public:
     virtual FolderPtr folder( int64_t folderId ) const = 0;
     virtual FolderPtr folder( const std::string& mrl ) const = 0;
     /**
-     * @brief removeEntryPoint Removes an entry point
-     * @param entryPoint The MRL of the entry point to remove
+     * @brief removeRoot Removes a root folder
+     * @param root The MRL of the root folder point to remove
      *
-     * This will remove the provided entry point from the list of know locations
+     * This will remove the provided root folder from the list of know locations
      * to manage by the media library.
      * The location will be ignored afterward, even if it is a sub folder of
      * another managed location.
@@ -899,9 +907,9 @@ public:
      *       task
      * @note This must be called after initialize()
      */
-    virtual void removeEntryPoint( const std::string& entryPoint ) = 0;
+    virtual void removeRoot( const std::string& root ) = 0;
     /**
-     * @brief banFolder will prevent an entry point folder from being discovered.
+     * @brief banFolder will prevent a root folder from being discovered.
      * If the folder was already discovered, it will be removed prior to the ban, and all
      * associated media will be discarded.
      * @param mrl The MRL to ban
@@ -912,9 +920,9 @@ public:
      */
     virtual void banFolder( const std::string& mrl ) = 0;
     /**
-     * @brief unbanFolder Unban an entrypoint.
-     * In case this entry point was indeed previously banned, this will issue a reload of
-     * that entry point
+     * @brief unbanFolder Unban a root folder.
+     * In case this root folder was indeed previously banned, this will issue a
+     * reload of that folder
      * @param mrl The MRL to unban
      * @note This method is asynchronous, but will interrupt any ongoing
      *       discovery, process the request, and resume the previously running
@@ -923,12 +931,12 @@ public:
      */
     virtual void unbanFolder( const std::string& mrl ) = 0;
     /**
-     * @brief bannedEntryPoints Returns a query representing the banned entry points
+     * @brief bannedRoots Returns a query representing the banned root folders.
      *
-     * The result set will include entry points on missing devices as well. Folder
-     * hierarchy isn't preserved, and the results are flattened.
+     * The result set will include root folders on missing devices as well.
+     * Folder hierarchy isn't preserved, and the results are flattened.
      */
-    virtual Query<IFolder> bannedEntryPoints() const = 0;
+    virtual Query<IFolder> bannedRoots() const = 0;
     /**
      * @brief pauseBackgroundOperations Will stop potentially CPU intensive background
      * operations, until resumeBackgroundOperations() is called.
@@ -941,7 +949,7 @@ public:
      */
     virtual void resumeBackgroundOperations() = 0;
     /**
-     * @brief reload Reload all known entry points
+     * @brief reload Reload all known roots
      * @note This must be called after initialize()
      *
      * This will start the discoverer thread, appropriate device listers and
@@ -949,14 +957,14 @@ public:
      */
     virtual void reload() = 0;
     /**
-     * @brief reload Reload a specific entry point
-     * @param entryPoint The entrypoint to reload
+     * @brief reload Reload a specific root folder.
+     * @param root The root folder to reload
      * @note This must be called after initialize()
      *
      * This will start the discoverer thread, appropriate device listers and
      * file system factories if needed.
      */
-    virtual void reload( const std::string& entryPoint ) = 0;
+    virtual void reload( const std::string& root ) = 0;
     /**
      * @brief forceParserRetry Forces a re-run of all metadata parsers and resets any
      * unterminated file retry count to 0, granting them 3 new tries at being parsed
@@ -990,7 +998,7 @@ public:
     /**
      * @brief enableFailedThumbnailRegeneration Allow failed thumbnail attempt to be retried
      *
-     * This will not attempt to regenerate the thumbnail immediatly, requestThumbnail
+     * This will not attempt to regenerate the thumbnail immediately, requestThumbnail
      * still has to be called afterward.
      */
     virtual void enableFailedThumbnailRegeneration() = 0;
@@ -1048,7 +1056,7 @@ public:
      * This will delete *ALL* removable devices from the database, causing *ALL*
      * files & media stored on that device to be deleted as well.
      * This is intended for applications with an external device lister to
-     * recover in case of an issue causing multiple devices or invalide entries
+     * recover in case of an issue causing multiple devices or invalid entries
      * to be inserted in the database
      */
     virtual bool deleteRemovableDevices() = 0;

include/medialibrary/IPlaylist.h

@@ -123,19 +123,48 @@ public:
     /// If the position is greater than the playlist size, it will be interpreted
     /// as a regular append operation, and the item position will be set to
     /// <playlist size>
-    /// For instance, on the playlist [<B,0>, <A,1>, <C,2>], if add(D, 999)
-    /// gets called, the resulting playlist will be [<A,0>, <C,1>, <B,2>, <D,3>]
+    /// For instance, on the playlist [<A,0>, <B,1>, <C,2>], if add(D, 999)
+    /// gets called, the resulting playlist will be [<A,0>, <B,1>, <C,2>, <D,3>]
     ///
     virtual bool add( const IMedia& media, uint32_t position ) = 0;
 
+    /// \brief append a list of medias to a playlist
+    /// The medias will be the last element of a subsequent call to media()
+    /// \param mediaList The medias to add
+    /// \return true on success, false on failure.
+    ///
+    /// For instance on the playlist [<A,0>, <B,1>, <C,2>], if apend([D,E])
+    /// gets called, the resulting playlist will be [<A,0>, <B,1>, <C,2>, <D,3>, <E,4>]
+    ///
+    virtual bool append( const std::vector<MediaPtr>& mediaList ) = 0;
+    ///
+    /// \brief add Add a list of medias to the playlist at the given position.
+    /// \param mediaList The medias to add
+    /// \param position The position of this new medias, in the [0;size-1] range
+    /// \return true on success, false on failure
+    ///
+    /// For instance on the playlist [<A,0>, <B,1>, <C,2>], if apend([D,E], 2)
+    /// gets called, the resulting playlist will be [<A,0>, <B,1>, <D,2>, <E,3>, <C,4>]
+    ///
+    /// If the position is greater than the playlist size, it will be interpreted
+    /// as a regular append operation, and the item position will be set to
+    /// <playlist size
+    /// For instance, on the playlist [<A,0>, <B,1>, <C,2>], if add([D,E], 999)
+    /// gets called, the resulting playlist will be [<A,0>, <B,1>, <C,2>, <D,3>, <E,4>]
+    ///
+    virtual bool add( const std::vector<MediaPtr>& mediaList, uint32_t position ) = 0;
+
     /// Convenience wrappers
     virtual bool append( int64_t mediaId ) = 0;
     virtual bool add( int64_t mediaId, uint32_t position ) = 0;
+    virtual bool append( const std::vector<int64_t>& mediaList ) = 0;
+    virtual bool add( const std::vector<int64_t>& mediaList, uint32_t position ) = 0;
 
     ///
     /// \brief move Change the position of a media
     /// \param from The position of the item being moved
     /// \param to The moved item target position
+    /// \param count The number of elements to move
     ///
     /// \return true on success, false on failure
     ///
@@ -145,21 +174,35 @@ public:
     /// [<A,0>, <B,1>, <C,2>] on which move(0, 1) is called will result in the
     /// playlist being changed to
     /// [<B,0>, <A,1>, <C,2>]
+    ///
+    /// Likewise, when moving multiple elements:
+    /// On the playlist [<A,0>, <B,1>, <C,2>, <D,3>, <E,4>], move(1, 3, 2) results in
+    /// [<A,0>, <D,1>, <B,2>, <C,3>, <E,4>]
+    ///
+    /// Moving one or multiple elements at the same position or within its range has no effects.
+    /// On the playlist [<A,0>, <B,1>, <C,2>, <D,3>, <E,4>], move(1,1) or move(2,3,2)
+    /// doesn't alter the playlist. Modification won't be notified, the function returns true
+    ///
     /// If the target position is out of range (ie greater than the playlist size)
     /// the target position will be interpreted as the playlist size (prior to insertion).
-    /// For instance, on the playlist [<B,0>, <A,1>, <C,2>], if move(0, 999)
-    /// gets called, the resulting playlist will be [<A,0>, <C,1>, <B,2>]
+    /// For instance, on the playlist [<A,0>, <B,1>, <C,2>], if move(0, 999)
+    /// gets called, the resulting playlist will be [<B,0>, <C,1>, <A,2>].
     ///
-    virtual bool move( uint32_t from, uint32_t to ) = 0;
+    virtual bool move( uint32_t from, uint32_t to, uint32_t count = 1 ) = 0;
     ///
-    /// \brief remove Removes an item from the playlist
+    /// \brief remove Removes a range of items from the playlist
     /// \param position The position of the item to remove.
+    /// \param count The number of element to remove (one by default)
     /// \return true on success, false on failure
     ///
-    virtual bool remove( uint32_t position ) = 0;
+    /// For instance, a playlist with <media,position> like
+    /// [<A,0>, <B,1>, <C,2>, <D,3>] on which remove(1, 2) is called will result in the
+    /// playlist being changed to[<A,0>, <D,1>]
+    ///
+    virtual bool remove( uint32_t position, uint32_t count = 1 ) = 0;
     ///
     /// \brief isReadOnly Return true if the playlist is backed by an actual file
-    ///                   and should therefor not modified directly.
+    ///                   and should therefore not modified directly.
     /// \return true if the playlist should be considered read-only, false otherwise
     ///
     /// If the application doesn't respect this, the medialibrary will, for

include/medialibrary/IQuery.h

@@ -45,7 +45,7 @@ public:
     /**
      * @brief items returns a subset of a query result
      * @param nbItems The number of item requested
-     * @param offset The number of elements to omit from the begining of the result
+     * @param offset The number of elements to omit from the beginning of the result
      * @return A vector of shared pointer for the requested type.
      *
      * If nbItems & offset are both 0, then this method returns all results.

include/medialibrary/IService.h

@@ -60,20 +60,20 @@ public:
     virtual bool isNewMediaNotificationEnabled() const = 0;
     virtual bool setNewMediaNotificationEnabled( bool enabled ) = 0;
     /**
-     * @brief maxCachedSize Returns the maximum size of the cache for all of this service
+     * @brief maxCacheSize Returns the maximum size of the cache for all of this service
      * @return The maximum cache size or -1 if the limit isn't set for this service
      *
      * If the limit isn't set, the global maximum cache size setting will be
      * used instead.
      */
-    virtual int64_t maxCachedSize() const = 0;
+    virtual int64_t maxCacheSize() const = 0;
     /**
-     * @brief setMaxCachedSize Sets the maximum cache size for this service
+     * @brief setMaxCacheSize Sets the maximum cache size for this service
      * @param maxSize A size in bytes, or -1 to disable the setting for the service
      *                and inherit the default one.
      * @return true if the change was successful, false otherwise.
      */
-    virtual bool setMaxCachedSize( int64_t maxSize ) = 0;
+    virtual bool setMaxCacheSize( int64_t maxSize ) = 0;
     virtual bool addSubscription( std::string mrl ) = 0;
     virtual Query<ISubscription> subscriptions( const QueryParameters* params ) const = 0;
     virtual Query<ISubscription> searchSubscription( const std::string& pattern,

include/medialibrary/ISubscription.h

@@ -66,17 +66,17 @@ public:
      */
     virtual bool setMaxCachedMedia( int32_t nbCachedMedia ) = 0;
     /**
-     * @brief maxCachedSize Returns the maximum size in bytes for this collection
+     * @brief maxCacheSize Returns the maximum size in bytes for this collection
      *
      * This will return the collection specific setting, regardless of the global
      * setting value.
      * In case the value is unset, -1 will be returned. In this case, the parent
      * setting will be used when performing caching.
      */
-    virtual int64_t maxCachedSize() const = 0;
+    virtual int64_t maxCacheSize() const = 0;
     /**
-     * @brief setMaxCachedSize Sets the maximum cached size for this collection
-     * @param maxCachedSize The size in bytes for this collection cache, or a
+     * @brief setMaxCacheSize Sets the maximum cache size for this collection
+     * @param maxCacheSize The size in bytes for this collection cache, or a
      *                      negative value to use the parent setting.
      * @return true if the change was successful, false otherwise.
      *
@@ -85,7 +85,7 @@ public:
      * prevail when caching.
      * If passing the current value, this will return true.
      */
-    virtual bool setMaxCachedSize( int64_t maxCachedSize ) = 0;
+    virtual bool setMaxCacheSize( int64_t maxCacheSize ) = 0;
     /**
      * @brief newMediaNotification Returns the new media notification setting
      * @return A positive value if explicitly enabled, 0 if explicitly disabled, -1 is unset

include/medialibrary/filesystem/IFileSystemFactory.h

@@ -76,7 +76,7 @@ namespace fs
          * @param ml A media library instance pointer
          * @return true in case of success, false otherwise.
          *
-         * If this returns false, the factory will be abandonned and the shared_ptr
+         * If this returns false, the factory will be abandoned and the shared_ptr
          * for to that factory provided through SetupConfig will be destroyed
          * If this factory handles a scheme that was already registered, it will
          * not be used by the media library but this function will still be invoked

libvlcpp @ 44c1f48e

-Subproject commit c07bf8ddcc8f30394ffcf82bd9b89ad7ae335125
+Subproject commit 44c1f48e56a66c3f418175af1e1ef3fd1ab1b118

meson.build

 project('medialibrary', ['cpp','c'],
   license: 'LGPLv2+',
-  version: '0.13.0',
+  version: '0.14.0',
   meson_version: '>=0.56',
   default_options: [
     'cpp_std=c++14',

src/Album.cpp

@@ -232,7 +232,7 @@ std::string Album::addRequestJoin( const QueryParameters* params,
         case SortingCriteria::ReleaseDate:
         case SortingCriteria::Duration:
         case SortingCriteria::TrackNumber:
-            /* No other tables required for this criterias */
+            /* No other tables required for this criteria */
             break;
         case SortingCriteria::PlayCount:
         case SortingCriteria::InsertionDate:

src/Artist.cpp

@@ -477,7 +477,7 @@ std::string Artist::trigger( Triggers trigger, uint32_t dbModelVersion )
             // Automatically delete the artists that don't have any albums left,
             // except the 2 special artists.
             // Those are assumed to always exist, and deleting them would cause
-            // a constaint violation error when inserting an album with
+            // a constraint violation error when inserting an album with
             // unknown/various artist(s).
             // The alternative would be to always check the special artists for
             // existence, which would be much slower when inserting an unknown

src/Artist.h

@@ -96,7 +96,7 @@ public:
      * For instance, if an artist gets assigned the cover from an album, the
      * thumbnail object is likely to have the Media origin if the album was just
      * created.
-     * Specifying the origin explicitely allows for a finer control on the hierarchy
+     * Specifying the origin explicitly allows for a finer control on the hierarchy
      *
      * The implementation may chose to ignore a thumbnail update based on the
      * current & new origin. In this case, `true` will still be returned.

src/CacheWorker.cpp

@@ -58,14 +58,22 @@ void CacheWorker::setCacher( std::shared_ptr<ICacher> cacher )
     m_cacher = std::move( cacher );
 }
 
-void CacheWorker::queueTask( std::shared_ptr<Media> m, bool cache )
+bool CacheWorker::queueTask( std::shared_ptr<Media> m, bool cache )
 {
     std::lock_guard<compat::Mutex> lock{ m_mutex };
+
+    if ( m_cacher == nullptr )
+    {
+        LOG_WARN( "Cache implementation not provided" );
+        return false;
+    }
+
     m_tasks.emplace( std::move( m ), cache );
     if ( m_thread.joinable() == false )
         m_thread = compat::Thread{ &CacheWorker::run, this };
     else
         m_cond.notify_all();
+    return true;
 }
 
 bool CacheWorker::cacheMedia( std::shared_ptr<Media> m )
@@ -78,8 +86,7 @@ bool CacheWorker::cacheMedia( std::shared_ptr<Media> m )
         LOG_DEBUG( "Media ", m->id(), " is already cached" );
         return true;
     }
-    queueTask( std::move( m ), true );
-    return true;
+    return queueTask( std::move( m ), true );
 }
 
 bool CacheWorker::removeCached( std::shared_ptr<Media> m )
@@ -92,8 +99,7 @@ bool CacheWorker::removeCached( std::shared_ptr<Media> m )
         LOG_DEBUG( "Media ", m->id(), " is not cached" );
         return false;
     }
-    queueTask( std::move( m ), false );
-    return true;
+    return queueTask( std::move( m ), false );
 }
 
 void CacheWorker::cacheSubscriptions()
@@ -117,7 +123,9 @@ void CacheWorker::resume()
 
 void CacheWorker::stop()
 {
-    m_cacher->interrupt();
+    if ( m_cacher != nullptr )
+        m_cacher->interrupt();
+
     {
         std::lock_guard<compat::Mutex> lock{ m_mutex };
         if ( m_thread.joinable() == false )
@@ -289,7 +297,7 @@ bool CacheWorker::evictIfNeeded( const File& file, Subscription* s,
             maxMedia = m_ml->settings().nbCachedMediaPerSubscription();
         }
         auto subCacheSize = s->cachedSize();
-        auto maxSubCacheSize = s->maxCachedSize();
+        auto maxSubCacheSize = s->maxCacheSize();
         auto nbCachedMediaInSub = s->cachedMedia( false )->count();
         LOG_DEBUG( "Subscription #", s->id(), " has ", nbCachedMediaInSub,
                    "/", maxMedia, " cached media" );

src/CacheWorker.h

@@ -73,7 +73,7 @@ private:
     void checkCache();
     bool removeFromCache( const std::string& mrl );
     bool evictIfNeeded( const File& file, Subscription* s, IFile::CacheType cacheType );
-    void queueTask( std::shared_ptr<Media> m, bool cache );
+    bool queueTask( std::shared_ptr<Media> m, bool cache );
     uint64_t availableSubscriptionCacheSize() const;
     uint64_t availableCacheSize() const;