libavfilter/af_ashowinfo.c
e30a0b1b
 /*
  * Copyright (c) 2011 Stefano Sabatini
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
9bd23f68
  * filter for showing textual audio frame information
e30a0b1b
  */
 
20dd41af
 #include <inttypes.h>
 #include <stddef.h>
 
e30a0b1b
 #include "libavutil/adler32.h"
093804a9
 #include "libavutil/attributes.h"
a903f8f0
 #include "libavutil/channel_layout.h"
20dd41af
 #include "libavutil/common.h"
b4679ecd
 #include "libavutil/downmix_info.h"
 #include "libavutil/intreadwrite.h"
20dd41af
 #include "libavutil/mem.h"
b4679ecd
 #include "libavutil/replaygain.h"
175ab5f9
 #include "libavutil/timestamp.h"
20dd41af
 #include "libavutil/samplefmt.h"
 
7046bd9b
 #include "libavcodec/avcodec.h"
 
4522df52
 #include "audio.h"
e30a0b1b
 #include "avfilter.h"
565e4993
 #include "internal.h"
e30a0b1b
 
20dd41af
 typedef struct AShowInfoContext {
     /**
      * Scratch space for individual plane checksums for planar audio
      */
     uint32_t *plane_checksums;
 } AShowInfoContext;
e30a0b1b
 
093804a9
 static av_cold void uninit(AVFilterContext *ctx)
20dd41af
 {
     AShowInfoContext *s = ctx->priv;
     av_freep(&s->plane_checksums);
 }
 
b4679ecd
 static void dump_matrixenc(AVFilterContext *ctx, AVFrameSideData *sd)
 {
     enum AVMatrixEncoding enc;
 
     av_log(ctx, AV_LOG_INFO, "matrix encoding: ");
 
     if (sd->size < sizeof(enum AVMatrixEncoding)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
 
     enc = *(enum AVMatrixEncoding *)sd->data;
     switch (enc) {
     case AV_MATRIX_ENCODING_NONE:           av_log(ctx, AV_LOG_INFO, "none");                break;
9c21c08f
     case AV_MATRIX_ENCODING_DOLBY:          av_log(ctx, AV_LOG_INFO, "Dolby Surround");      break;
b4679ecd
     case AV_MATRIX_ENCODING_DPLII:          av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic II");  break;
     case AV_MATRIX_ENCODING_DPLIIX:         av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic IIx"); break;
     case AV_MATRIX_ENCODING_DPLIIZ:         av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic IIz"); break;
     case AV_MATRIX_ENCODING_DOLBYEX:        av_log(ctx, AV_LOG_INFO, "Dolby EX");            break;
     case AV_MATRIX_ENCODING_DOLBYHEADPHONE: av_log(ctx, AV_LOG_INFO, "Dolby Headphone");     break;
     default:                                av_log(ctx, AV_LOG_WARNING, "unknown");          break;
     }
 }
 
 static void dump_downmix(AVFilterContext *ctx, AVFrameSideData *sd)
 {
     AVDownmixInfo *di;
 
     av_log(ctx, AV_LOG_INFO, "downmix: ");
     if (sd->size < sizeof(*di)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
 
     di = (AVDownmixInfo *)sd->data;
 
     av_log(ctx, AV_LOG_INFO, "preferred downmix type - ");
     switch (di->preferred_downmix_type) {
     case AV_DOWNMIX_TYPE_LORO:    av_log(ctx, AV_LOG_INFO, "Lo/Ro");              break;
     case AV_DOWNMIX_TYPE_LTRT:    av_log(ctx, AV_LOG_INFO, "Lt/Rt");              break;
     case AV_DOWNMIX_TYPE_DPLII:   av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic II"); break;
     default:                      av_log(ctx, AV_LOG_WARNING, "unknown");         break;
     }
 
     av_log(ctx, AV_LOG_INFO, " Mix levels: center %f (%f ltrt) - "
            "surround %f (%f ltrt) - lfe %f",
            di->center_mix_level, di->center_mix_level_ltrt,
            di->surround_mix_level, di->surround_mix_level_ltrt,
            di->lfe_mix_level);
 }
 
 static void print_gain(AVFilterContext *ctx, const char *str, int32_t gain)
 {
     av_log(ctx, AV_LOG_INFO, "%s - ", str);
     if (gain == INT32_MIN)
         av_log(ctx, AV_LOG_INFO, "unknown");
     else
         av_log(ctx, AV_LOG_INFO, "%f", gain / 100000.0f);
     av_log(ctx, AV_LOG_INFO, ", ");
 }
 
 static void print_peak(AVFilterContext *ctx, const char *str, uint32_t peak)
 {
     av_log(ctx, AV_LOG_INFO, "%s - ", str);
     if (!peak)
         av_log(ctx, AV_LOG_INFO, "unknown");
     else
         av_log(ctx, AV_LOG_INFO, "%f", (float)peak / UINT32_MAX);
     av_log(ctx, AV_LOG_INFO, ", ");
 }
 
 static void dump_replaygain(AVFilterContext *ctx, AVFrameSideData *sd)
 {
     AVReplayGain *rg;
 
     av_log(ctx, AV_LOG_INFO, "replaygain: ");
     if (sd->size < sizeof(*rg)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
     rg = (AVReplayGain*)sd->data;
 
     print_gain(ctx, "track gain", rg->track_gain);
     print_peak(ctx, "track peak", rg->track_peak);
     print_gain(ctx, "album gain", rg->album_gain);
     print_peak(ctx, "album peak", rg->album_peak);
 }
 
728685f3
 static void dump_audio_service_type(AVFilterContext *ctx, AVFrameSideData *sd)
 {
     enum AVAudioServiceType *ast;
 
     av_log(ctx, AV_LOG_INFO, "audio service type: ");
     if (sd->size < sizeof(*ast)) {
         av_log(ctx, AV_LOG_INFO, "invalid data");
         return;
     }
     ast = (enum AVAudioServiceType*)sd->data;
     switch (*ast) {
     case AV_AUDIO_SERVICE_TYPE_MAIN:              av_log(ctx, AV_LOG_INFO, "Main Audio Service"); break;
     case AV_AUDIO_SERVICE_TYPE_EFFECTS:           av_log(ctx, AV_LOG_INFO, "Effects");            break;
     case AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED: av_log(ctx, AV_LOG_INFO, "Visually Impaired");  break;
     case AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED:  av_log(ctx, AV_LOG_INFO, "Hearing Impaired");   break;
     case AV_AUDIO_SERVICE_TYPE_DIALOGUE:          av_log(ctx, AV_LOG_INFO, "Dialogue");           break;
     case AV_AUDIO_SERVICE_TYPE_COMMENTARY:        av_log(ctx, AV_LOG_INFO, "Commentary");         break;
     case AV_AUDIO_SERVICE_TYPE_EMERGENCY:         av_log(ctx, AV_LOG_INFO, "Emergency");          break;
     case AV_AUDIO_SERVICE_TYPE_VOICE_OVER:        av_log(ctx, AV_LOG_INFO, "Voice Over");         break;
     case AV_AUDIO_SERVICE_TYPE_KARAOKE:           av_log(ctx, AV_LOG_INFO, "Karaoke");            break;
     default:                                      av_log(ctx, AV_LOG_INFO, "unknown");            break;
     }
 }
 
b4679ecd
 static void dump_unknown(AVFilterContext *ctx, AVFrameSideData *sd)
 {
     av_log(ctx, AV_LOG_INFO, "unknown side data type: %d, size %d bytes", sd->type, sd->size);
 }
 
7e350379
 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
e30a0b1b
 {
     AVFilterContext *ctx = inlink->dst;
20dd41af
     AShowInfoContext *s  = ctx->priv;
e30a0b1b
     char chlayout_str[128];
20dd41af
     uint32_t checksum = 0;
099dfcaa
     int channels    = inlink->channels;
20dd41af
     int planar      = av_sample_fmt_is_planar(buf->format);
     int block_align = av_get_bytes_per_sample(buf->format) * (planar ? 1 : channels);
7e350379
     int data_size   = buf->nb_samples * block_align;
20dd41af
     int planes      = planar ? channels : 1;
     int i;
081e117b
     void *tmp_ptr = av_realloc_array(s->plane_checksums, channels, sizeof(*s->plane_checksums));
5cac0656
 
     if (!tmp_ptr)
         return AVERROR(ENOMEM);
     s->plane_checksums = tmp_ptr;
20dd41af
 
     for (i = 0; i < planes; i++) {
         uint8_t *data = buf->extended_data[i];
 
         s->plane_checksums[i] = av_adler32_update(0, data, data_size);
         checksum = i ? av_adler32_update(checksum, data, data_size) :
                        s->plane_checksums[0];
e30a0b1b
     }
 
     av_get_channel_layout_string(chlayout_str, sizeof(chlayout_str), -1,
7e350379
                                  buf->channel_layout);
e30a0b1b
 
     av_log(ctx, AV_LOG_INFO,
39dc1bc9
            "n:%"PRId64" pts:%s pts_time:%s pos:%"PRId64" "
79456652
            "fmt:%s channels:%d chlayout:%s rate:%d nb_samples:%d "
7513234b
            "checksum:%08"PRIX32" ",
39dc1bc9
            inlink->frame_count,
e79c3858
            av_ts2str(buf->pts), av_ts2timestr(buf->pts, &inlink->time_base),
a05a44e2
            av_frame_get_pkt_pos(buf),
            av_get_sample_fmt_name(buf->format), av_frame_get_channels(buf), chlayout_str,
7e350379
            buf->sample_rate, buf->nb_samples,
20dd41af
            checksum);
 
     av_log(ctx, AV_LOG_INFO, "plane_checksums: [ ");
     for (i = 0; i < planes; i++)
7513234b
         av_log(ctx, AV_LOG_INFO, "%08"PRIX32" ", s->plane_checksums[i]);
f89f9bda
     av_log(ctx, AV_LOG_INFO, "]\n");
e30a0b1b
 
b4679ecd
     for (i = 0; i < buf->nb_side_data; i++) {
         AVFrameSideData *sd = buf->side_data[i];
 
         av_log(ctx, AV_LOG_INFO, "  side data - ");
         switch (sd->type) {
         case AV_FRAME_DATA_MATRIXENCODING: dump_matrixenc (ctx, sd); break;
         case AV_FRAME_DATA_DOWNMIX_INFO:   dump_downmix   (ctx, sd); break;
         case AV_FRAME_DATA_REPLAYGAIN:     dump_replaygain(ctx, sd); break;
728685f3
         case AV_FRAME_DATA_AUDIO_SERVICE_TYPE: dump_audio_service_type(ctx, sd); break;
b4679ecd
         default:                           dump_unknown   (ctx, sd); break;
         }
 
         av_log(ctx, AV_LOG_INFO, "\n");
     }
 
cd7febd3
     return ff_filter_frame(inlink->dst->outputs[0], buf);
e30a0b1b
 }
 
20dd41af
 static const AVFilterPad inputs[] = {
     {
b211607b
         .name         = "default",
         .type         = AVMEDIA_TYPE_AUDIO,
         .filter_frame = filter_frame,
20dd41af
     },
b211607b
     { NULL }
20dd41af
 };
 
 static const AVFilterPad outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_AUDIO,
     },
b211607b
     { NULL }
20dd41af
 };
 
cd43ca04
 AVFilter ff_af_ashowinfo = {
e30a0b1b
     .name        = "ashowinfo",
     .description = NULL_IF_CONFIG_SMALL("Show textual information for each audio frame."),
20dd41af
     .priv_size   = sizeof(AShowInfoContext),
     .uninit      = uninit,
     .inputs      = inputs,
     .outputs     = outputs,
e30a0b1b
 };