Bug 842243 - Part 2: Add OggWriter.h/.cpp; Implementation of Ogg container. r=roc, r=tterribe

content/media/ogg/OggWriter.cpp

@@ -0,0 +1,113 @@
+/* -*- 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/. */
+#include "OggWriter.h"
+
+#undef LOG
+#ifdef MOZ_WIDGET_GONK
+#include <android/log.h>
+#define LOG(args...) __android_log_print(ANDROID_LOG_INFO, "MediaEncoder", ## args);
+#else
+#define LOG(args, ...)
+#endif
+
+namespace mozilla {
+
+OggWriter::OggWriter() : ContainerWriter()
+{
+  if (NS_FAILED(Init())) {
+    LOG("ERROR! Fail to initialize the OggWriter.");
+  }
+}
+
+nsresult
+OggWriter::Init()
+{
+  MOZ_ASSERT(!mInitialized);
+
+  // The serial number (serialno) should be a random number, for the current
+  // implementation where the output file contains only a single stream, this
+  // serialno is used to differentiate between files.
+  srand(static_cast<unsigned>(PR_Now()));
+  int rc = ogg_stream_init(&mOggStreamState, rand());
+
+  mPacket.b_o_s = 1;
+  mPacket.e_o_s = 0;
+  mPacket.granulepos = 0;
+  mPacket.packet = nullptr;
+  mPacket.packetno = 0;
+  mPacket.bytes = 0;
+
+  mInitialized = (rc == 0);
+
+  return (rc == 0) ? NS_OK : NS_ERROR_NOT_INITIALIZED;
+}
+
+nsresult
+OggWriter::WriteEncodedTrack(const nsTArray<uint8_t>& aBuffer, int aDuration,
+                             uint32_t aFlags)
+{
+  MOZ_ASSERT(!ogg_stream_eos(&mOggStreamState),
+             "No data can be written after eos has marked.");
+
+  // Set eos flag to true, and once the eos is written to a packet, there must
+  // not be anymore pages after a page has marked as eos.
+  if (aFlags & ContainerWriter::END_OF_STREAM) {
+    LOG("[OggWriter] Set e_o_s flag to true.");
+    mPacket.e_o_s = 1;
+  }
+
+  mPacket.packet = const_cast<uint8_t*>(aBuffer.Elements());
+  mPacket.bytes = aBuffer.Length();
+  mPacket.granulepos += aDuration;
+
+  // 0 returned on success. -1 returned in the event of internal error.
+  // The data in the packet is copied into the internal storage managed by the
+  // mOggStreamState, so we are free to alter the contents of mPacket after
+  // this call has returned.
+  int rc = ogg_stream_packetin(&mOggStreamState, &mPacket);
+  if (rc < 0) {
+    LOG("[OggWriter] Failed in ogg_stream_packetin! (%d).", rc);
+    return NS_ERROR_FAILURE;
+  }
+
+  if (mPacket.b_o_s) {
+    mPacket.b_o_s = 0;
+  }
+  mPacket.packetno++;
+  mPacket.packet = nullptr;
+
+  return NS_OK;
+}
+
+nsresult
+OggWriter::GetContainerData(nsTArray<nsTArray<uint8_t> >* aOutputBufs,
+                            uint32_t aFlags)
+{
+  int rc = -1;
+  // Force generate a page even if the amount of packet data is not enough.
+  // Usually do so after a header packet.
+  if (aFlags & ContainerWriter::FLUSH_NEEDED) {
+    // rc = 0 means no packet to put into a page, or an internal error.
+    rc = ogg_stream_flush(&mOggStreamState, &mOggPage);
+  } else {
+    // rc = 0 means insufficient data has accumulated to fill a page, or an
+    // internal error has occurred.
+    rc = ogg_stream_pageout(&mOggStreamState, &mOggPage);
+  }
+
+  if (rc) {
+    aOutputBufs->AppendElement();
+    aOutputBufs->LastElement().SetLength(mOggPage.header_len +
+                                         mOggPage.body_len);
+    memcpy(aOutputBufs->LastElement().Elements(), mOggPage.header,
+           mOggPage.header_len);
+    memcpy(aOutputBufs->LastElement().Elements() + mOggPage.header_len,
+           mOggPage.body, mOggPage.body_len);
+  }
+
+  return (rc > 0) ? NS_OK : NS_ERROR_FAILURE;
+}
+
+}

content/media/ogg/OggWriter.h

@@ -0,0 +1,39 @@
+/* -*- 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 OggWriter_h_
+#define OggWriter_h_
+
+#include "ContainerWriter.h"
+#include <ogg/ogg.h>
+
+namespace mozilla {
+/**
+ * WriteEncodedTrack inserts raw packets into Ogg stream (ogg_stream_state), and
+ * GetContainerData outputs an ogg_page when enough packets have been written
+ * to the Ogg stream.
+ * For more details, please reference:
+ * http://www.xiph.org/ogg/doc/libogg/encoding.html
+ */
+class OggWriter : public ContainerWriter
+{
+public:
+  OggWriter();
+
+  nsresult WriteEncodedTrack(const nsTArray<uint8_t>& aBuffer, int aDuration,
+                             uint32_t aFlags = 0) MOZ_OVERRIDE;
+
+  nsresult GetContainerData(nsTArray<nsTArray<uint8_t> >* aOutputBufs,
+                            uint32_t aFlags = 0) MOZ_OVERRIDE;
+
+private:
+  nsresult Init();
+
+  ogg_stream_state mOggStreamState;
+  ogg_page mOggPage;
+  ogg_packet mPacket;
+};
+}
+#endif

content/media/ogg/moz.build

@@ -10,11 +10,13 @@ EXPORTS += [
     'OggCodecState.h',
     'OggDecoder.h',
     'OggReader.h',
+    'OggWriter.h',
 ]
 
 CPP_SOURCES += [
     'OggCodecState.cpp',
     'OggDecoder.cpp',
     'OggReader.cpp',
+    'OggWriter.cpp',
 ]
 

layout/media/symbols.def.in

@@ -57,9 +57,13 @@ ogg_page_granulepos
 ogg_page_serialno
 ogg_stream_check
 ogg_stream_clear
+ogg_stream_eos
+ogg_stream_flush
 ogg_stream_init
+ogg_stream_packetin
 ogg_stream_packetout
 ogg_stream_pagein
+ogg_stream_pageout
 ogg_stream_reset
 ogg_sync_buffer
 ogg_sync_clear