gstreamer_base/subclass/
base_sink.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use std::ptr;
4
5use glib::{prelude::*, translate::*};
6use gst::subclass::prelude::*;
7
8use crate::{ffi, BaseSink};
9
10pub trait BaseSinkImpl: ElementImpl + ObjectSubclass<Type: IsA<BaseSink>> {
11    fn start(&self) -> Result<(), gst::ErrorMessage> {
12        self.parent_start()
13    }
14
15    fn stop(&self) -> Result<(), gst::ErrorMessage> {
16        self.parent_stop()
17    }
18
19    fn render(&self, buffer: &gst::Buffer) -> Result<gst::FlowSuccess, gst::FlowError> {
20        self.parent_render(buffer)
21    }
22
23    fn prepare(&self, buffer: &gst::Buffer) -> Result<gst::FlowSuccess, gst::FlowError> {
24        self.parent_prepare(buffer)
25    }
26
27    fn render_list(&self, list: &gst::BufferList) -> Result<gst::FlowSuccess, gst::FlowError> {
28        self.parent_render_list(list)
29    }
30
31    fn prepare_list(&self, list: &gst::BufferList) -> Result<gst::FlowSuccess, gst::FlowError> {
32        self.parent_prepare_list(list)
33    }
34
35    fn query(&self, query: &mut gst::QueryRef) -> bool {
36        BaseSinkImplExt::parent_query(self, query)
37    }
38
39    fn event(&self, event: gst::Event) -> bool {
40        self.parent_event(event)
41    }
42
43    fn caps(&self, filter: Option<&gst::Caps>) -> Option<gst::Caps> {
44        self.parent_caps(filter)
45    }
46
47    fn set_caps(&self, caps: &gst::Caps) -> Result<(), gst::LoggableError> {
48        self.parent_set_caps(caps)
49    }
50
51    fn fixate(&self, caps: gst::Caps) -> gst::Caps {
52        self.parent_fixate(caps)
53    }
54
55    fn unlock(&self) -> Result<(), gst::ErrorMessage> {
56        self.parent_unlock()
57    }
58
59    fn unlock_stop(&self) -> Result<(), gst::ErrorMessage> {
60        self.parent_unlock_stop()
61    }
62
63    fn propose_allocation(
64        &self,
65        query: &mut gst::query::Allocation,
66    ) -> Result<(), gst::LoggableError> {
67        self.parent_propose_allocation(query)
68    }
69}
70
71pub trait BaseSinkImplExt: BaseSinkImpl {
72    fn parent_start(&self) -> Result<(), gst::ErrorMessage> {
73        unsafe {
74            let data = Self::type_data();
75            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
76            (*parent_class)
77                .start
78                .map(|f| {
79                    if from_glib(f(self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0)) {
80                        Ok(())
81                    } else {
82                        Err(gst::error_msg!(
83                            gst::CoreError::StateChange,
84                            ["Parent function `start` failed"]
85                        ))
86                    }
87                })
88                .unwrap_or(Ok(()))
89        }
90    }
91
92    fn parent_stop(&self) -> Result<(), gst::ErrorMessage> {
93        unsafe {
94            let data = Self::type_data();
95            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
96            (*parent_class)
97                .stop
98                .map(|f| {
99                    if from_glib(f(self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0)) {
100                        Ok(())
101                    } else {
102                        Err(gst::error_msg!(
103                            gst::CoreError::StateChange,
104                            ["Parent function `stop` failed"]
105                        ))
106                    }
107                })
108                .unwrap_or(Ok(()))
109        }
110    }
111
112    fn parent_render(&self, buffer: &gst::Buffer) -> Result<gst::FlowSuccess, gst::FlowError> {
113        unsafe {
114            let data = Self::type_data();
115            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
116            (*parent_class)
117                .render
118                .map(|f| {
119                    try_from_glib(f(
120                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
121                        buffer.to_glib_none().0,
122                    ))
123                })
124                .unwrap_or(Ok(gst::FlowSuccess::Ok))
125        }
126    }
127
128    fn parent_prepare(&self, buffer: &gst::Buffer) -> Result<gst::FlowSuccess, gst::FlowError> {
129        unsafe {
130            let data = Self::type_data();
131            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
132            (*parent_class)
133                .prepare
134                .map(|f| {
135                    try_from_glib(f(
136                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
137                        buffer.to_glib_none().0,
138                    ))
139                })
140                .unwrap_or(Ok(gst::FlowSuccess::Ok))
141        }
142    }
143
144    fn parent_render_list(
145        &self,
146        list: &gst::BufferList,
147    ) -> Result<gst::FlowSuccess, gst::FlowError>;
148
149    fn parent_prepare_list(
150        &self,
151        list: &gst::BufferList,
152    ) -> Result<gst::FlowSuccess, gst::FlowError>;
153
154    fn parent_query(&self, query: &mut gst::QueryRef) -> bool {
155        unsafe {
156            let data = Self::type_data();
157            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
158            (*parent_class)
159                .query
160                .map(|f| {
161                    from_glib(f(
162                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
163                        query.as_mut_ptr(),
164                    ))
165                })
166                .unwrap_or(false)
167        }
168    }
169
170    fn parent_event(&self, event: gst::Event) -> bool {
171        unsafe {
172            let data = Self::type_data();
173            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
174            (*parent_class)
175                .event
176                .map(|f| {
177                    from_glib(f(
178                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
179                        event.into_glib_ptr(),
180                    ))
181                })
182                .unwrap_or(true)
183        }
184    }
185
186    fn parent_caps(&self, filter: Option<&gst::Caps>) -> Option<gst::Caps> {
187        unsafe {
188            let data = Self::type_data();
189            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
190
191            (*parent_class)
192                .get_caps
193                .map(|f| {
194                    from_glib_full(f(
195                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
196                        filter.to_glib_none().0,
197                    ))
198                })
199                .unwrap_or(None)
200        }
201    }
202
203    fn parent_set_caps(&self, caps: &gst::Caps) -> Result<(), gst::LoggableError> {
204        unsafe {
205            let data = Self::type_data();
206            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
207            (*parent_class)
208                .set_caps
209                .map(|f| {
210                    gst::result_from_gboolean!(
211                        f(
212                            self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
213                            caps.to_glib_none().0
214                        ),
215                        gst::CAT_RUST,
216                        "Parent function `set_caps` failed"
217                    )
218                })
219                .unwrap_or(Ok(()))
220        }
221    }
222
223    fn parent_fixate(&self, caps: gst::Caps) -> gst::Caps {
224        unsafe {
225            let data = Self::type_data();
226            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
227
228            match (*parent_class).fixate {
229                Some(fixate) => from_glib_full(fixate(
230                    self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
231                    caps.into_glib_ptr(),
232                )),
233                None => caps,
234            }
235        }
236    }
237
238    fn parent_unlock(&self) -> Result<(), gst::ErrorMessage> {
239        unsafe {
240            let data = Self::type_data();
241            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
242            (*parent_class)
243                .unlock
244                .map(|f| {
245                    if from_glib(f(self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0)) {
246                        Ok(())
247                    } else {
248                        Err(gst::error_msg!(
249                            gst::CoreError::Failed,
250                            ["Parent function `unlock` failed"]
251                        ))
252                    }
253                })
254                .unwrap_or(Ok(()))
255        }
256    }
257
258    fn parent_unlock_stop(&self) -> Result<(), gst::ErrorMessage> {
259        unsafe {
260            let data = Self::type_data();
261            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
262            (*parent_class)
263                .unlock_stop
264                .map(|f| {
265                    if from_glib(f(self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0)) {
266                        Ok(())
267                    } else {
268                        Err(gst::error_msg!(
269                            gst::CoreError::Failed,
270                            ["Parent function `unlock_stop` failed"]
271                        ))
272                    }
273                })
274                .unwrap_or(Ok(()))
275        }
276    }
277
278    fn parent_propose_allocation(
279        &self,
280        query: &mut gst::query::Allocation,
281    ) -> Result<(), gst::LoggableError> {
282        unsafe {
283            let data = Self::type_data();
284            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
285            (*parent_class)
286                .propose_allocation
287                .map(|f| {
288                    gst::result_from_gboolean!(
289                        f(
290                            self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
291                            query.as_mut_ptr(),
292                        ),
293                        gst::CAT_RUST,
294                        "Parent function `propose_allocation` failed",
295                    )
296                })
297                .unwrap_or(Ok(()))
298        }
299    }
300}
301
302impl<T: BaseSinkImpl> BaseSinkImplExt for T {
303    fn parent_render_list(
304        &self,
305        list: &gst::BufferList,
306    ) -> Result<gst::FlowSuccess, gst::FlowError> {
307        unsafe {
308            let data = Self::type_data();
309            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
310            (*parent_class)
311                .render_list
312                .map(|f| {
313                    try_from_glib(f(
314                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
315                        list.to_glib_none().0,
316                    ))
317                })
318                .unwrap_or_else(|| {
319                    for buffer in list.iter() {
320                        self.render(&from_glib_borrow(buffer.as_ptr()))?;
321                    }
322                    Ok(gst::FlowSuccess::Ok)
323                })
324        }
325    }
326
327    fn parent_prepare_list(
328        &self,
329        list: &gst::BufferList,
330    ) -> Result<gst::FlowSuccess, gst::FlowError> {
331        unsafe {
332            let data = Self::type_data();
333            let parent_class = data.as_ref().parent_class() as *mut ffi::GstBaseSinkClass;
334            (*parent_class)
335                .prepare_list
336                .map(|f| {
337                    try_from_glib(f(
338                        self.obj().unsafe_cast_ref::<BaseSink>().to_glib_none().0,
339                        list.to_glib_none().0,
340                    ))
341                })
342                .unwrap_or_else(|| {
343                    for buffer in list.iter() {
344                        self.prepare(&from_glib_borrow(buffer.as_ptr()))?;
345                    }
346                    Ok(gst::FlowSuccess::Ok)
347                })
348        }
349    }
350}
351
352unsafe impl<T: BaseSinkImpl> IsSubclassable<T> for BaseSink {
353    fn class_init(klass: &mut glib::Class<Self>) {
354        Self::parent_class_init::<T>(klass);
355        let klass = klass.as_mut();
356        klass.start = Some(base_sink_start::<T>);
357        klass.stop = Some(base_sink_stop::<T>);
358        klass.render = Some(base_sink_render::<T>);
359        klass.render_list = Some(base_sink_render_list::<T>);
360        klass.prepare = Some(base_sink_prepare::<T>);
361        klass.prepare_list = Some(base_sink_prepare_list::<T>);
362        klass.query = Some(base_sink_query::<T>);
363        klass.event = Some(base_sink_event::<T>);
364        klass.get_caps = Some(base_sink_get_caps::<T>);
365        klass.set_caps = Some(base_sink_set_caps::<T>);
366        klass.fixate = Some(base_sink_fixate::<T>);
367        klass.unlock = Some(base_sink_unlock::<T>);
368        klass.unlock_stop = Some(base_sink_unlock_stop::<T>);
369        klass.propose_allocation = Some(base_sink_propose_allocation::<T>);
370    }
371}
372
373unsafe extern "C" fn base_sink_start<T: BaseSinkImpl>(
374    ptr: *mut ffi::GstBaseSink,
375) -> glib::ffi::gboolean {
376    let instance = &*(ptr as *mut T::Instance);
377    let imp = instance.imp();
378
379    gst::panic_to_error!(imp, false, {
380        match imp.start() {
381            Ok(()) => true,
382            Err(err) => {
383                imp.post_error_message(err);
384                false
385            }
386        }
387    })
388    .into_glib()
389}
390
391unsafe extern "C" fn base_sink_stop<T: BaseSinkImpl>(
392    ptr: *mut ffi::GstBaseSink,
393) -> glib::ffi::gboolean {
394    let instance = &*(ptr as *mut T::Instance);
395    let imp = instance.imp();
396
397    gst::panic_to_error!(imp, false, {
398        match imp.stop() {
399            Ok(()) => true,
400            Err(err) => {
401                imp.post_error_message(err);
402                false
403            }
404        }
405    })
406    .into_glib()
407}
408
409unsafe extern "C" fn base_sink_render<T: BaseSinkImpl>(
410    ptr: *mut ffi::GstBaseSink,
411    buffer: *mut gst::ffi::GstBuffer,
412) -> gst::ffi::GstFlowReturn {
413    let instance = &*(ptr as *mut T::Instance);
414    let imp = instance.imp();
415    let buffer = from_glib_borrow(buffer);
416
417    gst::panic_to_error!(imp, gst::FlowReturn::Error, { imp.render(&buffer).into() }).into_glib()
418}
419
420unsafe extern "C" fn base_sink_prepare<T: BaseSinkImpl>(
421    ptr: *mut ffi::GstBaseSink,
422    buffer: *mut gst::ffi::GstBuffer,
423) -> gst::ffi::GstFlowReturn {
424    let instance = &*(ptr as *mut T::Instance);
425    let imp = instance.imp();
426    let buffer = from_glib_borrow(buffer);
427
428    gst::panic_to_error!(imp, gst::FlowReturn::Error, { imp.prepare(&buffer).into() }).into_glib()
429}
430
431unsafe extern "C" fn base_sink_render_list<T: BaseSinkImpl>(
432    ptr: *mut ffi::GstBaseSink,
433    list: *mut gst::ffi::GstBufferList,
434) -> gst::ffi::GstFlowReturn {
435    let instance = &*(ptr as *mut T::Instance);
436    let imp = instance.imp();
437    let list = from_glib_borrow(list);
438
439    gst::panic_to_error!(imp, gst::FlowReturn::Error, {
440        imp.render_list(&list).into()
441    })
442    .into_glib()
443}
444
445unsafe extern "C" fn base_sink_prepare_list<T: BaseSinkImpl>(
446    ptr: *mut ffi::GstBaseSink,
447    list: *mut gst::ffi::GstBufferList,
448) -> gst::ffi::GstFlowReturn {
449    let instance = &*(ptr as *mut T::Instance);
450    let imp = instance.imp();
451    let list = from_glib_borrow(list);
452
453    gst::panic_to_error!(imp, gst::FlowReturn::Error, {
454        imp.prepare_list(&list).into()
455    })
456    .into_glib()
457}
458
459unsafe extern "C" fn base_sink_query<T: BaseSinkImpl>(
460    ptr: *mut ffi::GstBaseSink,
461    query_ptr: *mut gst::ffi::GstQuery,
462) -> glib::ffi::gboolean {
463    let instance = &*(ptr as *mut T::Instance);
464    let imp = instance.imp();
465    let query = gst::QueryRef::from_mut_ptr(query_ptr);
466
467    gst::panic_to_error!(imp, false, { BaseSinkImpl::query(imp, query) }).into_glib()
468}
469
470unsafe extern "C" fn base_sink_event<T: BaseSinkImpl>(
471    ptr: *mut ffi::GstBaseSink,
472    event_ptr: *mut gst::ffi::GstEvent,
473) -> glib::ffi::gboolean {
474    let instance = &*(ptr as *mut T::Instance);
475    let imp = instance.imp();
476
477    gst::panic_to_error!(imp, false, { imp.event(from_glib_full(event_ptr)) }).into_glib()
478}
479
480unsafe extern "C" fn base_sink_get_caps<T: BaseSinkImpl>(
481    ptr: *mut ffi::GstBaseSink,
482    filter: *mut gst::ffi::GstCaps,
483) -> *mut gst::ffi::GstCaps {
484    let instance = &*(ptr as *mut T::Instance);
485    let imp = instance.imp();
486    let filter = Option::<gst::Caps>::from_glib_borrow(filter);
487
488    gst::panic_to_error!(imp, None, { imp.caps(filter.as_ref().as_ref()) })
489        .map(|caps| caps.into_glib_ptr())
490        .unwrap_or(ptr::null_mut())
491}
492
493unsafe extern "C" fn base_sink_set_caps<T: BaseSinkImpl>(
494    ptr: *mut ffi::GstBaseSink,
495    caps: *mut gst::ffi::GstCaps,
496) -> glib::ffi::gboolean {
497    let instance = &*(ptr as *mut T::Instance);
498    let imp = instance.imp();
499    let caps = from_glib_borrow(caps);
500
501    gst::panic_to_error!(imp, false, {
502        match imp.set_caps(&caps) {
503            Ok(()) => true,
504            Err(err) => {
505                err.log_with_imp(imp);
506                false
507            }
508        }
509    })
510    .into_glib()
511}
512
513unsafe extern "C" fn base_sink_fixate<T: BaseSinkImpl>(
514    ptr: *mut ffi::GstBaseSink,
515    caps: *mut gst::ffi::GstCaps,
516) -> *mut gst::ffi::GstCaps {
517    let instance = &*(ptr as *mut T::Instance);
518    let imp = instance.imp();
519    let caps = from_glib_full(caps);
520
521    gst::panic_to_error!(imp, gst::Caps::new_empty(), { imp.fixate(caps) }).into_glib_ptr()
522}
523
524unsafe extern "C" fn base_sink_unlock<T: BaseSinkImpl>(
525    ptr: *mut ffi::GstBaseSink,
526) -> glib::ffi::gboolean {
527    let instance = &*(ptr as *mut T::Instance);
528    let imp = instance.imp();
529
530    gst::panic_to_error!(imp, false, {
531        match imp.unlock() {
532            Ok(()) => true,
533            Err(err) => {
534                imp.post_error_message(err);
535                false
536            }
537        }
538    })
539    .into_glib()
540}
541
542unsafe extern "C" fn base_sink_unlock_stop<T: BaseSinkImpl>(
543    ptr: *mut ffi::GstBaseSink,
544) -> glib::ffi::gboolean {
545    let instance = &*(ptr as *mut T::Instance);
546    let imp = instance.imp();
547
548    gst::panic_to_error!(imp, false, {
549        match imp.unlock_stop() {
550            Ok(()) => true,
551            Err(err) => {
552                imp.post_error_message(err);
553                false
554            }
555        }
556    })
557    .into_glib()
558}
559
560unsafe extern "C" fn base_sink_propose_allocation<T: BaseSinkImpl>(
561    ptr: *mut ffi::GstBaseSink,
562    query: *mut gst::ffi::GstQuery,
563) -> glib::ffi::gboolean {
564    let instance = &*(ptr as *mut T::Instance);
565    let imp = instance.imp();
566    let query = match gst::QueryRef::from_mut_ptr(query).view_mut() {
567        gst::QueryViewMut::Allocation(allocation) => allocation,
568        _ => unreachable!(),
569    };
570
571    gst::panic_to_error!(imp, false, {
572        match imp.propose_allocation(query) {
573            Ok(()) => true,
574            Err(err) => {
575                err.log_with_imp_and_level(imp, gst::DebugLevel::Info);
576                false
577            }
578        }
579    })
580    .into_glib()
581}
gstreamer_base/subclass/base_sink.rs

gstreamer_base/subclass/
base_sink.rs
