Merge CV, ver=5.1; ops/methods from HV, and interface from CV where possible

[goodguy/history.git] / cinelerra-5.1 / cinelerra / framecache.h

diff --git a/cinelerra-5.1/cinelerra/framecache.h b/cinelerra-5.1/cinelerra/framecache.h
new file mode 100644 (file)
index 0000000..2dcf4c8
--- /dev/null
+++ b/cinelerra-5.1/cinelerra/framecache.h
@@ -0,0 +1,116 @@
+
+/*
+ * CINELERRA
+ * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * 
+ */
+
+#ifndef FRAMECACHE_H
+#define FRAMECACHE_H
+
+
+#include "cachebase.h"
+#include "indexable.inc"
+#include "mutex.inc"
+#include "vframe.inc"
+
+
+#include <stdint.h>
+
+// Simply a table of images described by frame position and dimensions.
+// The frame position is relative to the frame rate of the source file.
+// This object is used by File for playback.
+// and MWindow for timeline drawing.
+// CICache scans all the files for
+// frame caches and deletes what's needed to maintain the cache size.
+
+class FrameCacheItem : public CacheItemBase
+{
+public:
+       FrameCacheItem();
+       ~FrameCacheItem();
+
+       int get_size();
+
+       VFrame *data;
+       double frame_rate;
+       int layer;
+};
+
+class FrameCache : public CacheBase
+{
+public:
+       FrameCache();
+       ~FrameCache();
+
+// Returns 1 if frame exists in cache and copies it to the frame argument.
+       int get_frame(VFrame *frame, 
+               int64_t position,
+               int layer,
+               double frame_rate,
+               int source_id = -1);
+// Returns pointer to cache entry if frame exists or 0.
+// If a frame is found, the frame cache is left in the locked state until 
+// unlock is called.  If nothing is found, the frame cache is unlocked before
+// returning.  This keeps the item from being deleted.
+// asset - supplied by user if the cache is not part of a file.
+       VFrame* get_frame_ptr(int64_t position,
+               int layer,
+               double frame_rate,
+               int color_model,
+               int w,
+               int h,
+               int source_id = -1);
+// Puts the frame in cache.
+// use_copy - if 1 a copy of the frame is made.  if 0 the argument is stored.
+// The copy of the frame is deleted by FrameCache in a future delete_oldest.
+// asset - supplied by user if the cache is not part of a file.
+       void put_frame(VFrame *frame, 
+               int64_t position,
+               int layer,
+               double frame_rate,
+               int use_copy,
+               Indexable *indexable);
+
+       void dump();
+
+
+
+
+
+private:
+// Return 1 if matching frame exists.
+// Return 0 if not.
+       int frame_exists(VFrame *format,
+               int64_t position,
+               int layer,
+               double frame_rate,
+               FrameCacheItem **item_return,
+               int source_id);
+       int frame_exists(int64_t position, 
+               int layer,
+               double frame_rate,
+               int color_model,
+               int w,
+               int h,
+               FrameCacheItem **item_return,
+               int source_id);
+};
+
+
+
+#endif