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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use glib;
use glib::translate::*;
use glib::ObjectExt;
use gst;
use gst_base_sys;
use std::mem;

glib_wrapper! {
    /// This class is for elements that receive buffers in an undesired size.
    /// While for example raw video contains one image per buffer, the same is not
    /// true for a lot of other formats, especially those that come directly from
    /// a file. So if you have undefined buffer sizes and require a specific size,
    /// this object is for you.
    ///
    /// An adapter is created with `Adapter::new`. It can be freed again with
    /// `gobject::ObjectExt::unref`.
    ///
    /// The theory of operation is like this: All buffers received are put
    /// into the adapter using `Adapter::push` and the data is then read back
    /// in chunks of the desired size using `Adapter::map`/`Adapter::unmap`
    /// and/or `Adapter::copy`. After the data has been processed, it is freed
    /// using `Adapter::unmap`.
    ///
    /// Other methods such as `Adapter::take` and `Adapter::take_buffer`
    /// combine `Adapter::map` and `Adapter::unmap` in one method and are
    /// potentially more convenient for some use cases.
    ///
    /// For example, a sink pad's chain function that needs to pass data to a library
    /// in 512-byte chunks could be implemented like this:
    ///
    /// ```C
    /// static GstFlowReturn
    /// sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
    /// {
    ///   MyElement *this;
    ///   GstAdapter *adapter;
    ///   GstFlowReturn ret = GST_FLOW_OK;
    ///
    ///   this = MY_ELEMENT (parent);
    ///
    ///   adapter = this->adapter;
    ///
    ///   // put buffer into adapter
    ///   gst_adapter_push (adapter, buffer);
    ///
    ///   // while we can read out 512 bytes, process them
    ///   while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
    ///     const guint8 *data = gst_adapter_map (adapter, 512);
    ///     // use flowreturn as an error value
    ///     ret = my_library_foo (data);
    ///     gst_adapter_unmap (adapter);
    ///     gst_adapter_flush (adapter, 512);
    ///   }
    ///   return ret;
    /// }
    /// ```
    ///
    /// For another example, a simple element inside GStreamer that uses `Adapter`
    /// is the libvisual element.
    ///
    /// An element using `Adapter` in its sink pad chain function should ensure that
    /// when the FLUSH_STOP event is received, that any queued data is cleared using
    /// `Adapter::clear`. Data should also be cleared or processed on EOS and
    /// when changing state from `gst::State::Paused` to `gst::State::Ready`.
    ///
    /// Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might
    /// need to clear the adapter after a discontinuity.
    ///
    /// The adapter will keep track of the timestamps of the buffers
    /// that were pushed. The last seen timestamp before the current position
    /// can be queried with `Adapter::prev_pts`. This function can
    /// optionally return the number of bytes between the start of the buffer that
    /// carried the timestamp and the current adapter position. The distance is
    /// useful when dealing with, for example, raw audio samples because it allows
    /// you to calculate the timestamp of the current adapter position by using the
    /// last seen timestamp and the amount of bytes since. Additionally, the
    /// `Adapter::prev_pts_at_offset` can be used to determine the last
    /// seen timestamp at a particular offset in the adapter.
    ///
    /// The adapter will also keep track of the offset of the buffers
    /// (`GST_BUFFER_OFFSET`) that were pushed. The last seen offset before the
    /// current position can be queried with `Adapter::prev_offset`. This function
    /// can optionally return the number of bytes between the start of the buffer
    /// that carried the offset and the current adapter position.
    ///
    /// Additionally the adapter also keeps track of the PTS, DTS and buffer offset
    /// at the last discontinuity, which can be retrieved with
    /// `Adapter::pts_at_discont`, `Adapter::dts_at_discont` and
    /// `Adapter::offset_at_discont`. The number of bytes that were consumed
    /// since then can be queried with `Adapter::distance_from_discont`.
    ///
    /// A last thing to note is that while `Adapter` is pretty optimized,
    /// merging buffers still might be an operation that requires a `malloc` and
    /// `memcpy` operation, and these operations are not the fastest. Because of
    /// this, some functions like `Adapter::available_fast` are provided to help
    /// speed up such cases should you want to. To avoid repeated memory allocations,
    /// `Adapter::copy` can be used to copy data into a (statically allocated)
    /// user provided buffer.
    ///
    /// `Adapter` is not MT safe. All operations on an adapter must be serialized by
    /// the caller. This is not normally a problem, however, as the normal use case
    /// of `Adapter` is inside one pad's chain function, in which case access is
    /// serialized via the pad's STREAM_LOCK.
    ///
    /// Note that `Adapter::push` takes ownership of the buffer passed. Use
    /// `gst_buffer_ref` before pushing it into the adapter if you still want to
    /// access the buffer later. The adapter will never modify the data in the
    /// buffer pushed in it.
    ///
    /// # Implements
    ///
    /// [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
    pub struct Adapter(Object<gst_base_sys::GstAdapter, gst_base_sys::GstAdapterClass, AdapterClass>);

    match fn {
        get_type => || gst_base_sys::gst_adapter_get_type(),
    }
}

impl Adapter {
    /// Creates a new `Adapter`. Free with `gobject::ObjectExt::unref`.
    ///
    /// # Returns
    ///
    /// a new `Adapter`
    pub fn new() -> Adapter {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gst_base_sys::gst_adapter_new()) }
    }

    /// Gets the maximum amount of bytes available, that is it returns the maximum
    /// value that can be supplied to `Adapter::map` without that function
    /// returning `None`.
    ///
    /// # Returns
    ///
    /// number of bytes available in `self`
    pub fn available(&self) -> usize {
        unsafe { gst_base_sys::gst_adapter_available(self.to_glib_none().0) }
    }

    /// Gets the maximum number of bytes that are immediately available without
    /// requiring any expensive operations (like copying the data into a
    /// temporary buffer).
    ///
    /// # Returns
    ///
    /// number of bytes that are available in `self` without expensive
    /// operations
    pub fn available_fast(&self) -> usize {
        unsafe { gst_base_sys::gst_adapter_available_fast(self.to_glib_none().0) }
    }

    /// Removes all buffers from `self`.
    pub fn clear(&self) {
        unsafe {
            gst_base_sys::gst_adapter_clear(self.to_glib_none().0);
        }
    }

    /// Similar to gst_adapter_copy, but more suitable for language bindings. `size`
    /// bytes of data starting at `offset` will be copied out of the buffers contained
    /// in `self` and into a new `glib::Bytes` structure which is returned. Depending on
    /// the value of the `size` argument an empty `glib::Bytes` structure may be returned.
    /// ## `offset`
    /// the bytes offset in the adapter to start from
    /// ## `size`
    /// the number of bytes to copy
    ///
    /// # Returns
    ///
    /// A new `glib::Bytes` structure containing the copied data.
    pub fn copy_bytes(&self, offset: usize, size: usize) -> Result<glib::Bytes, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_copy_bytes(
                self.to_glib_none().0,
                offset,
                size,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to copy bytes"))
        }
    }

    pub fn distance_from_discont(&self) -> u64 {
        unsafe { gst_base_sys::gst_adapter_distance_from_discont(self.to_glib_none().0) }
    }

    /// Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
    /// flag, or GST_CLOCK_TIME_NONE.
    ///
    /// Feature: `v1_10`
    ///
    ///
    /// # Returns
    ///
    /// The DTS at the last discont or GST_CLOCK_TIME_NONE.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn dts_at_discont(&self) -> gst::ClockTime {
        unsafe {
            from_glib(gst_base_sys::gst_adapter_dts_at_discont(
                self.to_glib_none().0,
            ))
        }
    }

    /// Flushes the first `flush` bytes in the `self`. The caller must ensure that
    /// at least this many bytes are available.
    ///
    /// See also: `Adapter::map`, `Adapter::unmap`
    /// ## `flush`
    /// the number of bytes to flush
    pub fn flush(&self, flush: usize) {
        unsafe {
            gst_base_sys::gst_adapter_flush(self.to_glib_none().0, flush);
        }
    }

    /// Returns a `gst::Buffer` containing the first `nbytes` of the `self`, but
    /// does not flush them from the adapter. See `Adapter::take_buffer`
    /// for details.
    ///
    /// Caller owns a reference to the returned buffer. `gst_buffer_unref` after
    /// usage.
    ///
    /// Free-function: gst_buffer_unref
    /// ## `nbytes`
    /// the number of bytes to get
    ///
    /// # Returns
    ///
    /// a `gst::Buffer` containing the first
    ///  `nbytes` of the adapter, or `None` if `nbytes` bytes are not available.
    ///  `gst_buffer_unref` when no longer needed.
    pub fn get_buffer(&self, nbytes: usize) -> Result<gst::Buffer, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_get_buffer(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to get buffer"))
        }
    }

    /// Returns a `gst::Buffer` containing the first `nbytes` of the `self`, but
    /// does not flush them from the adapter. See `Adapter::take_buffer_fast`
    /// for details.
    ///
    /// Caller owns a reference to the returned buffer. `gst_buffer_unref` after
    /// usage.
    ///
    /// Free-function: gst_buffer_unref
    /// ## `nbytes`
    /// the number of bytes to get
    ///
    /// # Returns
    ///
    /// a `gst::Buffer` containing the first
    ///  `nbytes` of the adapter, or `None` if `nbytes` bytes are not available.
    ///  `gst_buffer_unref` when no longer needed.
    pub fn get_buffer_fast(&self, nbytes: usize) -> Result<gst::Buffer, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_get_buffer_fast(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to get buffer"))
        }
    }

    /// Returns a `gst::BufferList` of buffers containing the first `nbytes` bytes of
    /// the `self` but does not flush them from the adapter. See
    /// `Adapter::take_buffer_list` for details.
    ///
    /// Caller owns the returned list. Call `gst_buffer_list_unref` to free
    /// the list after usage.
    /// ## `nbytes`
    /// the number of bytes to get
    ///
    /// # Returns
    ///
    /// a `gst::BufferList` of buffers containing
    ///  the first `nbytes` of the adapter, or `None` if `nbytes` bytes are not
    ///  available
    pub fn get_buffer_list(&self, nbytes: usize) -> Result<gst::BufferList, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_get_buffer_list(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to get buffer list"))
        }
    }

    /// Returns a `glib::List` of buffers containing the first `nbytes` bytes of the
    /// `self`, but does not flush them from the adapter. See
    /// `Adapter::take_list` for details.
    ///
    /// Caller owns returned list and contained buffers. `gst_buffer_unref` each
    /// buffer in the list before freeing the list after usage.
    /// ## `nbytes`
    /// the number of bytes to get
    ///
    /// # Returns
    ///
    /// a `glib::List` of
    ///  buffers containing the first `nbytes` of the adapter, or `None` if `nbytes`
    ///  bytes are not available
    pub fn get_list(&self, nbytes: usize) -> Vec<gst::Buffer> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(gst_base_sys::gst_adapter_get_list(
                self.to_glib_none().0,
                nbytes,
            ))
        }
    }

    /// Scan for pattern `pattern` with applied mask `mask` in the adapter data,
    /// starting from offset `offset`.
    ///
    /// The bytes in `pattern` and `mask` are interpreted left-to-right, regardless
    /// of endianness. All four bytes of the pattern must be present in the
    /// adapter for it to match, even if the first or last bytes are masked out.
    ///
    /// It is an error to call this function without making sure that there is
    /// enough data (offset+size bytes) in the adapter.
    ///
    /// This function calls `Adapter::masked_scan_uint32_peek` passing `None`
    /// for value.
    /// ## `mask`
    /// mask to apply to data before matching against `pattern`
    /// ## `pattern`
    /// pattern to match (after mask is applied)
    /// ## `offset`
    /// offset into the adapter data from which to start scanning, returns
    ///  the last scanned position.
    /// ## `size`
    /// number of bytes to scan from offset
    ///
    /// # Returns
    ///
    /// offset of the first match, or -1 if no match was found.
    ///
    /// Example:
    ///
    /// ```text
    /// // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
    ///
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
    /// // -> returns 0
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
    /// // -> returns -1
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
    /// // -> returns 1
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
    /// // -> returns -1
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
    /// // -> returns 0
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
    /// // -> returns 2
    /// gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
    /// // -> returns -1
    /// ```
    pub fn masked_scan_uint32(&self, mask: u32, pattern: u32, offset: usize, size: usize) -> isize {
        unsafe {
            gst_base_sys::gst_adapter_masked_scan_uint32(
                self.to_glib_none().0,
                mask,
                pattern,
                offset,
                size,
            )
        }
    }

    /// Scan for pattern `pattern` with applied mask `mask` in the adapter data,
    /// starting from offset `offset`. If a match is found, the value that matched
    /// is returned through `value`, otherwise `value` is left untouched.
    ///
    /// The bytes in `pattern` and `mask` are interpreted left-to-right, regardless
    /// of endianness. All four bytes of the pattern must be present in the
    /// adapter for it to match, even if the first or last bytes are masked out.
    ///
    /// It is an error to call this function without making sure that there is
    /// enough data (offset+size bytes) in the adapter.
    /// ## `mask`
    /// mask to apply to data before matching against `pattern`
    /// ## `pattern`
    /// pattern to match (after mask is applied)
    /// ## `offset`
    /// offset into the adapter data from which to start scanning, returns
    ///  the last scanned position.
    /// ## `size`
    /// number of bytes to scan from offset
    /// ## `value`
    /// pointer to uint32 to return matching data
    ///
    /// # Returns
    ///
    /// offset of the first match, or -1 if no match was found.
    pub fn masked_scan_uint32_peek(
        &self,
        mask: u32,
        pattern: u32,
        offset: usize,
        size: usize,
    ) -> (isize, u32) {
        unsafe {
            let mut value = mem::MaybeUninit::uninit();
            let ret = gst_base_sys::gst_adapter_masked_scan_uint32_peek(
                self.to_glib_none().0,
                mask,
                pattern,
                offset,
                size,
                value.as_mut_ptr(),
            );
            let value = value.assume_init();
            (ret, value)
        }
    }

    /// Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
    /// flag, or GST_BUFFER_OFFSET_NONE.
    ///
    /// Feature: `v1_10`
    ///
    ///
    /// # Returns
    ///
    /// The offset at the last discont or GST_BUFFER_OFFSET_NONE.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn offset_at_discont(&self) -> u64 {
        unsafe { gst_base_sys::gst_adapter_offset_at_discont(self.to_glib_none().0) }
    }

    /// Get the dts that was before the current byte in the adapter. When
    /// `distance` is given, the amount of bytes between the dts and the current
    /// position is returned.
    ///
    /// The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
    /// the adapter is first created or when it is cleared. This also means that before
    /// the first byte with a dts is removed from the adapter, the dts
    /// and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
    /// ## `distance`
    /// pointer to location for distance, or `None`
    ///
    /// # Returns
    ///
    /// The previously seen dts.
    pub fn prev_dts(&self) -> (gst::ClockTime, u64) {
        unsafe {
            let mut distance = mem::MaybeUninit::uninit();
            let ret = from_glib(gst_base_sys::gst_adapter_prev_dts(
                self.to_glib_none().0,
                distance.as_mut_ptr(),
            ));
            let distance = distance.assume_init();
            (ret, distance)
        }
    }

    /// Get the dts that was before the byte at offset `offset` in the adapter. When
    /// `distance` is given, the amount of bytes between the dts and the current
    /// position is returned.
    ///
    /// The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
    /// the adapter is first created or when it is cleared. This also means that before
    /// the first byte with a dts is removed from the adapter, the dts
    /// and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
    /// ## `offset`
    /// the offset in the adapter at which to get timestamp
    /// ## `distance`
    /// pointer to location for distance, or `None`
    ///
    /// # Returns
    ///
    /// The previously seen dts at given offset.
    pub fn prev_dts_at_offset(&self, offset: usize) -> (gst::ClockTime, u64) {
        unsafe {
            let mut distance = mem::MaybeUninit::uninit();
            let ret = from_glib(gst_base_sys::gst_adapter_prev_dts_at_offset(
                self.to_glib_none().0,
                offset,
                distance.as_mut_ptr(),
            ));
            let distance = distance.assume_init();
            (ret, distance)
        }
    }

    /// Get the offset that was before the current byte in the adapter. When
    /// `distance` is given, the amount of bytes between the offset and the current
    /// position is returned.
    ///
    /// The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0
    /// when the adapter is first created or when it is cleared. This also means that
    /// before the first byte with an offset is removed from the adapter, the offset
    /// and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.
    ///
    /// Feature: `v1_10`
    ///
    /// ## `distance`
    /// pointer to a location for distance, or `None`
    ///
    /// # Returns
    ///
    /// The previous seen offset.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn prev_offset(&self) -> (u64, u64) {
        unsafe {
            let mut distance = mem::MaybeUninit::uninit();
            let ret =
                gst_base_sys::gst_adapter_prev_offset(self.to_glib_none().0, distance.as_mut_ptr());
            let distance = distance.assume_init();
            (ret, distance)
        }
    }

    /// Get the pts that was before the current byte in the adapter. When
    /// `distance` is given, the amount of bytes between the pts and the current
    /// position is returned.
    ///
    /// The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
    /// the adapter is first created or when it is cleared. This also means that before
    /// the first byte with a pts is removed from the adapter, the pts
    /// and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
    /// ## `distance`
    /// pointer to location for distance, or `None`
    ///
    /// # Returns
    ///
    /// The previously seen pts.
    pub fn prev_pts(&self) -> (gst::ClockTime, u64) {
        unsafe {
            let mut distance = mem::MaybeUninit::uninit();
            let ret = from_glib(gst_base_sys::gst_adapter_prev_pts(
                self.to_glib_none().0,
                distance.as_mut_ptr(),
            ));
            let distance = distance.assume_init();
            (ret, distance)
        }
    }

    /// Get the pts that was before the byte at offset `offset` in the adapter. When
    /// `distance` is given, the amount of bytes between the pts and the current
    /// position is returned.
    ///
    /// The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
    /// the adapter is first created or when it is cleared. This also means that before
    /// the first byte with a pts is removed from the adapter, the pts
    /// and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
    /// ## `offset`
    /// the offset in the adapter at which to get timestamp
    /// ## `distance`
    /// pointer to location for distance, or `None`
    ///
    /// # Returns
    ///
    /// The previously seen pts at given offset.
    pub fn prev_pts_at_offset(&self, offset: usize) -> (gst::ClockTime, u64) {
        unsafe {
            let mut distance = mem::MaybeUninit::uninit();
            let ret = from_glib(gst_base_sys::gst_adapter_prev_pts_at_offset(
                self.to_glib_none().0,
                offset,
                distance.as_mut_ptr(),
            ));
            let distance = distance.assume_init();
            (ret, distance)
        }
    }

    /// Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT
    /// flag, or GST_CLOCK_TIME_NONE.
    ///
    /// Feature: `v1_10`
    ///
    ///
    /// # Returns
    ///
    /// The PTS at the last discont or GST_CLOCK_TIME_NONE.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn pts_at_discont(&self) -> gst::ClockTime {
        unsafe {
            from_glib(gst_base_sys::gst_adapter_pts_at_discont(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns a `gst::Buffer` containing the first `nbytes` bytes of the
    /// `self`. The returned bytes will be flushed from the adapter.
    /// This function is potentially more performant than
    /// `Adapter::take` since it can reuse the memory in pushed buffers
    /// by subbuffering or merging. This function will always return a
    /// buffer with a single memory region.
    ///
    /// Note that no assumptions should be made as to whether certain buffer
    /// flags such as the DISCONT flag are set on the returned buffer, or not.
    /// The caller needs to explicitly set or unset flags that should be set or
    /// unset.
    ///
    /// Since 1.6 this will also copy over all GstMeta of the input buffers except
    /// for meta with the `gst::MetaFlags::Pooled` flag or with the "memory" tag.
    ///
    /// Caller owns a reference to the returned buffer. `gst_buffer_unref` after
    /// usage.
    ///
    /// Free-function: gst_buffer_unref
    /// ## `nbytes`
    /// the number of bytes to take
    ///
    /// # Returns
    ///
    /// a `gst::Buffer` containing the first
    ///  `nbytes` of the adapter, or `None` if `nbytes` bytes are not available.
    ///  `gst_buffer_unref` when no longer needed.
    pub fn take_buffer(&self, nbytes: usize) -> Result<gst::Buffer, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_take_buffer(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to take buffer"))
        }
    }

    /// Returns a `gst::Buffer` containing the first `nbytes` of the `self`.
    /// The returned bytes will be flushed from the adapter. This function
    /// is potentially more performant than `Adapter::take_buffer` since
    /// it can reuse the memory in pushed buffers by subbuffering or
    /// merging. Unlike `Adapter::take_buffer`, the returned buffer may
    /// be composed of multiple non-contiguous `gst::Memory` objects, no
    /// copies are made.
    ///
    /// Note that no assumptions should be made as to whether certain buffer
    /// flags such as the DISCONT flag are set on the returned buffer, or not.
    /// The caller needs to explicitly set or unset flags that should be set or
    /// unset.
    ///
    /// This will also copy over all GstMeta of the input buffers except
    /// for meta with the `gst::MetaFlags::Pooled` flag or with the "memory" tag.
    ///
    /// This function can return buffer up to the return value of
    /// `Adapter::available` without making copies if possible.
    ///
    /// Caller owns a reference to the returned buffer. `gst_buffer_unref` after
    /// usage.
    ///
    /// Free-function: gst_buffer_unref
    /// ## `nbytes`
    /// the number of bytes to take
    ///
    /// # Returns
    ///
    /// a `gst::Buffer` containing the first
    ///  `nbytes` of the adapter, or `None` if `nbytes` bytes are not available.
    ///  `gst_buffer_unref` when no longer needed.
    pub fn take_buffer_fast(&self, nbytes: usize) -> Result<gst::Buffer, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_take_buffer_fast(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to take buffer"))
        }
    }

    /// Returns a `gst::BufferList` of buffers containing the first `nbytes` bytes of
    /// the `self`. The returned bytes will be flushed from the adapter.
    /// When the caller can deal with individual buffers, this function is more
    /// performant because no memory should be copied.
    ///
    /// Caller owns the returned list. Call `gst_buffer_list_unref` to free
    /// the list after usage.
    /// ## `nbytes`
    /// the number of bytes to take
    ///
    /// # Returns
    ///
    /// a `gst::BufferList` of buffers containing
    ///  the first `nbytes` of the adapter, or `None` if `nbytes` bytes are not
    ///  available
    pub fn take_buffer_list(&self, nbytes: usize) -> Result<gst::BufferList, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_base_sys::gst_adapter_take_buffer_list(
                self.to_glib_none().0,
                nbytes,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to take buffer list"))
        }
    }

    /// Returns a `glib::List` of buffers containing the first `nbytes` bytes of the
    /// `self`. The returned bytes will be flushed from the adapter.
    /// When the caller can deal with individual buffers, this function is more
    /// performant because no memory should be copied.
    ///
    /// Caller owns returned list and contained buffers. `gst_buffer_unref` each
    /// buffer in the list before freeing the list after usage.
    /// ## `nbytes`
    /// the number of bytes to take
    ///
    /// # Returns
    ///
    /// a `glib::List` of
    ///  buffers containing the first `nbytes` of the adapter, or `None` if `nbytes`
    ///  bytes are not available
    pub fn take_list(&self, nbytes: usize) -> Vec<gst::Buffer> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(gst_base_sys::gst_adapter_take_list(
                self.to_glib_none().0,
                nbytes,
            ))
        }
    }
}

impl Default for Adapter {
    fn default() -> Self {
        Self::new()
    }
}

unsafe impl glib::SendUnique for Adapter {
    fn is_unique(&self) -> bool {
        self.ref_count() == 1
    }
}