summaryrefslogtreecommitdiff
path: root/video_reader.h
diff options
context:
space:
mode:
authorDmitry Kovalev <dkovalev@google.com>2014-02-05 18:34:46 -0800
committerDmitry Kovalev <dkovalev@google.com>2014-02-05 20:34:51 -0800
commit37e6fd3d765e192f24de65c472fb0cef6a3d9a77 (patch)
tree3a09237d98b4eff48e6a41bef84479ee537a48f0 /video_reader.h
parentcebda1b65cf821b3dd7bbdd3a93c8e2bfe9b499b (diff)
downloadlibvpx-37e6fd3d765e192f24de65c472fb0cef6a3d9a77.tar.gz
Adding video reader/writer APIs.
Right now only IVF format is supported which is enough for example code. Other formats like y4m, webm, raw yuv will be supported later. Change-Id: I34c6f20731c1851947587ca5c589d7856b675164
Diffstat (limited to 'video_reader.h')
-rw-r--r--video_reader.h52
1 files changed, 52 insertions, 0 deletions
diff --git a/video_reader.h b/video_reader.h
new file mode 100644
index 000000000..a62c6d710
--- /dev/null
+++ b/video_reader.h
@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2014 The WebM project authors. All Rights Reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef VIDEO_READER_H_
+#define VIDEO_READER_H_
+
+#include "./video_common.h"
+
+// The following code is work in progress. It is going to support transparent
+// reading of input files. Right now only IVF format is supported for
+// simplicity. The main goal the API is to be simple and easy to use in example
+// code and in vpxenc/vpxdec later. All low-level details like memory
+// buffer management are hidden from API users.
+struct VpxVideoReaderStruct;
+typedef struct VpxVideoReaderStruct VpxVideoReader;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Opens the input file for reading and inspects it to determine file type.
+// Returns an opaque VpxVideoReader* upon success, or NULL upon failure.
+// Right now only IVF format is supported.
+VpxVideoReader *vpx_video_reader_open(const char *filename);
+
+// Frees all resources associated with VpxVideoReader* returned from
+// vpx_video_reader_open() call.
+void vpx_video_reader_close(VpxVideoReader *reader);
+
+// Reads frame from the file and stores it in internal buffer.
+int vpx_video_reader_read_frame(VpxVideoReader *reader);
+
+// Returns the pointer to memory buffer with frame data read by last call to
+// vpx_video_reader_read_frame().
+const uint8_t *vpx_video_reader_get_frame(VpxVideoReader *reader,
+ size_t *size);
+
+// Fills VpxVideoInfo with information from opened video file.
+const VpxVideoInfo *vpx_video_reader_get_info(VpxVideoReader *reader);
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+#endif // VIDEO_READER_H_