~ubuntu-branches/ubuntu/oneiric/libav/oneiric

« back to all changes in this revision

Viewing changes to libavutil/file.h

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2011-04-30 14:27:42 UTC
  • mfrom: (1.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20110430142742-quvblxk1tj6adlh5
Tags: 4:0.7~b1-1ubuntu1
* Merge from debian. Remaining changes:
  - don't build against libfaad, libdirac, librtmp and libopenjpeg
    (all in universe)
  - explicitly --enable-pic on powerpc, cf. LP #654666
  - different arm configure bits that should probably better be
    merged into debian
* Cherry-picked from git: 
  - install doc/APIChanges and refer to them in NEWS.Debian (Closes: #623682)
  - don't try to install non-existing documentation, fixes FTBFS on powerpc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 misc file utilities
 
26
 */
 
27
 
 
28
/**
 
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().
 
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(const char *filename, uint8_t **bufptr, size_t *size,
 
41
                int log_offset, void *log_ctx);
 
42
 
 
43
/**
 
44
 * Unmap or free the buffer bufptr created by av_file_map().
 
45
 *
 
46
 * @param size size in bytes of bufptr, must be the same as returned
 
47
 * by av_file_map()
 
48
 */
 
49
void av_file_unmap(uint8_t *bufptr, size_t size);
 
50
 
 
51
#endif /* AVUTIL_FILE_H */