o Added preliminary support for timed-text wrapping for AS-02. This

    work will require changes in SMPTE ST 429-5 and perhaps other
    standards work, so files created with this implementation are
    "speculative".  Publication of the revised ST 429-5 may not occur
    until early 2015.
  o Moved LocalFilenameResolver into the AS_DCP public API so that it
    can be used by other modules including AS-02.
  o Fixed wave wrapping UL in clip-wrapped AS-02 files.  Renamed some
    UL constants to reflect "clip" or "frame" wrapping.
  o Re-factored JP2K_PDesc_to_MD() and MD_to_JP2K_PDesc() to work
    with GenericPictureEssenceDescriptor objects.
  o Fixed a bug that was suppressing PictureComponentSizing,
    CodingStyleDefault and QuantizationDefault when writing the
    essence descriptor in a JP2K file (AS-DCP and AS-02).
  o Fixed the version byte on the following UL values:
    	  StereoscopicPictureSubDescriptor
	  GenericPictureEssenceDescriptor_ColorPrimaries
	  GenericPictureEssenceDescriptor_ActiveHeight
	  GenericPictureEssenceDescriptor_ActiveWidth
	  GenericPictureEssenceDescriptor_ActiveXOffset
	  GenericPictureEssenceDescriptor_ActiveYOffset
  o Added some essence descriptor options to as-02-wrap.
  o Added TTML timed-text wrapping option to as-02-wrap.
  o Changed bit rate display in asdcp-info from mebi-bits/s to
    mega-bits/s.
  o Added "SMPTE" / "Interop" format type display to asdcp-info.
  o Modified asdcp-wrap to assume -L when wrapping timed-text (since
    there is no MXF text wrapping for Interop.)
  o Fixed missing-index-partion bugs for AS-02 files.

1 files changed, 146 insertions, 0 deletions

diff --git a/src/AS_02.h b/src/AS_02.h
index e534dd4..3437152 100644
--- a/src/AS_02.h
+++ b/src/AS_02.h
@@ -314,6 +314,152 @@ namespace AS_02
     };
   } // namespace PCM
 
+  //---------------------------------------------------------------------------------
+  //
+  namespace TimedText
+    {
+      using ASDCP::TimedText::TimedTextDescriptor;
+      using ASDCP::TimedText::TimedTextResourceDescriptor;
+      using ASDCP::TimedText::ResourceList_t;
+
+      //
+      class ST2052_TextParser
+	{
+	  class h__TextParser;
+	  ASDCP::mem_ptr<h__TextParser> m_Parser;
+	  ASDCP_NO_COPY_CONSTRUCT(ST2052_TextParser);
+
+	public:
+	  ST2052_TextParser();
+	  virtual ~ST2052_TextParser();
+
+	  // Opens an XML file for reading, parses data to provide a complete
+	  // set of stream metadata for the MXFWriter below.
+	  Result_t OpenRead(const std::string& filename) const;
+
+	  // Parse an XML string 
+	  Result_t OpenRead(const std::string& xml_doc, const std::string& filename) const;
+
+	  // Fill a TimedTextDescriptor struct with the values from the file's contents.
+	  // Returns RESULT_INIT if the file is not open.
+	  Result_t FillTimedTextDescriptor(ASDCP::TimedText::TimedTextDescriptor&) const;
+
+	  // Reads the complete Timed Text Resource into the given string.
+	  Result_t ReadTimedTextResource(std::string&) const;
+
+	  // Reads the Ancillary Resource having the given ID. Fails if the buffer
+	  // is too small or the resource does not exist. The optional Resolver
+	  // argument can be provided which will be used to retrieve the resource
+	  // having a particulat UUID. If a Resolver is not supplied, the default
+	  // internal resolver will return the contents of the file having the UUID
+	  // as the filename. The filename must exist in the same directory as the
+	  // XML file opened with OpenRead().
+	  Result_t ReadAncillaryResource(const Kumu::UUID&, ASDCP::TimedText::FrameBuffer&,
+					 const ASDCP::TimedText::IResourceResolver* Resolver = 0) const;
+	};
+
+      //
+      class MXFWriter
+	{
+	  class h__Writer;
+	  ASDCP::mem_ptr<h__Writer> m_Writer;
+	  ASDCP_NO_COPY_CONSTRUCT(MXFWriter);
+
+	public:
+	  MXFWriter();
+	  virtual ~MXFWriter();
+
+	  // Warning: direct manipulation of MXF structures can interfere
+	  // with the normal operation of the wrapper.  Caveat emptor!
+	  virtual ASDCP::MXF::OP1aHeader& OP1aHeader();
+	  virtual ASDCP::MXF::RIP& RIP();
+
+	  // Open the file for writing. The file must not exist. Returns error if
+	  // the operation cannot be completed or if nonsensical data is discovered
+	  // in the essence descriptor.
+	  Result_t OpenWrite(const std::string& filename, const ASDCP::WriterInfo&,
+			     const ASDCP::TimedText::TimedTextDescriptor&, ui32_t HeaderSize = 16384);
+
+	  // Writes the Timed-Text Resource to the MXF file. The file must be UTF-8
+	  // encoded. If the optional AESEncContext argument is present, the essence
+	  // is encrypted prior to writing. Fails if the file is not open, is finalized,
+	  // or an operating system error occurs.
+	  // This method may only be called once, and it must be called before any
+	  // call to WriteAncillaryResource(). RESULT_STATE will be returned if these
+	  // conditions are not met.
+	  Result_t WriteTimedTextResource(const std::string& XMLDoc, ASDCP::AESEncContext* = 0, ASDCP::HMACContext* = 0);
+
+	  // Writes an Ancillary Resource to the MXF file. If the optional AESEncContext
+	  // argument is present, the essence is encrypted prior to writing.
+	  // Fails if the file is not open, is finalized, or an operating system
+	  // error occurs. RESULT_STATE will be returned if the method is called before
+	  // WriteTimedTextResource()
+	  Result_t WriteAncillaryResource(const ASDCP::TimedText::FrameBuffer&, ASDCP::AESEncContext* = 0, ASDCP::HMACContext* = 0);
+
+	  // Closes the MXF file, writing the index and revised header.
+	  Result_t Finalize();
+	};
+
+      //
+      class MXFReader
+	{
+	  class h__Reader;
+	  ASDCP::mem_ptr<h__Reader> m_Reader;
+	  ASDCP_NO_COPY_CONSTRUCT(MXFReader);
+
+	public:
+	  MXFReader();
+	  virtual ~MXFReader();
+
+	  // Warning: direct manipulation of MXF structures can interfere
+	  // with the normal operation of the wrapper.  Caveat emptor!
+	  virtual ASDCP::MXF::OP1aHeader& OP1aHeader();
+	  virtual AS_02::MXF::AS02IndexReader& AS02IndexReader();
+	  virtual ASDCP::MXF::RIP& RIP();
+
+	  // Open the file for reading. The file must exist. Returns error if the
+	  // operation cannot be completed.
+	  Result_t OpenRead(const std::string& filename) const;
+
+	  // Returns RESULT_INIT if the file is not open.
+	  Result_t Close() const;
+
+	  // Fill a TimedTextDescriptor struct with the values from the file's header.
+	  // Returns RESULT_INIT if the file is not open.
+	  Result_t FillTimedTextDescriptor(ASDCP::TimedText::TimedTextDescriptor&) const;
+
+	  // Fill a WriterInfo struct with the values from the file's header.
+	  // Returns RESULT_INIT if the file is not open.
+	  Result_t FillWriterInfo(ASDCP::WriterInfo&) const;
+
+	  // Reads the complete Timed Text Resource into the given string. Fails if the resource
+	  // is encrypted and AESDecContext is NULL (use the following method to retrieve the
+	  // raw ciphertet block).
+	  Result_t ReadTimedTextResource(std::string&, ASDCP::AESDecContext* = 0, ASDCP::HMACContext* = 0) const;
+
+	  // Reads the complete Timed Text Resource from the MXF file. If the optional AESEncContext
+	  // argument is present, the resource is decrypted after reading. If the MXF
+	  // file is encrypted and the AESDecContext argument is NULL, the frame buffer
+	  // will contain the ciphertext frame data. If the HMACContext argument is
+	  // not NULL, the HMAC will be calculated (if the file supports it).
+	  // Returns RESULT_INIT if the file is not open, failure if the frame number is
+	  // out of range, or if optional decrypt or HAMC operations fail.
+	  Result_t ReadTimedTextResource(ASDCP::TimedText::FrameBuffer&, ASDCP::AESDecContext* = 0, ASDCP::HMACContext* = 0) const;
+
+	  // Reads the timed-text resource having the given UUID from the MXF file. If the
+	  // optional AESEncContext argument is present, the resource is decrypted after
+	  // reading. If the MXF file is encrypted and the AESDecContext argument is NULL,
+	  // the frame buffer will contain the ciphertext frame data. If the HMACContext
+	  // argument is not NULL, the HMAC will be calculated (if the file supports it).
+	  // Returns RESULT_INIT if the file is not open, failure if the frame number is
+	  // out of range, or if optional decrypt or HAMC operations fail.
+	  Result_t ReadAncillaryResource(const Kumu::UUID&, ASDCP::TimedText::FrameBuffer&, ASDCP::AESDecContext* = 0, ASDCP::HMACContext* = 0) const;
+
+	  // Print debugging information to stream
+	  void     DumpHeaderMetadata(FILE* = 0) const;
+	  void     DumpIndex(FILE* = 0) const;
+	};
+    } // namespace TimedText
 
 
 } // namespace AS_02