summaryrefslogtreecommitdiff
path: root/src/AS_02_IAB.h
diff options
context:
space:
mode:
authormilla <marc.illa@dolby.com>2021-05-26 13:30:01 +0200
committerStefan Kersten <stefan.kersten@dolby.com>2021-09-09 11:22:11 +0200
commitc7bf747462f303a7173693cacc4479df72037fb4 (patch)
tree1fc303e03319fe80fc9db6f2d7f6fa4f6a3eff1e /src/AS_02_IAB.h
parent3dd7454de034d96faf5571526d935d1d93560e05 (diff)
Writeframe and Readframe in line with other APIs (they now use framebuffer)
Diffstat (limited to 'src/AS_02_IAB.h')
-rw-r--r--src/AS_02_IAB.h47
1 files changed, 23 insertions, 24 deletions
diff --git a/src/AS_02_IAB.h b/src/AS_02_IAB.h
index 7e489e6..100f967 100644
--- a/src/AS_02_IAB.h
+++ b/src/AS_02_IAB.h
@@ -112,17 +112,17 @@ namespace AS_02 {
const ASDCP::Rational& sampling_rate = ASDCP::SampleRate_48k
);
- /**
- * Writes a single frame.
- *
- * Must be preceded by a succesful OpenWrite() call followed by zero or more WriteFrame() calls
- *
- * @param frame Pointer to a complete IA Frame
- * @param sz Size in bytes of the IA Frame
- * @return RESULT_OK indicates that the frame is written and additional frames can be written,
- * otherwise the reader is reset and the file is left is an undermined state.
- */
- Result_t WriteFrame(const ui8_t* frame, ui32_t sz);
+ /**
+ * Writes a single frame.
+ *
+ * Must be preceded by a succesful OpenWrite() call followed by zero or more WriteFrame() calls
+ *
+ * @param frame a complete IA Frame
+ * @return RESULT_OK indicates that the frame is written and additional frames can be written,
+ * otherwise the reader is reset and the file is left is an undermined state.
+ */
+ Result_t WriteFrame(const ASDCP::FrameBuffer& frame);
+
/**
* Writes an XML text document to the MXF file as per RP 2057. If the
@@ -135,10 +135,10 @@ namespace AS_02 {
/**
* Writes the Track File footer and closes the file.
- *
+ *
* Must be preceded by a succesful OpenWrite() call followed by zero or more WriteFrame() calls
- *
- * @return RESULT_OK indicates that the frame is written and additional frames can be written,
+ *
+ * @return RESULT_OK indicates that the frame is written and additional frames can be written,
* otherwise the reader is reset and the file is left is an undermined state.
*/
Result_t Finalize();
@@ -229,16 +229,15 @@ namespace AS_02 {
*/
Result_t FillWriterInfo(ASDCP::WriterInfo& writer_info) const;
- /**
- * Reads an IA Frame.
- *
- * @param frame_number Index of the frame to be read. Must be in the range [0, GetFrameCount()).
- * @param frame Frame data. Must not be modified. Remains valid until the next call to ReadFrame().
- * @return RESULT_OK indicates that more frames are ready to be read,
- * otherwise the file is closed and the reader reset
- */
- Result_t ReadFrame(ui32_t frame_number, Frame& frame);
-
+ /**
+ * Reads an IA Frame.
+ *
+ * @param frame_number Index of the frame to be read. Must be in the range [0, GetFrameCount()).
+ * @param frame Frame data. Must not be modified. Remains valid until the next call to ReadFrame().
+ * @return RESULT_OK indicates that more frames are ready to be read,
+ * otherwise the file is closed and the reader reset
+ */
+ Result_t ReadFrame(ui32_t frame_number, ASDCP::FrameBuffer& frame);
/** Reads a Generic Stream Partition payload. Returns RESULT_INIT if the file is
* not open, or RESULT_FORMAT if the SID is not present in the RIP, or if the