OpenShot Library | libopenshot  0.3.2
FFmpegReader.cpp
Go to the documentation of this file.
1 
12 // Copyright (c) 2008-2019 OpenShot Studios, LLC, Fabrice Bellard
13 //
14 // SPDX-License-Identifier: LGPL-3.0-or-later
15 
16 #include <thread> // for std::this_thread::sleep_for
17 #include <chrono> // for std::chrono::milliseconds
18 #include <unistd.h>
19 
20 #include "FFmpegUtilities.h"
21 
22 #include "FFmpegReader.h"
23 #include "Exceptions.h"
24 #include "Timeline.h"
25 #include "ZmqLogger.h"
26 
27 #define ENABLE_VAAPI 0
28 
29 #if USE_HW_ACCEL
30 #define MAX_SUPPORTED_WIDTH 1950
31 #define MAX_SUPPORTED_HEIGHT 1100
32 
33 #if ENABLE_VAAPI
34 #include "libavutil/hwcontext_vaapi.h"
35 
36 typedef struct VAAPIDecodeContext {
37  VAProfile va_profile;
38  VAEntrypoint va_entrypoint;
39  VAConfigID va_config;
40  VAContextID va_context;
41 
42 #if FF_API_STRUCT_VAAPI_CONTEXT
43  // FF_DISABLE_DEPRECATION_WARNINGS
44  int have_old_context;
45  struct vaapi_context *old_context;
46  AVBufferRef *device_ref;
47  // FF_ENABLE_DEPRECATION_WARNINGS
48 #endif
49 
50  AVHWDeviceContext *device;
51  AVVAAPIDeviceContext *hwctx;
52 
53  AVHWFramesContext *frames;
54  AVVAAPIFramesContext *hwfc;
55 
56  enum AVPixelFormat surface_format;
57  int surface_count;
58  } VAAPIDecodeContext;
59 #endif // ENABLE_VAAPI
60 #endif // USE_HW_ACCEL
61 
62 
63 using namespace openshot;
64 
65 int hw_de_on = 0;
66 #if USE_HW_ACCEL
67  AVPixelFormat hw_de_av_pix_fmt_global = AV_PIX_FMT_NONE;
68  AVHWDeviceType hw_de_av_device_type_global = AV_HWDEVICE_TYPE_NONE;
69 #endif
70 
71 FFmpegReader::FFmpegReader(const std::string &path, bool inspect_reader)
72  : last_frame(0), is_seeking(0), seeking_pts(0), seeking_frame(0), seek_count(0), NO_PTS_OFFSET(-99999),
73  path(path), is_video_seek(true), check_interlace(false), check_fps(false), enable_seek(true), is_open(false),
74  seek_audio_frame_found(0), seek_video_frame_found(0),is_duration_known(false), largest_frame_processed(0),
75  current_video_frame(0), packet(NULL), max_concurrent_frames(OPEN_MP_NUM_PROCESSORS), audio_pts(0),
76  video_pts(0), pFormatCtx(NULL), videoStream(-1), audioStream(-1), pCodecCtx(NULL), aCodecCtx(NULL),
77  pStream(NULL), aStream(NULL), pFrame(NULL), previous_packet_location{-1,0},
78  hold_packet(false) {
79 
80  // Initialize FFMpeg, and register all formats and codecs
83 
84  // Init timestamp offsets
85  pts_offset_seconds = NO_PTS_OFFSET;
86  video_pts_seconds = NO_PTS_OFFSET;
87  audio_pts_seconds = NO_PTS_OFFSET;
88 
89  // Init cache
90  working_cache.SetMaxBytesFromInfo(max_concurrent_frames * info.fps.ToDouble() * 2, info.width, info.height, info.sample_rate, info.channels);
91  final_cache.SetMaxBytesFromInfo(max_concurrent_frames * 2, info.width, info.height, info.sample_rate, info.channels);
92 
93  // Open and Close the reader, to populate its attributes (such as height, width, etc...)
94  if (inspect_reader) {
95  Open();
96  Close();
97  }
98 }
99 
101  if (is_open)
102  // Auto close reader if not already done
103  Close();
104 }
105 
106 // This struct holds the associated video frame and starting sample # for an audio packet.
107 bool AudioLocation::is_near(AudioLocation location, int samples_per_frame, int64_t amount) {
108  // Is frame even close to this one?
109  if (abs(location.frame - frame) >= 2)
110  // This is too far away to be considered
111  return false;
112 
113  // Note that samples_per_frame can vary slightly frame to frame when the
114  // audio sampling rate is not an integer multiple of the video fps.
115  int64_t diff = samples_per_frame * (location.frame - frame) + location.sample_start - sample_start;
116  if (abs(diff) <= amount)
117  // close
118  return true;
119 
120  // not close
121  return false;
122 }
123 
124 #if USE_HW_ACCEL
125 
126 // Get hardware pix format
127 static enum AVPixelFormat get_hw_dec_format(AVCodecContext *ctx, const enum AVPixelFormat *pix_fmts)
128 {
129  const enum AVPixelFormat *p;
130 
131  for (p = pix_fmts; *p != AV_PIX_FMT_NONE; p++) {
132  switch (*p) {
133 #if defined(__linux__)
134  // Linux pix formats
135  case AV_PIX_FMT_VAAPI:
136  hw_de_av_pix_fmt_global = AV_PIX_FMT_VAAPI;
137  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VAAPI;
138  return *p;
139  break;
140  case AV_PIX_FMT_VDPAU:
141  hw_de_av_pix_fmt_global = AV_PIX_FMT_VDPAU;
142  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VDPAU;
143  return *p;
144  break;
145 #endif
146 #if defined(_WIN32)
147  // Windows pix formats
148  case AV_PIX_FMT_DXVA2_VLD:
149  hw_de_av_pix_fmt_global = AV_PIX_FMT_DXVA2_VLD;
150  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_DXVA2;
151  return *p;
152  break;
153  case AV_PIX_FMT_D3D11:
154  hw_de_av_pix_fmt_global = AV_PIX_FMT_D3D11;
155  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_D3D11VA;
156  return *p;
157  break;
158 #endif
159 #if defined(__APPLE__)
160  // Apple pix formats
161  case AV_PIX_FMT_VIDEOTOOLBOX:
162  hw_de_av_pix_fmt_global = AV_PIX_FMT_VIDEOTOOLBOX;
163  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
164  return *p;
165  break;
166 #endif
167  // Cross-platform pix formats
168  case AV_PIX_FMT_CUDA:
169  hw_de_av_pix_fmt_global = AV_PIX_FMT_CUDA;
170  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_CUDA;
171  return *p;
172  break;
173  case AV_PIX_FMT_QSV:
174  hw_de_av_pix_fmt_global = AV_PIX_FMT_QSV;
175  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_QSV;
176  return *p;
177  break;
178  default:
179  // This is only here to silence unused-enum warnings
180  break;
181  }
182  }
183  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::get_hw_dec_format (Unable to decode this file using hardware decode)");
184  return AV_PIX_FMT_NONE;
185 }
186 
187 int FFmpegReader::IsHardwareDecodeSupported(int codecid)
188 {
189  int ret;
190  switch (codecid) {
191  case AV_CODEC_ID_H264:
192  case AV_CODEC_ID_MPEG2VIDEO:
193  case AV_CODEC_ID_VC1:
194  case AV_CODEC_ID_WMV1:
195  case AV_CODEC_ID_WMV2:
196  case AV_CODEC_ID_WMV3:
197  ret = 1;
198  break;
199  default :
200  ret = 0;
201  break;
202  }
203  return ret;
204 }
205 #endif // USE_HW_ACCEL
206 
208  // Open reader if not already open
209  if (!is_open) {
210  // Prevent async calls to the following code
211  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
212 
213  // Initialize format context
214  pFormatCtx = NULL;
215  {
217  ZmqLogger::Instance()->AppendDebugMethod("Decode hardware acceleration settings", "hw_de_on", hw_de_on, "HARDWARE_DECODER", openshot::Settings::Instance()->HARDWARE_DECODER);
218  }
219 
220  // Open video file
221  if (avformat_open_input(&pFormatCtx, path.c_str(), NULL, NULL) != 0)
222  throw InvalidFile("File could not be opened.", path);
223 
224  // Retrieve stream information
225  if (avformat_find_stream_info(pFormatCtx, NULL) < 0)
226  throw NoStreamsFound("No streams found in file.", path);
227 
228  videoStream = -1;
229  audioStream = -1;
230 
231  // Init end-of-file detection variables
232  packet_status.reset(true);
233 
234  // Loop through each stream, and identify the video and audio stream index
235  for (unsigned int i = 0; i < pFormatCtx->nb_streams; i++) {
236  // Is this a video stream?
237  if (AV_GET_CODEC_TYPE(pFormatCtx->streams[i]) == AVMEDIA_TYPE_VIDEO && videoStream < 0) {
238  videoStream = i;
239  packet_status.video_eof = false;
240  packet_status.packets_eof = false;
241  packet_status.end_of_file = false;
242  }
243  // Is this an audio stream?
244  if (AV_GET_CODEC_TYPE(pFormatCtx->streams[i]) == AVMEDIA_TYPE_AUDIO && audioStream < 0) {
245  audioStream = i;
246  packet_status.audio_eof = false;
247  packet_status.packets_eof = false;
248  packet_status.end_of_file = false;
249  }
250  }
251  if (videoStream == -1 && audioStream == -1)
252  throw NoStreamsFound("No video or audio streams found in this file.", path);
253 
254  // Is there a video stream?
255  if (videoStream != -1) {
256  // Set the stream index
257  info.video_stream_index = videoStream;
258 
259  // Set the codec and codec context pointers
260  pStream = pFormatCtx->streams[videoStream];
261 
262  // Find the codec ID from stream
263  const AVCodecID codecId = AV_FIND_DECODER_CODEC_ID(pStream);
264 
265  // Get codec and codec context from stream
266  const AVCodec *pCodec = avcodec_find_decoder(codecId);
267  AVDictionary *opts = NULL;
268  int retry_decode_open = 2;
269  // If hw accel is selected but hardware cannot handle repeat with software decoding
270  do {
271  pCodecCtx = AV_GET_CODEC_CONTEXT(pStream, pCodec);
272 #if USE_HW_ACCEL
273  if (hw_de_on && (retry_decode_open==2)) {
274  // Up to here no decision is made if hardware or software decode
275  hw_de_supported = IsHardwareDecodeSupported(pCodecCtx->codec_id);
276  }
277 #endif
278  retry_decode_open = 0;
279 
280  // Set number of threads equal to number of processors (not to exceed 16)
281  pCodecCtx->thread_count = std::min(FF_NUM_PROCESSORS, 16);
282 
283  if (pCodec == NULL) {
284  throw InvalidCodec("A valid video codec could not be found for this file.", path);
285  }
286 
287  // Init options
288  av_dict_set(&opts, "strict", "experimental", 0);
289 #if USE_HW_ACCEL
290  if (hw_de_on && hw_de_supported) {
291  // Open Hardware Acceleration
292  int i_decoder_hw = 0;
293  char adapter[256];
294  char *adapter_ptr = NULL;
295  int adapter_num;
297  fprintf(stderr, "Hardware decoding device number: %d\n", adapter_num);
298 
299  // Set hardware pix format (callback)
300  pCodecCtx->get_format = get_hw_dec_format;
301 
302  if (adapter_num < 3 && adapter_num >=0) {
303 #if defined(__linux__)
304  snprintf(adapter,sizeof(adapter),"/dev/dri/renderD%d", adapter_num+128);
305  adapter_ptr = adapter;
307  switch (i_decoder_hw) {
308  case 1:
309  hw_de_av_device_type = AV_HWDEVICE_TYPE_VAAPI;
310  break;
311  case 2:
312  hw_de_av_device_type = AV_HWDEVICE_TYPE_CUDA;
313  break;
314  case 6:
315  hw_de_av_device_type = AV_HWDEVICE_TYPE_VDPAU;
316  break;
317  case 7:
318  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
319  break;
320  default:
321  hw_de_av_device_type = AV_HWDEVICE_TYPE_VAAPI;
322  break;
323  }
324 
325 #elif defined(_WIN32)
326  adapter_ptr = NULL;
328  switch (i_decoder_hw) {
329  case 2:
330  hw_de_av_device_type = AV_HWDEVICE_TYPE_CUDA;
331  break;
332  case 3:
333  hw_de_av_device_type = AV_HWDEVICE_TYPE_DXVA2;
334  break;
335  case 4:
336  hw_de_av_device_type = AV_HWDEVICE_TYPE_D3D11VA;
337  break;
338  case 7:
339  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
340  break;
341  default:
342  hw_de_av_device_type = AV_HWDEVICE_TYPE_DXVA2;
343  break;
344  }
345 #elif defined(__APPLE__)
346  adapter_ptr = NULL;
348  switch (i_decoder_hw) {
349  case 5:
350  hw_de_av_device_type = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
351  break;
352  case 7:
353  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
354  break;
355  default:
356  hw_de_av_device_type = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
357  break;
358  }
359 #endif
360 
361  } else {
362  adapter_ptr = NULL; // Just to be sure
363  }
364 
365  // Check if it is there and writable
366 #if defined(__linux__)
367  if( adapter_ptr != NULL && access( adapter_ptr, W_OK ) == 0 ) {
368 #elif defined(_WIN32)
369  if( adapter_ptr != NULL ) {
370 #elif defined(__APPLE__)
371  if( adapter_ptr != NULL ) {
372 #endif
373  ZmqLogger::Instance()->AppendDebugMethod("Decode Device present using device");
374  }
375  else {
376  adapter_ptr = NULL; // use default
377  ZmqLogger::Instance()->AppendDebugMethod("Decode Device not present using default");
378  }
379 
380  hw_device_ctx = NULL;
381  // Here the first hardware initialisations are made
382  if (av_hwdevice_ctx_create(&hw_device_ctx, hw_de_av_device_type, adapter_ptr, NULL, 0) >= 0) {
383  if (!(pCodecCtx->hw_device_ctx = av_buffer_ref(hw_device_ctx))) {
384  throw InvalidCodec("Hardware device reference create failed.", path);
385  }
386 
387  /*
388  av_buffer_unref(&ist->hw_frames_ctx);
389  ist->hw_frames_ctx = av_hwframe_ctx_alloc(hw_device_ctx);
390  if (!ist->hw_frames_ctx) {
391  av_log(avctx, AV_LOG_ERROR, "Error creating a CUDA frames context\n");
392  return AVERROR(ENOMEM);
393  }
394 
395  frames_ctx = (AVHWFramesContext*)ist->hw_frames_ctx->data;
396 
397  frames_ctx->format = AV_PIX_FMT_CUDA;
398  frames_ctx->sw_format = avctx->sw_pix_fmt;
399  frames_ctx->width = avctx->width;
400  frames_ctx->height = avctx->height;
401 
402  av_log(avctx, AV_LOG_DEBUG, "Initializing CUDA frames context: sw_format = %s, width = %d, height = %d\n",
403  av_get_pix_fmt_name(frames_ctx->sw_format), frames_ctx->width, frames_ctx->height);
404 
405 
406  ret = av_hwframe_ctx_init(pCodecCtx->hw_device_ctx);
407  ret = av_hwframe_ctx_init(ist->hw_frames_ctx);
408  if (ret < 0) {
409  av_log(avctx, AV_LOG_ERROR, "Error initializing a CUDA frame pool\n");
410  return ret;
411  }
412  */
413  }
414  else {
415  throw InvalidCodec("Hardware device create failed.", path);
416  }
417  }
418 #endif // USE_HW_ACCEL
419 
420  // Disable per-frame threading for album arts
421  // Using FF_THREAD_FRAME adds one frame decoding delay per thread,
422  // but there's only one frame in this case.
423  if (HasAlbumArt())
424  {
425  pCodecCtx->thread_type &= ~FF_THREAD_FRAME;
426  }
427 
428  // Open video codec
429  int avcodec_return = avcodec_open2(pCodecCtx, pCodec, &opts);
430  if (avcodec_return < 0) {
431  std::stringstream avcodec_error_msg;
432  avcodec_error_msg << "A video codec was found, but could not be opened. Error: " << av_err2string(avcodec_return);
433  throw InvalidCodec(avcodec_error_msg.str(), path);
434  }
435 
436 #if USE_HW_ACCEL
437  if (hw_de_on && hw_de_supported) {
438  AVHWFramesConstraints *constraints = NULL;
439  void *hwconfig = NULL;
440  hwconfig = av_hwdevice_hwconfig_alloc(hw_device_ctx);
441 
442 // TODO: needs va_config!
443 #if ENABLE_VAAPI
444  ((AVVAAPIHWConfig *)hwconfig)->config_id = ((VAAPIDecodeContext *)(pCodecCtx->priv_data))->va_config;
445  constraints = av_hwdevice_get_hwframe_constraints(hw_device_ctx,hwconfig);
446 #endif // ENABLE_VAAPI
447  if (constraints) {
448  if (pCodecCtx->coded_width < constraints->min_width ||
449  pCodecCtx->coded_height < constraints->min_height ||
450  pCodecCtx->coded_width > constraints->max_width ||
451  pCodecCtx->coded_height > constraints->max_height) {
452  ZmqLogger::Instance()->AppendDebugMethod("DIMENSIONS ARE TOO LARGE for hardware acceleration\n");
453  hw_de_supported = 0;
454  retry_decode_open = 1;
455  AV_FREE_CONTEXT(pCodecCtx);
456  if (hw_device_ctx) {
457  av_buffer_unref(&hw_device_ctx);
458  hw_device_ctx = NULL;
459  }
460  }
461  else {
462  // All is just peachy
463  ZmqLogger::Instance()->AppendDebugMethod("\nDecode hardware acceleration is used\n", "Min width :", constraints->min_width, "Min Height :", constraints->min_height, "MaxWidth :", constraints->max_width, "MaxHeight :", constraints->max_height, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
464  retry_decode_open = 0;
465  }
466  av_hwframe_constraints_free(&constraints);
467  if (hwconfig) {
468  av_freep(&hwconfig);
469  }
470  }
471  else {
472  int max_h, max_w;
473  //max_h = ((getenv( "LIMIT_HEIGHT_MAX" )==NULL) ? MAX_SUPPORTED_HEIGHT : atoi(getenv( "LIMIT_HEIGHT_MAX" )));
475  //max_w = ((getenv( "LIMIT_WIDTH_MAX" )==NULL) ? MAX_SUPPORTED_WIDTH : atoi(getenv( "LIMIT_WIDTH_MAX" )));
477  ZmqLogger::Instance()->AppendDebugMethod("Constraints could not be found using default limit\n");
478  //cerr << "Constraints could not be found using default limit\n";
479  if (pCodecCtx->coded_width < 0 ||
480  pCodecCtx->coded_height < 0 ||
481  pCodecCtx->coded_width > max_w ||
482  pCodecCtx->coded_height > max_h ) {
483  ZmqLogger::Instance()->AppendDebugMethod("DIMENSIONS ARE TOO LARGE for hardware acceleration\n", "Max Width :", max_w, "Max Height :", max_h, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
484  hw_de_supported = 0;
485  retry_decode_open = 1;
486  AV_FREE_CONTEXT(pCodecCtx);
487  if (hw_device_ctx) {
488  av_buffer_unref(&hw_device_ctx);
489  hw_device_ctx = NULL;
490  }
491  }
492  else {
493  ZmqLogger::Instance()->AppendDebugMethod("\nDecode hardware acceleration is used\n", "Max Width :", max_w, "Max Height :", max_h, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
494  retry_decode_open = 0;
495  }
496  }
497  } // if hw_de_on && hw_de_supported
498  else {
499  ZmqLogger::Instance()->AppendDebugMethod("\nDecode in software is used\n");
500  }
501 #else
502  retry_decode_open = 0;
503 #endif // USE_HW_ACCEL
504  } while (retry_decode_open); // retry_decode_open
505  // Free options
506  av_dict_free(&opts);
507 
508  // Update the File Info struct with video details (if a video stream is found)
509  UpdateVideoInfo();
510  }
511 
512  // Is there an audio stream?
513  if (audioStream != -1) {
514  // Set the stream index
515  info.audio_stream_index = audioStream;
516 
517  // Get a pointer to the codec context for the audio stream
518  aStream = pFormatCtx->streams[audioStream];
519 
520  // Find the codec ID from stream
521  AVCodecID codecId = AV_FIND_DECODER_CODEC_ID(aStream);
522 
523  // Get codec and codec context from stream
524  const AVCodec *aCodec = avcodec_find_decoder(codecId);
525  aCodecCtx = AV_GET_CODEC_CONTEXT(aStream, aCodec);
526 
527  // Set number of threads equal to number of processors (not to exceed 16)
528  aCodecCtx->thread_count = std::min(FF_NUM_PROCESSORS, 16);
529 
530  if (aCodec == NULL) {
531  throw InvalidCodec("A valid audio codec could not be found for this file.", path);
532  }
533 
534  // Init options
535  AVDictionary *opts = NULL;
536  av_dict_set(&opts, "strict", "experimental", 0);
537 
538  // Open audio codec
539  if (avcodec_open2(aCodecCtx, aCodec, &opts) < 0)
540  throw InvalidCodec("An audio codec was found, but could not be opened.", path);
541 
542  // Free options
543  av_dict_free(&opts);
544 
545  // Update the File Info struct with audio details (if an audio stream is found)
546  UpdateAudioInfo();
547  }
548 
549  // Add format metadata (if any)
550  AVDictionaryEntry *tag = NULL;
551  while ((tag = av_dict_get(pFormatCtx->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
552  QString str_key = tag->key;
553  QString str_value = tag->value;
554  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
555  }
556 
557  // Init previous audio location to zero
558  previous_packet_location.frame = -1;
559  previous_packet_location.sample_start = 0;
560 
561  // Adjust cache size based on size of frame and audio
562  working_cache.SetMaxBytesFromInfo(max_concurrent_frames * info.fps.ToDouble() * 2, info.width, info.height, info.sample_rate, info.channels);
564 
565  // Scan PTS for any offsets (i.e. non-zero starting streams). At least 1 stream must start at zero timestamp.
566  // This method allows us to shift timestamps to ensure at least 1 stream is starting at zero.
567  UpdatePTSOffset();
568 
569  // Override an invalid framerate
570  if (info.fps.ToFloat() > 240.0f || (info.fps.num <= 0 || info.fps.den <= 0) || info.video_length <= 0) {
571  // Calculate FPS, duration, video bit rate, and video length manually
572  // by scanning through all the video stream packets
573  CheckFPS();
574  }
575 
576  // Mark as "open"
577  is_open = true;
578 
579  // Seek back to beginning of file (if not already seeking)
580  if (!is_seeking) {
581  Seek(1);
582  }
583  }
584 }
585 
587  // Close all objects, if reader is 'open'
588  if (is_open) {
589  // Prevent async calls to the following code
590  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
591 
592  // Mark as "closed"
593  is_open = false;
594 
595  // Keep track of most recent packet
596  AVPacket *recent_packet = packet;
597 
598  // Drain any packets from the decoder
599  packet = NULL;
600  int attempts = 0;
601  int max_attempts = 128;
602  while (packet_status.packets_decoded() < packet_status.packets_read() && attempts < max_attempts) {
603  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::Close (Drain decoder loop)",
604  "packets_read", packet_status.packets_read(),
605  "packets_decoded", packet_status.packets_decoded(),
606  "attempts", attempts);
607  if (packet_status.video_decoded < packet_status.video_read) {
608  ProcessVideoPacket(info.video_length);
609  }
610  if (packet_status.audio_decoded < packet_status.audio_read) {
611  ProcessAudioPacket(info.video_length);
612  }
613  attempts++;
614  }
615 
616  // Remove packet
617  if (recent_packet) {
618  RemoveAVPacket(recent_packet);
619  }
620 
621  // Close the video codec
622  if (info.has_video) {
623  if(avcodec_is_open(pCodecCtx)) {
624  avcodec_flush_buffers(pCodecCtx);
625  }
626  AV_FREE_CONTEXT(pCodecCtx);
627 #if USE_HW_ACCEL
628  if (hw_de_on) {
629  if (hw_device_ctx) {
630  av_buffer_unref(&hw_device_ctx);
631  hw_device_ctx = NULL;
632  }
633  }
634 #endif // USE_HW_ACCEL
635  }
636 
637  // Close the audio codec
638  if (info.has_audio) {
639  if(avcodec_is_open(aCodecCtx)) {
640  avcodec_flush_buffers(aCodecCtx);
641  }
642  AV_FREE_CONTEXT(aCodecCtx);
643  }
644 
645  // Clear final cache
646  final_cache.Clear();
647  working_cache.Clear();
648 
649  // Close the video file
650  avformat_close_input(&pFormatCtx);
651  av_freep(&pFormatCtx);
652 
653  // Reset some variables
654  last_frame = 0;
655  hold_packet = false;
656  largest_frame_processed = 0;
657  seek_audio_frame_found = 0;
658  seek_video_frame_found = 0;
659  current_video_frame = 0;
660  last_video_frame.reset();
661  }
662 }
663 
664 bool FFmpegReader::HasAlbumArt() {
665  // Check if the video stream we use is an attached picture
666  // This won't return true if the file has a cover image as a secondary stream
667  // like an MKV file with an attached image file
668  return pFormatCtx && videoStream >= 0 && pFormatCtx->streams[videoStream]
669  && (pFormatCtx->streams[videoStream]->disposition & AV_DISPOSITION_ATTACHED_PIC);
670 }
671 
672 void FFmpegReader::UpdateAudioInfo() {
673  // Set default audio channel layout (if needed)
674  if (AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout == 0)
675  AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout = av_get_default_channel_layout(AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels);
676 
677  if (info.sample_rate > 0) {
678  // Skip init - if info struct already populated
679  return;
680  }
681 
682  // Set values of FileInfo struct
683  info.has_audio = true;
684  info.file_size = pFormatCtx->pb ? avio_size(pFormatCtx->pb) : -1;
685  info.acodec = aCodecCtx->codec->name;
686  info.channels = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels;
687  info.channel_layout = (ChannelLayout) AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout;
688  info.sample_rate = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->sample_rate;
689  info.audio_bit_rate = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->bit_rate;
690  if (info.audio_bit_rate <= 0) {
691  // Get bitrate from format
692  info.audio_bit_rate = pFormatCtx->bit_rate;
693  }
694 
695  // Set audio timebase
696  info.audio_timebase.num = aStream->time_base.num;
697  info.audio_timebase.den = aStream->time_base.den;
698 
699  // Get timebase of audio stream (if valid) and greater than the current duration
700  if (aStream->duration > 0 && aStream->duration > info.duration) {
701  // Get duration from audio stream
702  info.duration = aStream->duration * info.audio_timebase.ToDouble();
703  } else if (pFormatCtx->duration > 0 && info.duration <= 0.0f) {
704  // Use the format's duration
705  info.duration = float(pFormatCtx->duration) / AV_TIME_BASE;
706  }
707 
708  // Calculate duration from filesize and bitrate (if any)
709  if (info.duration <= 0.0f && info.video_bit_rate > 0 && info.file_size > 0) {
710  // Estimate from bitrate, total bytes, and framerate
712  }
713 
714  // Check for an invalid video length
715  if (info.has_video && info.video_length <= 0) {
716  // Calculate the video length from the audio duration
718  }
719 
720  // Set video timebase (if no video stream was found)
721  if (!info.has_video) {
722  // Set a few important default video settings (so audio can be divided into frames)
723  info.fps.num = 24;
724  info.fps.den = 1;
725  info.video_timebase.num = 1;
726  info.video_timebase.den = 24;
728  info.width = 720;
729  info.height = 480;
730 
731  // Use timeline to set correct width & height (if any)
732  Clip *parent = static_cast<Clip *>(ParentClip());
733  if (parent) {
734  if (parent->ParentTimeline()) {
735  // Set max width/height based on parent clip's timeline (if attached to a timeline)
736  info.width = parent->ParentTimeline()->preview_width;
737  info.height = parent->ParentTimeline()->preview_height;
738  }
739  }
740  }
741 
742  // Fix invalid video lengths for certain types of files (MP3 for example)
743  if (info.has_video && ((info.duration * info.fps.ToDouble()) - info.video_length > 60)) {
745  }
746 
747  // Add audio metadata (if any found)
748  AVDictionaryEntry *tag = NULL;
749  while ((tag = av_dict_get(aStream->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
750  QString str_key = tag->key;
751  QString str_value = tag->value;
752  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
753  }
754 }
755 
756 void FFmpegReader::UpdateVideoInfo() {
757  if (info.vcodec.length() > 0) {
758  // Skip init - if info struct already populated
759  return;
760  }
761 
762  // Set values of FileInfo struct
763  info.has_video = true;
764  info.file_size = pFormatCtx->pb ? avio_size(pFormatCtx->pb) : -1;
765  info.height = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->height;
766  info.width = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->width;
767  info.vcodec = pCodecCtx->codec->name;
768  info.video_bit_rate = (pFormatCtx->bit_rate / 8);
769 
770  // Frame rate from the container and codec
771  AVRational framerate = av_guess_frame_rate(pFormatCtx, pStream, NULL);
772  if (!check_fps) {
773  info.fps.num = framerate.num;
774  info.fps.den = framerate.den;
775  }
776 
777  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::UpdateVideoInfo", "info.fps.num", info.fps.num, "info.fps.den", info.fps.den);
778 
779  // TODO: remove excessive debug info in the next releases
780  // The debug info below is just for comparison and troubleshooting on users side during the transition period
781  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::UpdateVideoInfo (pStream->avg_frame_rate)", "num", pStream->avg_frame_rate.num, "den", pStream->avg_frame_rate.den);
782 
783  if (pStream->sample_aspect_ratio.num != 0) {
784  info.pixel_ratio.num = pStream->sample_aspect_ratio.num;
785  info.pixel_ratio.den = pStream->sample_aspect_ratio.den;
786  } else if (AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.num != 0) {
787  info.pixel_ratio.num = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.num;
788  info.pixel_ratio.den = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.den;
789  } else {
790  info.pixel_ratio.num = 1;
791  info.pixel_ratio.den = 1;
792  }
793  info.pixel_format = AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx);
794 
795  // Calculate the DAR (display aspect ratio)
797 
798  // Reduce size fraction
799  size.Reduce();
800 
801  // Set the ratio based on the reduced fraction
802  info.display_ratio.num = size.num;
803  info.display_ratio.den = size.den;
804 
805  // Get scan type and order from codec context/params
806  if (!check_interlace) {
807  check_interlace = true;
808  AVFieldOrder field_order = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->field_order;
809  switch(field_order) {
810  case AV_FIELD_PROGRESSIVE:
811  info.interlaced_frame = false;
812  break;
813  case AV_FIELD_TT:
814  case AV_FIELD_TB:
815  info.interlaced_frame = true;
816  info.top_field_first = true;
817  break;
818  case AV_FIELD_BT:
819  case AV_FIELD_BB:
820  info.interlaced_frame = true;
821  info.top_field_first = false;
822  break;
823  case AV_FIELD_UNKNOWN:
824  // Check again later?
825  check_interlace = false;
826  break;
827  }
828  // check_interlace will prevent these checks being repeated,
829  // unless it was cleared because we got an AV_FIELD_UNKNOWN response.
830  }
831 
832  // Set the video timebase
833  info.video_timebase.num = pStream->time_base.num;
834  info.video_timebase.den = pStream->time_base.den;
835 
836  // Set the duration in seconds, and video length (# of frames)
837  info.duration = pStream->duration * info.video_timebase.ToDouble();
838 
839  // Check for valid duration (if found)
840  if (info.duration <= 0.0f && pFormatCtx->duration >= 0) {
841  // Use the format's duration
842  info.duration = float(pFormatCtx->duration) / AV_TIME_BASE;
843  }
844 
845  // Calculate duration from filesize and bitrate (if any)
846  if (info.duration <= 0.0f && info.video_bit_rate > 0 && info.file_size > 0) {
847  // Estimate from bitrate, total bytes, and framerate
849  }
850 
851  // Certain "image" formats do not have a valid duration
852  if (info.duration <= 0.0f && pStream->duration == AV_NOPTS_VALUE && pFormatCtx->duration == AV_NOPTS_VALUE) {
853  // Force an "image" duration
854  info.duration = 60 * 60 * 1; // 1 hour duration
855  info.video_length = 1;
856  info.has_single_image = true;
857  }
858 
859  // Get the # of video frames (if found in stream)
860  // Only set this 1 time (this method can be called multiple times)
861  if (pStream->nb_frames > 0 && info.video_length <= 0) {
862  info.video_length = pStream->nb_frames;
863  }
864 
865  // No duration found in stream of file
866  if (info.duration <= 0.0f) {
867  // No duration is found in the video stream
868  info.duration = -1;
869  info.video_length = -1;
870  is_duration_known = false;
871  } else {
872  // Yes, a duration was found
873  is_duration_known = true;
874 
875  // Calculate number of frames (if not already found in metadata)
876  // Only set this 1 time (this method can be called multiple times)
877  if (info.video_length <= 0) {
879  }
880  }
881 
882  // Add video metadata (if any)
883  AVDictionaryEntry *tag = NULL;
884  while ((tag = av_dict_get(pStream->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
885  QString str_key = tag->key;
886  QString str_value = tag->value;
887  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
888  }
889 }
890 
892  return this->is_duration_known;
893 }
894 
895 std::shared_ptr<Frame> FFmpegReader::GetFrame(int64_t requested_frame) {
896  // Check for open reader (or throw exception)
897  if (!is_open)
898  throw ReaderClosed("The FFmpegReader is closed. Call Open() before calling this method.", path);
899 
900  // Adjust for a requested frame that is too small or too large
901  if (requested_frame < 1)
902  requested_frame = 1;
903  if (requested_frame > info.video_length && is_duration_known)
904  requested_frame = info.video_length;
905  if (info.has_video && info.video_length == 0)
906  // Invalid duration of video file
907  throw InvalidFile("Could not detect the duration of the video or audio stream.", path);
908 
909  // Debug output
910  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "requested_frame", requested_frame, "last_frame", last_frame);
911 
912  // Check the cache for this frame
913  std::shared_ptr<Frame> frame = final_cache.GetFrame(requested_frame);
914  if (frame) {
915  // Debug output
916  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "returned cached frame", requested_frame);
917 
918  // Return the cached frame
919  return frame;
920  } else {
921 
922  // Prevent async calls to the remainder of this code
923  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
924 
925  // Check the cache a 2nd time (due to the potential previous lock)
926  frame = final_cache.GetFrame(requested_frame);
927  if (frame) {
928  // Debug output
929  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "returned cached frame on 2nd look", requested_frame);
930 
931  } else {
932  // Frame is not in cache
933  // Reset seek count
934  seek_count = 0;
935 
936  // Are we within X frames of the requested frame?
937  int64_t diff = requested_frame - last_frame;
938  if (diff >= 1 && diff <= 20) {
939  // Continue walking the stream
940  frame = ReadStream(requested_frame);
941  } else {
942  // Greater than 30 frames away, or backwards, we need to seek to the nearest key frame
943  if (enable_seek) {
944  // Only seek if enabled
945  Seek(requested_frame);
946 
947  } else if (!enable_seek && diff < 0) {
948  // Start over, since we can't seek, and the requested frame is smaller than our position
949  // Since we are seeking to frame 1, this actually just closes/re-opens the reader
950  Seek(1);
951  }
952 
953  // Then continue walking the stream
954  frame = ReadStream(requested_frame);
955  }
956  }
957  return frame;
958  }
959 }
960 
961 // Read the stream until we find the requested Frame
962 std::shared_ptr<Frame> FFmpegReader::ReadStream(int64_t requested_frame) {
963  // Allocate video frame
964  bool check_seek = false;
965  int packet_error = -1;
966 
967  // Debug output
968  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream", "requested_frame", requested_frame, "max_concurrent_frames", max_concurrent_frames);
969 
970  // Loop through the stream until the correct frame is found
971  while (true) {
972  // Check if working frames are 'finished'
973  if (!is_seeking) {
974  // Check for final frames
975  CheckWorkingFrames(requested_frame);
976  }
977 
978  // Check if requested 'final' frame is available (and break out of loop if found)
979  bool is_cache_found = (final_cache.GetFrame(requested_frame) != NULL);
980  if (is_cache_found) {
981  break;
982  }
983 
984  if (!hold_packet || !packet) {
985  // Get the next packet
986  packet_error = GetNextPacket();
987  if (packet_error < 0 && !packet) {
988  // No more packets to be found
989  packet_status.packets_eof = true;
990  }
991  }
992 
993  // Debug output
994  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (GetNextPacket)", "requested_frame", requested_frame,"packets_read", packet_status.packets_read(), "packets_decoded", packet_status.packets_decoded(), "is_seeking", is_seeking);
995 
996  // Check the status of a seek (if any)
997  if (is_seeking) {
998  check_seek = CheckSeek(false);
999  } else {
1000  check_seek = false;
1001  }
1002 
1003  if (check_seek) {
1004  // Packet may become NULL on Close inside Seek if CheckSeek returns false
1005  // Jump to the next iteration of this loop
1006  continue;
1007  }
1008 
1009  // Video packet
1010  if ((info.has_video && packet && packet->stream_index == videoStream) ||
1011  (info.has_video && packet_status.video_decoded < packet_status.video_read) ||
1012  (info.has_video && !packet && !packet_status.video_eof)) {
1013  // Process Video Packet
1014  ProcessVideoPacket(requested_frame);
1015  }
1016  // Audio packet
1017  if ((info.has_audio && packet && packet->stream_index == audioStream) ||
1018  (info.has_audio && !packet && packet_status.audio_decoded < packet_status.audio_read) ||
1019  (info.has_audio && !packet && !packet_status.audio_eof)) {
1020  // Process Audio Packet
1021  ProcessAudioPacket(requested_frame);
1022  }
1023 
1024  // Remove unused packets (sometimes we purposely ignore video or audio packets,
1025  // if the has_video or has_audio properties are manually overridden)
1026  if ((!info.has_video && packet && packet->stream_index == videoStream) ||
1027  (!info.has_audio && packet && packet->stream_index == audioStream)) {
1028  // Keep track of deleted packet counts
1029  if (packet->stream_index == videoStream) {
1030  packet_status.video_decoded++;
1031  } else if (packet->stream_index == audioStream) {
1032  packet_status.audio_decoded++;
1033  }
1034 
1035  // Remove unused packets (sometimes we purposely ignore video or audio packets,
1036  // if the has_video or has_audio properties are manually overridden)
1037  RemoveAVPacket(packet);
1038  packet = NULL;
1039  }
1040 
1041  // Determine end-of-stream (waiting until final decoder threads finish)
1042  // Force end-of-stream in some situations
1043  packet_status.end_of_file = packet_status.packets_eof && packet_status.video_eof && packet_status.audio_eof;
1044  if ((packet_status.packets_eof && packet_status.packets_read() == packet_status.packets_decoded()) || packet_status.end_of_file) {
1045  // Force EOF (end of file) variables to true, if decoder does not support EOF detection.
1046  // If we have no more packets, and all known packets have been decoded
1047  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (force EOF)", "packets_read", packet_status.packets_read(), "packets_decoded", packet_status.packets_decoded(), "packets_eof", packet_status.packets_eof, "video_eof", packet_status.video_eof, "audio_eof", packet_status.audio_eof, "end_of_file", packet_status.end_of_file);
1048  if (!packet_status.video_eof) {
1049  packet_status.video_eof = true;
1050  }
1051  if (!packet_status.audio_eof) {
1052  packet_status.audio_eof = true;
1053  }
1054  packet_status.end_of_file = true;
1055  break;
1056  }
1057  } // end while
1058 
1059  // Debug output
1060  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (Completed)",
1061  "packets_read", packet_status.packets_read(),
1062  "packets_decoded", packet_status.packets_decoded(),
1063  "end_of_file", packet_status.end_of_file,
1064  "largest_frame_processed", largest_frame_processed,
1065  "Working Cache Count", working_cache.Count());
1066 
1067  // Have we reached end-of-stream (or the final frame)?
1068  if (!packet_status.end_of_file && requested_frame >= info.video_length) {
1069  // Force end-of-stream
1070  packet_status.end_of_file = true;
1071  }
1072  if (packet_status.end_of_file) {
1073  // Mark any other working frames as 'finished'
1074  CheckWorkingFrames(requested_frame);
1075  }
1076 
1077  // Return requested frame (if found)
1078  std::shared_ptr<Frame> frame = final_cache.GetFrame(requested_frame);
1079  if (frame)
1080  // Return prepared frame
1081  return frame;
1082  else {
1083 
1084  // Check if largest frame is still cached
1085  frame = final_cache.GetFrame(largest_frame_processed);
1086  int samples_in_frame = Frame::GetSamplesPerFrame(requested_frame, info.fps,
1088  if (frame) {
1089  // Copy and return the largest processed frame (assuming it was the last in the video file)
1090  std::shared_ptr<Frame> f = CreateFrame(largest_frame_processed);
1091 
1092  // Use solid color (if no image data found)
1093  if (!frame->has_image_data) {
1094  // Use solid black frame if no image data available
1095  f->AddColor(info.width, info.height, "#000");
1096  }
1097  // Silence audio data (if any), since we are repeating the last frame
1098  frame->AddAudioSilence(samples_in_frame);
1099 
1100  return frame;
1101  } else {
1102  // The largest processed frame is no longer in cache, return a blank frame
1103  std::shared_ptr<Frame> f = CreateFrame(largest_frame_processed);
1104  f->AddColor(info.width, info.height, "#000");
1105  f->AddAudioSilence(samples_in_frame);
1106  return f;
1107  }
1108  }
1109 
1110 }
1111 
1112 // Get the next packet (if any)
1113 int FFmpegReader::GetNextPacket() {
1114  int found_packet = 0;
1115  AVPacket *next_packet;
1116  next_packet = new AVPacket();
1117  found_packet = av_read_frame(pFormatCtx, next_packet);
1118 
1119  if (packet) {
1120  // Remove previous packet before getting next one
1121  RemoveAVPacket(packet);
1122  packet = NULL;
1123  }
1124  if (found_packet >= 0) {
1125  // Update current packet pointer
1126  packet = next_packet;
1127 
1128  // Keep track of packet stats
1129  if (packet->stream_index == videoStream) {
1130  packet_status.video_read++;
1131  } else if (packet->stream_index == audioStream) {
1132  packet_status.audio_read++;
1133  }
1134  } else {
1135  // No more packets found
1136  delete next_packet;
1137  packet = NULL;
1138  }
1139  // Return if packet was found (or error number)
1140  return found_packet;
1141 }
1142 
1143 // Get an AVFrame (if any)
1144 bool FFmpegReader::GetAVFrame() {
1145  int frameFinished = 0;
1146 
1147  // Decode video frame
1148  AVFrame *next_frame = AV_ALLOCATE_FRAME();
1149 
1150 #if IS_FFMPEG_3_2
1151  int send_packet_err = 0;
1152  int64_t send_packet_pts = 0;
1153  if ((packet && packet->stream_index == videoStream) || !packet) {
1154  send_packet_err = avcodec_send_packet(pCodecCtx, packet);
1155 
1156  if (packet && send_packet_err >= 0) {
1157  send_packet_pts = GetPacketPTS();
1158  hold_packet = false;
1159  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet succeeded)", "send_packet_err", send_packet_err, "send_packet_pts", send_packet_pts);
1160  }
1161  }
1162 
1163  #if USE_HW_ACCEL
1164  // Get the format from the variables set in get_hw_dec_format
1165  hw_de_av_pix_fmt = hw_de_av_pix_fmt_global;
1166  hw_de_av_device_type = hw_de_av_device_type_global;
1167  #endif // USE_HW_ACCEL
1168  if (send_packet_err < 0 && send_packet_err != AVERROR_EOF) {
1169  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: Not sent [" + av_err2string(send_packet_err) + "])", "send_packet_err", send_packet_err, "send_packet_pts", send_packet_pts);
1170  if (send_packet_err == AVERROR(EAGAIN)) {
1171  hold_packet = true;
1172  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(EAGAIN): user must read output with avcodec_receive_frame()", "send_packet_pts", send_packet_pts);
1173  }
1174  if (send_packet_err == AVERROR(EINVAL)) {
1175  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush", "send_packet_pts", send_packet_pts);
1176  }
1177  if (send_packet_err == AVERROR(ENOMEM)) {
1178  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(ENOMEM): failed to add packet to internal queue, or legitimate decoding errors", "send_packet_pts", send_packet_pts);
1179  }
1180  }
1181 
1182  // Always try and receive a packet, if not EOF.
1183  // Even if the above avcodec_send_packet failed to send,
1184  // we might still need to receive a packet.
1185  int receive_frame_err = 0;
1186  AVFrame *next_frame2;
1187 #if USE_HW_ACCEL
1188  if (hw_de_on && hw_de_supported) {
1189  next_frame2 = AV_ALLOCATE_FRAME();
1190  }
1191  else
1192 #endif // USE_HW_ACCEL
1193  {
1194  next_frame2 = next_frame;
1195  }
1196  pFrame = AV_ALLOCATE_FRAME();
1197  while (receive_frame_err >= 0) {
1198  receive_frame_err = avcodec_receive_frame(pCodecCtx, next_frame2);
1199 
1200  if (receive_frame_err != 0) {
1201  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (receive frame: frame not ready yet from decoder [\" + av_err2string(receive_frame_err) + \"])", "receive_frame_err", receive_frame_err, "send_packet_pts", send_packet_pts);
1202 
1203  if (receive_frame_err == AVERROR_EOF) {
1205  "FFmpegReader::GetAVFrame (receive frame: AVERROR_EOF: EOF detected from decoder, flushing buffers)", "send_packet_pts", send_packet_pts);
1206  avcodec_flush_buffers(pCodecCtx);
1207  packet_status.video_eof = true;
1208  }
1209  if (receive_frame_err == AVERROR(EINVAL)) {
1211  "FFmpegReader::GetAVFrame (receive frame: AVERROR(EINVAL): invalid frame received, flushing buffers)", "send_packet_pts", send_packet_pts);
1212  avcodec_flush_buffers(pCodecCtx);
1213  }
1214  if (receive_frame_err == AVERROR(EAGAIN)) {
1216  "FFmpegReader::GetAVFrame (receive frame: AVERROR(EAGAIN): output is not available in this state - user must try to send new input)", "send_packet_pts", send_packet_pts);
1217  }
1218  if (receive_frame_err == AVERROR_INPUT_CHANGED) {
1220  "FFmpegReader::GetAVFrame (receive frame: AVERROR_INPUT_CHANGED: current decoded frame has changed parameters with respect to first decoded frame)", "send_packet_pts", send_packet_pts);
1221  }
1222 
1223  // Break out of decoding loop
1224  // Nothing ready for decoding yet
1225  break;
1226  }
1227 
1228 #if USE_HW_ACCEL
1229  if (hw_de_on && hw_de_supported) {
1230  int err;
1231  if (next_frame2->format == hw_de_av_pix_fmt) {
1232  next_frame->format = AV_PIX_FMT_YUV420P;
1233  if ((err = av_hwframe_transfer_data(next_frame,next_frame2,0)) < 0) {
1234  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (Failed to transfer data to output frame)", "hw_de_on", hw_de_on);
1235  }
1236  if ((err = av_frame_copy_props(next_frame,next_frame2)) < 0) {
1237  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (Failed to copy props to output frame)", "hw_de_on", hw_de_on);
1238  }
1239  }
1240  }
1241  else
1242 #endif // USE_HW_ACCEL
1243  { // No hardware acceleration used -> no copy from GPU memory needed
1244  next_frame = next_frame2;
1245  }
1246 
1247  // TODO also handle possible further frames
1248  // Use only the first frame like avcodec_decode_video2
1249  frameFinished = 1;
1250  packet_status.video_decoded++;
1251 
1252  av_image_alloc(pFrame->data, pFrame->linesize, info.width, info.height, (AVPixelFormat)(pStream->codecpar->format), 1);
1253  av_image_copy(pFrame->data, pFrame->linesize, (const uint8_t**)next_frame->data, next_frame->linesize,
1254  (AVPixelFormat)(pStream->codecpar->format), info.width, info.height);
1255 
1256  // Get display PTS from video frame, often different than packet->pts.
1257  // Sending packets to the decoder (i.e. packet->pts) is async,
1258  // and retrieving packets from the decoder (frame->pts) is async. In most decoders
1259  // sending and retrieving are separated by multiple calls to this method.
1260  if (next_frame->pts != AV_NOPTS_VALUE) {
1261  // This is the current decoded frame (and should be the pts used) for
1262  // processing this data
1263  video_pts = next_frame->pts;
1264  } else if (next_frame->pkt_dts != AV_NOPTS_VALUE) {
1265  // Some videos only set this timestamp (fallback)
1266  video_pts = next_frame->pkt_dts;
1267  }
1268 
1270  "FFmpegReader::GetAVFrame (Successful frame received)", "video_pts", video_pts, "send_packet_pts", send_packet_pts);
1271 
1272  // break out of loop after each successful image returned
1273  break;
1274  }
1275 #if USE_HW_ACCEL
1276  if (hw_de_on && hw_de_supported) {
1277  AV_FREE_FRAME(&next_frame2);
1278  }
1279  #endif // USE_HW_ACCEL
1280 #else
1281  avcodec_decode_video2(pCodecCtx, next_frame, &frameFinished, packet);
1282 
1283  // always allocate pFrame (because we do that in the ffmpeg >= 3.2 as well); it will always be freed later
1284  pFrame = AV_ALLOCATE_FRAME();
1285 
1286  // is frame finished
1287  if (frameFinished) {
1288  // AVFrames are clobbered on the each call to avcodec_decode_video, so we
1289  // must make a copy of the image data before this method is called again.
1290  avpicture_alloc((AVPicture *) pFrame, pCodecCtx->pix_fmt, info.width, info.height);
1291  av_picture_copy((AVPicture *) pFrame, (AVPicture *) next_frame, pCodecCtx->pix_fmt, info.width,
1292  info.height);
1293  }
1294 #endif // IS_FFMPEG_3_2
1295 
1296  // deallocate the frame
1297  AV_FREE_FRAME(&next_frame);
1298 
1299  // Did we get a video frame?
1300  return frameFinished;
1301 }
1302 
1303 // Check the current seek position and determine if we need to seek again
1304 bool FFmpegReader::CheckSeek(bool is_video) {
1305  // Are we seeking for a specific frame?
1306  if (is_seeking) {
1307  // Determine if both an audio and video packet have been decoded since the seek happened.
1308  // If not, allow the ReadStream method to keep looping
1309  if ((is_video_seek && !seek_video_frame_found) || (!is_video_seek && !seek_audio_frame_found))
1310  return false;
1311 
1312  // Check for both streams
1313  if ((info.has_video && !seek_video_frame_found) || (info.has_audio && !seek_audio_frame_found))
1314  return false;
1315 
1316  // Determine max seeked frame
1317  int64_t max_seeked_frame = std::max(seek_audio_frame_found, seek_video_frame_found);
1318 
1319  // determine if we are "before" the requested frame
1320  if (max_seeked_frame >= seeking_frame) {
1321  // SEEKED TOO FAR
1322  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckSeek (Too far, seek again)",
1323  "is_video_seek", is_video_seek,
1324  "max_seeked_frame", max_seeked_frame,
1325  "seeking_frame", seeking_frame,
1326  "seeking_pts", seeking_pts,
1327  "seek_video_frame_found", seek_video_frame_found,
1328  "seek_audio_frame_found", seek_audio_frame_found);
1329 
1330  // Seek again... to the nearest Keyframe
1331  Seek(seeking_frame - (10 * seek_count * seek_count));
1332  } else {
1333  // SEEK WORKED
1334  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckSeek (Successful)",
1335  "is_video_seek", is_video_seek,
1336  "packet->pts", GetPacketPTS(),
1337  "seeking_pts", seeking_pts,
1338  "seeking_frame", seeking_frame,
1339  "seek_video_frame_found", seek_video_frame_found,
1340  "seek_audio_frame_found", seek_audio_frame_found);
1341 
1342  // Seek worked, and we are "before" the requested frame
1343  is_seeking = false;
1344  seeking_frame = 0;
1345  seeking_pts = -1;
1346  }
1347  }
1348 
1349  // return the pts to seek to (if any)
1350  return is_seeking;
1351 }
1352 
1353 // Process a video packet
1354 void FFmpegReader::ProcessVideoPacket(int64_t requested_frame) {
1355  // Get the AVFrame from the current packet
1356  // This sets the video_pts to the correct timestamp
1357  int frame_finished = GetAVFrame();
1358 
1359  // Check if the AVFrame is finished and set it
1360  if (!frame_finished) {
1361  // No AVFrame decoded yet, bail out
1362  if (pFrame) {
1363  RemoveAVFrame(pFrame);
1364  }
1365  return;
1366  }
1367 
1368  // Calculate current frame #
1369  int64_t current_frame = ConvertVideoPTStoFrame(video_pts);
1370 
1371  // Track 1st video packet after a successful seek
1372  if (!seek_video_frame_found && is_seeking)
1373  seek_video_frame_found = current_frame;
1374 
1375  // Create or get the existing frame object. Requested frame needs to be created
1376  // in working_cache at least once. Seek can clear the working_cache, so we must
1377  // add the requested frame back to the working_cache here. If it already exists,
1378  // it will be moved to the top of the working_cache.
1379  working_cache.Add(CreateFrame(requested_frame));
1380 
1381  // Debug output
1382  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessVideoPacket (Before)", "requested_frame", requested_frame, "current_frame", current_frame);
1383 
1384  // Init some things local (for OpenMP)
1385  PixelFormat pix_fmt = AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx);
1386  int height = info.height;
1387  int width = info.width;
1388  int64_t video_length = info.video_length;
1389 
1390  // Create variables for a RGB Frame (since most videos are not in RGB, we must convert it)
1391  AVFrame *pFrameRGB = nullptr;
1392  uint8_t *buffer = nullptr;
1393 
1394  // Allocate an AVFrame structure
1395  pFrameRGB = AV_ALLOCATE_FRAME();
1396  if (pFrameRGB == nullptr)
1397  throw OutOfMemory("Failed to allocate frame buffer", path);
1398 
1399  // Determine the max size of this source image (based on the timeline's size, the scaling mode,
1400  // and the scaling keyframes). This is a performance improvement, to keep the images as small as possible,
1401  // without losing quality. NOTE: We cannot go smaller than the timeline itself, or the add_layer timeline
1402  // method will scale it back to timeline size before scaling it smaller again. This needs to be fixed in
1403  // the future.
1404  int max_width = info.width;
1405  int max_height = info.height;
1406 
1407  Clip *parent = static_cast<Clip *>(ParentClip());
1408  if (parent) {
1409  if (parent->ParentTimeline()) {
1410  // Set max width/height based on parent clip's timeline (if attached to a timeline)
1411  max_width = parent->ParentTimeline()->preview_width;
1412  max_height = parent->ParentTimeline()->preview_height;
1413  }
1414  if (parent->scale == SCALE_FIT || parent->scale == SCALE_STRETCH) {
1415  // Best fit or Stretch scaling (based on max timeline size * scaling keyframes)
1416  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1417  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1418  max_width = std::max(float(max_width), max_width * max_scale_x);
1419  max_height = std::max(float(max_height), max_height * max_scale_y);
1420 
1421  } else if (parent->scale == SCALE_CROP) {
1422  // Cropping scale mode (based on max timeline size * cropped size * scaling keyframes)
1423  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1424  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1425  QSize width_size(max_width * max_scale_x,
1426  round(max_width / (float(info.width) / float(info.height))));
1427  QSize height_size(round(max_height / (float(info.height) / float(info.width))),
1428  max_height * max_scale_y);
1429  // respect aspect ratio
1430  if (width_size.width() >= max_width && width_size.height() >= max_height) {
1431  max_width = std::max(max_width, width_size.width());
1432  max_height = std::max(max_height, width_size.height());
1433  } else {
1434  max_width = std::max(max_width, height_size.width());
1435  max_height = std::max(max_height, height_size.height());
1436  }
1437 
1438  } else {
1439  // Scale video to equivalent unscaled size
1440  // Since the preview window can change sizes, we want to always
1441  // scale against the ratio of original video size to timeline size
1442  float preview_ratio = 1.0;
1443  if (parent->ParentTimeline()) {
1444  Timeline *t = (Timeline *) parent->ParentTimeline();
1445  preview_ratio = t->preview_width / float(t->info.width);
1446  }
1447  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1448  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1449  max_width = info.width * max_scale_x * preview_ratio;
1450  max_height = info.height * max_scale_y * preview_ratio;
1451  }
1452  }
1453 
1454  // Determine if image needs to be scaled (for performance reasons)
1455  int original_height = height;
1456  if (max_width != 0 && max_height != 0 && max_width < width && max_height < height) {
1457  // Override width and height (but maintain aspect ratio)
1458  float ratio = float(width) / float(height);
1459  int possible_width = round(max_height * ratio);
1460  int possible_height = round(max_width / ratio);
1461 
1462  if (possible_width <= max_width) {
1463  // use calculated width, and max_height
1464  width = possible_width;
1465  height = max_height;
1466  } else {
1467  // use max_width, and calculated height
1468  width = max_width;
1469  height = possible_height;
1470  }
1471  }
1472 
1473  // Determine required buffer size and allocate buffer
1474  const int bytes_per_pixel = 4;
1475  int buffer_size = (width * height * bytes_per_pixel) + 128;
1476  buffer = new unsigned char[buffer_size]();
1477 
1478  // Copy picture data from one AVFrame (or AVPicture) to another one.
1479  AV_COPY_PICTURE_DATA(pFrameRGB, buffer, PIX_FMT_RGBA, width, height);
1480 
1481  int scale_mode = SWS_FAST_BILINEAR;
1482  if (openshot::Settings::Instance()->HIGH_QUALITY_SCALING) {
1483  scale_mode = SWS_BICUBIC;
1484  }
1485  SwsContext *img_convert_ctx = sws_getContext(info.width, info.height, AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx), width,
1486  height, PIX_FMT_RGBA, scale_mode, NULL, NULL, NULL);
1487 
1488  // Resize / Convert to RGB
1489  sws_scale(img_convert_ctx, pFrame->data, pFrame->linesize, 0,
1490  original_height, pFrameRGB->data, pFrameRGB->linesize);
1491 
1492  // Create or get the existing frame object
1493  std::shared_ptr<Frame> f = CreateFrame(current_frame);
1494 
1495  // Add Image data to frame
1496  if (!ffmpeg_has_alpha(AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx))) {
1497  // Add image with no alpha channel, Speed optimization
1498  f->AddImage(width, height, bytes_per_pixel, QImage::Format_RGBA8888_Premultiplied, buffer);
1499  } else {
1500  // Add image with alpha channel (this will be converted to premultipled when needed, but is slower)
1501  f->AddImage(width, height, bytes_per_pixel, QImage::Format_RGBA8888, buffer);
1502  }
1503 
1504  // Update working cache
1505  working_cache.Add(f);
1506 
1507  // Keep track of last last_video_frame
1508  last_video_frame = f;
1509 
1510  // Free the RGB image
1511  AV_FREE_FRAME(&pFrameRGB);
1512 
1513  // Remove frame and packet
1514  RemoveAVFrame(pFrame);
1515  sws_freeContext(img_convert_ctx);
1516 
1517  // Get video PTS in seconds
1518  video_pts_seconds = (double(video_pts) * info.video_timebase.ToDouble()) + pts_offset_seconds;
1519 
1520  // Debug output
1521  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessVideoPacket (After)", "requested_frame", requested_frame, "current_frame", current_frame, "f->number", f->number, "video_pts_seconds", video_pts_seconds);
1522 }
1523 
1524 // Process an audio packet
1525 void FFmpegReader::ProcessAudioPacket(int64_t requested_frame) {
1526  AudioLocation location;
1527  // Calculate location of current audio packet
1528  if (packet && packet->pts != AV_NOPTS_VALUE) {
1529  // Determine related video frame and starting sample # from audio PTS
1530  location = GetAudioPTSLocation(packet->pts);
1531 
1532  // Track 1st audio packet after a successful seek
1533  if (!seek_audio_frame_found && is_seeking)
1534  seek_audio_frame_found = location.frame;
1535  }
1536 
1537  // Create or get the existing frame object. Requested frame needs to be created
1538  // in working_cache at least once. Seek can clear the working_cache, so we must
1539  // add the requested frame back to the working_cache here. If it already exists,
1540  // it will be moved to the top of the working_cache.
1541  working_cache.Add(CreateFrame(requested_frame));
1542 
1543  // Debug output
1544  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (Before)",
1545  "requested_frame", requested_frame,
1546  "target_frame", location.frame,
1547  "starting_sample", location.sample_start);
1548 
1549  // Init an AVFrame to hold the decoded audio samples
1550  int frame_finished = 0;
1551  AVFrame *audio_frame = AV_ALLOCATE_FRAME();
1552  AV_RESET_FRAME(audio_frame);
1553 
1554  int packet_samples = 0;
1555  int data_size = 0;
1556 
1557 #if IS_FFMPEG_3_2
1558  int send_packet_err = avcodec_send_packet(aCodecCtx, packet);
1559  if (send_packet_err < 0 && send_packet_err != AVERROR_EOF) {
1560  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (Packet not sent)");
1561  }
1562  else {
1563  int receive_frame_err = avcodec_receive_frame(aCodecCtx, audio_frame);
1564  if (receive_frame_err >= 0) {
1565  frame_finished = 1;
1566  }
1567  if (receive_frame_err == AVERROR_EOF) {
1568  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (EOF detected from decoder)");
1569  packet_status.audio_eof = true;
1570  }
1571  if (receive_frame_err == AVERROR(EINVAL) || receive_frame_err == AVERROR_EOF) {
1572  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (invalid frame received or EOF from decoder)");
1573  avcodec_flush_buffers(aCodecCtx);
1574  }
1575  if (receive_frame_err != 0) {
1576  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (frame not ready yet from decoder)");
1577  }
1578  }
1579 #else
1580  int used = avcodec_decode_audio4(aCodecCtx, audio_frame, &frame_finished, packet);
1581 #endif
1582 
1583  if (frame_finished) {
1584  packet_status.audio_decoded++;
1585 
1586  // This can be different than the current packet, so we need to look
1587  // at the current AVFrame from the audio decoder. This timestamp should
1588  // be used for the remainder of this function
1589  audio_pts = audio_frame->pts;
1590 
1591  // Determine related video frame and starting sample # from audio PTS
1592  location = GetAudioPTSLocation(audio_pts);
1593 
1594  // determine how many samples were decoded
1595  int plane_size = -1;
1596  data_size = av_samples_get_buffer_size(&plane_size, AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels,
1597  audio_frame->nb_samples, (AVSampleFormat) (AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx)), 1);
1598 
1599  // Calculate total number of samples
1600  packet_samples = audio_frame->nb_samples * AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels;
1601  } else {
1602  if (audio_frame) {
1603  // Free audio frame
1604  AV_FREE_FRAME(&audio_frame);
1605  }
1606  }
1607 
1608  // Estimate the # of samples and the end of this packet's location (to prevent GAPS for the next timestamp)
1609  int pts_remaining_samples = packet_samples / info.channels; // Adjust for zero based array
1610 
1611  // Bail if no samples found
1612  if (pts_remaining_samples == 0) {
1613  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (No samples, bailing)",
1614  "packet_samples", packet_samples,
1615  "info.channels", info.channels,
1616  "pts_remaining_samples", pts_remaining_samples);
1617  return;
1618  }
1619 
1620  while (pts_remaining_samples) {
1621  // Get Samples per frame (for this frame number)
1622  int samples_per_frame = Frame::GetSamplesPerFrame(previous_packet_location.frame, info.fps, info.sample_rate, info.channels);
1623 
1624  // Calculate # of samples to add to this frame
1625  int samples = samples_per_frame - previous_packet_location.sample_start;
1626  if (samples > pts_remaining_samples)
1627  samples = pts_remaining_samples;
1628 
1629  // Decrement remaining samples
1630  pts_remaining_samples -= samples;
1631 
1632  if (pts_remaining_samples > 0) {
1633  // next frame
1634  previous_packet_location.frame++;
1635  previous_packet_location.sample_start = 0;
1636  } else {
1637  // Increment sample start
1638  previous_packet_location.sample_start += samples;
1639  }
1640  }
1641 
1642  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (ReSample)",
1643  "packet_samples", packet_samples,
1644  "info.channels", info.channels,
1645  "info.sample_rate", info.sample_rate,
1646  "aCodecCtx->sample_fmt", AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx));
1647 
1648  // Create output frame
1649  AVFrame *audio_converted = AV_ALLOCATE_FRAME();
1650  AV_RESET_FRAME(audio_converted);
1651  audio_converted->nb_samples = audio_frame->nb_samples;
1652  av_samples_alloc(audio_converted->data, audio_converted->linesize, info.channels, audio_frame->nb_samples, AV_SAMPLE_FMT_FLTP, 0);
1653 
1654  SWRCONTEXT *avr = NULL;
1655 
1656  // setup resample context
1657  avr = SWR_ALLOC();
1658  av_opt_set_int(avr, "in_channel_layout", AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout, 0);
1659  av_opt_set_int(avr, "out_channel_layout", AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout, 0);
1660  av_opt_set_int(avr, "in_sample_fmt", AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx), 0);
1661  av_opt_set_int(avr, "out_sample_fmt", AV_SAMPLE_FMT_FLTP, 0);
1662  av_opt_set_int(avr, "in_sample_rate", info.sample_rate, 0);
1663  av_opt_set_int(avr, "out_sample_rate", info.sample_rate, 0);
1664  av_opt_set_int(avr, "in_channels", info.channels, 0);
1665  av_opt_set_int(avr, "out_channels", info.channels, 0);
1666  SWR_INIT(avr);
1667 
1668  // Convert audio samples
1669  int nb_samples = SWR_CONVERT(avr, // audio resample context
1670  audio_converted->data, // output data pointers
1671  audio_converted->linesize[0], // output plane size, in bytes. (0 if unknown)
1672  audio_converted->nb_samples, // maximum number of samples that the output buffer can hold
1673  audio_frame->data, // input data pointers
1674  audio_frame->linesize[0], // input plane size, in bytes (0 if unknown)
1675  audio_frame->nb_samples); // number of input samples to convert
1676 
1677  // Deallocate resample buffer
1678  SWR_CLOSE(avr);
1679  SWR_FREE(&avr);
1680  avr = NULL;
1681 
1682  int64_t starting_frame_number = -1;
1683  for (int channel_filter = 0; channel_filter < info.channels; channel_filter++) {
1684  // Array of floats (to hold samples for each channel)
1685  starting_frame_number = location.frame;
1686  int channel_buffer_size = nb_samples;
1687  auto *channel_buffer = (float *) (audio_converted->data[channel_filter]);
1688 
1689  // Loop through samples, and add them to the correct frames
1690  int start = location.sample_start;
1691  int remaining_samples = channel_buffer_size;
1692  while (remaining_samples > 0) {
1693  // Get Samples per frame (for this frame number)
1694  int samples_per_frame = Frame::GetSamplesPerFrame(starting_frame_number, info.fps, info.sample_rate, info.channels);
1695 
1696  // Calculate # of samples to add to this frame
1697  int samples = std::fmin(samples_per_frame - start, remaining_samples);
1698 
1699  // Create or get the existing frame object
1700  std::shared_ptr<Frame> f = CreateFrame(starting_frame_number);
1701 
1702  // Add samples for current channel to the frame.
1703  f->AddAudio(true, channel_filter, start, channel_buffer, samples, 1.0f);
1704 
1705  // Debug output
1706  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (f->AddAudio)",
1707  "frame", starting_frame_number,
1708  "start", start,
1709  "samples", samples,
1710  "channel", channel_filter,
1711  "samples_per_frame", samples_per_frame);
1712 
1713  // Add or update cache
1714  working_cache.Add(f);
1715 
1716  // Decrement remaining samples
1717  remaining_samples -= samples;
1718 
1719  // Increment buffer (to next set of samples)
1720  if (remaining_samples > 0)
1721  channel_buffer += samples;
1722 
1723  // Increment frame number
1724  starting_frame_number++;
1725 
1726  // Reset starting sample #
1727  start = 0;
1728  }
1729  }
1730 
1731  // Free AVFrames
1732  av_free(audio_converted->data[0]);
1733  AV_FREE_FRAME(&audio_converted);
1734  AV_FREE_FRAME(&audio_frame);
1735 
1736  // Get audio PTS in seconds
1737  audio_pts_seconds = (double(audio_pts) * info.audio_timebase.ToDouble()) + pts_offset_seconds;
1738 
1739  // Debug output
1740  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (After)",
1741  "requested_frame", requested_frame,
1742  "starting_frame", location.frame,
1743  "end_frame", starting_frame_number - 1,
1744  "audio_pts_seconds", audio_pts_seconds);
1745 
1746 }
1747 
1748 
1749 // Seek to a specific frame. This is not always frame accurate, it's more of an estimation on many codecs.
1750 void FFmpegReader::Seek(int64_t requested_frame) {
1751  // Adjust for a requested frame that is too small or too large
1752  if (requested_frame < 1)
1753  requested_frame = 1;
1754  if (requested_frame > info.video_length)
1755  requested_frame = info.video_length;
1756  if (requested_frame > largest_frame_processed && packet_status.end_of_file) {
1757  // Not possible to search past largest_frame once EOF is reached (no more packets)
1758  return;
1759  }
1760 
1761  // Debug output
1762  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::Seek",
1763  "requested_frame", requested_frame,
1764  "seek_count", seek_count,
1765  "last_frame", last_frame);
1766 
1767  // Clear working cache (since we are seeking to another location in the file)
1768  working_cache.Clear();
1769 
1770  // Reset the last frame variable
1771  video_pts = 0.0;
1772  video_pts_seconds = NO_PTS_OFFSET;
1773  audio_pts = 0.0;
1774  audio_pts_seconds = NO_PTS_OFFSET;
1775  hold_packet = false;
1776  last_frame = 0;
1777  current_video_frame = 0;
1778  largest_frame_processed = 0;
1779  bool has_audio_override = info.has_audio;
1780  bool has_video_override = info.has_video;
1781 
1782  // Init end-of-file detection variables
1783  packet_status.reset(false);
1784 
1785  // Increment seek count
1786  seek_count++;
1787 
1788  // If seeking near frame 1, we need to close and re-open the file (this is more reliable than seeking)
1789  int buffer_amount = std::max(max_concurrent_frames, 8);
1790  if (requested_frame - buffer_amount < 20) {
1791  // prevent Open() from seeking again
1792  is_seeking = true;
1793 
1794  // Close and re-open file (basically seeking to frame 1)
1795  Close();
1796  Open();
1797 
1798  // Update overrides (since closing and re-opening might update these)
1799  info.has_audio = has_audio_override;
1800  info.has_video = has_video_override;
1801 
1802  // Not actually seeking, so clear these flags
1803  is_seeking = false;
1804  if (seek_count == 1) {
1805  // Don't redefine this on multiple seek attempts for a specific frame
1806  seeking_frame = 1;
1807  seeking_pts = ConvertFrameToVideoPTS(1);
1808  }
1809  seek_audio_frame_found = 0; // used to detect which frames to throw away after a seek
1810  seek_video_frame_found = 0; // used to detect which frames to throw away after a seek
1811 
1812  } else {
1813  // Seek to nearest key-frame (aka, i-frame)
1814  bool seek_worked = false;
1815  int64_t seek_target = 0;
1816 
1817  // Seek video stream (if any), except album arts
1818  if (!seek_worked && info.has_video && !HasAlbumArt()) {
1819  seek_target = ConvertFrameToVideoPTS(requested_frame - buffer_amount);
1820  if (av_seek_frame(pFormatCtx, info.video_stream_index, seek_target, AVSEEK_FLAG_BACKWARD) < 0) {
1821  fprintf(stderr, "%s: error while seeking video stream\n", pFormatCtx->AV_FILENAME);
1822  } else {
1823  // VIDEO SEEK
1824  is_video_seek = true;
1825  seek_worked = true;
1826  }
1827  }
1828 
1829  // Seek audio stream (if not already seeked... and if an audio stream is found)
1830  if (!seek_worked && info.has_audio) {
1831  seek_target = ConvertFrameToAudioPTS(requested_frame - buffer_amount);
1832  if (av_seek_frame(pFormatCtx, info.audio_stream_index, seek_target, AVSEEK_FLAG_BACKWARD) < 0) {
1833  fprintf(stderr, "%s: error while seeking audio stream\n", pFormatCtx->AV_FILENAME);
1834  } else {
1835  // AUDIO SEEK
1836  is_video_seek = false;
1837  seek_worked = true;
1838  }
1839  }
1840 
1841  // Was the seek successful?
1842  if (seek_worked) {
1843  // Flush audio buffer
1844  if (info.has_audio)
1845  avcodec_flush_buffers(aCodecCtx);
1846 
1847  // Flush video buffer
1848  if (info.has_video)
1849  avcodec_flush_buffers(pCodecCtx);
1850 
1851  // Reset previous audio location to zero
1852  previous_packet_location.frame = -1;
1853  previous_packet_location.sample_start = 0;
1854 
1855  // init seek flags
1856  is_seeking = true;
1857  if (seek_count == 1) {
1858  // Don't redefine this on multiple seek attempts for a specific frame
1859  seeking_pts = seek_target;
1860  seeking_frame = requested_frame;
1861  }
1862  seek_audio_frame_found = 0; // used to detect which frames to throw away after a seek
1863  seek_video_frame_found = 0; // used to detect which frames to throw away after a seek
1864 
1865  } else {
1866  // seek failed
1867  seeking_pts = 0;
1868  seeking_frame = 0;
1869 
1870  // prevent Open() from seeking again
1871  is_seeking = true;
1872 
1873  // Close and re-open file (basically seeking to frame 1)
1874  Close();
1875  Open();
1876 
1877  // Not actually seeking, so clear these flags
1878  is_seeking = false;
1879 
1880  // disable seeking for this reader (since it failed)
1881  enable_seek = false;
1882 
1883  // Update overrides (since closing and re-opening might update these)
1884  info.has_audio = has_audio_override;
1885  info.has_video = has_video_override;
1886  }
1887  }
1888 }
1889 
1890 // Get the PTS for the current video packet
1891 int64_t FFmpegReader::GetPacketPTS() {
1892  if (packet) {
1893  int64_t current_pts = packet->pts;
1894  if (current_pts == AV_NOPTS_VALUE && packet->dts != AV_NOPTS_VALUE)
1895  current_pts = packet->dts;
1896 
1897  // Return adjusted PTS
1898  return current_pts;
1899  } else {
1900  // No packet, return NO PTS
1901  return AV_NOPTS_VALUE;
1902  }
1903 }
1904 
1905 // Update PTS Offset (if any)
1906 void FFmpegReader::UpdatePTSOffset() {
1907  if (pts_offset_seconds != NO_PTS_OFFSET) {
1908  // Skip this method if we have already set PTS offset
1909  return;
1910  }
1911  pts_offset_seconds = 0.0;
1912  double video_pts_offset_seconds = 0.0;
1913  double audio_pts_offset_seconds = 0.0;
1914 
1915  bool has_video_pts = false;
1916  if (!info.has_video) {
1917  // Mark as checked
1918  has_video_pts = true;
1919  }
1920  bool has_audio_pts = false;
1921  if (!info.has_audio) {
1922  // Mark as checked
1923  has_audio_pts = true;
1924  }
1925 
1926  // Loop through the stream (until a packet from all streams is found)
1927  while (!has_video_pts || !has_audio_pts) {
1928  // Get the next packet (if any)
1929  if (GetNextPacket() < 0)
1930  // Break loop when no more packets found
1931  break;
1932 
1933  // Get PTS of this packet
1934  int64_t pts = GetPacketPTS();
1935 
1936  // Video packet
1937  if (!has_video_pts && packet->stream_index == videoStream) {
1938  // Get the video packet start time (in seconds)
1939  video_pts_offset_seconds = 0.0 - (video_pts * info.video_timebase.ToDouble());
1940 
1941  // Is timestamp close to zero (within X seconds)
1942  // Ignore wildly invalid timestamps (i.e. -234923423423)
1943  if (std::abs(video_pts_offset_seconds) <= 10.0) {
1944  has_video_pts = true;
1945  }
1946  }
1947  else if (!has_audio_pts && packet->stream_index == audioStream) {
1948  // Get the audio packet start time (in seconds)
1949  audio_pts_offset_seconds = 0.0 - (pts * info.audio_timebase.ToDouble());
1950 
1951  // Is timestamp close to zero (within X seconds)
1952  // Ignore wildly invalid timestamps (i.e. -234923423423)
1953  if (std::abs(audio_pts_offset_seconds) <= 10.0) {
1954  has_audio_pts = true;
1955  }
1956  }
1957  }
1958 
1959  // Do we have all valid timestamps to determine PTS offset?
1960  if (has_video_pts && has_audio_pts) {
1961  // Set PTS Offset to the smallest offset
1962  // [ video timestamp ]
1963  // [ audio timestamp ]
1964  //
1965  // ** SHIFT TIMESTAMPS TO ZERO **
1966  //
1967  //[ video timestamp ]
1968  // [ audio timestamp ]
1969  //
1970  // Since all offsets are negative at this point, we want the max value, which
1971  // represents the closest to zero
1972  pts_offset_seconds = std::max(video_pts_offset_seconds, audio_pts_offset_seconds);
1973  }
1974 }
1975 
1976 // Convert PTS into Frame Number
1977 int64_t FFmpegReader::ConvertVideoPTStoFrame(int64_t pts) {
1978  // Apply PTS offset
1979  int64_t previous_video_frame = current_video_frame;
1980 
1981  // Get the video packet start time (in seconds)
1982  double video_seconds = (double(pts) * info.video_timebase.ToDouble()) + pts_offset_seconds;
1983 
1984  // Divide by the video timebase, to get the video frame number (frame # is decimal at this point)
1985  int64_t frame = round(video_seconds * info.fps.ToDouble()) + 1;
1986 
1987  // Keep track of the expected video frame #
1988  if (current_video_frame == 0)
1989  current_video_frame = frame;
1990  else {
1991 
1992  // Sometimes frames are duplicated due to identical (or similar) timestamps
1993  if (frame == previous_video_frame) {
1994  // return -1 frame number
1995  frame = -1;
1996  } else {
1997  // Increment expected frame
1998  current_video_frame++;
1999  }
2000  }
2001 
2002  // Return frame #
2003  return frame;
2004 }
2005 
2006 // Convert Frame Number into Video PTS
2007 int64_t FFmpegReader::ConvertFrameToVideoPTS(int64_t frame_number) {
2008  // Get timestamp of this frame (in seconds)
2009  double seconds = (double(frame_number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2010 
2011  // Calculate the # of video packets in this timestamp
2012  int64_t video_pts = round(seconds / info.video_timebase.ToDouble());
2013 
2014  // Apply PTS offset (opposite)
2015  return video_pts;
2016 }
2017 
2018 // Convert Frame Number into Video PTS
2019 int64_t FFmpegReader::ConvertFrameToAudioPTS(int64_t frame_number) {
2020  // Get timestamp of this frame (in seconds)
2021  double seconds = (double(frame_number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2022 
2023  // Calculate the # of audio packets in this timestamp
2024  int64_t audio_pts = round(seconds / info.audio_timebase.ToDouble());
2025 
2026  // Apply PTS offset (opposite)
2027  return audio_pts;
2028 }
2029 
2030 // Calculate Starting video frame and sample # for an audio PTS
2031 AudioLocation FFmpegReader::GetAudioPTSLocation(int64_t pts) {
2032  // Get the audio packet start time (in seconds)
2033  double audio_seconds = (double(pts) * info.audio_timebase.ToDouble()) + pts_offset_seconds;
2034 
2035  // Divide by the video timebase, to get the video frame number (frame # is decimal at this point)
2036  double frame = (audio_seconds * info.fps.ToDouble()) + 1;
2037 
2038  // Frame # as a whole number (no more decimals)
2039  int64_t whole_frame = int64_t(frame);
2040 
2041  // Remove the whole number, and only get the decimal of the frame
2042  double sample_start_percentage = frame - double(whole_frame);
2043 
2044  // Get Samples per frame
2045  int samples_per_frame = Frame::GetSamplesPerFrame(whole_frame, info.fps, info.sample_rate, info.channels);
2046 
2047  // Calculate the sample # to start on
2048  int sample_start = round(double(samples_per_frame) * sample_start_percentage);
2049 
2050  // Protect against broken (i.e. negative) timestamps
2051  if (whole_frame < 1)
2052  whole_frame = 1;
2053  if (sample_start < 0)
2054  sample_start = 0;
2055 
2056  // Prepare final audio packet location
2057  AudioLocation location = {whole_frame, sample_start};
2058 
2059  // Compare to previous audio packet (and fix small gaps due to varying PTS timestamps)
2060  if (previous_packet_location.frame != -1) {
2061  if (location.is_near(previous_packet_location, samples_per_frame, samples_per_frame)) {
2062  int64_t orig_frame = location.frame;
2063  int orig_start = location.sample_start;
2064 
2065  // Update sample start, to prevent gaps in audio
2066  location.sample_start = previous_packet_location.sample_start;
2067  location.frame = previous_packet_location.frame;
2068 
2069  // Debug output
2070  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAudioPTSLocation (Audio Gap Detected)", "Source Frame", orig_frame, "Source Audio Sample", orig_start, "Target Frame", location.frame, "Target Audio Sample", location.sample_start, "pts", pts);
2071 
2072  } else {
2073  // Debug output
2074  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAudioPTSLocation (Audio Gap Ignored - too big)", "Previous location frame", previous_packet_location.frame, "Target Frame", location.frame, "Target Audio Sample", location.sample_start, "pts", pts);
2075  }
2076  }
2077 
2078  // Set previous location
2079  previous_packet_location = location;
2080 
2081  // Return the associated video frame and starting sample #
2082  return location;
2083 }
2084 
2085 // Create a new Frame (or return an existing one) and add it to the working queue.
2086 std::shared_ptr<Frame> FFmpegReader::CreateFrame(int64_t requested_frame) {
2087  // Check working cache
2088  std::shared_ptr<Frame> output = working_cache.GetFrame(requested_frame);
2089 
2090  if (!output) {
2091  // (re-)Check working cache
2092  output = working_cache.GetFrame(requested_frame);
2093  if(output) return output;
2094 
2095  // Create a new frame on the working cache
2096  output = std::make_shared<Frame>(requested_frame, info.width, info.height, "#000000", Frame::GetSamplesPerFrame(requested_frame, info.fps, info.sample_rate, info.channels), info.channels);
2097  output->SetPixelRatio(info.pixel_ratio.num, info.pixel_ratio.den); // update pixel ratio
2098  output->ChannelsLayout(info.channel_layout); // update audio channel layout from the parent reader
2099  output->SampleRate(info.sample_rate); // update the frame's sample rate of the parent reader
2100 
2101  working_cache.Add(output);
2102 
2103  // Set the largest processed frame (if this is larger)
2104  if (requested_frame > largest_frame_processed)
2105  largest_frame_processed = requested_frame;
2106  }
2107  // Return frame
2108  return output;
2109 }
2110 
2111 // Determine if frame is partial due to seek
2112 bool FFmpegReader::IsPartialFrame(int64_t requested_frame) {
2113 
2114  // Sometimes a seek gets partial frames, and we need to remove them
2115  bool seek_trash = false;
2116  int64_t max_seeked_frame = seek_audio_frame_found; // determine max seeked frame
2117  if (seek_video_frame_found > max_seeked_frame) {
2118  max_seeked_frame = seek_video_frame_found;
2119  }
2120  if ((info.has_audio && seek_audio_frame_found && max_seeked_frame >= requested_frame) ||
2121  (info.has_video && seek_video_frame_found && max_seeked_frame >= requested_frame)) {
2122  seek_trash = true;
2123  }
2124 
2125  return seek_trash;
2126 }
2127 
2128 // Check the working queue, and move finished frames to the finished queue
2129 void FFmpegReader::CheckWorkingFrames(int64_t requested_frame) {
2130 
2131  // Prevent async calls to the following code
2132  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
2133 
2134  // Get a list of current working queue frames in the cache (in-progress frames)
2135  std::vector<std::shared_ptr<openshot::Frame>> working_frames = working_cache.GetFrames();
2136  std::vector<std::shared_ptr<openshot::Frame>>::iterator working_itr;
2137 
2138  // Loop through all working queue frames (sorted by frame #)
2139  for(working_itr = working_frames.begin(); working_itr != working_frames.end(); ++working_itr)
2140  {
2141  // Get working frame
2142  std::shared_ptr<Frame> f = *working_itr;
2143 
2144  // Was a frame found? Is frame requested yet?
2145  if (!f || f->number > requested_frame) {
2146  // If not, skip to next one
2147  continue;
2148  }
2149 
2150  // Calculate PTS in seconds (of working frame), and the most recent processed pts value
2151  double frame_pts_seconds = (double(f->number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2152  double recent_pts_seconds = std::max(video_pts_seconds, audio_pts_seconds);
2153 
2154  // Determine if video and audio are ready (based on timestamps)
2155  bool is_video_ready = false;
2156  bool is_audio_ready = false;
2157  double recent_pts_diff = recent_pts_seconds - frame_pts_seconds;
2158  if ((frame_pts_seconds <= video_pts_seconds)
2159  || (recent_pts_diff > 1.5)
2160  || packet_status.video_eof || packet_status.end_of_file) {
2161  // Video stream is past this frame (so it must be done)
2162  // OR video stream is too far behind, missing, or end-of-file
2163  is_video_ready = true;
2164  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (video ready)",
2165  "frame_number", f->number,
2166  "frame_pts_seconds", frame_pts_seconds,
2167  "video_pts_seconds", video_pts_seconds,
2168  "recent_pts_diff", recent_pts_diff);
2169  if (info.has_video && !f->has_image_data) {
2170  // Frame has no image data (copy from previous frame)
2171  // Loop backwards through final frames (looking for the nearest, previous frame image)
2172  for (int64_t previous_frame = requested_frame - 1; previous_frame > 0; previous_frame--) {
2173  std::shared_ptr<Frame> previous_frame_instance = final_cache.GetFrame(previous_frame);
2174  if (previous_frame_instance && previous_frame_instance->has_image_data) {
2175  // Copy image from last decoded frame
2176  f->AddImage(std::make_shared<QImage>(previous_frame_instance->GetImage()->copy()));
2177  break;
2178  }
2179  }
2180 
2181  if (last_video_frame && !f->has_image_data) {
2182  // Copy image from last decoded frame
2183  f->AddImage(std::make_shared<QImage>(last_video_frame->GetImage()->copy()));
2184  } else if (!f->has_image_data) {
2185  f->AddColor("#000000");
2186  }
2187  }
2188  }
2189 
2190  double audio_pts_diff = audio_pts_seconds - frame_pts_seconds;
2191  if ((frame_pts_seconds < audio_pts_seconds && audio_pts_diff > 1.0)
2192  || (recent_pts_diff > 1.5)
2193  || packet_status.audio_eof || packet_status.end_of_file) {
2194  // Audio stream is past this frame (so it must be done)
2195  // OR audio stream is too far behind, missing, or end-of-file
2196  // Adding a bit of margin here, to allow for partial audio packets
2197  is_audio_ready = true;
2198  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (audio ready)",
2199  "frame_number", f->number,
2200  "frame_pts_seconds", frame_pts_seconds,
2201  "audio_pts_seconds", audio_pts_seconds,
2202  "audio_pts_diff", audio_pts_diff,
2203  "recent_pts_diff", recent_pts_diff);
2204  }
2205  bool is_seek_trash = IsPartialFrame(f->number);
2206 
2207  // Adjust for available streams
2208  if (!info.has_video) is_video_ready = true;
2209  if (!info.has_audio) is_audio_ready = true;
2210 
2211  // Debug output
2212  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames",
2213  "frame_number", f->number,
2214  "is_video_ready", is_video_ready,
2215  "is_audio_ready", is_audio_ready,
2216  "video_eof", packet_status.video_eof,
2217  "audio_eof", packet_status.audio_eof,
2218  "end_of_file", packet_status.end_of_file);
2219 
2220  // Check if working frame is final
2221  if ((!packet_status.end_of_file && is_video_ready && is_audio_ready) || packet_status.end_of_file || is_seek_trash) {
2222  // Debug output
2223  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (mark frame as final)",
2224  "requested_frame", requested_frame,
2225  "f->number", f->number,
2226  "is_seek_trash", is_seek_trash,
2227  "Working Cache Count", working_cache.Count(),
2228  "Final Cache Count", final_cache.Count(),
2229  "end_of_file", packet_status.end_of_file);
2230 
2231  if (!is_seek_trash) {
2232  // Move frame to final cache
2233  final_cache.Add(f);
2234 
2235  // Remove frame from working cache
2236  working_cache.Remove(f->number);
2237 
2238  // Update last frame processed
2239  last_frame = f->number;
2240  } else {
2241  // Seek trash, so delete the frame from the working cache, and never add it to the final cache.
2242  working_cache.Remove(f->number);
2243  }
2244 
2245  }
2246  }
2247 
2248  // Clear vector of frames
2249  working_frames.clear();
2250  working_frames.shrink_to_fit();
2251 }
2252 
2253 // Check for the correct frames per second (FPS) value by scanning the 1st few seconds of video packets.
2254 void FFmpegReader::CheckFPS() {
2255  if (check_fps) {
2256  // Do not check FPS more than 1 time
2257  return;
2258  } else {
2259  check_fps = true;
2260  }
2261 
2262  int frames_per_second[3] = {0,0,0};
2263  int max_fps_index = sizeof(frames_per_second) / sizeof(frames_per_second[0]);
2264  int fps_index = 0;
2265 
2266  int all_frames_detected = 0;
2267  int starting_frames_detected = 0;
2268 
2269  // Loop through the stream
2270  while (true) {
2271  // Get the next packet (if any)
2272  if (GetNextPacket() < 0)
2273  // Break loop when no more packets found
2274  break;
2275 
2276  // Video packet
2277  if (packet->stream_index == videoStream) {
2278  // Get the video packet start time (in seconds)
2279  double video_seconds = (double(GetPacketPTS()) * info.video_timebase.ToDouble()) + pts_offset_seconds;
2280  fps_index = int(video_seconds); // truncate float timestamp to int (second 1, second 2, second 3)
2281 
2282  // Is this video packet from the first few seconds?
2283  if (fps_index >= 0 && fps_index < max_fps_index) {
2284  // Yes, keep track of how many frames per second (over the first few seconds)
2285  starting_frames_detected++;
2286  frames_per_second[fps_index]++;
2287  }
2288 
2289  // Track all video packets detected
2290  all_frames_detected++;
2291  }
2292  }
2293 
2294  // Calculate FPS (based on the first few seconds of video packets)
2295  float avg_fps = 30.0;
2296  if (starting_frames_detected > 0 && fps_index > 0) {
2297  avg_fps = float(starting_frames_detected) / std::min(fps_index, max_fps_index);
2298  }
2299 
2300  // Verify average FPS is a reasonable value
2301  if (avg_fps < 8.0) {
2302  // Invalid FPS assumed, so switching to a sane default FPS instead
2303  avg_fps = 30.0;
2304  }
2305 
2306  // Update FPS (truncate average FPS to Integer)
2307  info.fps = Fraction(int(avg_fps), 1);
2308 
2309  // Update Duration and Length
2310  if (all_frames_detected > 0) {
2311  // Use all video frames detected to calculate # of frames
2312  info.video_length = all_frames_detected;
2313  info.duration = all_frames_detected / avg_fps;
2314  } else {
2315  // Use previous duration to calculate # of frames
2316  info.video_length = info.duration * avg_fps;
2317  }
2318 
2319  // Update video bit rate
2321 }
2322 
2323 // Remove AVFrame from cache (and deallocate its memory)
2324 void FFmpegReader::RemoveAVFrame(AVFrame *remove_frame) {
2325  // Remove pFrame (if exists)
2326  if (remove_frame) {
2327  // Free memory
2328  av_freep(&remove_frame->data[0]);
2329 #ifndef WIN32
2330  AV_FREE_FRAME(&remove_frame);
2331 #endif
2332  }
2333 }
2334 
2335 // Remove AVPacket from cache (and deallocate its memory)
2336 void FFmpegReader::RemoveAVPacket(AVPacket *remove_packet) {
2337  // deallocate memory for packet
2338  AV_FREE_PACKET(remove_packet);
2339 
2340  // Delete the object
2341  delete remove_packet;
2342 }
2343 
2344 // Generate JSON string of this object
2345 std::string FFmpegReader::Json() const {
2346 
2347  // Return formatted string
2348  return JsonValue().toStyledString();
2349 }
2350 
2351 // Generate Json::Value for this object
2352 Json::Value FFmpegReader::JsonValue() const {
2353 
2354  // Create root json object
2355  Json::Value root = ReaderBase::JsonValue(); // get parent properties
2356  root["type"] = "FFmpegReader";
2357  root["path"] = path;
2358 
2359  // return JsonValue
2360  return root;
2361 }
2362 
2363 // Load JSON string into this object
2364 void FFmpegReader::SetJson(const std::string value) {
2365 
2366  // Parse JSON string into JSON objects
2367  try {
2368  const Json::Value root = openshot::stringToJson(value);
2369  // Set all values that match
2370  SetJsonValue(root);
2371  }
2372  catch (const std::exception& e) {
2373  // Error parsing JSON (or missing keys)
2374  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
2375  }
2376 }
2377 
2378 // Load Json::Value into this object
2379 void FFmpegReader::SetJsonValue(const Json::Value root) {
2380 
2381  // Set parent data
2383 
2384  // Set data from Json (if key is found)
2385  if (!root["path"].isNull())
2386  path = root["path"].asString();
2387 
2388  // Re-Open path, and re-init everything (if needed)
2389  if (is_open) {
2390  Close();
2391  Open();
2392  }
2393 }
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:16
openshot::CacheMemory::Clear
void Clear()
Clear the cache of all frames.
Definition: CacheMemory.cpp:221
AV_FIND_DECODER_CODEC_ID
#define AV_FIND_DECODER_CODEC_ID(av_stream)
Definition: FFmpegUtilities.h:204
openshot::ReaderInfo::sample_rate
int sample_rate
The number of audio samples per second (44100 is a common sample rate)
Definition: ReaderBase.h:60
openshot::FFmpegReader::FFmpegReader
FFmpegReader(const std::string &path, bool inspect_reader=true)
Constructor for FFmpegReader.
Definition: FFmpegReader.cpp:71
openshot::Fraction::ToFloat
float ToFloat()
Return this fraction as a float (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:35
openshot::Settings::HARDWARE_DECODER
int HARDWARE_DECODER
Use video codec for faster video decoding (if supported)
Definition: Settings.h:62
openshot::Coordinate::Y
double Y
The Y value of the coordinate (usually representing the value of the property being animated)
Definition: Coordinate.h:41
openshot::CacheMemory::Count
int64_t Count()
Count the frames in the queue.
Definition: CacheMemory.cpp:235
FFmpegUtilities.h
Header file for FFmpegUtilities.
openshot::ReaderBase::JsonValue
virtual Json::Value JsonValue() const =0
Generate Json::Value for this object.
Definition: ReaderBase.cpp:107
openshot::InvalidCodec
Exception when no valid codec is found for a file.
Definition: Exceptions.h:172
openshot::TimelineBase::preview_width
int preview_width
Optional preview width of timeline image. If your preview window is smaller than the timeline,...
Definition: TimelineBase.h:44
openshot::PacketStatus::reset
void reset(bool eof)
Definition: FFmpegReader.h:68
openshot::CacheMemory::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number)
Get a frame from the cache.
Definition: CacheMemory.cpp:80
openshot::FFmpegReader::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t requested_frame) override
Definition: FFmpegReader.cpp:895
AV_COPY_PICTURE_DATA
#define AV_COPY_PICTURE_DATA(av_frame, buffer, pix_fmt, width, height)
Definition: FFmpegUtilities.h:216
openshot::CacheMemory::Add
void Add(std::shared_ptr< openshot::Frame > frame)
Add a Frame to the cache.
Definition: CacheMemory.cpp:46
PixelFormat
#define PixelFormat
Definition: FFmpegUtilities.h:100
AV_ALLOCATE_FRAME
#define AV_ALLOCATE_FRAME()
Definition: FFmpegUtilities.h:196
openshot::ReaderBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition: ReaderBase.cpp:162
SWR_CONVERT
#define SWR_CONVERT(ctx, out, linesize, out_count, in, linesize2, in_count)
Definition: FFmpegUtilities.h:142
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Point::co
Coordinate co
This is the primary coordinate.
Definition: Point.h:66
FF_NUM_PROCESSORS
#define FF_NUM_PROCESSORS
Definition: OpenMPUtilities.h:24
openshot::Clip::scale_y
openshot::Keyframe scale_y
Curve representing the vertical scaling in percent (0 to 1)
Definition: Clip.h:307
openshot::AudioLocation
This struct holds the associated video frame and starting sample # for an audio packet.
Definition: AudioLocation.h:25
openshot::AudioLocation::frame
int64_t frame
Definition: AudioLocation.h:26
openshot::Clip
This class represents a clip (used to arrange readers on the timeline)
Definition: Clip.h:89
openshot::Fraction
This class represents a fraction.
Definition: Fraction.h:30
openshot::AudioLocation::sample_start
int sample_start
Definition: AudioLocation.h:27
AV_FREE_FRAME
#define AV_FREE_FRAME(av_frame)
Definition: FFmpegUtilities.h:200
openshot::Keyframe::GetMaxPoint
Point GetMaxPoint() const
Get max point (by Y coordinate)
Definition: KeyFrame.cpp:245
openshot::ReaderBase::info
openshot::ReaderInfo info
Information about the current media file.
Definition: ReaderBase.h:88
openshot::ReaderInfo::interlaced_frame
bool interlaced_frame
Definition: ReaderBase.h:56
Timeline.h
Header file for Timeline class.
openshot::Clip::ParentTimeline
void ParentTimeline(openshot::TimelineBase *new_timeline) override
Set associated Timeline pointer.
Definition: Clip.cpp:383
openshot::FFmpegReader::~FFmpegReader
virtual ~FFmpegReader()
Destructor.
Definition: FFmpegReader.cpp:100
openshot::ReaderInfo::audio_bit_rate
int audio_bit_rate
The bit rate of the audio stream (in bytes)
Definition: ReaderBase.h:59
openshot::CacheMemory::Remove
void Remove(int64_t frame_number)
Remove a specific frame.
Definition: CacheMemory.cpp:154
AV_FREE_PACKET
#define AV_FREE_PACKET(av_packet)
Definition: FFmpegUtilities.h:201
openshot::ReaderInfo::duration
float duration
Length of time (in seconds)
Definition: ReaderBase.h:43
openshot::ReaderInfo::has_video
bool has_video
Determines if this file has a video stream.
Definition: ReaderBase.h:40
openshot::FFmpegReader::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: FFmpegReader.cpp:2352
openshot::PacketStatus::audio_read
int64_t audio_read
Definition: FFmpegReader.h:49
openshot::ReaderInfo::width
int width
The width of the video (in pixesl)
Definition: ReaderBase.h:46
openshot::FFmpegReader::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: FFmpegReader.cpp:2364
openshot::PacketStatus::packets_eof
bool packets_eof
Definition: FFmpegReader.h:55
hw_de_av_pix_fmt_global
AVPixelFormat hw_de_av_pix_fmt_global
Definition: FFmpegReader.cpp:67
openshot::PacketStatus::audio_decoded
int64_t audio_decoded
Definition: FFmpegReader.h:50
openshot::Fraction::ToDouble
double ToDouble() const
Return this fraction as a double (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:40
openshot::PacketStatus::video_read
int64_t video_read
Definition: FFmpegReader.h:47
hw_de_on
int hw_de_on
Definition: FFmpegReader.cpp:65
openshot::CacheBase::SetMaxBytesFromInfo
void SetMaxBytesFromInfo(int64_t number_of_frames, int width, int height, int sample_rate, int channels)
Set maximum bytes to a different amount based on a ReaderInfo struct.
Definition: CacheBase.cpp:30
openshot::Clip::scale_x
openshot::Keyframe scale_x
Curve representing the horizontal scaling in percent (0 to 1)
Definition: Clip.h:306
AV_GET_CODEC_ATTRIBUTES
#define AV_GET_CODEC_ATTRIBUTES(av_stream, av_context)
Definition: FFmpegUtilities.h:211
openshot::ReaderInfo::video_length
int64_t video_length
The number of frames in the video stream.
Definition: ReaderBase.h:53
hw_de_av_device_type_global
AVHWDeviceType hw_de_av_device_type_global
Definition: FFmpegReader.cpp:68
openshot::ReaderInfo::height
int height
The height of the video (in pixels)
Definition: ReaderBase.h:45
openshot::PacketStatus::video_eof
bool video_eof
Definition: FFmpegReader.h:53
openshot::Fraction::num
int num
Numerator for the fraction.
Definition: Fraction.h:32
if
if(!codec) codec
ZmqLogger.h
Header file for ZeroMQ-based Logger class.
openshot::Fraction::den
int den
Denominator for the fraction.
Definition: Fraction.h:33
OPEN_MP_NUM_PROCESSORS
#define OPEN_MP_NUM_PROCESSORS
Definition: OpenMPUtilities.h:23
AV_RESET_FRAME
#define AV_RESET_FRAME(av_frame)
Definition: FFmpegUtilities.h:199
openshot::AudioLocation::is_near
bool is_near(AudioLocation location, int samples_per_frame, int64_t amount)
Definition: FFmpegReader.cpp:107
SWR_CLOSE
#define SWR_CLOSE(ctx)
Definition: FFmpegUtilities.h:145
openshot::ReaderInfo::has_audio
bool has_audio
Determines if this file has an audio stream.
Definition: ReaderBase.h:41
openshot::Settings::DE_LIMIT_HEIGHT_MAX
int DE_LIMIT_HEIGHT_MAX
Maximum rows that hardware decode can handle.
Definition: Settings.h:74
openshot::InvalidJSON
Exception for invalid JSON.
Definition: Exceptions.h:217
openshot::FFmpegReader::enable_seek
bool enable_seek
Definition: FFmpegReader.h:232
openshot::ReaderInfo::file_size
int64_t file_size
Size of file (in bytes)
Definition: ReaderBase.h:44
openshot::Timeline
This class represents a timeline.
Definition: Timeline.h:148
openshot::FFmpegReader::Open
void Open() override
Open File - which is called by the constructor automatically.
Definition: FFmpegReader.cpp:207
openshot::OutOfMemory
Exception when memory could not be allocated.
Definition: Exceptions.h:348
openshot::SCALE_CROP
@ SCALE_CROP
Scale the clip until both height and width fill the canvas (cropping the overlap)
Definition: Enums.h:37
SWR_INIT
#define SWR_INIT(ctx)
Definition: FFmpegUtilities.h:147
SWRCONTEXT
#define SWRCONTEXT
Definition: FFmpegUtilities.h:148
openshot::PacketStatus::audio_eof
bool audio_eof
Definition: FFmpegReader.h:54
openshot::ReaderInfo::has_single_image
bool has_single_image
Determines if this file only contains a single image.
Definition: ReaderBase.h:42
openshot::FFmpegReader::final_cache
CacheMemory final_cache
Final cache object used to hold final frames.
Definition: FFmpegReader.h:228
openshot::ReaderInfo::video_timebase
openshot::Fraction video_timebase
The video timebase determines how long each frame stays on the screen.
Definition: ReaderBase.h:55
openshot::Settings::Instance
static Settings * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: Settings.cpp:23
openshot::ReaderInfo::metadata
std::map< std::string, std::string > metadata
An optional map/dictionary of metadata for this reader.
Definition: ReaderBase.h:65
path
path
Definition: FFmpegWriter.cpp:1444
openshot::Frame::GetSamplesPerFrame
int GetSamplesPerFrame(openshot::Fraction fps, int sample_rate, int channels)
Calculate the # of samples per video frame (for the current frame number)
Definition: Frame.cpp:484
openshot::InvalidFile
Exception for files that can not be found or opened.
Definition: Exceptions.h:187
openshot::ReaderInfo::audio_stream_index
int audio_stream_index
The index of the audio stream.
Definition: ReaderBase.h:63
openshot::ZmqLogger::Instance
static ZmqLogger * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: ZmqLogger.cpp:35
openshot::ReaderInfo::audio_timebase
openshot::Fraction audio_timebase
The audio timebase determines how long each audio packet should be played.
Definition: ReaderBase.h:64
openshot::FFmpegReader::Close
void Close() override
Close File.
Definition: FFmpegReader.cpp:586
openshot::SCALE_FIT
@ SCALE_FIT
Scale the clip until either height or width fills the canvas (with no cropping)
Definition: Enums.h:38
openshot::PacketStatus::packets_read
int64_t packets_read()
Definition: FFmpegReader.h:58
openshot::ReaderInfo::pixel_format
int pixel_format
The pixel format (i.e. YUV420P, RGB24, etc...)
Definition: ReaderBase.h:47
openshot::ZmqLogger::AppendDebugMethod
void AppendDebugMethod(std::string method_name, std::string arg1_name="", float arg1_value=-1.0, std::string arg2_name="", float arg2_value=-1.0, std::string arg3_name="", float arg3_value=-1.0, std::string arg4_name="", float arg4_value=-1.0, std::string arg5_name="", float arg5_value=-1.0, std::string arg6_name="", float arg6_value=-1.0)
Append debug information.
Definition: ZmqLogger.cpp:178
openshot::ReaderInfo::vcodec
std::string vcodec
The name of the video codec used to encode / decode the video stream.
Definition: ReaderBase.h:52
openshot::PacketStatus::packets_decoded
int64_t packets_decoded()
Definition: FFmpegReader.h:63
AV_GET_CODEC_TYPE
#define AV_GET_CODEC_TYPE(av_stream)
Definition: FFmpegUtilities.h:203
openshot::ReaderClosed
Exception when a reader is closed, and a frame is requested.
Definition: Exceptions.h:363
openshot::ReaderInfo::channel_layout
openshot::ChannelLayout channel_layout
The channel layout (mono, stereo, 5 point surround, etc...)
Definition: ReaderBase.h:62
AV_FREE_CONTEXT
#define AV_FREE_CONTEXT(av_context)
Definition: FFmpegUtilities.h:202
PIX_FMT_RGBA
#define PIX_FMT_RGBA
Definition: FFmpegUtilities.h:103
AV_GET_CODEC_PIXEL_FORMAT
#define AV_GET_CODEC_PIXEL_FORMAT(av_stream, av_context)
Definition: FFmpegUtilities.h:212
AVCODEC_REGISTER_ALL
#define AVCODEC_REGISTER_ALL
Definition: FFmpegUtilities.h:192
SWR_FREE
#define SWR_FREE(ctx)
Definition: FFmpegUtilities.h:146
openshot::Settings::DE_LIMIT_WIDTH_MAX
int DE_LIMIT_WIDTH_MAX
Maximum columns that hardware decode can handle.
Definition: Settings.h:77
openshot::ReaderInfo::fps
openshot::Fraction fps
Frames per second, as a fraction (i.e. 24/1 = 24 fps)
Definition: ReaderBase.h:48
AV_GET_SAMPLE_FORMAT
#define AV_GET_SAMPLE_FORMAT(av_stream, av_context)
Definition: FFmpegUtilities.h:214
openshot::ReaderInfo::video_bit_rate
int video_bit_rate
The bit rate of the video stream (in bytes)
Definition: ReaderBase.h:49
openshot::PacketStatus::end_of_file
bool end_of_file
Definition: FFmpegReader.h:56
openshot::Clip::scale
openshot::ScaleType scale
The scale determines how a clip should be resized to fit its parent.
Definition: Clip.h:168
openshot::ReaderInfo::top_field_first
bool top_field_first
Definition: ReaderBase.h:57
openshot::ChannelLayout
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Definition: ChannelLayouts.h:28
SWR_ALLOC
#define SWR_ALLOC()
Definition: FFmpegUtilities.h:144
openshot::ReaderInfo::pixel_ratio
openshot::Fraction pixel_ratio
The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)
Definition: ReaderBase.h:50
AV_REGISTER_ALL
#define AV_REGISTER_ALL
Definition: FFmpegUtilities.h:191
openshot::CacheMemory::GetFrames
std::vector< std::shared_ptr< openshot::Frame > > GetFrames()
Get an array of all Frames.
Definition: CacheMemory.cpp:96
AV_GET_CODEC_CONTEXT
#define AV_GET_CODEC_CONTEXT(av_stream, av_codec)
Definition: FFmpegUtilities.h:205
openshot::ReaderInfo::video_stream_index
int video_stream_index
The index of the video stream.
Definition: ReaderBase.h:54
openshot::FFmpegReader::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: FFmpegReader.cpp:2379
openshot::SCALE_STRETCH
@ SCALE_STRETCH
Scale the clip until both height and width fill the canvas (distort to fit)
Definition: Enums.h:39
openshot::ReaderInfo::acodec
std::string acodec
The name of the audio codec used to encode / decode the video stream.
Definition: ReaderBase.h:58
openshot::NoStreamsFound
Exception when no streams are found in the file.
Definition: Exceptions.h:285
openshot::ReaderInfo::display_ratio
openshot::Fraction display_ratio
The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)
Definition: ReaderBase.h:51
openshot::ReaderInfo::channels
int channels
The number of audio channels used in the audio stream.
Definition: ReaderBase.h:61
openshot::FFmpegReader::Json
std::string Json() const override
Generate JSON string of this object.
Definition: FFmpegReader.cpp:2345
openshot::FFmpegReader::GetIsDurationKnown
bool GetIsDurationKnown()
Return true if frame can be read with GetFrame()
Definition: FFmpegReader.cpp:891
openshot::PacketStatus::video_decoded
int64_t video_decoded
Definition: FFmpegReader.h:48
opts
AVDictionary * opts
Definition: FFmpegWriter.cpp:1451
Exceptions.h
Header file for all Exception classes.
openshot::Settings::HW_DE_DEVICE_SET
int HW_DE_DEVICE_SET
Which GPU to use to decode (0 is the first)
Definition: Settings.h:80
FFmpegReader.h
Header file for FFmpegReader class.
openshot::ReaderBase::getFrameMutex
std::recursive_mutex getFrameMutex
Mutex for multiple threads.
Definition: ReaderBase.h:79
openshot::ReaderBase::ParentClip
openshot::ClipBase * ParentClip()
Parent clip object of this reader (which can be unparented and NULL)
Definition: ReaderBase.cpp:245