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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{AllocationParams, Memory, Object};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// Memory is usually created by allocators with a [`AllocatorExt::alloc()`][crate::prelude::AllocatorExt::alloc()]
    /// method call. When [`None`] is used as the allocator, the default allocator will
    /// be used.
    ///
    /// New allocators can be registered with [`register()`][Self::register()].
    /// Allocators are identified by name and can be retrieved with
    /// [`find()`][Self::find()]. [`AllocatorExt::set_default()`][crate::prelude::AllocatorExt::set_default()] can be used to change the
    /// default allocator.
    ///
    /// New memory can be created with [`Memory::new_wrapped()`][crate::Memory::new_wrapped()] that wraps the memory
    /// allocated elsewhere.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`AllocatorExt`][trait@crate::prelude::AllocatorExt], [`GstObjectExt`][trait@crate::prelude::GstObjectExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstAllocator")]
    pub struct Allocator(Object<ffi::GstAllocator, ffi::GstAllocatorClass>) @extends Object;

    match fn {
        type_ => || ffi::gst_allocator_get_type(),
    }
}

impl Allocator {
    pub const NONE: Option<&'static Allocator> = None;

    /// Find a previously registered allocator with `name`. When `name` is [`None`], the
    /// default allocator will be returned.
    /// ## `name`
    /// the name of the allocator
    ///
    /// # Returns
    ///
    /// a [`Allocator`][crate::Allocator] or [`None`] when
    /// the allocator with `name` was not registered.
    #[doc(alias = "gst_allocator_find")]
    pub fn find(name: Option<&str>) -> Option<Allocator> {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_allocator_find(name.to_glib_none().0)) }
    }
}

unsafe impl Send for Allocator {}
unsafe impl Sync for Allocator {}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Allocator>> Sealed for T {}
}

/// Trait containing all [`struct@Allocator`] methods.
///
/// # Implementors
///
/// [`Allocator`][struct@crate::Allocator]
pub trait AllocatorExt: IsA<Allocator> + sealed::Sealed + 'static {
    /// Use `self` to allocate a new memory block with memory that is at least
    /// `size` big.
    ///
    /// The optional `params` can specify the prefix and padding for the memory. If
    /// [`None`] is passed, no flags, no extra prefix/padding and a default alignment is
    /// used.
    ///
    /// The prefix/padding will be filled with 0 if flags contains
    /// [`MemoryFlags::ZERO_PREFIXED`][crate::MemoryFlags::ZERO_PREFIXED] and [`MemoryFlags::ZERO_PADDED`][crate::MemoryFlags::ZERO_PADDED] respectively.
    ///
    /// When `self` is [`None`], the default allocator will be used.
    ///
    /// The alignment in `params` is given as a bitmask so that `align` + 1 equals
    /// the amount of bytes to align to. For example, to align to 8 bytes,
    /// use an alignment of 7.
    /// ## `size`
    /// size of the visible memory area
    /// ## `params`
    /// optional parameters
    ///
    /// # Returns
    ///
    /// a new [`Memory`][crate::Memory].
    #[doc(alias = "gst_allocator_alloc")]
    fn alloc(
        &self,
        size: usize,
        params: Option<&AllocationParams>,
    ) -> Result<Memory, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_allocator_alloc(
                self.as_ref().to_glib_none().0,
                size,
                mut_override(params.to_glib_none().0),
            ))
            .ok_or_else(|| glib::bool_error!("Failed to allocate memory"))
        }
    }

    /// Set the default allocator.
    #[doc(alias = "gst_allocator_set_default")]
    fn set_default(self) {
        unsafe {
            ffi::gst_allocator_set_default(self.upcast().into_glib_ptr());
        }
    }
}

impl<O: IsA<Allocator>> AllocatorExt for O {}