subprojects/gst-plugins-good/gst/rtp/gstbuffermemory.h

   1 /* GStreamer
   2  * Copyright (C) 2020 Ognyan Tonchev <ognyan at axis dot com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __GST_BUFFER_MEMORY_H__
  21 #define __GST_BUFFER_MEMORY_H__
  22
  23 #include <gst/gst.h>
  24
  25 G_BEGIN_DECLS
  26
  27 struct _GstBufferMemoryMap
  28 {
  29   /* private datas */
  30
  31   GstBuffer *buf;
  32   GstMemory *mem;
  33   GstMapInfo map;
  34   guint index;
  35   gsize total_size;
  36
  37   /* public datas */
  38
  39   /* data of the currently mapped memory */
  40   const guint8 *data;
  41   guint offset;
  42
  43   /* size of the currently mapped memory */
  44   gsize size;
  45
  46   /* When advancing through the data with gst_buffer_memory_advance_bytes ()
  47    * the data field is also advanced and the size field decreased with the
  48    * corresponding number of bytes. If all the bytes from the currently mapped
  49    * GstMemory have been consumed then a new GstMemory will be mapped and data
  50    * and size fileds will be updated.
  51    * */
  52 };
  53 typedef struct _GstBufferMemoryMap GstBufferMemoryMap;
  54
  55 G_GNUC_INTERNAL
  56 gboolean gst_buffer_memory_map (GstBuffer * buffer, GstBufferMemoryMap * map);
  57
  58 G_GNUC_INTERNAL
  59 gboolean gst_buffer_memory_advance_bytes (GstBufferMemoryMap * map, gsize size);
  60
  61 G_GNUC_INTERNAL
  62 void gst_buffer_memory_unmap (GstBufferMemoryMap * map);
  63
  64 G_END_DECLS
  65
  66 #endif /* __GST_BUFFER_MEMORY_H__ */