ffmpeg.libavutil.file source code

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 module ffmpeg.libavutil.file;
19 extern (C) @nogc nothrow:
20 
21 /**
22  * @file
23  * Misc file utilities.
24  */
25 
26 /**
27  * Read the file with name filename, and put its content in a newly
28  * allocated buffer or map it with mmap() when available.
29  * In case of success set *bufptr to the read or mmapped buffer, and
30  * *size to the size in bytes of the buffer in *bufptr.
31  * Unlike mmap this function succeeds with zero sized files, in this
32  * case *bufptr will be set to NULL and *size will be set to 0.
33  * The returned buffer must be released with av_file_unmap().
34  *
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
39  */
40 int av_file_map (
41     const(char)* filename,
42     ubyte** bufptr,
43     size_t* size,
44     int log_offset,
45     void* log_ctx);
46 
47 /**
48  * Unmap or free the buffer bufptr created by av_file_map().
49  *
50  * @param size size in bytes of bufptr, must be the same as returned
51  * by av_file_map()
52  */
53 void av_file_unmap (ubyte* bufptr, size_t size);
54 
55 /**
56  * Wrapper to work around the lack of mkstemp() on mingw.
57  * Also, tries to create file in /tmp first, if possible.
58  * *prefix can be a character constant; *filename will be allocated internally.
59  * @return file descriptor of opened file (or negative value corresponding to an
60  * AVERROR code on error)
61  * and opened file name in **filename.
62  * @note On very old libcs it is necessary to set a secure umask before
63  *       calling this, av_tempfile() can't call umask itself as it is used in
64  *       libraries and could interfere with the calling application.
65  * @deprecated as fd numbers cannot be passed saftely between libs on some platforms
66  */
67 int av_tempfile (const(char)* prefix, char** filename, int log_offset, void* log_ctx);
68 
69 /* AVUTIL_FILE_H */