/usr/include/pjmedia/avi_stream.h is in libpjproject-dev 2.1.0.0.ast20130823-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | /* $Id: avi_stream.h 3715 2011-08-19 09:35:25Z nanang $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_AVI_STREAM_H__
#define __PJMEDIA_AVI_STREAM_H__
/**
* @file avi_stream.h
* @brief AVI file player.
*/
#include <pjmedia/port.h>
PJ_BEGIN_DECL
/**
* @defgroup PJMEDIA_FILE_PLAY AVI File Player
* @ingroup PJMEDIA_PORT
* @brief Video and audio playback from AVI file
* @{
*/
/**
* AVI file player options.
*/
enum pjmedia_avi_file_player_option
{
/**
* Tell the file player to return NULL frame when the whole
* file has been played.
*/
PJMEDIA_AVI_FILE_NO_LOOP = 1
};
/**
* AVI stream data type.
*/
typedef pjmedia_port pjmedia_avi_stream;
/**
* Opaque data type for AVI streams. AVI streams is a collection of
* zero or more AVI stream.
*/
typedef struct pjmedia_avi_streams pjmedia_avi_streams;
/**
* Create avi streams to play an AVI file. AVI player supports
* reading AVI file with uncompressed video format and
* 16 bit PCM or compressed G.711 A-law/U-law audio format.
*
* @param pool Pool to create the streams.
* @param filename File name to open.
* @param flags Avi streams creation flags.
* @param p_streams Pointer to receive the avi streams instance.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_avi_player_create_streams(pj_pool_t *pool,
const char *filename,
unsigned flags,
pjmedia_avi_streams **p_streams);
/**
* Get the number of AVI stream.
*
* @param streams The AVI streams.
*
* @return The number of AVI stream.
*/
PJ_DECL(unsigned)
pjmedia_avi_streams_get_num_streams(pjmedia_avi_streams *streams);
/**
* Return the idx-th stream of the AVI streams.
*
* @param streams The AVI streams.
* @param idx The stream index.
*
* @return The AVI stream or NULL if it does not exist.
*/
PJ_DECL(pjmedia_avi_stream *)
pjmedia_avi_streams_get_stream(pjmedia_avi_streams *streams,
unsigned idx);
/**
* Return an AVI stream with a certain media type from the AVI streams.
*
* @param streams The AVI streams.
* @param start_idx The starting index.
* @param media_type The media type of the stream.
*
* @return The AVI stream or NULL if it does not exist.
*/
PJ_DECL(pjmedia_avi_stream *)
pjmedia_avi_streams_get_stream_by_media(pjmedia_avi_streams *streams,
unsigned start_idx,
pjmedia_type media_type);
/**
* Return the media port of an AVI stream.
*
* @param stream The AVI stream.
*
* @return The media port.
*/
PJ_INLINE(pjmedia_port *)
pjmedia_avi_stream_get_port(pjmedia_avi_stream *stream)
{
return (pjmedia_port *)stream;
}
/**
* Get the data length, in bytes.
*
* @param stream The AVI stream.
*
* @return The length of the data, in bytes. Upon error it will
* return negative value.
*/
PJ_DECL(pj_ssize_t) pjmedia_avi_stream_get_len(pjmedia_avi_stream *stream);
/**
* Register a callback to be called when the file reading has reached the
* end of file. If the file is set to play repeatedly, then the callback
* will be called multiple times. Note that only one callback can be
* registered for each AVI stream.
*
* @param stream The AVI stream.
* @param user_data User data to be specified in the callback
* @param cb Callback to be called. If the callback returns non-
* PJ_SUCCESS, the playback will stop. Note that if
* application destroys the file port in the callback,
* it must return non-PJ_SUCCESS here.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_avi_stream_set_eof_cb(pjmedia_avi_stream *stream,
void *user_data,
pj_status_t (*cb)(pjmedia_avi_stream *stream,
void *usr_data));
/**
* @}
*/
PJ_END_DECL
#endif /* __PJMEDIA_AVI_STREAM_H__ */
|