fa3aeb83ee10a76a61b2920f728778c34945066f
[goodguy/history.git] / cinelerra-5.0 / cinelerra / filebase.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef FILEBASE_H
23 #define FILEBASE_H
24
25 #include "asset.inc"
26 #include "assets.inc"
27 #include "colormodels.h"
28 #include "edit.inc"
29 #include "ffmpeg.inc"
30 #include "guicast.h"
31 #include "file.inc"
32 #include "filelist.inc"
33 #include "overlayframe.inc"
34 #include "strategies.inc"
35 #include "vframe.inc"
36
37 #include <sys/types.h>
38
39 // Number of samples saved before the current read position
40 #define HISTORY_MAX 0x10000
41
42 // inherited by every file interpreter
43 class FileBase
44 {
45 public:
46         FileBase(Asset *asset, File *file);
47         virtual ~FileBase();
48
49
50         friend class File;
51         friend class FFMPEG;
52         friend class FileList;
53         friend class FrameWriter;
54
55
56
57
58         int get_mode(char *mode, int rd, int wr);
59         int reset_parameters();
60
61
62
63         virtual void get_parameters(BC_WindowBase *parent_window,
64                         Asset *asset,
65                         BC_WindowBase **format_window,
66                         int audio_options,
67                         int video_options,
68                         int lock_compressor) {};
69
70
71
72         virtual int get_index(char *index_path) { return 1; }
73         virtual int check_header() { return 0; }  // Test file to see if it is of this type.
74         virtual int reset_parameters_derived() { return 0; }
75         virtual int read_header() { return 1; }   // WAV files for getting header
76         virtual int open_file(int rd, int wr) { return 1; }
77         virtual int close_file();
78         virtual int close_file_derived() { return 0; }
79         int set_dither();
80         virtual int seek_end() { return 0; }
81         virtual int seek_start() { return 0; }
82         virtual int64_t get_video_position() { return 0; }
83         virtual int64_t get_audio_position() { return 0; }
84         virtual int set_video_position(int64_t x) { return 0; }
85         virtual int set_audio_position(int64_t x) { return 0; }
86         virtual int set_subtitle(int value) { return -1; }
87         virtual int select_video_stream(Asset *asset, int vstream) { return -1; }
88         virtual int select_audio_stream(Asset *asset, int astream) { return -1; }
89         virtual int set_program(int no) { return -1; }
90         virtual int get_cell_time(int no, double &time) { time = -1.; return 1; }
91         virtual int get_system_time(int64_t &tm) { tm = -1; return 1; }
92         virtual int get_audio_for_video(int vstream, int astream, int64_t &channel_mask) {
93                  channel_mask = 0;  return -1;
94         }
95         virtual int get_video_pid(int track) { return -1; }
96         virtual int get_video_info(int track, int &pid, double &framerate,
97                 int &width, int &height, char *title=0) { return -1; }
98
99         virtual int get_thumbnail(int stream, int64_t &position,
100                 unsigned char *&thumbnail, int &ww, int &hh) { return -1; }
101         virtual int set_skimming(int track, int skim, skim_fn fn, void *vp) { return -1; }
102         virtual int skim_video(int track, void *vp, skim_fn fn) { return -1; }
103
104 // Subclass should call this to add the base class allocation.
105 // Only used in read mode.
106         virtual int64_t base_memory_usage();
107
108         virtual int write_samples(double **buffer,
109                 int64_t len) { return 0; }
110         virtual int write_frames(VFrame ***frames, int len) { return 0; }
111         virtual int read_compressed_frame(VFrame *buffer) { return 0; }
112         virtual int write_compressed_frame(VFrame *buffers) { return 0; }
113         virtual int64_t compressed_frame_size() { return 0; }
114 // Doubles are used to allow resampling
115         virtual int read_samples(double *buffer, int64_t len) { return 0; }
116         virtual int read_frame(VFrame *frame) { return 1; }
117 // get dvb record stream file descriptor
118         virtual int record_fd() { return -1; }
119
120         virtual int prefer_samples_float() {return 0;};
121         virtual int read_samples_float(float *buffer, int64_t len) { return 0; };
122
123
124 // Return either the argument or another colormodel which read_frame should
125 // use.
126         virtual int colormodel_supported(int colormodel) { return BC_RGB888; }
127 // This file can copy compressed frames directly from the asset
128         virtual int can_copy_from(Asset *asset, int64_t position) { return 0; }
129         virtual int get_render_strategy(ArrayList<int>* render_strategies) { return VRENDER_VPIXEL; }
130
131 // Manages an audio history buffer
132         void update_pcm_history(int64_t len);
133 // Returns history_start + history_size
134         int64_t get_history_sample();
135 // contiguous float
136         void append_history(float **new_data, int len);
137 // Interleaved short
138         void append_history(short *new_data, int len);
139         void read_history(double *dst,
140                 int64_t start_sample,
141                 int channel,
142                 int64_t len);
143         void allocate_history(int len);
144
145 // For static functions to access it
146         Asset *asset;
147         int rd, wr;
148
149 protected:
150 // Return 1 if the render_strategy is present on the list.
151         static int search_render_strategies(ArrayList<int>* render_strategies, int render_strategy);
152
153 // convert samples into file format
154         int64_t samples_to_raw(char *out_buffer,
155                                                         float **in_buffer, // was **buffer
156                                                         int64_t input_len,
157                                                         int bits,
158                                                         int channels,
159                                                         int byte_order,
160                                                         int signed_);
161
162 // overwrites the buffer from PCM data depending on feather.
163         int raw_to_samples(float *out_buffer, char *in_buffer,
164                 int64_t samples, int bits, int channels, int channel, int feather,
165                 float lfeather_len, float lfeather_gain, float lfeather_slope);
166
167 // Overwrite the buffer from float data using feather.
168         int overlay_float_buffer(float *out_buffer, float *in_buffer,
169                 int64_t samples,
170                 float lfeather_len, float lfeather_gain, float lfeather_slope);
171
172 // convert a frame to and from file format
173
174         int64_t frame_to_raw(unsigned char *out_buffer,
175                                         VFrame *in_frame,
176                                         int w,
177                                         int h,
178                                         int use_alpha,
179                                         int use_float,
180                                         int color_model);
181
182 // allocate a buffer for translating int to float
183         int get_audio_buffer(char **buffer, int64_t len, int64_t bits, int64_t channels); // audio
184
185 // Allocate a buffer for feathering floats
186         int get_float_buffer(float **buffer, int64_t len);
187
188 // allocate a buffer for translating video to VFrame
189         int get_video_buffer(unsigned char **buffer, int depth); // video
190         int get_row_pointers(unsigned char *buffer, unsigned char ***pointers, int depth);
191         static int match4(const char *in, const char *out);   // match 4 bytes for a quicktime type
192
193         int64_t ima4_samples_to_bytes(int64_t samples, int channels);
194         int64_t ima4_bytes_to_samples(int64_t bytes, int channels);
195
196         float *float_buffer;          // for floating point feathering
197         unsigned char **row_pointers_in, **row_pointers_out;
198         int64_t prev_buffer_position;  // for audio determines if reading raw data is necessary
199         int64_t prev_frame_position;   // for video determines if reading raw video data is necessary
200         int64_t prev_bytes; // determines if new raw buffer is needed and used for getting memory usage
201         int64_t prev_len;
202         int prev_track;
203         int prev_layer;
204         int dither;
205         int internal_byte_order;
206         File *file;
207
208 // ================================= Audio compression
209         double **pcm_history;
210         int64_t history_allocated;
211         int64_t history_size;
212         int64_t history_start;
213         int history_channels;
214 // Range to decode to fill history buffer.  Maintained by FileBase.
215         int64_t decode_start;
216         int64_t decode_len;
217 // End of last decoded sample.  Maintained by user for seeking.
218         int64_t decode_end;
219
220
221 private:
222
223
224
225
226 // ULAW
227         float ulawtofloat(char ulaw);
228         char floattoulaw(float value);
229         int generate_ulaw_tables();
230         int delete_ulaw_tables();
231         float *ulawtofloat_table, *ulawtofloat_ptr;
232         unsigned char *floattoulaw_table, *floattoulaw_ptr;
233
234 // IMA4
235         int init_ima4();
236         int delete_ima4();
237         int ima4_decode_block(int16_t *output, unsigned char *input);
238         int ima4_decode_sample(int *predictor, int nibble, int *index, int *step);
239         int ima4_encode_block(unsigned char *output, int16_t *input, int step, int channel);
240         int ima4_encode_sample(int *last_sample, int *last_index, int *nibble, int next_sample);
241
242         static int ima4_step[89];
243         static int ima4_index[16];
244         int *last_ima4_samples;
245         int *last_ima4_indexes;
246         int ima4_block_size;
247         int ima4_block_samples;
248         OverlayFrame *overlayer;
249 };
250
251 #endif