2 * This file is part of FFmpeg.
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.
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.
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
25 * @file misc file utilities
29 * Read the file with name filename, and put its content in a newly
30 * allocated buffer or map it with mmap() when available.
31 * In case of success set *bufptr to the read or mmapped buffer, and
32 * *size to the size in bytes of the buffer in *bufptr.
33 * The returned buffer must be released with av_file_unmap().
35 * @param log_offset loglevel offset used for logging
36 * @param log_ctx context used for logging
37 * @return a non negative number in case of success, a negative value
38 * corresponding to an AVERROR error code in case of failure
40 int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
41 int log_offset, void *log_ctx);
44 * Unmap or free the buffer bufptr created by av_file_map().
46 * @param size size in bytes of bufptr, must be the same as returned
49 void av_file_unmap(uint8_t *bufptr, size_t size);
51 #endif /* AVUTIL_FILE_H */