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