aboutsummaryrefslogtreecommitdiff
path: root/packages/noncvs/windows/extra/Gem/dev/plugins/record.h
diff options
context:
space:
mode:
Diffstat (limited to 'packages/noncvs/windows/extra/Gem/dev/plugins/record.h')
-rw-r--r--packages/noncvs/windows/extra/Gem/dev/plugins/record.h108
1 files changed, 108 insertions, 0 deletions
diff --git a/packages/noncvs/windows/extra/Gem/dev/plugins/record.h b/packages/noncvs/windows/extra/Gem/dev/plugins/record.h
new file mode 100644
index 00000000..8b317539
--- /dev/null
+++ b/packages/noncvs/windows/extra/Gem/dev/plugins/record.h
@@ -0,0 +1,108 @@
+/* -----------------------------------------------------------------
+
+GEM - Graphics Environment for Multimedia
+
+Load an digital video (like AVI, Mpeg, Quicktime) into a pix block
+(OS independant interface)
+
+Copyright (c) 2010-2011 IOhannes m zmölnig. forum::für::umläute. IEM. zmoelnig@iem.at
+For information on usage and redistribution, and for a DISCLAIMER OF ALL
+WARRANTIES, see the file, "GEM.LICENSE.TERMS" in this distribution.
+
+-----------------------------------------------------------------*/
+
+#ifndef _INCLUDE__GEM_PLUGINS_RECORD_H_
+#define _INCLUDE__GEM_PLUGINS_RECORD_H_
+
+#include "Gem/Image.h"
+#include "Gem/Properties.h"
+#include <string>
+
+
+/*-----------------------------------------------------------------
+ -------------------------------------------------------------------
+ CLASS
+ record
+
+ parent class for the system- and library-dependent record-loader classes
+
+ KEYWORDS
+ pix record movie
+
+ DESCRIPTION
+
+ -----------------------------------------------------------------*/
+namespace gem { namespace plugins {
+ class GEM_EXTERN record
+{
+public:
+
+ //////////
+ // returns an instance wrapping all plugins or NULL
+ // if NULL is returned, you might still try your luck with manually accessing the
+ // PluginFactory
+ static record*getInstance(void);
+
+ /////////
+ // dtor must be virtual
+ virtual ~record(void);
+
+ /**
+ * get a list of supported codecs (short-form names, e.g. "mjpa")
+ */
+ virtual std::vector<std::string>getCodecs(void) = 0;
+ /**
+ * get a human readable description of the given codec (e.g. "Motion Jpeg A")
+ */
+ virtual const std::string getCodecDescription(const std::string codecname) = 0;
+ /**
+ * set the current codec
+ */
+ virtual bool setCodec(const std::string name) = 0;
+
+ /**
+ * list all properties the currently selected codec supports
+ * if the enumeration fails, this returns <code>false</code>
+ */
+ virtual bool enumProperties(gem::Properties&props) = 0;
+
+ //////////
+ // popup a dialog to set the codec interactively (interesting on os-x and w32)
+ // just return FALSE if you don't support dialogs
+ virtual bool dialog(void) = 0;
+
+ //////////
+ // start recording
+ /*
+ * returns TRUE if opening was successfull, FALSE otherwise
+ */
+ virtual bool start(const std::string filename, gem::Properties&props) = 0;
+
+ //////////
+ // record a frame
+ virtual bool write(imageStruct*) = 0;
+
+ //////////
+ // stop recording
+ virtual void stop (void) = 0;
+
+ };
+}; };
+
+
+
+/*
+ * factory code:
+ * to use these macros, you have to include "plugins/PluginFactory.h"
+ */
+
+/**
+ * \fn REGISTER_RECORDFACTORY(const char *id, Class recordClass)
+ * registers a new class "recordClass" with the record-factory
+ *
+ * \param id a symbolic (const char*) ID for the given class
+ * \param recordClass a class derived from "record"
+ */
+#define REGISTER_RECORDFACTORY(id, TYP) static gem::PluginFactoryRegistrar::registrar<TYP, gem::plugins::record> fac_record_ ## TYP (id)
+
+#endif // for header file