mediaiostats.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/duration.h>
#include <promeki/error.h>
#include <promeki/framecount.h>
#include <promeki/string.h>
#include <promeki/stringlist.h>
#include <promeki/variantdatabase.h>
#include <promeki/windowedstat.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class MediaIOStats : public VariantDatabase<"MediaIOStats"> {
        public:
                using Base = VariantDatabase<"MediaIOStats">;
                using Base::Base;
 
                // ---- Per-command keys (populated by framework + backend on
                //      every command's MediaIOCommand::stats) ----
 
                PROMEKI_DECLARE_ID(ExecuteDuration,
                                   VariantSpec()
                                           .setType(DataTypeDuration)
                                           .setDefault(Duration::zero())
                                           .setDescription("Wall time spent executing the command."));
                PROMEKI_DECLARE_ID(QueueWaitDuration,
                                   VariantSpec()
                                           .setType(DataTypeDuration)
                                           .setDefault(Duration::zero())
                                           .setDescription("Wall time spent in the strand queue."));
                PROMEKI_DECLARE_ID(BytesProcessed,
                                   VariantSpec()
                                           .setType(DataTypeInt64)
                                           .setDefault(int64_t(0))
                                           .setMin(int64_t(0))
                                           .setDescription("Payload bytes produced or consumed."));
 
                // ---- Instance-wide cumulative keys (populated when a
                //      MediaIOCommandStats command resolves) ----
 
                PROMEKI_DECLARE_ID(FramesDropped, VariantSpec()
                                                          .setType(DataTypeFrameCount)
                                                          .setDefault(FrameCount(0))
                                                          .setDescription("Total frames dropped since open."));
                PROMEKI_DECLARE_ID(FramesRepeated, VariantSpec()
                                                           .setType(DataTypeFrameCount)
                                                           .setDefault(FrameCount(0))
                                                           .setDescription("Total frames repeated due to underrun."));
                PROMEKI_DECLARE_ID(FramesLate, VariantSpec()
                                                       .setType(DataTypeFrameCount)
                                                       .setDefault(FrameCount(0))
                                                       .setDescription("Total frames that arrived late."));
                PROMEKI_DECLARE_ID(QueueDepth, VariantSpec()
                                                       .setType(DataTypeInt64)
                                                       .setDefault(int64_t(0))
                                                       .setMin(int64_t(0))
                                                       .setDescription("Current depth of internal buffer."));
                PROMEKI_DECLARE_ID(QueueCapacity, VariantSpec()
                                                          .setType(DataTypeInt64)
                                                          .setDefault(int64_t(0))
                                                          .setMin(int64_t(0))
                                                          .setDescription("Capacity of internal buffer."));
                PROMEKI_DECLARE_ID(BytesPerSecond, VariantSpec()
                                                           .setType(DataTypeDouble)
                                                           .setDefault(0.0)
                                                           .setMin(0.0)
                                                           .setDescription("Current data rate in bytes per second."));
                PROMEKI_DECLARE_ID(FramesPerSecond,
                                   VariantSpec()
                                           .setType(DataTypeDouble)
                                           .setDefault(0.0)
                                           .setMin(0.0)
                                           .setDescription("Current frame rate in frames per second."));
                PROMEKI_DECLARE_ID(AverageLatencyMs, VariantSpec()
                                                             .setType(DataTypeDouble)
                                                             .setDefault(0.0)
                                                             .setMin(0.0)
                                                             .setDescription("Average end-to-end latency in ms."));
                PROMEKI_DECLARE_ID(PeakLatencyMs, VariantSpec()
                                                          .setType(DataTypeDouble)
                                                          .setDefault(0.0)
                                                          .setMin(0.0)
                                                          .setDescription("Peak observed latency in ms."));
                PROMEKI_DECLARE_ID(AverageProcessingMs,
                                   VariantSpec()
                                           .setType(DataTypeDouble)
                                           .setDefault(0.0)
                                           .setMin(0.0)
                                           .setDescription("Average per-frame processing time in ms."));
                PROMEKI_DECLARE_ID(PeakProcessingMs, VariantSpec()
                                                             .setType(DataTypeDouble)
                                                             .setDefault(0.0)
                                                             .setMin(0.0)
                                                             .setDescription("Peak per-frame processing time in ms."));
                PROMEKI_DECLARE_ID(LastErrorMessage, VariantSpec()
                                                             .setType(DataTypeString)
                                                             .setDefault(String())
                                                             .setDescription("Most recent error description."));
                PROMEKI_DECLARE_ID(PendingOperations,
                                   VariantSpec()
                                           .setType(DataTypeInt64)
                                           .setDefault(int64_t(0))
                                           .setMin(int64_t(0))
                                           .setDescription("Commands queued on the strand but not yet running."));
 
                Error setFromJson(ID id, const Variant &val) {
                        if (val.type() == DataTypeString) {
                                const String s = val.get<String>();
                                if (s.startsWith("cap=")) {
                                        auto r = WindowedStat::fromString(s);
                                        if (error(r).isOk()) {
                                                Error err;
                                                set(id, Variant(value(r)), &err);
                                                return err;
                                        }
                                }
                        }
                        return Base::setFromJson(id, val);
                }
 
                String toString() const;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV