2013-07-01 05:15:43 +02:00
|
|
|
// Copyright (c) 2013, Thomas Goyne <plorkyeran@aegisub.org>
|
2008-03-06 20:20:25 +01:00
|
|
|
//
|
2013-07-01 05:15:43 +02:00
|
|
|
// Permission to use, copy, modify, and distribute this software for any
|
|
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
|
|
// copyright notice and this permission notice appear in all copies.
|
2008-03-06 20:20:25 +01:00
|
|
|
//
|
2013-07-01 05:15:43 +02:00
|
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
|
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
|
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
2008-03-06 20:20:25 +01:00
|
|
|
//
|
2009-07-29 07:43:02 +02:00
|
|
|
// Aegisub Project http://www.aegisub.org/
|
|
|
|
|
2012-09-25 01:47:38 +02:00
|
|
|
#include <boost/container/list.hpp>
|
2009-09-11 04:36:34 +02:00
|
|
|
|
2008-03-07 22:00:20 +01:00
|
|
|
#include "include/aegisub/video_provider.h"
|
2008-03-06 20:20:25 +01:00
|
|
|
|
2010-07-08 06:29:04 +02:00
|
|
|
struct CachedFrame;
|
2008-03-06 20:20:25 +01:00
|
|
|
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
/// @class VideoProviderCache
|
2012-02-08 00:16:41 +01:00
|
|
|
/// @brief A wrapper around a video provider which provides LRU caching
|
2008-03-06 20:20:25 +01:00
|
|
|
class VideoProviderCache : public VideoProvider {
|
2012-02-08 00:16:41 +01:00
|
|
|
/// The source provider to get frames from
|
2013-06-08 06:19:40 +02:00
|
|
|
std::unique_ptr<VideoProvider> master;
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
2012-02-08 00:16:41 +01:00
|
|
|
/// @brief Maximum size of the cache in bytes
|
|
|
|
///
|
|
|
|
/// Note that this is a soft limit. The cache stops allocating new frames
|
|
|
|
/// once it has exceeded the limit, but it never tries to shrink
|
|
|
|
const size_t max_cache_size;
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
2012-02-08 00:16:41 +01:00
|
|
|
/// Cache of video frames with the most recently used ones at the front
|
2012-09-25 01:47:38 +02:00
|
|
|
boost::container::list<CachedFrame> cache;
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
2008-03-06 20:20:25 +01:00
|
|
|
public:
|
2013-07-01 05:15:43 +02:00
|
|
|
VideoProviderCache(std::unique_ptr<VideoProvider> master);
|
2012-02-08 00:16:41 +01:00
|
|
|
~VideoProviderCache();
|
|
|
|
|
2013-11-21 18:13:36 +01:00
|
|
|
std::shared_ptr<VideoFrame> GetFrame(int n) override;
|
|
|
|
|
|
|
|
int GetFrameCount() const override { return master->GetFrameCount(); }
|
|
|
|
int GetWidth() const override { return master->GetWidth(); }
|
|
|
|
int GetHeight() const override { return master->GetHeight(); }
|
|
|
|
double GetDAR() const override { return master->GetDAR(); }
|
|
|
|
agi::vfr::Framerate GetFPS() const override { return master->GetFPS(); }
|
|
|
|
std::vector<int> GetKeyFrames() const override { return master->GetKeyFrames(); }
|
|
|
|
std::string GetWarning() const override { return master->GetWarning(); }
|
|
|
|
std::string GetDecoderName() const override { return master->GetDecoderName(); }
|
|
|
|
std::string GetColorSpace() const override { return master->GetColorSpace(); }
|
2010-07-08 06:29:04 +02:00
|
|
|
};
|