Report stream serial numbers more consistently

Summary: Report serial numbers more consistently everywhere we provide stream IDs.

Reviewed By: liorda

Differential Revision: D85787556

fbshipit-source-id: fa6ff6b3b0f43159f8ebdcea348efe879e018f52

Author: Georges Berenger

csrc/reader/MultiVRSReader.cpp

@@ -993,9 +993,12 @@ PyObject* OssMultiVRSReader::getRecordInfo(
   string type = lowercaseTypeName(record.recordType);
   pyDict_SetItemWithDecRef(dic, pyObject("record_type"), pyObject(type));
   pyDict_SetItemWithDecRef(dic, pyObject("record_timestamp"), pyObject(record.timestamp));
-  const std::string streamIdName = reader_.getUniqueStreamId(&record).getNumericName();
+  UniqueStreamId uniqueStreamId = reader_.getUniqueStreamId(&record);
+  const std::string streamIdName = uniqueStreamId.getNumericName();
   pyDict_SetItemWithDecRef(dic, pyObject("stream_id"), pyObject(streamIdName));
   pyDict_SetItemWithDecRef(dic, pyObject("recordable_id"), pyObject(streamIdName));
+  pyDict_SetItemWithDecRef(
+      dic, pyObject("serial_number"), pyObject(reader_.getSerialNumber(uniqueStreamId)));
   return dic;
 }
 

csrc/reader/MultiVRSReader.h

@@ -265,6 +265,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getAllRecordsInfo();
 
   /// Get basic record information for a number of records in the file.
@@ -275,6 +276,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getRecordsInfo(int32_t firstIndex, int32_t count);
 
   /// Get basic record information for all the read enabled streams' records.
@@ -283,6 +285,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getEnabledStreamsRecordsInfo();
 
   // ---------------
@@ -296,6 +299,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// If there are no records for this index, throws an IndexError exception.
   py::object gotoRecord(int index);
 
@@ -306,6 +310,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// If there are no records at or after this timestamp, throws an IndexError exception.
   py::object gotoTime(double timestamp);
 
@@ -356,6 +361,7 @@ class OssMultiVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record, as number of seconds (double).
   /// "stream_id": stream id of the stream the record was read from.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// "metadata_count": number of metadata blocks read. Use getMetadata() to get them.
   /// "image_count": number of image blocks read. Use getImageXXX() to get them.
   /// "audio_block_count": number of audio blocks read. Use getAudioBlockXXX() to get them.

csrc/reader/VRSReader.cpp

@@ -45,7 +45,10 @@
 
 namespace {
 
-PyObject* getRecordInfo(const IndexRecord::RecordInfo& record, int32_t recordIndex) {
+PyObject* getRecordInfo(
+    RecordFileReader& reader,
+    const IndexRecord::RecordInfo& record,
+    int32_t recordIndex) {
   PyObject* dic = PyDict_New();
   pyDict_SetItemWithDecRef(dic, pyObject("record_index"), pyObject(recordIndex));
   string type = lowercaseTypeName(record.recordType);
@@ -54,6 +57,10 @@ PyObject* getRecordInfo(const IndexRecord::RecordInfo& record, int32_t recordInd
   pyDict_SetItemWithDecRef(dic, pyObject("stream_id"), pyObject(record.streamId.getNumericName()));
   pyDict_SetItemWithDecRef(
       dic, pyObject("recordable_id"), pyObject(record.streamId.getNumericName()));
+  pyDict_SetItemWithDecRef(
+      dic, pyObject("recordable_id"), pyObject(record.streamId.getNumericName()));
+  pyDict_SetItemWithDecRef(
+      dic, pyObject("serial_number"), pyObject(reader.getSerialNumber(record.streamId)));
   return dic;
 }
 
@@ -620,7 +627,7 @@ py::object OssVRSReader::getAllRecordsInfo() {
   PyObject* list = PyList_New(listSize);
   int32_t recordIndex = 0;
   for (const auto& record : index) {
-    auto pyRecordInfo = getRecordInfo(record, recordIndex);
+    auto pyRecordInfo = getRecordInfo(reader_, record, recordIndex);
     PyList_SetItem(list, recordIndex, pyRecordInfo);
     recordIndex++;
   }
@@ -640,7 +647,7 @@ py::object OssVRSReader::getRecordsInfo(int32_t firstIndex, int32_t count) {
   PyObject* list = PyList_New(last - first);
   int32_t recordIndex = 0;
   for (size_t sourceIndex = first; sourceIndex < last; ++sourceIndex, ++recordIndex) {
-    auto pyRecordInfo = getRecordInfo(index[sourceIndex], sourceIndex);
+    auto pyRecordInfo = getRecordInfo(reader_, index[sourceIndex], sourceIndex);
     PyList_SetItem(list, recordIndex, pyRecordInfo);
   }
   return pyWrap(list);
@@ -656,7 +663,7 @@ py::object OssVRSReader::getEnabledStreamsRecordsInfo() {
     int32_t recordIndex = 0;
     for (const auto& record : index) {
       if (enabledStreams_.find(record.streamId) != enabledStreams_.end()) {
-        auto pyRecordInfo = getRecordInfo(record, recordIndex);
+        auto pyRecordInfo = getRecordInfo(reader_, record, recordIndex);
         PyList_Append(list, pyRecordInfo);
         Py_DECREF(pyRecordInfo);
       }
@@ -686,7 +693,8 @@ py::object OssVRSReader::getNextRecordInfo(const char* errorMessage) {
     nextRecordIndex_ = static_cast<uint32_t>(index.size());
     throw py::index_error(errorMessage);
   }
-  return pyWrap(getRecordInfo(index[nextRecordIndex_], static_cast<int32_t>(nextRecordIndex_)));
+  return pyWrap(
+      getRecordInfo(reader_, index[nextRecordIndex_], static_cast<int32_t>(nextRecordIndex_)));
 }
 
 py::object OssVRSReader::readNextRecord() {

csrc/reader/VRSReader.h

@@ -319,6 +319,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getAllRecordsInfo();
 
   /// Get basic record information for a number of records in the file.
@@ -329,6 +330,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getRecordsInfo(int32_t firstIndex, int32_t count);
 
   /// Get basic record information for all the read enabled streams' records.
@@ -337,6 +339,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   py::object getEnabledStreamsRecordsInfo();
 
   // ---------------
@@ -350,6 +353,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// If there are no records for this index, throws an IndexError exception.
   py::object gotoRecord(int index);
 
@@ -360,6 +364,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record.
   /// "stream_id": streamId of the record.
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// If there are no records at or after this timestamp, throws an IndexError exception.
   py::object gotoTime(double timestamp);
 
@@ -410,6 +415,7 @@ class OssVRSReader : public VRSReaderBase {
   /// "record_timestamp": timestamp of the record, as number of seconds (double).
   /// "stream_id": stream id of the stream the record was read from .
   /// "record_type": record type, either "configuration", "state" or "data".
+  /// "serial_number": stream serial number.
   /// "metadata_count": number of metadata blocks read. Use getMetadata() to get them.
   /// "image_count": number of image blocks read. Use getImageXXX() to get them.
   /// "audio_block_count": number of audio blocks read. Use getAudioBlockXXX() to get them.