juce_AudioThumbnailCache.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  AudioThumbnailCache
{
public:
    //==============================================================================
    explicit AudioThumbnailCache (int maxNumThumbsToStore);
 
    virtual ~AudioThumbnailCache();
 
    //==============================================================================
    void clear();
 
    bool loadThumb (AudioThumbnailBase& thumb, int64 hashCode);
 
    void storeThumb (const AudioThumbnailBase& thumb, int64 hashCode);
 
    void removeThumb (int64 hashCode);
 
    //==============================================================================
    bool readFromStream (InputStream& source);
 
    void writeToStream (OutputStream& stream);
 
    TimeSliceThread& getTimeSliceThread() noexcept      { return thread; }
 
protected:
    virtual void saveNewlyFinishedThumbnail (const AudioThumbnailBase&, int64 hashCode);
 
    virtual bool loadNewThumb (AudioThumbnailBase&, int64 hashCode);
 
private:
    //==============================================================================
    TimeSliceThread thread;
 
    class ThumbnailCacheEntry;
    OwnedArray<ThumbnailCacheEntry> thumbs;
    CriticalSection lock;
    int maxNumThumbsToStore;
 
    ThumbnailCacheEntry* findThumbFor (int64 hash) const;
    int findOldestThumb() const;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioThumbnailCache)
};
 
} // namespace juce