streamcraft 0.0.1

General purpose data/multimedia pipeline framework
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
96
97

// Copyright (C) 2024  MAlba124 <marlhan@proton.me>
//
// StreamCraft is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// StreamCraft is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with StreamCraft.  If not, see <https://www.gnu.org/licenses/>.

use crossbeam_channel::Receiver;

use crate::pipeline::{self, Datagram, Parent};

#[derive(PartialEq)]
pub enum CommonFormat {
    Text,
    Bytes,
}

#[derive(PartialEq)]
pub enum Sink {
    One(CommonFormat),
    None,
}

impl Sink {
    pub fn has_none(&self) -> bool {
        matches!(self, Sink::None)
    }
}

#[derive(PartialEq)]
pub enum Srcs {
    One(CommonFormat),
    None,
}

impl Srcs {
    pub fn has_none(&self) -> bool {
        matches!(self, Srcs::None)
    }
}

pub fn sink_is_compatible_with_src(sink: Sink, src: Srcs) -> bool {
    match sink {
        Sink::One(format) => src == Srcs::One(format),
        _ => false,
    }
}

pub struct ElementArchitecture {
    pub sink: Sink,
    pub srcs: Srcs,
}

#[derive(PartialEq)]
pub enum ElementType {
    TextSink,
    TextSrc,
    BytesSrc,
    BytesSink,
}

pub trait Element: Sync + Send {
    fn get_sink_type(&self) -> ElementType;
    fn get_architecture(&self) -> ElementArchitecture;
    fn run(
        &mut self,
        parent_datagram_receiver: Receiver<Datagram>,
    ) -> Result<(), pipeline::error::Error>;
    fn set_parent(&mut self, parent: Parent);
    fn cleanup(&mut self) -> Result<(), pipeline::error::Error>;
}

// TODO: Make it so elements are NOT valid when this macro is not used.
#[macro_export]
macro_rules! element_def {
    ($element:ty, $name:literal) => {
        impl Drop for $element {
            fn drop(&mut self) {
                if let Err(e) = self.cleanup() {
                    $crate::error!("Failed to drop: {e}");
                }
            }
        }

        $crate::define_log_info! {
            $name
        }
    };
}