summaryrefslogtreecommitdiffstats
path: root/dom/media/encoder/ContainerWriter.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/media/encoder/ContainerWriter.h')
-rw-r--r--dom/media/encoder/ContainerWriter.h78
1 files changed, 78 insertions, 0 deletions
diff --git a/dom/media/encoder/ContainerWriter.h b/dom/media/encoder/ContainerWriter.h
new file mode 100644
index 000000000..1bd66cbc6
--- /dev/null
+++ b/dom/media/encoder/ContainerWriter.h
@@ -0,0 +1,78 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-*/
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef ContainerWriter_h_
+#define ContainerWriter_h_
+
+#include "nsTArray.h"
+#include "EncodedFrameContainer.h"
+#include "TrackMetadataBase.h"
+
+namespace mozilla {
+/**
+ * ContainerWriter packs encoded track data into a specific media container.
+ */
+class ContainerWriter {
+public:
+ ContainerWriter()
+ : mInitialized(false)
+ , mIsWritingComplete(false)
+ {}
+ virtual ~ContainerWriter() {}
+ // Mapping to DOMLocalMediaStream::TrackTypeHints
+ enum {
+ CREATE_AUDIO_TRACK = 1 << 0,
+ CREATE_VIDEO_TRACK = 1 << 1,
+ };
+ enum {
+ END_OF_STREAM = 1 << 0
+ };
+
+ /**
+ * Writes encoded track data from aBuffer to a packet, and insert this packet
+ * into the internal stream of container writer. aDuration is the playback
+ * duration of this packet in number of samples. aFlags is true with
+ * END_OF_STREAM if this is the last packet of track.
+ * Currently, WriteEncodedTrack doesn't support multiple tracks.
+ */
+ virtual nsresult WriteEncodedTrack(const EncodedFrameContainer& aData,
+ uint32_t aFlags = 0) = 0;
+
+ /**
+ * Set the meta data pointer into muxer
+ * This function will check the integrity of aMetadata.
+ * If the meta data isn't well format, this function will return NS_ERROR_FAILURE to caller,
+ * else save the pointer to mMetadata and return NS_OK.
+ */
+ virtual nsresult SetMetadata(TrackMetadataBase* aMetadata) = 0;
+
+ /**
+ * Indicate if the writer has finished to output data
+ */
+ virtual bool IsWritingComplete() { return mIsWritingComplete; }
+
+ enum {
+ FLUSH_NEEDED = 1 << 0,
+ GET_HEADER = 1 << 1
+ };
+
+ /**
+ * Copies the final container data to a buffer if it has accumulated enough
+ * packets from WriteEncodedTrack. This buffer of data is appended to
+ * aOutputBufs, and existing elements of aOutputBufs should not be modified.
+ * aFlags is true with FLUSH_NEEDED will force OggWriter to flush an ogg page
+ * even it is not full, and copy these container data to a buffer for
+ * aOutputBufs to append.
+ */
+ virtual nsresult GetContainerData(nsTArray<nsTArray<uint8_t> >* aOutputBufs,
+ uint32_t aFlags = 0) = 0;
+protected:
+ bool mInitialized;
+ bool mIsWritingComplete;
+};
+
+} // namespace mozilla
+
+#endif