summaryrefslogtreecommitdiffstats
path: root/src/StatsPublish.h
blob: 7ff7da4157b0d269d8fc572c8d4b2ebadf5dbb1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/* ------------------------------------------------------------------
 * Copyright (C) 2019 Matthias P. Braendli
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 * -------------------------------------------------------------------
 */

#pragma once
#include <string>
#include <cstdint>
#include <cstddef>
#include <cstdio>

/*! \file StatsPublish.h
 *
 * Collects and sends some stats to a UNIX DGRAM socket so that an external tool
 * like ODR-EncoderManager can display it.
 *
 * Currently, only audio levels are collected.
 *
 * Output is formatted in YAML
 */
class StatsPublisher {
    public:
        StatsPublisher(const std::string& socket_path);
        StatsPublisher(const StatsPublisher& other) = delete;
        StatsPublisher& operator=(const StatsPublisher& other) = delete;
        ~StatsPublisher();

        /*! Update peak audio level information */
        void update_audio_levels(int16_t audiolevel_left, int16_t audiolevel_right);

        /*! Increments the underrun counter */
        void notify_underrun();

        /*! Increments the overrun counter */
        void notify_overrun();

        /*! Send the collected stats to the socket, doesn't block. If the socket is
         * not connected, the data is lost.
         *
         * Clears the collected data.  */
        void send_stats();

    private:
        std::string m_socket_path;
        int m_sock = -1;

        int16_t m_audio_left = 0;
        int16_t m_audio_right = 0;

        size_t m_num_underruns = 0;
        size_t m_num_overruns = 0;

        bool m_destination_available = true;
};