VideoCacheThread.h

Go to the documentation of this file.

 
// Copyright (c) 2008-2025 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef OPENSHOT_VIDEO_CACHE_THREAD_H
#define OPENSHOT_VIDEO_CACHE_THREAD_H
 
#include "ReaderBase.h"
 
#include <AppConfig.h>
#include <juce_audio_basics/juce_audio_basics.h>
#include <memory>
 
namespace openshot
{
    using juce::Thread;

    class VideoCacheThread : public Thread
    {
    public:
        VideoCacheThread();
        ~VideoCacheThread() override;

        bool isReady();

        void Play() {};

        void Stop() {};

        void setSpeed(int new_speed);

        int getSpeed() const { return speed; }

        void Seek(int64_t new_position);

        void Seek(int64_t new_position, bool start_preroll);

        bool StartThread();

        bool StopThread(int timeoutMs = 0);

        void Reader(ReaderBase* new_reader) { reader = new_reader; Play(); }
 
    protected:
        void run() override;

        int64_t getBytes(int width, int height, int sample_rate, int channels, float fps);
 
        //---------- Helper functions, broken out for clarity & unit testing ----------

        int computeDirection() const;

        void handleUserSeek(int64_t playhead, int dir);

        bool clearCacheIfPaused(int64_t playhead, bool paused, CacheBase* cache);

        void computeWindowBounds(int64_t playhead,
                                 int dir,
                                 int64_t ahead_count,
                                 int64_t timeline_end,
                                 int64_t& window_begin,
                                 int64_t& window_end) const;

        bool prefetchWindow(CacheBase* cache,
                            int64_t window_begin,
                            int64_t window_end,
                            int dir,
                            ReaderBase* reader);
 
        //---------- Internal state ----------
 
        std::shared_ptr<Frame> last_cached_frame; 
 
        int speed;            
        int last_speed;       
        int last_dir;         
        bool userSeeked;      
 
        int64_t requested_display_frame; 
        int64_t current_display_frame;   
        int64_t cached_frame_count;      
 
        int64_t min_frames_ahead;        
        int64_t timeline_max_frame;      
 
        ReaderBase* reader;              
        bool force_directional_cache;    
 
        int64_t last_cached_index;       
    };
 
} // namespace openshot
 
#endif // OPENSHOT_VIDEO_CACHE_THREAD_H