]> git.sesse.net Git - ffmpeg/blob - doc/examples/hw_decode.c
doc/examples/hw_decode: Remove setting deprecated refcounted_frames
[ffmpeg] / doc / examples / hw_decode.c
1 /*
2  * Copyright (c) 2017 Jun Zhao
3  * Copyright (c) 2017 Kaixuan Liu
4  *
5  * HW Acceleration API (video decoding) decode sample
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 /**
25  * @file
26  * HW-Accelerated decoding example.
27  *
28  * @example hw_decode.c
29  * This example shows how to do HW-accelerated decoding with output
30  * frames from the HW video surfaces.
31  */
32
33 #include <stdio.h>
34
35 #include <libavcodec/avcodec.h>
36 #include <libavformat/avformat.h>
37 #include <libavutil/pixdesc.h>
38 #include <libavutil/hwcontext.h>
39 #include <libavutil/opt.h>
40 #include <libavutil/avassert.h>
41 #include <libavutil/imgutils.h>
42
43 static AVBufferRef *hw_device_ctx = NULL;
44 static enum AVPixelFormat hw_pix_fmt;
45 static FILE *output_file = NULL;
46
47 static int hw_decoder_init(AVCodecContext *ctx, const enum AVHWDeviceType type)
48 {
49     int err = 0;
50
51     if ((err = av_hwdevice_ctx_create(&hw_device_ctx, type,
52                                       NULL, NULL, 0)) < 0) {
53         fprintf(stderr, "Failed to create specified HW device.\n");
54         return err;
55     }
56     ctx->hw_device_ctx = av_buffer_ref(hw_device_ctx);
57
58     return err;
59 }
60
61 static enum AVPixelFormat get_hw_format(AVCodecContext *ctx,
62                                         const enum AVPixelFormat *pix_fmts)
63 {
64     const enum AVPixelFormat *p;
65
66     for (p = pix_fmts; *p != -1; p++) {
67         if (*p == hw_pix_fmt)
68             return *p;
69     }
70
71     fprintf(stderr, "Failed to get HW surface format.\n");
72     return AV_PIX_FMT_NONE;
73 }
74
75 static int decode_write(AVCodecContext *avctx, AVPacket *packet)
76 {
77     AVFrame *frame = NULL, *sw_frame = NULL;
78     AVFrame *tmp_frame = NULL;
79     uint8_t *buffer = NULL;
80     int size;
81     int ret = 0;
82
83     ret = avcodec_send_packet(avctx, packet);
84     if (ret < 0) {
85         fprintf(stderr, "Error during decoding\n");
86         return ret;
87     }
88
89     while (1) {
90         if (!(frame = av_frame_alloc()) || !(sw_frame = av_frame_alloc())) {
91             fprintf(stderr, "Can not alloc frame\n");
92             ret = AVERROR(ENOMEM);
93             goto fail;
94         }
95
96         ret = avcodec_receive_frame(avctx, frame);
97         if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF) {
98             av_frame_free(&frame);
99             av_frame_free(&sw_frame);
100             return 0;
101         } else if (ret < 0) {
102             fprintf(stderr, "Error while decoding\n");
103             goto fail;
104         }
105
106         if (frame->format == hw_pix_fmt) {
107             /* retrieve data from GPU to CPU */
108             if ((ret = av_hwframe_transfer_data(sw_frame, frame, 0)) < 0) {
109                 fprintf(stderr, "Error transferring the data to system memory\n");
110                 goto fail;
111             }
112             tmp_frame = sw_frame;
113         } else
114             tmp_frame = frame;
115
116         size = av_image_get_buffer_size(tmp_frame->format, tmp_frame->width,
117                                         tmp_frame->height, 1);
118         buffer = av_malloc(size);
119         if (!buffer) {
120             fprintf(stderr, "Can not alloc buffer\n");
121             ret = AVERROR(ENOMEM);
122             goto fail;
123         }
124         ret = av_image_copy_to_buffer(buffer, size,
125                                       (const uint8_t * const *)tmp_frame->data,
126                                       (const int *)tmp_frame->linesize, tmp_frame->format,
127                                       tmp_frame->width, tmp_frame->height, 1);
128         if (ret < 0) {
129             fprintf(stderr, "Can not copy image to buffer\n");
130             goto fail;
131         }
132
133         if ((ret = fwrite(buffer, 1, size, output_file)) < 0) {
134             fprintf(stderr, "Failed to dump raw data.\n");
135             goto fail;
136         }
137
138     fail:
139         av_frame_free(&frame);
140         av_frame_free(&sw_frame);
141         av_freep(&buffer);
142         if (ret < 0)
143             return ret;
144     }
145 }
146
147 int main(int argc, char *argv[])
148 {
149     AVFormatContext *input_ctx = NULL;
150     int video_stream, ret;
151     AVStream *video = NULL;
152     AVCodecContext *decoder_ctx = NULL;
153     AVCodec *decoder = NULL;
154     AVPacket packet;
155     enum AVHWDeviceType type;
156     int i;
157
158     if (argc < 4) {
159         fprintf(stderr, "Usage: %s <device type> <input file> <output file>\n", argv[0]);
160         return -1;
161     }
162
163     type = av_hwdevice_find_type_by_name(argv[1]);
164     if (type == AV_HWDEVICE_TYPE_NONE) {
165         fprintf(stderr, "Device type %s is not supported.\n", argv[1]);
166         fprintf(stderr, "Available device types:");
167         while((type = av_hwdevice_iterate_types(type)) != AV_HWDEVICE_TYPE_NONE)
168             fprintf(stderr, " %s", av_hwdevice_get_type_name(type));
169         fprintf(stderr, "\n");
170         return -1;
171     }
172
173     /* open the input file */
174     if (avformat_open_input(&input_ctx, argv[2], NULL, NULL) != 0) {
175         fprintf(stderr, "Cannot open input file '%s'\n", argv[2]);
176         return -1;
177     }
178
179     if (avformat_find_stream_info(input_ctx, NULL) < 0) {
180         fprintf(stderr, "Cannot find input stream information.\n");
181         return -1;
182     }
183
184     /* find the video stream information */
185     ret = av_find_best_stream(input_ctx, AVMEDIA_TYPE_VIDEO, -1, -1, &decoder, 0);
186     if (ret < 0) {
187         fprintf(stderr, "Cannot find a video stream in the input file\n");
188         return -1;
189     }
190     video_stream = ret;
191
192     for (i = 0;; i++) {
193         const AVCodecHWConfig *config = avcodec_get_hw_config(decoder, i);
194         if (!config) {
195             fprintf(stderr, "Decoder %s does not support device type %s.\n",
196                     decoder->name, av_hwdevice_get_type_name(type));
197             return -1;
198         }
199         if (config->methods & AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX &&
200             config->device_type == type) {
201             hw_pix_fmt = config->pix_fmt;
202             break;
203         }
204     }
205
206     if (!(decoder_ctx = avcodec_alloc_context3(decoder)))
207         return AVERROR(ENOMEM);
208
209     video = input_ctx->streams[video_stream];
210     if (avcodec_parameters_to_context(decoder_ctx, video->codecpar) < 0)
211         return -1;
212
213     decoder_ctx->get_format  = get_hw_format;
214
215     if (hw_decoder_init(decoder_ctx, type) < 0)
216         return -1;
217
218     if ((ret = avcodec_open2(decoder_ctx, decoder, NULL)) < 0) {
219         fprintf(stderr, "Failed to open codec for stream #%u\n", video_stream);
220         return -1;
221     }
222
223     /* open the file to dump raw data */
224     output_file = fopen(argv[3], "w+");
225
226     /* actual decoding and dump the raw data */
227     while (ret >= 0) {
228         if ((ret = av_read_frame(input_ctx, &packet)) < 0)
229             break;
230
231         if (video_stream == packet.stream_index)
232             ret = decode_write(decoder_ctx, &packet);
233
234         av_packet_unref(&packet);
235     }
236
237     /* flush the decoder */
238     packet.data = NULL;
239     packet.size = 0;
240     ret = decode_write(decoder_ctx, &packet);
241     av_packet_unref(&packet);
242
243     if (output_file)
244         fclose(output_file);
245     avcodec_free_context(&decoder_ctx);
246     avformat_close_input(&input_ctx);
247     av_buffer_unref(&hw_device_ctx);
248
249     return 0;
250 }