common/video_reader.h

   1 /*
   2  * Copyright (c) 2016, Alliance for Open Media. All rights reserved
   3  *
   4  * This source code is subject to the terms of the BSD 2 Clause License and
   5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
   6  * was not distributed with this source code in the LICENSE file, you can
   7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
   8  * Media Patent License 1.0 was not distributed with this source code in the
   9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
  10  */
  11
  12 #ifndef AOM_COMMON_VIDEO_READER_H_
  13 #define AOM_COMMON_VIDEO_READER_H_
  14
  15 #include "common/video_common.h"
  16
  17 // The following code is work in progress. It is going to  support transparent
  18 // reading of input files. Right now only IVF format is supported for
  19 // simplicity. The main goal the API is to be simple and easy to use in example
  20 // code and in aomenc/aomdec later. All low-level details like memory
  21 // buffer management are hidden from API users.
  22 struct AvxVideoReaderStruct;
  23 typedef struct AvxVideoReaderStruct AvxVideoReader;
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 // Opens the input file for reading and inspects it to determine file type.
  30 // Returns an opaque AvxVideoReader* upon success, or NULL upon failure.
  31 // Right now only IVF format is supported.
  32 AvxVideoReader *aom_video_reader_open(const char *filename);
  33
  34 // Frees all resources associated with AvxVideoReader* returned from
  35 // aom_video_reader_open() call.
  36 void aom_video_reader_close(AvxVideoReader *reader);
  37
  38 // Reads frame from the file and stores it in internal buffer.
  39 int aom_video_reader_read_frame(AvxVideoReader *reader);
  40
  41 // Returns the pointer to memory buffer with frame data read by last call to
  42 // aom_video_reader_read_frame().
  43 const uint8_t *aom_video_reader_get_frame(AvxVideoReader *reader, size_t *size);
  44
  45 // Returns the pts of the frame.
  46 int64_t aom_video_reader_get_frame_pts(AvxVideoReader *reader);
  47 // Return the reader file.
  48 FILE *aom_video_reader_get_file(AvxVideoReader *reader);
  49
  50 // Fills AvxVideoInfo with information from opened video file.
  51 const AvxVideoInfo *aom_video_reader_get_info(AvxVideoReader *reader);
  52
  53 // Set fourcc.
  54 void aom_video_reader_set_fourcc(AvxVideoReader *reader, uint32_t fourcc);
  55
  56 #ifdef __cplusplus
  57 }  // extern "C"
  58 #endif
  59
  60 #endif  // AOM_COMMON_VIDEO_READER_H_