doc/examples: add directory listing example
[ffmpeg.git] / doc / examples / avio_list_dir.c
1 /*
2  * Copyright (c) 2014 Lukasz Marek
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22
23 #include <libavcodec/avcodec.h>
24 #include <libavformat/avformat.h>
25 #include <libavformat/avio.h>
26
27 static const char *type_string(int type)
28 {
29     switch (type) {
30     case AVIO_ENTRY_DIRECTORY:
31         return "<DIR>";
32     case AVIO_ENTRY_FILE:
33         return "<FILE>";
34     case AVIO_ENTRY_BLOCK_DEVICE:
35         return "<BLOCK DEVICE>";
36     case AVIO_ENTRY_CHARACTER_DEVICE:
37         return "<CHARACTER DEVICE>";
38     case AVIO_ENTRY_NAMED_PIPE:
39         return "<PIPE>";
40     case AVIO_ENTRY_SYMBOLIC_LINK:
41         return "<LINK>";
42     case AVIO_ENTRY_SOCKET:
43         return "<SOCKET>";
44     case AVIO_ENTRY_UNKNOWN:
45     default:
46         break;
47     }
48     return "<UNKNOWN>";
49 }
50
51 int main(int argc, char *argv[])
52 {
53     const char *input_dir = NULL;
54     AVIODirEntry *entry = NULL;
55     AVIODirContext *ctx = NULL;
56     int cnt, ret;
57     char filemode[4], uid_and_gid[20];
58
59     av_log_set_level(AV_LOG_DEBUG);
60
61     if (argc != 2) {
62         fprintf(stderr, "usage: %s input_dir\n"
63                 "API example program to show how to list files in directory "
64                 "accessed through AVIOContext.\n", argv[0]);
65         return 1;
66     }
67     input_dir = argv[1];
68
69     /* register codecs and formats and other lavf/lavc components*/
70     av_register_all();
71
72     if ((ret = avio_open_dir(&ctx, input_dir, NULL)) < 0) {
73         av_log(NULL, AV_LOG_ERROR, "Cannot open directory: %s.\n", av_err2str(ret));
74         return 1;
75     }
76
77     cnt = 0;
78     for (;;) {
79         if ((ret = avio_read_dir(ctx, &entry)) < 0) {
80             av_log(NULL, AV_LOG_ERROR, "Cannot list directory: %s.\n", av_err2str(ret));
81             return 1;
82         }
83         if (!entry)
84             break;
85         if (entry->filemode == -1) {
86             snprintf(filemode, 4, "???");
87         } else {
88             snprintf(filemode, 4, "%3"PRIo64, entry->filemode);
89         }
90         snprintf(uid_and_gid, 20, "%"PRId64"(%"PRId64")", entry->user_id, entry->group_id);
91         if (cnt == 0)
92             av_log(NULL, AV_LOG_INFO, "%-9s %12s %30s %10s %s %16s %16s %16s\n",
93                    "TYPE", "SIZE", "NAME", "UID(GID)", "UGO", "MODIFIED",
94                    "ACCESSED", "STATUS_CHANGED");
95         av_log(NULL, AV_LOG_INFO, "%-9s %12"PRId64" %30s %10s %s %16"PRId64" %16"PRId64" %16"PRId64"\n",
96                type_string(entry->type),
97                entry->size,
98                entry->name,
99                uid_and_gid,
100                filemode,
101                entry->modification_timestamp,
102                entry->access_timestamp,
103                entry->status_change_timestamp);
104         avio_free_directory_entry(&entry);
105         cnt++;
106     };
107
108     avio_close_dir(&ctx);
109
110     return 0;
111 }