orbbec-sdk-sys 0.1.2+2.5.5

Low-level Rust bindings for https://github.com/orbbec/OrbbecSDK_v2
Documentation 
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// Copyright (c) Orbbec Inc. All Rights Reserved.
// Licensed under the MIT License.

#pragma once
#include "liveMedia.hh"
#include "BasicUsageEnvironment.hh"
#include "ObRTPSink.hpp"
#include <string>
#include <mutex>
#include <condition_variable>

namespace libobsensor {

const static uint16_t RTSP_RESPONSE_TIMEOUT_MS          = 12000;
const static uint16_t RTSP_RESPONSE_TIMEOUT_TEARDOWN_MS = 2000;
const static bool     RTP_STREAMING_OVER_TCP            = true;

enum CommandState {
    CMD_RESP_WITH_ERROR = -2,
    CMD_TIMEOUT         = -1,
    CMD_WAITING_RESP    = 0,
    CMD_DONE            = 1,
};

enum RTSPState {
    RTSP_DESCRIBE = 0,
    RTSP_SETUP,
    RTSP_PLAY,
    RTSP_TEARDOWN,
};

class ObRTSPClient : public RTSPClient {
public:
    static ObRTSPClient *createNew(std::shared_ptr<const StreamProfile> profile, UsageEnvironment &env, char const *rtspURL, MutableFrameCallback callback, int verbosityLevel = 0,
                                   portNumBits tunnelOverHTTPPortNum = 0, int socketNumToServer = -1);

    virtual ~ObRTSPClient() noexcept override;

public:
    void startStream();
    void stopStream();

protected:
    ObRTSPClient(std::shared_ptr<const StreamProfile> profile, UsageEnvironment &env, char const *rtspURL, MutableFrameCallback callback, int verbosityLevel = 0, portNumBits tunnelOverHTTPPortNum = 0,
                 int socketNumToServer = -1);

private:
    void DESCRIBE();
    // DESCRIBE command response, parse SDP, create media session
    static void cmdResponseHandlerDESCRIBE(RTSPClient *rtspClient, int resultCode, char *resultString);

    void SETUP();
    void setupNextSubsession();
    // SETUP command response, complete the creation of Subsession (create and bind sink)
    static void cmdResponseHandlerSETUP(RTSPClient *rtspClient, int resultCode, char *resultString);

    void PLAY();
    // PLAY command response, if the stream has a certain duration, create a scheduled task to close the stream
    static void cmdResponseHandlerPLAY(RTSPClient *rtspClient, int resultCode, char *resultString);

    void TEARDOWN();
    // TEARDOWN response
    static void cmdResponseHandlerTEARDOWN(RTSPClient *rtspClient, int resultCode, char *resultString);

    // Other event handler functions:
    static void subsessionAfterPlayingHandler(void *clientData);  // called when a stream's subsession (e.g., audio or video substream) ends
    static void subsessionByeHandler(void *clientData, char const *reason);
    // called when a RTCP "BYE" is received for a subsession
    static void streamStopEventHandler(void *clientData);
    // called at the end of a stream's expected duration (if the stream has not already signaled its end using a RTCP "BYE")

private:
    void clearSinks();

private:
    std::shared_ptr<const StreamProfile> profile_;
    MutableFrameCallback frameCallback_;

    std::string                 errorMsg_;
    CommandState                commandState_ = CMD_DONE;
    std::recursive_mutex        commandMutex_;
    std::condition_variable_any commandCv_;

    RTSPState RTSPState_ = RTSP_DESCRIBE;

    MediaSession            *mediaSession_      = nullptr;
    MediaSubsession         *curSubsession_     = nullptr;
    MediaSubsessionIterator *curSubsessionIter_ = nullptr;

    double    duration_        = 0;
    TaskToken streamTimerTask_ = NULL;
};

}  // namespace libobsensor