libavutil/file.h

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef AVUTIL_FILE_H
  20 #define AVUTIL_FILE_H
  21
  22 #include <stddef.h>
  23 #include <stdint.h>
  24
  25 #include "attributes.h"
  26
  27 /**
  28  * @file
  29  * Misc file utilities.
  30  */
  31
  32 /**
  33  * Read the file with name filename, and put its content in a newly
  34  * allocated buffer or map it with mmap() when available.
  35  * In case of success set *bufptr to the read or mmapped buffer, and
  36  * *size to the size in bytes of the buffer in *bufptr.
  37  * Unlike mmap this function succeeds with zero sized files, in this
  38  * case *bufptr will be set to NULL and *size will be set to 0.
  39  * The returned buffer must be released with av_file_unmap().
  40  *
  41  * @param filename path to the file
  42  * @param[out] bufptr pointee is set to the mapped or allocated buffer
  43  * @param[out] size pointee is set to the size in bytes of the buffer
  44  * @param log_offset loglevel offset used for logging
  45  * @param log_ctx context used for logging
  46  * @return a non negative number in case of success, a negative value
  47  * corresponding to an AVERROR error code in case of failure
  48  */
  49 av_warn_unused_result
  50 int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
  51                 int log_offset, void *log_ctx);
  52
  53 /**
  54  * Unmap or free the buffer bufptr created by av_file_map().
  55  *
  56  * @param bufptr the buffer previously created with av_file_map()
  57  * @param size size in bytes of bufptr, must be the same as returned
  58  * by av_file_map()
  59  */
  60 void av_file_unmap(uint8_t *bufptr, size_t size);
  61
  62 #endif /* AVUTIL_FILE_H */