libopenshot/include/Cache.h

#ifndef OPENSHOT_CACHE_H
#define OPENSHOT_CACHE_H

/**
 * \file
 * \brief Header file for Cache class
 * \author Copyright (c) 2011 Jonathan Thomas
 */

#include <map>
#include <deque>
#include "Frame.h"
#include "Exceptions.h"

/// This namespace is the default namespace for all code in the openshot library.
namespace openshot {

	/**
	 * \brief This class is a cache manager for Frame objects.  It is used by FileReaders (such as FFmpegReader) to cache
	 * recently accessed frames.
	 *
	 * Due to the high cost of decoding streams, once a frame is decoded, converted to RGB, and a Frame object is created,
	 * it critical to keep these Frames cached for performance reasons.  However, the larger the cache, the more memory
	 * is required.  You can set the max number of bytes to cache.
	 */
	class Cache {
	private:
		int64 total_bytes;			///< This is the current total bytes (that are in this cache)
		int64 max_bytes;			///< This is the max number of bytes to cache (0 = no limit)
		map<int, Frame*> frames;	///< This map holds the frame number and Frame objects
		deque<int> frame_numbers;	///< This queue holds a sequential list of cached Frame numbers

		/// Clean up cached frames that exceed the max number of bytes
		void CleanUp();

	public:
		/// Default constructor, no max bytes
		Cache();

		/// Constructor that sets the max bytes to cache
		Cache(int64 max_bytes);

		/// Add a Frame to the cache
		void Add(int frame_number, Frame* frame);

		/// Check for the existence of a frame in the cache
		bool Exists(int frame_number);

		/// Get a frame from the cache
		Frame* GetFrame(int frame_number);

		/// Get the smallest frame number
		Frame* GetSmallestFrame();

		/// Remove a specific frame
		void Remove(int frame_number);

		/// Remove a specific frame
		void Remove(int frame_number, bool delete_data);

		/// Clear the cache of all frames
		void Clear();

		/// Display a list of cached frame numbers
		void Display();

		/// Display the list of cache and clear the cache (mainly for debugging reasons)
		void DisplayAndClear();

		/// Count the frames in the queue
		int Count();

		/// Set maximum bytes to a different amount
		void SetMaxBytes(int64 number_of_bytes) { max_bytes = number_of_bytes; CleanUp(); };

		/// Gets the maximum bytes value
		int64 GetMaxBytes() { return max_bytes; };

	};

}

#endif