4 * Copyright (C) 2009 Adam Williams <broadcast at earthling dot net>
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.
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.
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
28 #include "condition.inc"
30 #include "filebase.inc"
34 #include "filefork.inc"
37 #include "filethread.inc"
38 #include "filexml.inc"
39 #include "formattools.inc"
40 #include "formatwindow.inc"
41 #include "framecache.inc"
44 #include "packagingengine.inc"
45 #include "pluginserver.inc"
46 #include "preferences.inc"
47 #include "samples.inc"
50 // ======================================= include file types here
54 // generic file opened by user
61 friend class FileFork;
63 // Get attributes for various file formats.
64 // The dither parameter is carried over from recording, where dither is done at the device.
65 int get_options(FormatTools *format,
70 // Close parameter window
73 // ===================================== start here
74 int set_processors(int cpus); // Set the number of cpus for certain codecs.
75 // Set the number of bytes to preload during reads for Quicktime.
76 int set_preload(int64_t size);
77 // Set the subtitle for libzmpeg3. -1 disables subtitles.
78 void set_subtitle(int value);
79 // Set whether to interpolate raw images
80 void set_interpolate_raw(int value);
81 // Set whether to white balance raw images. Always 0 if no interpolation.
82 void set_white_balance_raw(int value);
83 // When loading, the asset is deleted and a copy created in the EDL.
84 // void set_asset(Asset *asset);
86 // Enable or disable frame caching. Must be tied to file to know when
87 // to delete the file object. Otherwise we'd delete just the cached frames
88 // while the list of open files grew.
89 void set_cache_frames(int value);
90 // Delete frame cache. Return 0 if successful. Return 1 if
93 // Delete oldest frame from cache. Return 0 if successful. Return 1 if
97 // Format may be preset if the asset format is not 0.
98 int open_file(Preferences *preferences,
103 // Get index from the file if one exists. Returns 0 on success.
104 int get_index(char *index_path);
106 // start a thread for writing to avoid blocking during record
107 int start_audio_thread(int buffer_size, int ring_buffers);
108 int stop_audio_thread();
109 // The ring buffer must either be 1 or 2.
110 // The buffer_size for video needs to be > 1 on SMP systems to utilize
111 // multiple processors.
112 // For audio it's the number of samples per buffer.
113 // compressed - if 1 write_compressed_frame is called
114 // if 0 write_frames is called
115 int start_video_thread(int buffer_size,
119 int stop_video_thread();
121 int start_video_decode_thread();
123 // Return the thread.
124 // Used by functions that read only.
125 FileThread* get_video_thread();
127 // write any headers and close file
128 // ignore_thread is used by SigHandler to break out of the threads.
129 int close_file(int ignore_thread = 0);
130 void delete_temp_samples_buffer();
131 void delete_temp_frame_buffer();
133 // get length of file normalized to base samplerate
134 int64_t get_audio_length();
135 int64_t get_video_length();
137 // get current position
138 int64_t get_audio_position();
139 int64_t get_video_position();
143 // write samples for the current channel
144 // written to disk and file pointer updated after last channel is written
145 // return 1 if failed
146 // subsequent writes must be <= than first write's size because of buffers
147 int write_samples(Samples **buffer, int64_t len);
149 // Only called by filethread to write an array of an array of channels of frames.
150 int write_frames(VFrame ***frames, int len);
154 // For writing buffers in a background thread use these functions to get the buffer.
155 // Get a pointer to a buffer to write to.
156 Samples** get_audio_buffer();
157 VFrame*** get_video_buffer();
159 // Used by ResourcePixmap to directly access the cache.
160 FrameCache* get_frame_cache();
162 // Schedule a buffer for writing on the thread.
163 // thread calls write_samples
164 int write_audio_buffer(int64_t len);
165 int write_video_buffer(int64_t len);
170 // set channel for buffer accesses
171 int set_channel(int channel);
174 // set dvd program, no=-1 get current program
175 int set_program(int no);
177 int get_cell_time(int no, double &time);
179 int get_video_pid(int track);
181 int get_video_info(int track, int &pid, double &framerate,
182 int &width, int &height, char *title);
183 // update asset with selected audio/video layer data
184 int select_video_stream(Asset *asset, int vstream);
185 int select_audio_stream(Asset *asset, int astream);
186 // get dvb system_time
187 int get_system_time(int64_t &tm);
188 // get dvb audio channels for video stream
189 int get_audio_for_video(int vstream, int astream, int64_t &channel_mask);
190 // get frame thumbnail data
191 int get_thumbnail(int stream,
192 int64_t &position, unsigned char *&thumbnail, int &ww, int &hh);
193 int set_skimming(int track, int skim, skim_fn fn, void *vp);
194 int skim_video(int track, void *vp, skim_fn fn);
196 // set position in samples
197 int set_audio_position(int64_t position);
199 // Read samples for one channel into a shared memory segment.
200 // The offset is the offset in floats from the beginning of the buffer and the len
201 // is the length in floats from the offset.
202 // advances file pointer
203 // return 1 if failed
204 int read_samples(Samples *buffer, int64_t len);
207 // set layer for video read
208 // is_thread is used by FileThread::run to prevent recursive lockup.
209 int set_layer(int layer, int is_thread = 0);
210 // set position in frames
211 // is_thread is set by FileThread::run to prevent recursive lockup.
212 // int set_video_position(int64_t position, float base_framerate /* = -1 */, int is_thread /* = 0 */);
213 int set_video_position(int64_t position, int is_thread /* = 0 */);
215 // Read frame of video into the argument
216 // is_thread is used by FileThread::run to prevent recursive lockup.
217 int read_frame(VFrame *frame, int is_thread = 0);
220 // The following involve no extra copies.
221 // Direct copy routines for direct copy playback
222 int can_copy_from(Asset *asset, int64_t position, int output_w, int output_h); // This file can copy frames directly from the asset
223 int get_render_strategy(ArrayList<int>* render_strategies);
224 int64_t compressed_frame_size();
225 int read_compressed_frame(VFrame *buffer);
226 int write_compressed_frame(VFrame *buffer);
228 // These are separated into two routines so a file doesn't have to be
230 // Get best colormodel to translate for hardware accelerated playback.
231 // Called by VRender.
232 int get_best_colormodel(int driver);
233 // Get best colormodel for hardware accelerated recording.
234 // Called by VideoDevice.
235 static int get_best_colormodel(Asset *asset, int driver);
236 // Get nearest colormodel that can be decoded without a temporary frame.
237 // Used by read_frame.
238 int colormodel_supported(int colormodel);
240 // subclass memory usage
241 int64_t file_memory_usage();
242 // Used by CICache to calculate the total size of the cache.
243 // Based on temporary frames and a call to the file subclass.
244 // The return value is limited 1MB each in case of audio file.
245 // The minimum setting for cache_size should be bigger than 1MB.
246 int64_t get_memory_usage();
248 static int supports_video(ArrayList<PluginServer*> *plugindb, char *format); // returns 1 if the format supports video or audio
249 static int supports_audio(ArrayList<PluginServer*> *plugindb, char *format);
250 // Get the extension for the filename
251 static const char* get_tag(int format);
252 static const char* get_prefix(int format);
253 static int supports_video(int format); // returns 1 if the format supports video or audio
254 static int supports_audio(int format);
255 static int strtoformat(const char *format);
256 static const char* formattostr(int format);
257 static int strtoformat(ArrayList<PluginServer*> *plugindb, const char *format);
258 static const char* formattostr(ArrayList<PluginServer*> *plugindb, int format);
259 static int strtobits(const char *bits);
260 static const char* bitstostr(int bits);
261 static int str_to_byteorder(const char *string);
262 static const char* byteorder_to_str(int byte_order);
263 int bytes_per_sample(int bits); // Convert the bit descriptor into a byte count.
264 // get record stream file descriptor
267 Asset *asset; // Copy of asset since File outlives EDL
268 FileBase *file; // virtual class for file type
269 // Threads for writing data in the background.
270 FileThread *audio_thread, *video_thread;
272 // Temporary storage for color conversions
275 // Temporary storage for get_audio_buffer.
276 // [ring buffers][channels][Samples]
277 Samples ***temp_samples_buffer;
279 // Temporary storage for get_video_buffer.
280 // [Ring buffers][layers][temp_frame_size][VFrame]
281 VFrame ****temp_frame_buffer;
282 // Return value of get_video_buffer
283 VFrame ***current_frame_buffer;
284 // server copies of variables for threaded recording
285 int audio_ring_buffers;
286 int video_ring_buffers;
287 // Number of frames in the temp_frame_buffer
288 int video_buffer_size;
291 // Lock writes while recording video and audio.
292 // A binary lock won't do. We need a FIFO lock.
293 Condition *write_lock;
295 int64_t playback_preload;
296 int playback_subtitle;
298 int white_balance_raw;
300 // Position information is migrated here to allow samplerate conversion.
301 // Current position in file's samplerate.
302 // Can't normalize to base samplerate because this would
303 // require fractional positioning to know if the file's position changed.
304 int64_t current_sample;
305 int64_t current_frame;
310 // Position information normalized to project rates
311 int64_t normalized_sample;
312 // int64_t normalized_sample_rate;
313 Preferences *preferences;
315 static PackagingEngine *new_packaging_engine(Asset *asset);
318 void reset_parameters();
321 BC_WindowBase *format_window;
322 Condition *format_completion;
323 // framecache is only active locally, not on fileserver
324 FrameCache *frame_cache;
325 // Copy read frames to the cache
329 // Pointer to the fork object. 0 if this instance of File is the fork.
331 // If this instance is the fork.
333 // result_data must be locked during sync transaction
339 FileForker(Mutex &lk) : m(lk) { m.lock("FileForker::FileForker"); }
340 ~FileForker() { m.unlock(); }